FSx module#
Index > FSx
Auto-generated documentation for FSx type annotations stubs module mypy-boto3-fsx.
How to install#
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 boto3-stubs
for FSx
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[fsx]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[fsx]'
# standalone installation
python -m pip install mypy-boto3-fsx
How to uninstall#
python -m pip uninstall -y mypy-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 mypy_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 mypy_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 schemas.
# AdministrativeActionTypeType usage example
from mypy_boto3_fsx.literals import AdministrativeActionTypeType
def get_value() -> AdministrativeActionTypeType:
return "FILE_SYSTEM_ALIAS_ASSOCIATION"
- AdministrativeActionTypeType
- AliasLifecycleType
- AutoImportPolicyTypeType
- 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
- NfsVersionType
- OntapDeploymentTypeType
- OntapVolumeTypeType
- OpenZFSCopyStrategyType
- OpenZFSDataCompressionTypeType
- OpenZFSDeploymentTypeType
- OpenZFSQuotaTypeType
- ReportFormatType
- ReportScopeType
- ResourceTypeType
- RestoreOpenZFSVolumeOptionType
- SecurityStyleType
- SnapshotFilterNameType
- SnapshotLifecycleType
- StatusType
- StorageTypeType
- StorageVirtualMachineFilterNameType
- StorageVirtualMachineLifecycleType
- StorageVirtualMachineRootVolumeSecurityStyleType
- StorageVirtualMachineSubtypeType
- TieringPolicyNameType
- VolumeFilterNameType
- VolumeLifecycleType
- VolumeTypeType
- WindowsAccessAuditLogLevelType
- WindowsDeploymentTypeType
- FSxServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# ActiveDirectoryBackupAttributesTypeDef usage example
from mypy_boto3_fsx.type_defs import ActiveDirectoryBackupAttributesTypeDef
def get_value() -> ActiveDirectoryBackupAttributesTypeDef:
return {
"DomainName": ...,
}
- ActiveDirectoryBackupAttributesTypeDef
- AdministrativeActionFailureDetailsTypeDef
- AliasTypeDef
- AssociateFileSystemAliasesRequestRequestTypeDef
- AutoExportPolicyTypeDef
- AutoImportPolicyTypeDef
- BackupFailureDetailsTypeDef
- TagTypeDef
- CancelDataRepositoryTaskRequestRequestTypeDef
- CancelDataRepositoryTaskResponseTypeDef
- CompletionReportTypeDef
- FileCacheLustreMetadataConfigurationTypeDef
- CreateFileSystemFromBackupResponseTypeDef
- LustreLogCreateConfigurationTypeDef
- LustreRootSquashConfigurationTypeDef
- DiskIopsConfigurationTypeDef
- CreateFileSystemResponseTypeDef
- SelfManagedActiveDirectoryConfigurationTypeDef
- WindowsAuditLogCreateConfigurationTypeDef
- TieringPolicyTypeDef
- CreateOpenZFSOriginSnapshotConfigurationTypeDef
- OpenZFSUserOrGroupQuotaTypeDef
- DataRepositoryFailureDetailsTypeDef
- DataRepositoryTaskFailureDetailsTypeDef
- DataRepositoryTaskFilterTypeDef
- DataRepositoryTaskStatusTypeDef
- DeleteBackupRequestRequestTypeDef
- DeleteBackupResponseTypeDef
- DeleteDataRepositoryAssociationRequestRequestTypeDef
- DeleteDataRepositoryAssociationResponseTypeDef
- DeleteFileCacheRequestRequestTypeDef
- DeleteFileCacheResponseTypeDef
- DeleteSnapshotRequestRequestTypeDef
- DeleteSnapshotResponseTypeDef
- DeleteStorageVirtualMachineRequestRequestTypeDef
- DeleteStorageVirtualMachineResponseTypeDef
- DeleteVolumeOpenZFSConfigurationTypeDef
- FilterTypeDef
- DescribeFileCachesRequestRequestTypeDef
- DescribeFileSystemAliasesRequestRequestTypeDef
- DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef
- DescribeFileSystemsRequestRequestTypeDef
- DescribeFileSystemsResponseTypeDef
- SnapshotFilterTypeDef
- StorageVirtualMachineFilterTypeDef
- VolumeFilterTypeDef
- DisassociateFileSystemAliasesRequestRequestTypeDef
- FileCacheFailureDetailsTypeDef
- FileCacheNFSConfigurationTypeDef
- LustreLogConfigurationTypeDef
- FileSystemEndpointTypeDef
- FileSystemFailureDetailsTypeDef
- LifecycleTransitionReasonTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- ListTagsForResourceRequestRequestTypeDef
- OpenZFSClientConfigurationTypeDef
- OpenZFSOriginSnapshotConfigurationTypeDef
- PaginatorConfigTypeDef
- ReleaseFileSystemNfsV3LocksRequestRequestTypeDef
- ReleaseFileSystemNfsV3LocksResponseTypeDef
- ResponseMetadataTypeDef
- RestoreVolumeFromSnapshotRequestRequestTypeDef
- RestoreVolumeFromSnapshotResponseTypeDef
- SelfManagedActiveDirectoryAttributesTypeDef
- SelfManagedActiveDirectoryConfigurationUpdatesTypeDef
- SvmEndpointTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateFileCacheLustreConfigurationTypeDef
- UpdateFileSystemResponseTypeDef
- UpdateSnapshotRequestRequestTypeDef
- WindowsAuditLogConfigurationTypeDef
- AssociateFileSystemAliasesResponseTypeDef
- DescribeFileSystemAliasesResponseTypeDef
- DisassociateFileSystemAliasesResponseTypeDef
- NFSDataRepositoryConfigurationTypeDef
- S3DataRepositoryConfigurationTypeDef
- CopyBackupRequestRequestTypeDef
- CreateBackupRequestRequestTypeDef
- CreateSnapshotRequestRequestTypeDef
- DeleteFileSystemLustreConfigurationTypeDef
- DeleteFileSystemLustreResponseTypeDef
- DeleteFileSystemOpenZFSConfigurationTypeDef
- DeleteFileSystemOpenZFSResponseTypeDef
- DeleteFileSystemWindowsConfigurationTypeDef
- DeleteFileSystemWindowsResponseTypeDef
- DeleteVolumeOntapConfigurationTypeDef
- DeleteVolumeOntapResponseTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- CreateDataRepositoryTaskRequestRequestTypeDef
- CreateFileCacheLustreConfigurationTypeDef
- CreateFileSystemLustreConfigurationTypeDef
- UpdateFileSystemLustreConfigurationTypeDef
- CreateFileSystemOntapConfigurationTypeDef
- OpenZFSFileSystemConfigurationTypeDef
- UpdateFileSystemOntapConfigurationTypeDef
- UpdateFileSystemOpenZFSConfigurationTypeDef
- CreateSvmActiveDirectoryConfigurationTypeDef
- CreateFileSystemWindowsConfigurationTypeDef
- CreateOntapVolumeConfigurationTypeDef
- OntapVolumeConfigurationTypeDef
- UpdateOntapVolumeConfigurationTypeDef
- DataRepositoryConfigurationTypeDef
- DescribeDataRepositoryTasksRequestRequestTypeDef
- DataRepositoryTaskTypeDef
- DescribeBackupsRequestDescribeBackupsPaginateTypeDef
- DescribeBackupsRequestRequestTypeDef
- DescribeDataRepositoryAssociationsRequestRequestTypeDef
- DescribeSnapshotsRequestRequestTypeDef
- DescribeStorageVirtualMachinesRequestDescribeStorageVirtualMachinesPaginateTypeDef
- DescribeStorageVirtualMachinesRequestRequestTypeDef
- DescribeVolumesRequestDescribeVolumesPaginateTypeDef
- DescribeVolumesRequestRequestTypeDef
- FileCacheDataRepositoryAssociationTypeDef
- FileCacheLustreConfigurationTypeDef
- FileSystemEndpointsTypeDef
- SnapshotTypeDef
- OpenZFSNfsExportTypeDef
- SvmActiveDirectoryConfigurationTypeDef
- UpdateFileSystemWindowsConfigurationTypeDef
- UpdateSvmActiveDirectoryConfigurationTypeDef
- SvmEndpointsTypeDef
- UpdateFileCacheRequestRequestTypeDef
- WindowsFileSystemConfigurationTypeDef
- CreateDataRepositoryAssociationRequestRequestTypeDef
- DataRepositoryAssociationTypeDef
- UpdateDataRepositoryAssociationRequestRequestTypeDef
- DeleteFileSystemRequestRequestTypeDef
- DeleteFileSystemResponseTypeDef
- DeleteVolumeRequestRequestTypeDef
- DeleteVolumeResponseTypeDef
- CreateStorageVirtualMachineRequestRequestTypeDef
- CreateVolumeFromBackupRequestRequestTypeDef
- LustreFileSystemConfigurationTypeDef
- CreateDataRepositoryTaskResponseTypeDef
- DescribeDataRepositoryTasksResponseTypeDef
- CreateFileCacheRequestRequestTypeDef
- FileCacheCreatingTypeDef
- FileCacheTypeDef
- OntapFileSystemConfigurationTypeDef
- CreateSnapshotResponseTypeDef
- DescribeSnapshotsResponseTypeDef
- UpdateSnapshotResponseTypeDef
- CreateOpenZFSVolumeConfigurationTypeDef
- OpenZFSCreateRootVolumeConfigurationTypeDef
- OpenZFSVolumeConfigurationTypeDef
- UpdateOpenZFSVolumeConfigurationTypeDef
- UpdateFileSystemRequestRequestTypeDef
- UpdateStorageVirtualMachineRequestRequestTypeDef
- StorageVirtualMachineTypeDef
- CreateDataRepositoryAssociationResponseTypeDef
- DescribeDataRepositoryAssociationsResponseTypeDef
- UpdateDataRepositoryAssociationResponseTypeDef
- CreateFileCacheResponseTypeDef
- DescribeFileCachesResponseTypeDef
- UpdateFileCacheResponseTypeDef
- FileSystemTypeDef
- CreateVolumeRequestRequestTypeDef
- CreateFileSystemOpenZFSConfigurationTypeDef
- VolumeTypeDef
- UpdateVolumeRequestRequestTypeDef
- CreateStorageVirtualMachineResponseTypeDef
- DescribeStorageVirtualMachinesResponseTypeDef
- UpdateStorageVirtualMachineResponseTypeDef
- CreateFileSystemFromBackupRequestRequestTypeDef
- CreateFileSystemRequestRequestTypeDef
- AdministrativeActionTypeDef
- BackupTypeDef
- CreateVolumeFromBackupResponseTypeDef
- CreateVolumeResponseTypeDef
- DescribeVolumesResponseTypeDef
- UpdateVolumeResponseTypeDef
- CopyBackupResponseTypeDef
- CreateBackupResponseTypeDef
- DescribeBackupsResponseTypeDef