Python库 | mypy-boto3-storagegateway-1.17.43.0.tar.gz

# mypy-boto3-storagegateway [](https://pypi.org/project/mypy-boto3-storagegateway) [](https://pypi.org/project/mypy-boto3-storagegateway) [](https://mypy-boto3-builder.readthedocs.io/)  Type annotations for [boto3.StorageGateway 1.17.43](https://boto3.amazonaws.com/v1/documentation/api/1.17.43/reference/services/storagegateway.html#StorageGateway) 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-buider 4.4.0](https://github.com/vemel/mypy_boto3_builder). More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page. See how it helps to find and fix potential bugs:  - [mypy-boto3-storagegateway](#mypy-boto3-storagegateway) - [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 `StorageGateway` service. ```bash python -m pip install boto3-stubs[storagegateway] ``` ## 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[storagegateway]` in your environment: `python -m pip install 'boto3-stubs[storagegateway]'` Both type checking and auto-complete should work for `StorageGateway` service. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm - Install `boto-stubs[storagegateway]` in your environment: `python -m pip install 'boto3-stubs[storagegateway]'` Both type checking and auto-complete should work for `StorageGateway` 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[storagegateway]` in your environment: `python -m pip install 'boto3-stubs[storagegateway]'` - Run `mypy` as usual Type checking should work for `StorageGateway` service. No explicit type annotations required, write your `boto3` code as usual. ### pyright - Install `pyright`: `yarn global add pyright` - Install `boto-stubs[storagegateway]` in your environment: `python -m pip install 'boto3-stubs[storagegateway]'` - Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should work for `StorageGateway` service. No explicit type annotations required, write your `boto3` code as usual. ## Explicit type annotations ### Client annotations `StorageGatewayClient` provides annotations for `boto3.client("storagegateway")`. ```python import boto3 from mypy_boto3_storagegateway import StorageGatewayClient client: StorageGatewayClient = boto3.client("storagegateway") # 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: StorageGatewayClient = session.client("storagegateway") ``` ### Paginators annotations `mypy_boto3_storagegateway.paginator` module contains type annotations for all paginators. ```python from mypy_boto3_storagegateway import StorageGatewayClient from mypy_boto3_storagegateway.paginator import ( DescribeTapeArchivesPaginator, DescribeTapeRecoveryPointsPaginator, DescribeTapesPaginator, DescribeVTLDevicesPaginator, ListFileSharesPaginator, ListGatewaysPaginator, ListTagsForResourcePaginator, ListTapePoolsPaginator, ListTapesPaginator, ListVolumesPaginator, ) client: StorageGatewayClient = boto3.client("storagegateway") # Explicit type annotations are optional here # Type should be correctly discovered by mypy and IDEs # VSCode requires explicit type annotations describe_tape_archives_paginator: DescribeTapeArchivesPaginator = client.get_paginator("describe_tape_archives") describe_tape_recovery_points_paginator: DescribeTapeRecoveryPointsPaginator = client.get_paginator("describe_tape_recovery_points") describe_tapes_paginator: DescribeTapesPaginator = client.get_paginator("describe_tapes") describe_vtl_devices_paginator: DescribeVTLDevicesPaginator = client.get_paginator("describe_vtl_devices") list_file_shares_paginator: ListFileSharesPaginator = client.get_paginator("list_file_shares") list_gateways_paginator: ListGatewaysPaginator = client.get_paginator("list_gateways") list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource") list_tape_pools_paginator: ListTapePoolsPaginator = client.get_paginator("list_tape_pools") list_tapes_paginator: ListTapesPaginator = client.get_paginator("list_tapes") list_volumes_paginator: ListVolumesPaginator = client.get_paginator("list_volumes") ``` ### Typed dictionations `mypy_boto3_storagegateway.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_storagegateway.type_defs import ( AutomaticTapeCreationPolicyInfoTypeDef, AutomaticTapeCreationRuleTypeDef, BandwidthRateLimitIntervalTypeDef, CacheAttributesTypeDef, CachediSCSIVolumeTypeDef, ChapInfoTypeDef, DeviceiSCSIAttributesTypeDef, DiskTypeDef, FileShareInfoTypeDef, GatewayInfoTypeDef, NFSFileShareDefaultsTypeDef, NFSFileShareInfoTypeDef, NetworkInterfaceTypeDef, PoolInfoTypeDef, ResponseMetadata, SMBFileShareInfoTypeDef, StorediSCSIVolumeTypeDef, TagTypeDef, TapeArchiveTypeDef, TapeInfoTypeDef, TapeRecoveryPointInfoTypeDef, TapeTypeDef, VTLDeviceTypeDef, VolumeInfoTypeDef, VolumeRecoveryPointInfoTypeDef, VolumeiSCSIAttributesTypeDef, ActivateGatewayOutputTypeDef, AddCacheOutputTypeDef, AddTagsToResourceOutputTypeDef, AddUploadBufferOutputTypeDef, AddWorkingStorageOutputTypeDef, AssignTapePoolOutputTypeDef, AttachVolumeOutputTypeDef, CancelArchivalOutputTypeDef, CancelRetrievalOutputTypeDef, CreateCachediSCSIVolumeOutputTypeDef, CreateNFSFileShareOutputTypeDef, CreateSMBFileShareOutputTypeDef, CreateSnapshotFromVolumeRecoveryPointOutputTypeDef, CreateSnapshotOutputTypeDef, CreateStorediSCSIVolumeOutputTypeDef, CreateTapePoolOutputTypeDef, CreateTapeWithBarcodeOutputTypeDef, CreateTapesOutputTypeDef, DeleteAutomaticTapeCreationPolicyOutputTypeDef, DeleteBandwidthRateLimitOutputTypeDef, DeleteChapCredentialsOutputTypeDef, DeleteFileShareOutputTypeDef, DeleteGatewayOutputTypeDef, DeleteSnapshot