FSx module#
Index > FSx
Auto-generated documentation for FSx type annotations stubs module types-boto3-fsx.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
FSx
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and FSx
.
From PyPI with pip#
Install types-boto3
for FSx
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[fsx]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[fsx]'
# standalone installation
python -m pip install types-boto3-fsx
How to uninstall#
python -m pip uninstall -y types-boto3-fsx
Usage#
Code samples can be found in Examples.
FSxClient#
Type annotations and code completion for boto3.client("fsx")
as FSxClient
boto3 documentation
# FSxClient usage example
from boto3.session import Session
from types_boto3_fsx.client import FSxClient
def get_client() -> FSxClient:
return Session().client("fsx")
Paginators#
Type annotations and code completion for paginators
from boto3.client("fsx").get_paginator("...")
.
# DescribeBackupsPaginator usage example
from boto3.session import Session
from types_boto3_fsx.paginator import DescribeBackupsPaginator
def get_describe_backups_paginator() -> DescribeBackupsPaginator:
return Session().client("fsx").get_paginator("describe_backups"))
- DescribeBackupsPaginator
- DescribeFileSystemsPaginator
- DescribeStorageVirtualMachinesPaginator
- DescribeVolumesPaginator
- ListTagsForResourcePaginator
Literals#
Type annotations for literals used in methods and schema.
# AdministrativeActionTypeType usage example
from types_boto3_fsx.literals import AdministrativeActionTypeType
def get_value() -> AdministrativeActionTypeType:
return "DOWNLOAD_DATA_FROM_BACKUP"
- AdministrativeActionTypeType
- AliasLifecycleType
- AutoImportPolicyTypeType
- AutocommitPeriodTypeType
- BackupLifecycleType
- BackupTypeType
- DataCompressionTypeType
- DataRepositoryLifecycleType
- DataRepositoryTaskFilterNameType
- DataRepositoryTaskLifecycleType
- DataRepositoryTaskTypeType
- DeleteFileSystemOpenZFSOptionType
- DeleteOpenZFSVolumeOptionType
- DescribeBackupsPaginatorName
- DescribeFileSystemsPaginatorName
- DescribeStorageVirtualMachinesPaginatorName
- DescribeVolumesPaginatorName
- DiskIopsConfigurationModeType
- DriveCacheTypeType
- EventTypeType
- FileCacheLifecycleType
- FileCacheLustreDeploymentTypeType
- FileCacheTypeType
- FileSystemLifecycleType
- FileSystemMaintenanceOperationType
- FileSystemTypeType
- FilterNameType
- FlexCacheEndpointTypeType
- InputOntapVolumeTypeType
- ListTagsForResourcePaginatorName
- LustreAccessAuditLogLevelType
- LustreDeploymentTypeType
- MetadataConfigurationModeType
- NfsVersionType
- OntapDeploymentTypeType
- OntapVolumeTypeType
- OpenZFSCopyStrategyType
- OpenZFSDataCompressionTypeType
- OpenZFSDeploymentTypeType
- OpenZFSQuotaTypeType
- OpenZFSReadCacheSizingModeType
- PrivilegedDeleteType
- ReportFormatType
- ReportScopeType
- ResourceTypeType
- RestoreOpenZFSVolumeOptionType
- RetentionPeriodTypeType
- SecurityStyleType
- SnaplockTypeType
- SnapshotFilterNameType
- SnapshotLifecycleType
- StatusType
- StorageTypeType
- StorageVirtualMachineFilterNameType
- StorageVirtualMachineLifecycleType
- StorageVirtualMachineRootVolumeSecurityStyleType
- StorageVirtualMachineSubtypeType
- TieringPolicyNameType
- UnitType
- UpdateOpenZFSVolumeOptionType
- VolumeFilterNameType
- VolumeLifecycleType
- VolumeStyleType
- VolumeTypeType
- WindowsAccessAuditLogLevelType
- WindowsDeploymentTypeType
- FSxServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ActiveDirectoryBackupAttributesTypeDef
- AdministrativeActionFailureDetailsTypeDef
- AggregateConfigurationTypeDef
- AliasTypeDef
- AssociateFileSystemAliasesRequestTypeDef
- ResponseMetadataTypeDef
- AutoExportPolicyOutputTypeDef
- AutoExportPolicyTypeDef
- AutoImportPolicyOutputTypeDef
- AutoImportPolicyTypeDef
- AutocommitPeriodTypeDef
- BackupFailureDetailsTypeDef
- TagTypeDef
- CancelDataRepositoryTaskRequestTypeDef
- CompletionReportTypeDef
- CopySnapshotAndUpdateVolumeRequestTypeDef
- CreateAggregateConfigurationTypeDef
- FileCacheLustreMetadataConfigurationTypeDef
- CreateFileSystemLustreMetadataConfigurationTypeDef
- LustreLogCreateConfigurationTypeDef
- DiskIopsConfigurationTypeDef
- OpenZFSReadCacheConfigurationTypeDef
- SelfManagedActiveDirectoryConfigurationTypeDef
- WindowsAuditLogCreateConfigurationTypeDef
- TieringPolicyTypeDef
- CreateOpenZFSOriginSnapshotConfigurationTypeDef
- OpenZFSUserOrGroupQuotaTypeDef
- DataRepositoryFailureDetailsTypeDef
- DataRepositoryTaskFailureDetailsTypeDef
- DataRepositoryTaskFilterTypeDef
- DataRepositoryTaskStatusTypeDef
- DeleteBackupRequestTypeDef
- DeleteDataRepositoryAssociationRequestTypeDef
- DeleteFileCacheRequestTypeDef
- DeleteSnapshotRequestTypeDef
- DeleteStorageVirtualMachineRequestTypeDef
- DeleteVolumeOpenZFSConfigurationTypeDef
- FilterTypeDef
- PaginatorConfigTypeDef
- DescribeFileCachesRequestTypeDef
- DescribeFileSystemAliasesRequestTypeDef
- DescribeFileSystemsRequestTypeDef
- SnapshotFilterTypeDef
- StorageVirtualMachineFilterTypeDef
- VolumeFilterTypeDef
- DisassociateFileSystemAliasesRequestTypeDef
- DurationSinceLastAccessTypeDef
- FileCacheFailureDetailsTypeDef
- FileCacheNFSConfigurationTypeDef
- LustreLogConfigurationTypeDef
- FileSystemEndpointTypeDef
- FileSystemFailureDetailsTypeDef
- FileSystemLustreMetadataConfigurationTypeDef
- LifecycleTransitionReasonTypeDef
- ListTagsForResourceRequestTypeDef
- LustreRootSquashConfigurationOutputTypeDef
- LustreRootSquashConfigurationTypeDef
- OpenZFSClientConfigurationOutputTypeDef
- OpenZFSClientConfigurationTypeDef
- OpenZFSOriginSnapshotConfigurationTypeDef
- ReleaseFileSystemNfsV3LocksRequestTypeDef
- RestoreVolumeFromSnapshotRequestTypeDef
- RetentionPeriodTypeDef
- SelfManagedActiveDirectoryAttributesTypeDef
- SelfManagedActiveDirectoryConfigurationUpdatesTypeDef
- StartMisconfiguredStateRecoveryRequestTypeDef
- SvmEndpointTypeDef
- UntagResourceRequestTypeDef
- UpdateFileCacheLustreConfigurationTypeDef
- UpdateFileSystemLustreMetadataConfigurationTypeDef
- UpdateSharedVpcConfigurationRequestTypeDef
- UpdateSnapshotRequestTypeDef
- WindowsAuditLogConfigurationTypeDef
- AssociateFileSystemAliasesResponseTypeDef
- CancelDataRepositoryTaskResponseTypeDef
- DeleteBackupResponseTypeDef
- DeleteDataRepositoryAssociationResponseTypeDef
- DeleteFileCacheResponseTypeDef
- DeleteSnapshotResponseTypeDef
- DeleteStorageVirtualMachineResponseTypeDef
- DescribeFileSystemAliasesResponseTypeDef
- DescribeSharedVpcConfigurationResponseTypeDef
- DisassociateFileSystemAliasesResponseTypeDef
- UpdateSharedVpcConfigurationResponseTypeDef
- NFSDataRepositoryConfigurationTypeDef
- S3DataRepositoryConfigurationOutputTypeDef
- S3DataRepositoryConfigurationTypeDef
- CopyBackupRequestTypeDef
- CreateBackupRequestTypeDef
- CreateSnapshotRequestTypeDef
- DeleteFileSystemLustreConfigurationTypeDef
- DeleteFileSystemLustreResponseTypeDef
- DeleteFileSystemOpenZFSConfigurationTypeDef
- DeleteFileSystemOpenZFSResponseTypeDef
- DeleteFileSystemWindowsConfigurationTypeDef
- DeleteFileSystemWindowsResponseTypeDef
- DeleteVolumeOntapConfigurationTypeDef
- DeleteVolumeOntapResponseTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestTypeDef
- CreateFileCacheLustreConfigurationTypeDef
- CreateFileSystemOntapConfigurationTypeDef
- UpdateFileSystemOntapConfigurationTypeDef
- OpenZFSFileSystemConfigurationTypeDef
- UpdateFileSystemOpenZFSConfigurationTypeDef
- CreateSvmActiveDirectoryConfigurationTypeDef
- CreateFileSystemWindowsConfigurationTypeDef
- DataRepositoryConfigurationTypeDef
- DescribeDataRepositoryTasksRequestTypeDef
- DescribeBackupsRequestTypeDef
- DescribeDataRepositoryAssociationsRequestTypeDef
- DescribeBackupsRequestPaginateTypeDef
- DescribeFileSystemsRequestPaginateTypeDef
- ListTagsForResourceRequestPaginateTypeDef
- DescribeSnapshotsRequestTypeDef
- DescribeStorageVirtualMachinesRequestPaginateTypeDef
- DescribeStorageVirtualMachinesRequestTypeDef
- DescribeVolumesRequestPaginateTypeDef
- DescribeVolumesRequestTypeDef
- ReleaseConfigurationTypeDef
- FileCacheDataRepositoryAssociationTypeDef
- FileCacheLustreConfigurationTypeDef
- FileSystemEndpointsTypeDef
- SnapshotPaginatorTypeDef
- SnapshotTypeDef
- LustreRootSquashConfigurationUnionTypeDef
- OpenZFSNfsExportOutputTypeDef
- OpenZFSClientConfigurationUnionTypeDef
- SnaplockRetentionPeriodTypeDef
- SvmActiveDirectoryConfigurationTypeDef
- UpdateFileSystemWindowsConfigurationTypeDef
- UpdateSvmActiveDirectoryConfigurationTypeDef
- SvmEndpointsTypeDef
- UpdateFileCacheRequestTypeDef
- WindowsFileSystemConfigurationTypeDef
- DataRepositoryAssociationTypeDef
- S3DataRepositoryConfigurationUnionTypeDef
- DeleteFileSystemRequestTypeDef
- DeleteFileSystemResponseTypeDef
- DeleteVolumeRequestTypeDef
- DeleteVolumeResponseTypeDef
- CreateStorageVirtualMachineRequestTypeDef
- LustreFileSystemConfigurationTypeDef
- CreateDataRepositoryTaskRequestTypeDef
- DataRepositoryTaskTypeDef
- CreateFileCacheRequestTypeDef
- FileCacheCreatingTypeDef
- FileCacheTypeDef
- OntapFileSystemConfigurationTypeDef
- CreateSnapshotResponseTypeDef
- DescribeSnapshotsResponseTypeDef
- UpdateSnapshotResponseTypeDef
- CreateFileSystemLustreConfigurationTypeDef
- UpdateFileSystemLustreConfigurationTypeDef
- OpenZFSVolumeConfigurationTypeDef
- OpenZFSNfsExportTypeDef
- CreateSnaplockConfigurationTypeDef
- SnaplockConfigurationTypeDef
- UpdateSnaplockConfigurationTypeDef
- UpdateStorageVirtualMachineRequestTypeDef
- StorageVirtualMachineTypeDef
- CreateDataRepositoryAssociationResponseTypeDef
- DescribeDataRepositoryAssociationsResponseTypeDef
- UpdateDataRepositoryAssociationResponseTypeDef
- CreateDataRepositoryAssociationRequestTypeDef
- UpdateDataRepositoryAssociationRequestTypeDef
- CreateDataRepositoryTaskResponseTypeDef
- DescribeDataRepositoryTasksResponseTypeDef
- CreateFileCacheResponseTypeDef
- DescribeFileCachesResponseTypeDef
- UpdateFileCacheResponseTypeDef
- UpdateFileSystemRequestTypeDef
- OpenZFSNfsExportUnionTypeDef
- CreateOntapVolumeConfigurationTypeDef
- OntapVolumeConfigurationTypeDef
- UpdateOntapVolumeConfigurationTypeDef
- CreateStorageVirtualMachineResponseTypeDef
- DescribeStorageVirtualMachinesResponseTypeDef
- UpdateStorageVirtualMachineResponseTypeDef
- CreateOpenZFSVolumeConfigurationTypeDef
- OpenZFSCreateRootVolumeConfigurationTypeDef
- UpdateOpenZFSVolumeConfigurationTypeDef
- CreateVolumeFromBackupRequestTypeDef
- VolumePaginatorTypeDef
- VolumeTypeDef
- CreateVolumeRequestTypeDef
- CreateFileSystemOpenZFSConfigurationTypeDef
- UpdateVolumeRequestTypeDef
- AdministrativeActionPaginatorTypeDef
- DescribeVolumesResponsePaginatorTypeDef
- AdministrativeActionTypeDef
- CreateVolumeFromBackupResponseTypeDef
- CreateVolumeResponseTypeDef
- DescribeVolumesResponseTypeDef
- UpdateVolumeResponseTypeDef
- CreateFileSystemFromBackupRequestTypeDef
- CreateFileSystemRequestTypeDef
- FileSystemPaginatorTypeDef
- CopySnapshotAndUpdateVolumeResponseTypeDef
- FileSystemTypeDef
- RestoreVolumeFromSnapshotResponseTypeDef
- BackupPaginatorTypeDef
- DescribeFileSystemsResponsePaginatorTypeDef
- BackupTypeDef
- CreateFileSystemFromBackupResponseTypeDef
- CreateFileSystemResponseTypeDef
- DescribeFileSystemsResponseTypeDef
- ReleaseFileSystemNfsV3LocksResponseTypeDef
- StartMisconfiguredStateRecoveryResponseTypeDef
- UpdateFileSystemResponseTypeDef
- DescribeBackupsResponsePaginatorTypeDef
- CopyBackupResponseTypeDef
- CreateBackupResponseTypeDef
- DescribeBackupsResponseTypeDef