PyPI 官网下载 | mypy-boto3-fsx-1.16.19.0.tar.gz

# mypy-boto3-fsx [](https://pypi.org/project/mypy-boto3-fsx) [](https://pypi.org/project/mypy-boto3-fsx) [](https://mypy-boto3-builder.readthedocs.io/) Type annotations for [boto3.FSx 1.16.19](https://boto3.amazonaws.com/v1/documentation/api/1.16.19/reference/services/fsx.html#FSx) service compatible with [VSCode](https://code.visualstudio.com/), [PyCharm](https://www.jetbrains.com/pycharm/), [mypy](https://github.com/python/mypy), [pyright](https://github.com/microsoft/pyright) and other tools. Generated by [mypy-boto3-buider 3.2.2](https://github.com/vemel/mypy_boto3_builder). More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page. - [mypy-boto3-fsx](#mypy-boto3-fsx) - [How to install](#how-to-install) - [Usage](#usage) - [VSCode](#vscode) - [PyCharm](#pycharm) - [Other IDEs](#other-ides) - [mypy](#mypy) - [pyright](#pyright) - [Explicit type annotations](#explicit-type-annotations) - [Client annotations](#client-annotations) - [Paginators annotations](#paginators-annotations) - [Waiters annotations](#waiters-annotations) - [Service Resource annotations](#service-resource-annotations) - [Other resources annotations](#other-resources-annotations) - [Collections annotations](#collections-annotations) - [Typed dictionations](#typed-dictionations) ## How to install Install `boto3-stubs` for `FSx` service. ```bash python -m pip install boto3-stubs[fsx] ``` ## Usage ### 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 `boto-stubs[fsx]` in your environment: `python -m pip install 'boto3-stubs[fsx]'` Both type checking and auto-complete should work for `FSx` service. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm - Install `boto-stubs[fsx]` in your environment: `python -m pip install 'boto3-stubs[fsx]'` Both type checking and auto-complete should work for `FSx` service. No explicit type annotations required, write your `boto3` code as usual. Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules. ### Other IDEs Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work. ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto-stubs[fsx]` in your environment: `python -m pip install 'boto3-stubs[fsx]'` - Run `mypy` as usual Type checking should work for `FSx` service. No explicit type annotations required, write your `boto3` code as usual. ### pyright - Install `pyright`: `yarn global add pyright` - Install `boto-stubs[fsx]` in your environment: `python -m pip install 'boto3-stubs[fsx]'` - Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should work for `FSx` service. No explicit type annotations required, write your `boto3` code as usual. ## Explicit type annotations ### Client annotations `FSxClient` provides annotations for `boto3.client("fsx")`. ```python import boto3 from mypy_boto3_fsx import FSxClient client: FSxClient = boto3.client("fsx") # now client usage is checked by mypy and IDE should provide code auto-complete # works for session as well session = boto3.session.Session(region="us-west-1") session_client: FSxClient = session.client("fsx") ``` ### Paginators annotations `mypy_boto3_fsx.paginator` module contains type annotations for all paginators. ```python from mypy_boto3_fsx import FSxClient from mypy_boto3_fsx.paginator import ( DescribeBackupsPaginator, DescribeFileSystemsPaginator, ListTagsForResourcePaginator, ) client: FSxClient = boto3.client("fsx") # Explicit type annotations are optional here # Type should be correctly discovered by mypy and IDEs # VSCode requires explicit type annotations describe_backups_paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups") describe_file_systems_paginator: DescribeFileSystemsPaginator = client.get_paginator("describe_file_systems") list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource") ``` ### Typed dictionations `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, AdministrativeActionTypeDef, AliasTypeDef, AssociateFileSystemAliasesResponseTypeDef, BackupFailureDetailsTypeDef, BackupTypeDef, CancelDataRepositoryTaskResponseTypeDef, CompletionReportTypeDef, CreateBackupResponseTypeDef, CreateDataRepositoryTaskResponseTypeDef, CreateFileSystemFromBackupResponseTypeDef, CreateFileSystemLustreConfigurationTypeDef, CreateFileSystemResponseTypeDef, CreateFileSystemWindowsConfigurationTypeDef, DataRepositoryConfigurationTypeDef, DataRepositoryFailureDetailsTypeDef, DataRepositoryTaskFailureDetailsTypeDef, DataRepositoryTaskFilterTypeDef, DataRepositoryTaskStatusTypeDef, DataRepositoryTaskTypeDef, DeleteBackupResponseTypeDef, DeleteFileSystemLustreConfigurationTypeDef, DeleteFileSystemLustreResponseTypeDef, DeleteFileSystemResponseTypeDef, DeleteFileSystemWindowsConfigurationTypeDef, DeleteFileSystemWindowsResponseTypeDef, DescribeBackupsResponseTypeDef, DescribeDataRepositoryTasksResponseTypeDef, DescribeFileSystemAliasesResponseTypeDef, DescribeFileSystemsResponseTypeDef, DisassociateFileSystemAliasesResponseTypeDef, FileSystemFailureDetailsTypeDef, FileSystemTypeDef, FilterTypeDef, ListTagsForResourceResponseTypeDef, LustreFileSystemConfigurationTypeDef, PaginatorConfigTypeDef, SelfManagedActiveDirectoryAttributesTypeDef, SelfManagedActiveDirectoryConfigurationTypeDef, SelfManagedActiveDirectoryConfigurationUpdatesTypeDef, TagTypeDef, UpdateFileSystemLustreConfigurationTypeDef, UpdateFileSystemResponseTypeDef, UpdateFileSystemWindowsConfigurationTypeDef, WindowsFileSystemConfigurationTypeDef, ) def get_structure() -> ActiveDirectoryBackupAttributesTypeDef: return { ... } ```