diff options
Diffstat (limited to 'python-mypy-boto3-fsx.spec')
| -rw-r--r-- | python-mypy-boto3-fsx.spec | 1960 |
1 files changed, 1960 insertions, 0 deletions
diff --git a/python-mypy-boto3-fsx.spec b/python-mypy-boto3-fsx.spec new file mode 100644 index 0000000..1f31771 --- /dev/null +++ b/python-mypy-boto3-fsx.spec @@ -0,0 +1,1960 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-fsx +Version: 1.26.109 +Release: 1 +Summary: Type annotations for boto3.FSx 1.26.109 service generated with mypy-boto3-builder 7.14.5 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/29/92/8153b4a01a60781614bd2cc7f0f55c0538e2d5f293670b1765ce1f277cc3/mypy-boto3-fsx-1.26.109.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-fsx"></a> + +# mypy-boto3-fsx + +[](https://pypi.org/project/mypy-boto3-fsx) +[](https://pypi.org/project/mypy-boto3-fsx) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/) +[](https://pypistats.org/packages/mypy-boto3-fsx) + + + +Type annotations for +[boto3.FSx 1.26.109](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/fsx.html#FSx) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-fsx docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-fsx](#mypy-boto3-fsx) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `FSx`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `FSx` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-fsx +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[fsx]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[fsx]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`FSxClient` provides annotations for `boto3.client("fsx")`. + +```python +from boto3.session import Session + +from mypy_boto3_fsx import FSxClient + +client: FSxClient = Session().client("fsx") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_fsx.paginator` module contains type annotations for all paginators. + +```python +from boto3.session import Session + +from mypy_boto3_fsx import FSxClient +from mypy_boto3_fsx.paginator import ( + DescribeBackupsPaginator, + DescribeFileSystemsPaginator, + DescribeStorageVirtualMachinesPaginator, + DescribeVolumesPaginator, + ListTagsForResourcePaginator, +) + +client: FSxClient = Session().client("fsx") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_backups_paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups") +describe_file_systems_paginator: DescribeFileSystemsPaginator = client.get_paginator( + "describe_file_systems" +) +describe_storage_virtual_machines_paginator: DescribeStorageVirtualMachinesPaginator = ( + client.get_paginator("describe_storage_virtual_machines") +) +describe_volumes_paginator: DescribeVolumesPaginator = client.get_paginator("describe_volumes") +list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator( + "list_tags_for_resource" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_fsx.literals` module contains literals extracted from shapes that +can be used in user code for type checking. + +```python +from mypy_boto3_fsx.literals import ( + 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, +) + + +def check_value(value: AdministrativeActionTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_fsx.type_defs` module contains structures and shapes assembled to +typed dictionaries for additional type checking. + +```python +from mypy_boto3_fsx.type_defs import ( + ActiveDirectoryBackupAttributesTypeDef, + AdministrativeActionFailureDetailsTypeDef, + AliasTypeDef, + AssociateFileSystemAliasesRequestRequestTypeDef, + ResponseMetadataTypeDef, + AutoExportPolicyTypeDef, + AutoImportPolicyTypeDef, + BackupFailureDetailsTypeDef, + TagTypeDef, + CancelDataRepositoryTaskRequestRequestTypeDef, + CompletionReportTypeDef, + FileCacheLustreMetadataConfigurationTypeDef, + LustreLogCreateConfigurationTypeDef, + LustreRootSquashConfigurationTypeDef, + DiskIopsConfigurationTypeDef, + SelfManagedActiveDirectoryConfigurationTypeDef, + WindowsAuditLogCreateConfigurationTypeDef, + TieringPolicyTypeDef, + CreateOpenZFSOriginSnapshotConfigurationTypeDef, + OpenZFSUserOrGroupQuotaTypeDef, + DataRepositoryFailureDetailsTypeDef, + DataRepositoryTaskFailureDetailsTypeDef, + DataRepositoryTaskFilterTypeDef, + DataRepositoryTaskStatusTypeDef, + DeleteBackupRequestRequestTypeDef, + DeleteDataRepositoryAssociationRequestRequestTypeDef, + DeleteFileCacheRequestRequestTypeDef, + DeleteSnapshotRequestRequestTypeDef, + DeleteStorageVirtualMachineRequestRequestTypeDef, + DeleteVolumeOpenZFSConfigurationTypeDef, + FilterTypeDef, + PaginatorConfigTypeDef, + DescribeFileCachesRequestRequestTypeDef, + DescribeFileSystemAliasesRequestRequestTypeDef, + DescribeFileSystemsRequestRequestTypeDef, + SnapshotFilterTypeDef, + StorageVirtualMachineFilterTypeDef, + VolumeFilterTypeDef, + DisassociateFileSystemAliasesRequestRequestTypeDef, + FileCacheFailureDetailsTypeDef, + FileCacheNFSConfigurationTypeDef, + LustreLogConfigurationTypeDef, + FileSystemEndpointTypeDef, + FileSystemFailureDetailsTypeDef, + LifecycleTransitionReasonTypeDef, + ListTagsForResourceRequestRequestTypeDef, + OpenZFSClientConfigurationTypeDef, + OpenZFSOriginSnapshotConfigurationTypeDef, + ReleaseFileSystemNfsV3LocksRequestRequestTypeDef, + RestoreVolumeFromSnapshotRequestRequestTypeDef, + SelfManagedActiveDirectoryAttributesTypeDef, + SelfManagedActiveDirectoryConfigurationUpdatesTypeDef, + SvmEndpointTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateFileCacheLustreConfigurationTypeDef, + UpdateSnapshotRequestRequestTypeDef, + WindowsAuditLogConfigurationTypeDef, + AssociateFileSystemAliasesResponseTypeDef, + CancelDataRepositoryTaskResponseTypeDef, + CreateFileSystemFromBackupResponseTypeDef, + CreateFileSystemResponseTypeDef, + DeleteBackupResponseTypeDef, + DeleteDataRepositoryAssociationResponseTypeDef, + DeleteFileCacheResponseTypeDef, + DeleteSnapshotResponseTypeDef, + DeleteStorageVirtualMachineResponseTypeDef, + DescribeFileSystemAliasesResponseTypeDef, + DescribeFileSystemsResponseTypeDef, + DisassociateFileSystemAliasesResponseTypeDef, + ReleaseFileSystemNfsV3LocksResponseTypeDef, + RestoreVolumeFromSnapshotResponseTypeDef, + UpdateFileSystemResponseTypeDef, + 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, + DescribeBackupsRequestRequestTypeDef, + DescribeDataRepositoryAssociationsRequestRequestTypeDef, + DescribeBackupsRequestDescribeBackupsPaginateTypeDef, + DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef, + ListTagsForResourceRequestListTagsForResourcePaginateTypeDef, + 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, +) + + +def get_structure() -> ActiveDirectoryBackupAttributesTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from `botocore` schemas. +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-fsx` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-fsx +Summary: Type annotations for boto3.FSx 1.26.109 service generated with mypy-boto3-builder 7.14.5 +Provides: python-mypy-boto3-fsx +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-fsx +<a id="mypy-boto3-fsx"></a> + +# mypy-boto3-fsx + +[](https://pypi.org/project/mypy-boto3-fsx) +[](https://pypi.org/project/mypy-boto3-fsx) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/) +[](https://pypistats.org/packages/mypy-boto3-fsx) + + + +Type annotations for +[boto3.FSx 1.26.109](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/fsx.html#FSx) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-fsx docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-fsx](#mypy-boto3-fsx) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `FSx`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `FSx` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-fsx +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[fsx]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[fsx]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`FSxClient` provides annotations for `boto3.client("fsx")`. + +```python +from boto3.session import Session + +from mypy_boto3_fsx import FSxClient + +client: FSxClient = Session().client("fsx") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_fsx.paginator` module contains type annotations for all paginators. + +```python +from boto3.session import Session + +from mypy_boto3_fsx import FSxClient +from mypy_boto3_fsx.paginator import ( + DescribeBackupsPaginator, + DescribeFileSystemsPaginator, + DescribeStorageVirtualMachinesPaginator, + DescribeVolumesPaginator, + ListTagsForResourcePaginator, +) + +client: FSxClient = Session().client("fsx") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_backups_paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups") +describe_file_systems_paginator: DescribeFileSystemsPaginator = client.get_paginator( + "describe_file_systems" +) +describe_storage_virtual_machines_paginator: DescribeStorageVirtualMachinesPaginator = ( + client.get_paginator("describe_storage_virtual_machines") +) +describe_volumes_paginator: DescribeVolumesPaginator = client.get_paginator("describe_volumes") +list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator( + "list_tags_for_resource" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_fsx.literals` module contains literals extracted from shapes that +can be used in user code for type checking. + +```python +from mypy_boto3_fsx.literals import ( + 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, +) + + +def check_value(value: AdministrativeActionTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_fsx.type_defs` module contains structures and shapes assembled to +typed dictionaries for additional type checking. + +```python +from mypy_boto3_fsx.type_defs import ( + ActiveDirectoryBackupAttributesTypeDef, + AdministrativeActionFailureDetailsTypeDef, + AliasTypeDef, + AssociateFileSystemAliasesRequestRequestTypeDef, + ResponseMetadataTypeDef, + AutoExportPolicyTypeDef, + AutoImportPolicyTypeDef, + BackupFailureDetailsTypeDef, + TagTypeDef, + CancelDataRepositoryTaskRequestRequestTypeDef, + CompletionReportTypeDef, + FileCacheLustreMetadataConfigurationTypeDef, + LustreLogCreateConfigurationTypeDef, + LustreRootSquashConfigurationTypeDef, + DiskIopsConfigurationTypeDef, + SelfManagedActiveDirectoryConfigurationTypeDef, + WindowsAuditLogCreateConfigurationTypeDef, + TieringPolicyTypeDef, + CreateOpenZFSOriginSnapshotConfigurationTypeDef, + OpenZFSUserOrGroupQuotaTypeDef, + DataRepositoryFailureDetailsTypeDef, + DataRepositoryTaskFailureDetailsTypeDef, + DataRepositoryTaskFilterTypeDef, + DataRepositoryTaskStatusTypeDef, + DeleteBackupRequestRequestTypeDef, + DeleteDataRepositoryAssociationRequestRequestTypeDef, + DeleteFileCacheRequestRequestTypeDef, + DeleteSnapshotRequestRequestTypeDef, + DeleteStorageVirtualMachineRequestRequestTypeDef, + DeleteVolumeOpenZFSConfigurationTypeDef, + FilterTypeDef, + PaginatorConfigTypeDef, + DescribeFileCachesRequestRequestTypeDef, + DescribeFileSystemAliasesRequestRequestTypeDef, + DescribeFileSystemsRequestRequestTypeDef, + SnapshotFilterTypeDef, + StorageVirtualMachineFilterTypeDef, + VolumeFilterTypeDef, + DisassociateFileSystemAliasesRequestRequestTypeDef, + FileCacheFailureDetailsTypeDef, + FileCacheNFSConfigurationTypeDef, + LustreLogConfigurationTypeDef, + FileSystemEndpointTypeDef, + FileSystemFailureDetailsTypeDef, + LifecycleTransitionReasonTypeDef, + ListTagsForResourceRequestRequestTypeDef, + OpenZFSClientConfigurationTypeDef, + OpenZFSOriginSnapshotConfigurationTypeDef, + ReleaseFileSystemNfsV3LocksRequestRequestTypeDef, + RestoreVolumeFromSnapshotRequestRequestTypeDef, + SelfManagedActiveDirectoryAttributesTypeDef, + SelfManagedActiveDirectoryConfigurationUpdatesTypeDef, + SvmEndpointTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateFileCacheLustreConfigurationTypeDef, + UpdateSnapshotRequestRequestTypeDef, + WindowsAuditLogConfigurationTypeDef, + AssociateFileSystemAliasesResponseTypeDef, + CancelDataRepositoryTaskResponseTypeDef, + CreateFileSystemFromBackupResponseTypeDef, + CreateFileSystemResponseTypeDef, + DeleteBackupResponseTypeDef, + DeleteDataRepositoryAssociationResponseTypeDef, + DeleteFileCacheResponseTypeDef, + DeleteSnapshotResponseTypeDef, + DeleteStorageVirtualMachineResponseTypeDef, + DescribeFileSystemAliasesResponseTypeDef, + DescribeFileSystemsResponseTypeDef, + DisassociateFileSystemAliasesResponseTypeDef, + ReleaseFileSystemNfsV3LocksResponseTypeDef, + RestoreVolumeFromSnapshotResponseTypeDef, + UpdateFileSystemResponseTypeDef, + 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, + DescribeBackupsRequestRequestTypeDef, + DescribeDataRepositoryAssociationsRequestRequestTypeDef, + DescribeBackupsRequestDescribeBackupsPaginateTypeDef, + DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef, + ListTagsForResourceRequestListTagsForResourcePaginateTypeDef, + 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, +) + + +def get_structure() -> ActiveDirectoryBackupAttributesTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from `botocore` schemas. +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-fsx` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-fsx +Provides: python3-mypy-boto3-fsx-doc +%description help +<a id="mypy-boto3-fsx"></a> + +# mypy-boto3-fsx + +[](https://pypi.org/project/mypy-boto3-fsx) +[](https://pypi.org/project/mypy-boto3-fsx) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/) +[](https://pypistats.org/packages/mypy-boto3-fsx) + + + +Type annotations for +[boto3.FSx 1.26.109](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/fsx.html#FSx) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-fsx docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-fsx](#mypy-boto3-fsx) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `FSx`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `FSx` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-fsx +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[fsx]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[fsx]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[fsx]` in your environment: + +```bash +python -m pip install 'boto3-stubs[fsx]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`FSxClient` provides annotations for `boto3.client("fsx")`. + +```python +from boto3.session import Session + +from mypy_boto3_fsx import FSxClient + +client: FSxClient = Session().client("fsx") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_fsx.paginator` module contains type annotations for all paginators. + +```python +from boto3.session import Session + +from mypy_boto3_fsx import FSxClient +from mypy_boto3_fsx.paginator import ( + DescribeBackupsPaginator, + DescribeFileSystemsPaginator, + DescribeStorageVirtualMachinesPaginator, + DescribeVolumesPaginator, + ListTagsForResourcePaginator, +) + +client: FSxClient = Session().client("fsx") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_backups_paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups") +describe_file_systems_paginator: DescribeFileSystemsPaginator = client.get_paginator( + "describe_file_systems" +) +describe_storage_virtual_machines_paginator: DescribeStorageVirtualMachinesPaginator = ( + client.get_paginator("describe_storage_virtual_machines") +) +describe_volumes_paginator: DescribeVolumesPaginator = client.get_paginator("describe_volumes") +list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator( + "list_tags_for_resource" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_fsx.literals` module contains literals extracted from shapes that +can be used in user code for type checking. + +```python +from mypy_boto3_fsx.literals import ( + 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, +) + + +def check_value(value: AdministrativeActionTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_fsx.type_defs` module contains structures and shapes assembled to +typed dictionaries for additional type checking. + +```python +from mypy_boto3_fsx.type_defs import ( + ActiveDirectoryBackupAttributesTypeDef, + AdministrativeActionFailureDetailsTypeDef, + AliasTypeDef, + AssociateFileSystemAliasesRequestRequestTypeDef, + ResponseMetadataTypeDef, + AutoExportPolicyTypeDef, + AutoImportPolicyTypeDef, + BackupFailureDetailsTypeDef, + TagTypeDef, + CancelDataRepositoryTaskRequestRequestTypeDef, + CompletionReportTypeDef, + FileCacheLustreMetadataConfigurationTypeDef, + LustreLogCreateConfigurationTypeDef, + LustreRootSquashConfigurationTypeDef, + DiskIopsConfigurationTypeDef, + SelfManagedActiveDirectoryConfigurationTypeDef, + WindowsAuditLogCreateConfigurationTypeDef, + TieringPolicyTypeDef, + CreateOpenZFSOriginSnapshotConfigurationTypeDef, + OpenZFSUserOrGroupQuotaTypeDef, + DataRepositoryFailureDetailsTypeDef, + DataRepositoryTaskFailureDetailsTypeDef, + DataRepositoryTaskFilterTypeDef, + DataRepositoryTaskStatusTypeDef, + DeleteBackupRequestRequestTypeDef, + DeleteDataRepositoryAssociationRequestRequestTypeDef, + DeleteFileCacheRequestRequestTypeDef, + DeleteSnapshotRequestRequestTypeDef, + DeleteStorageVirtualMachineRequestRequestTypeDef, + DeleteVolumeOpenZFSConfigurationTypeDef, + FilterTypeDef, + PaginatorConfigTypeDef, + DescribeFileCachesRequestRequestTypeDef, + DescribeFileSystemAliasesRequestRequestTypeDef, + DescribeFileSystemsRequestRequestTypeDef, + SnapshotFilterTypeDef, + StorageVirtualMachineFilterTypeDef, + VolumeFilterTypeDef, + DisassociateFileSystemAliasesRequestRequestTypeDef, + FileCacheFailureDetailsTypeDef, + FileCacheNFSConfigurationTypeDef, + LustreLogConfigurationTypeDef, + FileSystemEndpointTypeDef, + FileSystemFailureDetailsTypeDef, + LifecycleTransitionReasonTypeDef, + ListTagsForResourceRequestRequestTypeDef, + OpenZFSClientConfigurationTypeDef, + OpenZFSOriginSnapshotConfigurationTypeDef, + ReleaseFileSystemNfsV3LocksRequestRequestTypeDef, + RestoreVolumeFromSnapshotRequestRequestTypeDef, + SelfManagedActiveDirectoryAttributesTypeDef, + SelfManagedActiveDirectoryConfigurationUpdatesTypeDef, + SvmEndpointTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateFileCacheLustreConfigurationTypeDef, + UpdateSnapshotRequestRequestTypeDef, + WindowsAuditLogConfigurationTypeDef, + AssociateFileSystemAliasesResponseTypeDef, + CancelDataRepositoryTaskResponseTypeDef, + CreateFileSystemFromBackupResponseTypeDef, + CreateFileSystemResponseTypeDef, + DeleteBackupResponseTypeDef, + DeleteDataRepositoryAssociationResponseTypeDef, + DeleteFileCacheResponseTypeDef, + DeleteSnapshotResponseTypeDef, + DeleteStorageVirtualMachineResponseTypeDef, + DescribeFileSystemAliasesResponseTypeDef, + DescribeFileSystemsResponseTypeDef, + DisassociateFileSystemAliasesResponseTypeDef, + ReleaseFileSystemNfsV3LocksResponseTypeDef, + RestoreVolumeFromSnapshotResponseTypeDef, + UpdateFileSystemResponseTypeDef, + 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, + DescribeBackupsRequestRequestTypeDef, + DescribeDataRepositoryAssociationsRequestRequestTypeDef, + DescribeBackupsRequestDescribeBackupsPaginateTypeDef, + DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef, + ListTagsForResourceRequestListTagsForResourcePaginateTypeDef, + 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, +) + + +def get_structure() -> ActiveDirectoryBackupAttributesTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from `botocore` schemas. +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-fsx` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_fsx/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-fsx-1.26.109 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-fsx -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.109-1 +- Package Spec generated |