%global _empty_manifest_terminate_build 0 Name: python-mypy-boto3-storagegateway Version: 1.26.0.post1 Release: 1 Summary: Type annotations for boto3.StorageGateway 1.26.0 service generated with mypy-boto3-builder 7.11.10 License: MIT License URL: https://github.com/youtype/mypy_boto3_builder Source0: https://mirrors.nju.edu.cn/pypi/web/packages/94/93/0cd221d18fe5afde5e08329499d644f930fd89c698e14d33ba5b1b2a3ac2/mypy-boto3-storagegateway-1.26.0.post1.tar.gz BuildArch: noarch Requires: python3-typing-extensions %description # mypy-boto3-storagegateway [![PyPI - mypy-boto3-storagegateway](https://img.shields.io/pypi/v/mypy-boto3-storagegateway.svg?color=blue)](https://pypi.org/project/mypy-boto3-storagegateway) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-storagegateway.svg?color=blue)](https://pypi.org/project/mypy-boto3-storagegateway) [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-storagegateway?color=blue)](https://pypistats.org/packages/mypy-boto3-storagegateway) ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) Type annotations for [boto3.StorageGateway 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/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-builder 7.11.10](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-storagegateway docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_storagegateway/). See how it helps to find and fix potential bugs: ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) - [mypy-boto3-storagegateway](#mypy-boto3-storagegateway) - [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) ## How to install ### 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 `StorageGateway`. ### From PyPI with pip Install `boto3-stubs` for `StorageGateway` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[storagegateway]' # 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[storagegateway]' # standalone installation python -m pip install mypy-boto3-storagegateway ``` ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm Install `boto3-stubs-lite[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[storagegateway]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` - 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. ### Sublime Text - Install `boto3-stubs[storagegateway]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` - 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. ### Other IDEs Not tested, but as long as your IDE supports `mypy` or `pyright`, everything should work. ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]'` ``` Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. ### pyright - Install `pyright`: `npm i -g pyright` - Install `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` 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. ## Explicit type annotations ### Client annotations `StorageGatewayClient` provides annotations for `boto3.client("storagegateway")`. ```python from boto3.session import Session from mypy_boto3_storagegateway import StorageGatewayClient client: StorageGatewayClient = Session().client("storagegateway") # now client usage is checked by mypy and IDE should provide code completion ``` ### Paginators annotations `mypy_boto3_storagegateway.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_storagegateway import StorageGatewayClient from mypy_boto3_storagegateway.paginator import ( DescribeTapeArchivesPaginator, DescribeTapeRecoveryPointsPaginator, DescribeTapesPaginator, DescribeVTLDevicesPaginator, ListFileSharesPaginator, ListFileSystemAssociationsPaginator, ListGatewaysPaginator, ListTagsForResourcePaginator, ListTapePoolsPaginator, ListTapesPaginator, ListVolumesPaginator, ) client: StorageGatewayClient = Session().client("storagegateway") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs 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_file_system_associations_paginator: ListFileSystemAssociationsPaginator = client.get_paginator( "list_file_system_associations" ) 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") ``` ### Literals `mypy_boto3_storagegateway.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_storagegateway.literals import ( ActiveDirectoryStatusType, AvailabilityMonitorTestStatusType, CaseSensitivityType, DescribeTapeArchivesPaginatorName, DescribeTapeRecoveryPointsPaginatorName, DescribeTapesPaginatorName, DescribeVTLDevicesPaginatorName, FileShareTypeType, GatewayCapacityType, HostEnvironmentType, ListFileSharesPaginatorName, ListFileSystemAssociationsPaginatorName, ListGatewaysPaginatorName, ListTagsForResourcePaginatorName, ListTapePoolsPaginatorName, ListTapesPaginatorName, ListVolumesPaginatorName, ObjectACLType, PoolStatusType, RetentionLockTypeType, SMBSecurityStrategyType, TapeStorageClassType, StorageGatewayServiceName, ServiceName, ResourceServiceName, PaginatorName, RegionName, ) def check_value(value: ActiveDirectoryStatusType) -> bool: ... ``` ### Typed dictionaries `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 ( TagTypeDef, ResponseMetadataTypeDef, AddCacheInputRequestTypeDef, AddUploadBufferInputRequestTypeDef, AddWorkingStorageInputRequestTypeDef, AssignTapePoolInputRequestTypeDef, CacheAttributesTypeDef, EndpointNetworkConfigurationTypeDef, AttachVolumeInputRequestTypeDef, AutomaticTapeCreationRuleTypeDef, BandwidthRateLimitIntervalTypeDef, VolumeiSCSIAttributesTypeDef, CancelArchivalInputRequestTypeDef, CancelRetrievalInputRequestTypeDef, ChapInfoTypeDef, NFSFileShareDefaultsTypeDef, DeleteAutomaticTapeCreationPolicyInputRequestTypeDef, DeleteBandwidthRateLimitInputRequestTypeDef, DeleteChapCredentialsInputRequestTypeDef, DeleteFileShareInputRequestTypeDef, DeleteGatewayInputRequestTypeDef, DeleteSnapshotScheduleInputRequestTypeDef, DeleteTapeArchiveInputRequestTypeDef, DeleteTapeInputRequestTypeDef, DeleteTapePoolInputRequestTypeDef, DeleteVolumeInputRequestTypeDef, DescribeAvailabilityMonitorTestInputRequestTypeDef, DescribeBandwidthRateLimitInputRequestTypeDef, DescribeBandwidthRateLimitScheduleInputRequestTypeDef, DescribeCacheInputRequestTypeDef, DescribeCachediSCSIVolumesInputRequestTypeDef, DescribeChapCredentialsInputRequestTypeDef, DescribeFileSystemAssociationsInputRequestTypeDef, DescribeGatewayInformationInputRequestTypeDef, NetworkInterfaceTypeDef, DescribeMaintenanceStartTimeInputRequestTypeDef, DescribeNFSFileSharesInputRequestTypeDef, DescribeSMBFileSharesInputRequestTypeDef, DescribeSMBSettingsInputRequestTypeDef, SMBLocalGroupsTypeDef, DescribeSnapshotScheduleInputRequestTypeDef, DescribeStorediSCSIVolumesInputRequestTypeDef, PaginatorConfigTypeDef, DescribeTapeArchivesInputRequestTypeDef, TapeArchiveTypeDef, DescribeTapeRecoveryPointsInputRequestTypeDef, TapeRecoveryPointInfoTypeDef, DescribeTapesInputRequestTypeDef, TapeTypeDef, DescribeUploadBufferInputRequestTypeDef, DescribeVTLDevicesInputRequestTypeDef, DescribeWorkingStorageInputRequestTypeDef, DetachVolumeInputRequestTypeDef, DeviceiSCSIAttributesTypeDef, DisableGatewayInputRequestTypeDef, DisassociateFileSystemInputRequestTypeDef, DiskTypeDef, FileShareInfoTypeDef, FileSystemAssociationStatusDetailTypeDef, FileSystemAssociationSummaryTypeDef, GatewayInfoTypeDef, JoinDomainInputRequestTypeDef, ListAutomaticTapeCreationPoliciesInputRequestTypeDef, ListFileSharesInputRequestTypeDef, ListFileSystemAssociationsInputRequestTypeDef, ListGatewaysInputRequestTypeDef, ListLocalDisksInputRequestTypeDef, ListTagsForResourceInputRequestTypeDef, ListTapePoolsInputRequestTypeDef, PoolInfoTypeDef, ListTapesInputRequestTypeDef, TapeInfoTypeDef, ListVolumeInitiatorsInputRequestTypeDef, ListVolumeRecoveryPointsInputRequestTypeDef, VolumeRecoveryPointInfoTypeDef, ListVolumesInputRequestTypeDef, VolumeInfoTypeDef, NotifyWhenUploadedInputRequestTypeDef, RefreshCacheInputRequestTypeDef, RemoveTagsFromResourceInputRequestTypeDef, ResetCacheInputRequestTypeDef, RetrieveTapeArchiveInputRequestTypeDef, RetrieveTapeRecoveryPointInputRequestTypeDef, SetLocalConsolePasswordInputRequestTypeDef, SetSMBGuestPasswordInputRequestTypeDef, ShutdownGatewayInputRequestTypeDef, StartAvailabilityMonitorTestInputRequestTypeDef, StartGatewayInputRequestTypeDef, UpdateBandwidthRateLimitInputRequestTypeDef, UpdateChapCredentialsInputRequestTypeDef, UpdateGatewayInformationInputRequestTypeDef, UpdateGatewaySoftwareNowInputRequestTypeDef, UpdateMaintenanceStartTimeInputRequestTypeDef, UpdateSMBFileShareVisibilityInputRequestTypeDef, UpdateSMBSecurityStrategyInputRequestTypeDef, UpdateVTLDeviceTypeInputRequestTypeDef, ActivateGatewayInputRequestTypeDef, AddTagsToResourceInputRequestTypeDef, CreateCachediSCSIVolumeInputRequestTypeDef, CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef, CreateSnapshotInputRequestTypeDef, CreateStorediSCSIVolumeInputRequestTypeDef, CreateTapePoolInputRequestTypeDef, CreateTapeWithBarcodeInputRequestTypeDef, CreateTapesInputRequestTypeDef, UpdateSnapshotScheduleInputRequestTypeDef, ActivateGatewayOutputTypeDef, AddCacheOutputTypeDef, AddTagsToResourceOutputTypeDef, AddUploadBufferOutputTypeDef, AddWorkingStorageOutputTypeDef, AssignTapePoolOutputTypeDef, AssociateFileSystemOutputTypeDef, AttachVolumeOutputTypeDef, CancelArchivalOutputTypeDef, CancelRetrievalOutputTypeDef, CreateCachediSCSIVolumeOutputTypeDef, CreateNFSFileShareOutputTypeDef, CreateSMBFileShareOutputTypeDef, CreateSnapshotFromVolumeRecoveryPointOutputTypeDef, CreateSnapshotOutputTypeDef, CreateStorediSCSIVolumeOutputTypeDef, CreateTapePoolOutputTypeDef, CreateTapeWithBarcodeOutputTypeDef, CreateTapesOutputTypeDef, DeleteAutomaticTapeCreationPolicyOutputTypeDef, DeleteBandwidthRateLimitOutputTypeDef, DeleteChapCredentialsOutputTypeDef, DeleteFileShareOutputTypeDef, DeleteGatewayOutputTypeDef, DeleteSnapshotScheduleOutputTypeDef, DeleteTapeArchiveOutputTypeDef, DeleteTapeOutputTypeDef, DeleteTapePoolOutputTypeDef, DeleteVolumeOutputTypeDef, DescribeAvailabilityMonitorTestOutputTypeDef, DescribeBandwidthRateLimitOutputTypeDef, DescribeCacheOutputTypeDef, DescribeMaintenanceStartTimeOutputTypeDef, DescribeSnapshotScheduleOutputTypeDef, DescribeUploadBufferOutputTypeDef, DescribeWorkingStorageOutputTypeDef, DetachVolumeOutputTypeDef, DisableGatewayOutputTypeDef, DisassociateFileSystemOutputTypeDef, JoinDomainOutputTypeDef, ListTagsForResourceOutputTypeDef, ListVolumeInitiatorsOutputTypeDef, NotifyWhenUploadedOutputTypeDef, RefreshCacheOutputTypeDef, RemoveTagsFromResourceOutputTypeDef, ResetCacheOutputTypeDef, RetrieveTapeArchiveOutputTypeDef, RetrieveTapeRecoveryPointOutputTypeDef, SetLocalConsolePasswordOutputTypeDef, SetSMBGuestPasswordOutputTypeDef, ShutdownGatewayOutputTypeDef, StartAvailabilityMonitorTestOutputTypeDef, StartGatewayOutputTypeDef, UpdateAutomaticTapeCreationPolicyOutputTypeDef, UpdateBandwidthRateLimitOutputTypeDef, UpdateBandwidthRateLimitScheduleOutputTypeDef, UpdateChapCredentialsOutputTypeDef, UpdateFileSystemAssociationOutputTypeDef, UpdateGatewayInformationOutputTypeDef, UpdateGatewaySoftwareNowOutputTypeDef, UpdateMaintenanceStartTimeOutputTypeDef, UpdateNFSFileShareOutputTypeDef, UpdateSMBFileShareOutputTypeDef, UpdateSMBFileShareVisibilityOutputTypeDef, UpdateSMBLocalGroupsOutputTypeDef, UpdateSMBSecurityStrategyOutputTypeDef, UpdateSnapshotScheduleOutputTypeDef, UpdateVTLDeviceTypeOutputTypeDef, CreateSMBFileShareInputRequestTypeDef, SMBFileShareInfoTypeDef, UpdateFileSystemAssociationInputRequestTypeDef, UpdateSMBFileShareInputRequestTypeDef, AssociateFileSystemInputRequestTypeDef, AutomaticTapeCreationPolicyInfoTypeDef, UpdateAutomaticTapeCreationPolicyInputRequestTypeDef, DescribeBandwidthRateLimitScheduleOutputTypeDef, UpdateBandwidthRateLimitScheduleInputRequestTypeDef, CachediSCSIVolumeTypeDef, StorediSCSIVolumeTypeDef, DescribeChapCredentialsOutputTypeDef, CreateNFSFileShareInputRequestTypeDef, NFSFileShareInfoTypeDef, UpdateNFSFileShareInputRequestTypeDef, DescribeGatewayInformationOutputTypeDef, DescribeSMBSettingsOutputTypeDef, UpdateSMBLocalGroupsInputRequestTypeDef, DescribeTapeArchivesInputDescribeTapeArchivesPaginateTypeDef, DescribeTapeRecoveryPointsInputDescribeTapeRecoveryPointsPaginateTypeDef, DescribeTapesInputDescribeTapesPaginateTypeDef, DescribeVTLDevicesInputDescribeVTLDevicesPaginateTypeDef, ListFileSharesInputListFileSharesPaginateTypeDef, ListFileSystemAssociationsInputListFileSystemAssociationsPaginateTypeDef, ListGatewaysInputListGatewaysPaginateTypeDef, ListTagsForResourceInputListTagsForResourcePaginateTypeDef, ListTapePoolsInputListTapePoolsPaginateTypeDef, ListTapesInputListTapesPaginateTypeDef, ListVolumesInputListVolumesPaginateTypeDef, DescribeTapeArchivesOutputTypeDef, DescribeTapeRecoveryPointsOutputTypeDef, DescribeTapesOutputTypeDef, VTLDeviceTypeDef, ListLocalDisksOutputTypeDef, ListFileSharesOutputTypeDef, FileSystemAssociationInfoTypeDef, ListFileSystemAssociationsOutputTypeDef, ListGatewaysOutputTypeDef, ListTapePoolsOutputTypeDef, ListTapesOutputTypeDef, ListVolumeRecoveryPointsOutputTypeDef, ListVolumesOutputTypeDef, DescribeSMBFileSharesOutputTypeDef, ListAutomaticTapeCreationPoliciesOutputTypeDef, DescribeCachediSCSIVolumesOutputTypeDef, DescribeStorediSCSIVolumesOutputTypeDef, DescribeNFSFileSharesOutputTypeDef, DescribeVTLDevicesOutputTypeDef, DescribeFileSystemAssociationsOutputTypeDef, ) def get_structure() -> TagTypeDef: return {...} ``` ## 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 a 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 the documentation (blame `botocore` docs if types are incorrect). - 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. ## What's new ### Implemented features - Fully type annotated `boto3`, `botocore` and `aiobotocore` 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.session` calls - Auto discovery of types for `session.client` and `session.session` 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 ### Latest changes Builder changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases). ## Versioning `mypy-boto3-storagegateway` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. ## 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 ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_storagegateway/) ## 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-storagegateway Summary: Type annotations for boto3.StorageGateway 1.26.0 service generated with mypy-boto3-builder 7.11.10 Provides: python-mypy-boto3-storagegateway BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-mypy-boto3-storagegateway # mypy-boto3-storagegateway [![PyPI - mypy-boto3-storagegateway](https://img.shields.io/pypi/v/mypy-boto3-storagegateway.svg?color=blue)](https://pypi.org/project/mypy-boto3-storagegateway) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-storagegateway.svg?color=blue)](https://pypi.org/project/mypy-boto3-storagegateway) [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-storagegateway?color=blue)](https://pypistats.org/packages/mypy-boto3-storagegateway) ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) Type annotations for [boto3.StorageGateway 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/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-builder 7.11.10](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-storagegateway docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_storagegateway/). See how it helps to find and fix potential bugs: ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) - [mypy-boto3-storagegateway](#mypy-boto3-storagegateway) - [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) ## How to install ### 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 `StorageGateway`. ### From PyPI with pip Install `boto3-stubs` for `StorageGateway` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[storagegateway]' # 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[storagegateway]' # standalone installation python -m pip install mypy-boto3-storagegateway ``` ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm Install `boto3-stubs-lite[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[storagegateway]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` - 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. ### Sublime Text - Install `boto3-stubs[storagegateway]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` - 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. ### Other IDEs Not tested, but as long as your IDE supports `mypy` or `pyright`, everything should work. ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]'` ``` Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. ### pyright - Install `pyright`: `npm i -g pyright` - Install `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` 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. ## Explicit type annotations ### Client annotations `StorageGatewayClient` provides annotations for `boto3.client("storagegateway")`. ```python from boto3.session import Session from mypy_boto3_storagegateway import StorageGatewayClient client: StorageGatewayClient = Session().client("storagegateway") # now client usage is checked by mypy and IDE should provide code completion ``` ### Paginators annotations `mypy_boto3_storagegateway.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_storagegateway import StorageGatewayClient from mypy_boto3_storagegateway.paginator import ( DescribeTapeArchivesPaginator, DescribeTapeRecoveryPointsPaginator, DescribeTapesPaginator, DescribeVTLDevicesPaginator, ListFileSharesPaginator, ListFileSystemAssociationsPaginator, ListGatewaysPaginator, ListTagsForResourcePaginator, ListTapePoolsPaginator, ListTapesPaginator, ListVolumesPaginator, ) client: StorageGatewayClient = Session().client("storagegateway") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs 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_file_system_associations_paginator: ListFileSystemAssociationsPaginator = client.get_paginator( "list_file_system_associations" ) 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") ``` ### Literals `mypy_boto3_storagegateway.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_storagegateway.literals import ( ActiveDirectoryStatusType, AvailabilityMonitorTestStatusType, CaseSensitivityType, DescribeTapeArchivesPaginatorName, DescribeTapeRecoveryPointsPaginatorName, DescribeTapesPaginatorName, DescribeVTLDevicesPaginatorName, FileShareTypeType, GatewayCapacityType, HostEnvironmentType, ListFileSharesPaginatorName, ListFileSystemAssociationsPaginatorName, ListGatewaysPaginatorName, ListTagsForResourcePaginatorName, ListTapePoolsPaginatorName, ListTapesPaginatorName, ListVolumesPaginatorName, ObjectACLType, PoolStatusType, RetentionLockTypeType, SMBSecurityStrategyType, TapeStorageClassType, StorageGatewayServiceName, ServiceName, ResourceServiceName, PaginatorName, RegionName, ) def check_value(value: ActiveDirectoryStatusType) -> bool: ... ``` ### Typed dictionaries `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 ( TagTypeDef, ResponseMetadataTypeDef, AddCacheInputRequestTypeDef, AddUploadBufferInputRequestTypeDef, AddWorkingStorageInputRequestTypeDef, AssignTapePoolInputRequestTypeDef, CacheAttributesTypeDef, EndpointNetworkConfigurationTypeDef, AttachVolumeInputRequestTypeDef, AutomaticTapeCreationRuleTypeDef, BandwidthRateLimitIntervalTypeDef, VolumeiSCSIAttributesTypeDef, CancelArchivalInputRequestTypeDef, CancelRetrievalInputRequestTypeDef, ChapInfoTypeDef, NFSFileShareDefaultsTypeDef, DeleteAutomaticTapeCreationPolicyInputRequestTypeDef, DeleteBandwidthRateLimitInputRequestTypeDef, DeleteChapCredentialsInputRequestTypeDef, DeleteFileShareInputRequestTypeDef, DeleteGatewayInputRequestTypeDef, DeleteSnapshotScheduleInputRequestTypeDef, DeleteTapeArchiveInputRequestTypeDef, DeleteTapeInputRequestTypeDef, DeleteTapePoolInputRequestTypeDef, DeleteVolumeInputRequestTypeDef, DescribeAvailabilityMonitorTestInputRequestTypeDef, DescribeBandwidthRateLimitInputRequestTypeDef, DescribeBandwidthRateLimitScheduleInputRequestTypeDef, DescribeCacheInputRequestTypeDef, DescribeCachediSCSIVolumesInputRequestTypeDef, DescribeChapCredentialsInputRequestTypeDef, DescribeFileSystemAssociationsInputRequestTypeDef, DescribeGatewayInformationInputRequestTypeDef, NetworkInterfaceTypeDef, DescribeMaintenanceStartTimeInputRequestTypeDef, DescribeNFSFileSharesInputRequestTypeDef, DescribeSMBFileSharesInputRequestTypeDef, DescribeSMBSettingsInputRequestTypeDef, SMBLocalGroupsTypeDef, DescribeSnapshotScheduleInputRequestTypeDef, DescribeStorediSCSIVolumesInputRequestTypeDef, PaginatorConfigTypeDef, DescribeTapeArchivesInputRequestTypeDef, TapeArchiveTypeDef, DescribeTapeRecoveryPointsInputRequestTypeDef, TapeRecoveryPointInfoTypeDef, DescribeTapesInputRequestTypeDef, TapeTypeDef, DescribeUploadBufferInputRequestTypeDef, DescribeVTLDevicesInputRequestTypeDef, DescribeWorkingStorageInputRequestTypeDef, DetachVolumeInputRequestTypeDef, DeviceiSCSIAttributesTypeDef, DisableGatewayInputRequestTypeDef, DisassociateFileSystemInputRequestTypeDef, DiskTypeDef, FileShareInfoTypeDef, FileSystemAssociationStatusDetailTypeDef, FileSystemAssociationSummaryTypeDef, GatewayInfoTypeDef, JoinDomainInputRequestTypeDef, ListAutomaticTapeCreationPoliciesInputRequestTypeDef, ListFileSharesInputRequestTypeDef, ListFileSystemAssociationsInputRequestTypeDef, ListGatewaysInputRequestTypeDef, ListLocalDisksInputRequestTypeDef, ListTagsForResourceInputRequestTypeDef, ListTapePoolsInputRequestTypeDef, PoolInfoTypeDef, ListTapesInputRequestTypeDef, TapeInfoTypeDef, ListVolumeInitiatorsInputRequestTypeDef, ListVolumeRecoveryPointsInputRequestTypeDef, VolumeRecoveryPointInfoTypeDef, ListVolumesInputRequestTypeDef, VolumeInfoTypeDef, NotifyWhenUploadedInputRequestTypeDef, RefreshCacheInputRequestTypeDef, RemoveTagsFromResourceInputRequestTypeDef, ResetCacheInputRequestTypeDef, RetrieveTapeArchiveInputRequestTypeDef, RetrieveTapeRecoveryPointInputRequestTypeDef, SetLocalConsolePasswordInputRequestTypeDef, SetSMBGuestPasswordInputRequestTypeDef, ShutdownGatewayInputRequestTypeDef, StartAvailabilityMonitorTestInputRequestTypeDef, StartGatewayInputRequestTypeDef, UpdateBandwidthRateLimitInputRequestTypeDef, UpdateChapCredentialsInputRequestTypeDef, UpdateGatewayInformationInputRequestTypeDef, UpdateGatewaySoftwareNowInputRequestTypeDef, UpdateMaintenanceStartTimeInputRequestTypeDef, UpdateSMBFileShareVisibilityInputRequestTypeDef, UpdateSMBSecurityStrategyInputRequestTypeDef, UpdateVTLDeviceTypeInputRequestTypeDef, ActivateGatewayInputRequestTypeDef, AddTagsToResourceInputRequestTypeDef, CreateCachediSCSIVolumeInputRequestTypeDef, CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef, CreateSnapshotInputRequestTypeDef, CreateStorediSCSIVolumeInputRequestTypeDef, CreateTapePoolInputRequestTypeDef, CreateTapeWithBarcodeInputRequestTypeDef, CreateTapesInputRequestTypeDef, UpdateSnapshotScheduleInputRequestTypeDef, ActivateGatewayOutputTypeDef, AddCacheOutputTypeDef, AddTagsToResourceOutputTypeDef, AddUploadBufferOutputTypeDef, AddWorkingStorageOutputTypeDef, AssignTapePoolOutputTypeDef, AssociateFileSystemOutputTypeDef, AttachVolumeOutputTypeDef, CancelArchivalOutputTypeDef, CancelRetrievalOutputTypeDef, CreateCachediSCSIVolumeOutputTypeDef, CreateNFSFileShareOutputTypeDef, CreateSMBFileShareOutputTypeDef, CreateSnapshotFromVolumeRecoveryPointOutputTypeDef, CreateSnapshotOutputTypeDef, CreateStorediSCSIVolumeOutputTypeDef, CreateTapePoolOutputTypeDef, CreateTapeWithBarcodeOutputTypeDef, CreateTapesOutputTypeDef, DeleteAutomaticTapeCreationPolicyOutputTypeDef, DeleteBandwidthRateLimitOutputTypeDef, DeleteChapCredentialsOutputTypeDef, DeleteFileShareOutputTypeDef, DeleteGatewayOutputTypeDef, DeleteSnapshotScheduleOutputTypeDef, DeleteTapeArchiveOutputTypeDef, DeleteTapeOutputTypeDef, DeleteTapePoolOutputTypeDef, DeleteVolumeOutputTypeDef, DescribeAvailabilityMonitorTestOutputTypeDef, DescribeBandwidthRateLimitOutputTypeDef, DescribeCacheOutputTypeDef, DescribeMaintenanceStartTimeOutputTypeDef, DescribeSnapshotScheduleOutputTypeDef, DescribeUploadBufferOutputTypeDef, DescribeWorkingStorageOutputTypeDef, DetachVolumeOutputTypeDef, DisableGatewayOutputTypeDef, DisassociateFileSystemOutputTypeDef, JoinDomainOutputTypeDef, ListTagsForResourceOutputTypeDef, ListVolumeInitiatorsOutputTypeDef, NotifyWhenUploadedOutputTypeDef, RefreshCacheOutputTypeDef, RemoveTagsFromResourceOutputTypeDef, ResetCacheOutputTypeDef, RetrieveTapeArchiveOutputTypeDef, RetrieveTapeRecoveryPointOutputTypeDef, SetLocalConsolePasswordOutputTypeDef, SetSMBGuestPasswordOutputTypeDef, ShutdownGatewayOutputTypeDef, StartAvailabilityMonitorTestOutputTypeDef, StartGatewayOutputTypeDef, UpdateAutomaticTapeCreationPolicyOutputTypeDef, UpdateBandwidthRateLimitOutputTypeDef, UpdateBandwidthRateLimitScheduleOutputTypeDef, UpdateChapCredentialsOutputTypeDef, UpdateFileSystemAssociationOutputTypeDef, UpdateGatewayInformationOutputTypeDef, UpdateGatewaySoftwareNowOutputTypeDef, UpdateMaintenanceStartTimeOutputTypeDef, UpdateNFSFileShareOutputTypeDef, UpdateSMBFileShareOutputTypeDef, UpdateSMBFileShareVisibilityOutputTypeDef, UpdateSMBLocalGroupsOutputTypeDef, UpdateSMBSecurityStrategyOutputTypeDef, UpdateSnapshotScheduleOutputTypeDef, UpdateVTLDeviceTypeOutputTypeDef, CreateSMBFileShareInputRequestTypeDef, SMBFileShareInfoTypeDef, UpdateFileSystemAssociationInputRequestTypeDef, UpdateSMBFileShareInputRequestTypeDef, AssociateFileSystemInputRequestTypeDef, AutomaticTapeCreationPolicyInfoTypeDef, UpdateAutomaticTapeCreationPolicyInputRequestTypeDef, DescribeBandwidthRateLimitScheduleOutputTypeDef, UpdateBandwidthRateLimitScheduleInputRequestTypeDef, CachediSCSIVolumeTypeDef, StorediSCSIVolumeTypeDef, DescribeChapCredentialsOutputTypeDef, CreateNFSFileShareInputRequestTypeDef, NFSFileShareInfoTypeDef, UpdateNFSFileShareInputRequestTypeDef, DescribeGatewayInformationOutputTypeDef, DescribeSMBSettingsOutputTypeDef, UpdateSMBLocalGroupsInputRequestTypeDef, DescribeTapeArchivesInputDescribeTapeArchivesPaginateTypeDef, DescribeTapeRecoveryPointsInputDescribeTapeRecoveryPointsPaginateTypeDef, DescribeTapesInputDescribeTapesPaginateTypeDef, DescribeVTLDevicesInputDescribeVTLDevicesPaginateTypeDef, ListFileSharesInputListFileSharesPaginateTypeDef, ListFileSystemAssociationsInputListFileSystemAssociationsPaginateTypeDef, ListGatewaysInputListGatewaysPaginateTypeDef, ListTagsForResourceInputListTagsForResourcePaginateTypeDef, ListTapePoolsInputListTapePoolsPaginateTypeDef, ListTapesInputListTapesPaginateTypeDef, ListVolumesInputListVolumesPaginateTypeDef, DescribeTapeArchivesOutputTypeDef, DescribeTapeRecoveryPointsOutputTypeDef, DescribeTapesOutputTypeDef, VTLDeviceTypeDef, ListLocalDisksOutputTypeDef, ListFileSharesOutputTypeDef, FileSystemAssociationInfoTypeDef, ListFileSystemAssociationsOutputTypeDef, ListGatewaysOutputTypeDef, ListTapePoolsOutputTypeDef, ListTapesOutputTypeDef, ListVolumeRecoveryPointsOutputTypeDef, ListVolumesOutputTypeDef, DescribeSMBFileSharesOutputTypeDef, ListAutomaticTapeCreationPoliciesOutputTypeDef, DescribeCachediSCSIVolumesOutputTypeDef, DescribeStorediSCSIVolumesOutputTypeDef, DescribeNFSFileSharesOutputTypeDef, DescribeVTLDevicesOutputTypeDef, DescribeFileSystemAssociationsOutputTypeDef, ) def get_structure() -> TagTypeDef: return {...} ``` ## 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 a 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 the documentation (blame `botocore` docs if types are incorrect). - 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. ## What's new ### Implemented features - Fully type annotated `boto3`, `botocore` and `aiobotocore` 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.session` calls - Auto discovery of types for `session.client` and `session.session` 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 ### Latest changes Builder changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases). ## Versioning `mypy-boto3-storagegateway` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. ## 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 ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_storagegateway/) ## 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-storagegateway Provides: python3-mypy-boto3-storagegateway-doc %description help # mypy-boto3-storagegateway [![PyPI - mypy-boto3-storagegateway](https://img.shields.io/pypi/v/mypy-boto3-storagegateway.svg?color=blue)](https://pypi.org/project/mypy-boto3-storagegateway) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-storagegateway.svg?color=blue)](https://pypi.org/project/mypy-boto3-storagegateway) [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-storagegateway?color=blue)](https://pypistats.org/packages/mypy-boto3-storagegateway) ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) Type annotations for [boto3.StorageGateway 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/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-builder 7.11.10](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-storagegateway docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_storagegateway/). See how it helps to find and fix potential bugs: ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) - [mypy-boto3-storagegateway](#mypy-boto3-storagegateway) - [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) ## How to install ### 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 `StorageGateway`. ### From PyPI with pip Install `boto3-stubs` for `StorageGateway` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[storagegateway]' # 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[storagegateway]' # standalone installation python -m pip install mypy-boto3-storagegateway ``` ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm Install `boto3-stubs-lite[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[storagegateway]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` - 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. ### Sublime Text - Install `boto3-stubs[storagegateway]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` - 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. ### Other IDEs Not tested, but as long as your IDE supports `mypy` or `pyright`, everything should work. ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]'` ``` Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. ### pyright - Install `pyright`: `npm i -g pyright` - Install `boto3-stubs[storagegateway]` in your environment: ```bash python -m pip install 'boto3-stubs[storagegateway]' ``` 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. ## Explicit type annotations ### Client annotations `StorageGatewayClient` provides annotations for `boto3.client("storagegateway")`. ```python from boto3.session import Session from mypy_boto3_storagegateway import StorageGatewayClient client: StorageGatewayClient = Session().client("storagegateway") # now client usage is checked by mypy and IDE should provide code completion ``` ### Paginators annotations `mypy_boto3_storagegateway.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_storagegateway import StorageGatewayClient from mypy_boto3_storagegateway.paginator import ( DescribeTapeArchivesPaginator, DescribeTapeRecoveryPointsPaginator, DescribeTapesPaginator, DescribeVTLDevicesPaginator, ListFileSharesPaginator, ListFileSystemAssociationsPaginator, ListGatewaysPaginator, ListTagsForResourcePaginator, ListTapePoolsPaginator, ListTapesPaginator, ListVolumesPaginator, ) client: StorageGatewayClient = Session().client("storagegateway") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs 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_file_system_associations_paginator: ListFileSystemAssociationsPaginator = client.get_paginator( "list_file_system_associations" ) 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") ``` ### Literals `mypy_boto3_storagegateway.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_storagegateway.literals import ( ActiveDirectoryStatusType, AvailabilityMonitorTestStatusType, CaseSensitivityType, DescribeTapeArchivesPaginatorName, DescribeTapeRecoveryPointsPaginatorName, DescribeTapesPaginatorName, DescribeVTLDevicesPaginatorName, FileShareTypeType, GatewayCapacityType, HostEnvironmentType, ListFileSharesPaginatorName, ListFileSystemAssociationsPaginatorName, ListGatewaysPaginatorName, ListTagsForResourcePaginatorName, ListTapePoolsPaginatorName, ListTapesPaginatorName, ListVolumesPaginatorName, ObjectACLType, PoolStatusType, RetentionLockTypeType, SMBSecurityStrategyType, TapeStorageClassType, StorageGatewayServiceName, ServiceName, ResourceServiceName, PaginatorName, RegionName, ) def check_value(value: ActiveDirectoryStatusType) -> bool: ... ``` ### Typed dictionaries `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 ( TagTypeDef, ResponseMetadataTypeDef, AddCacheInputRequestTypeDef, AddUploadBufferInputRequestTypeDef, AddWorkingStorageInputRequestTypeDef, AssignTapePoolInputRequestTypeDef, CacheAttributesTypeDef, EndpointNetworkConfigurationTypeDef, AttachVolumeInputRequestTypeDef, AutomaticTapeCreationRuleTypeDef, BandwidthRateLimitIntervalTypeDef, VolumeiSCSIAttributesTypeDef, CancelArchivalInputRequestTypeDef, CancelRetrievalInputRequestTypeDef, ChapInfoTypeDef, NFSFileShareDefaultsTypeDef, DeleteAutomaticTapeCreationPolicyInputRequestTypeDef, DeleteBandwidthRateLimitInputRequestTypeDef, DeleteChapCredentialsInputRequestTypeDef, DeleteFileShareInputRequestTypeDef, DeleteGatewayInputRequestTypeDef, DeleteSnapshotScheduleInputRequestTypeDef, DeleteTapeArchiveInputRequestTypeDef, DeleteTapeInputRequestTypeDef, DeleteTapePoolInputRequestTypeDef, DeleteVolumeInputRequestTypeDef, DescribeAvailabilityMonitorTestInputRequestTypeDef, DescribeBandwidthRateLimitInputRequestTypeDef, DescribeBandwidthRateLimitScheduleInputRequestTypeDef, DescribeCacheInputRequestTypeDef, DescribeCachediSCSIVolumesInputRequestTypeDef, DescribeChapCredentialsInputRequestTypeDef, DescribeFileSystemAssociationsInputRequestTypeDef, DescribeGatewayInformationInputRequestTypeDef, NetworkInterfaceTypeDef, DescribeMaintenanceStartTimeInputRequestTypeDef, DescribeNFSFileSharesInputRequestTypeDef, DescribeSMBFileSharesInputRequestTypeDef, DescribeSMBSettingsInputRequestTypeDef, SMBLocalGroupsTypeDef, DescribeSnapshotScheduleInputRequestTypeDef, DescribeStorediSCSIVolumesInputRequestTypeDef, PaginatorConfigTypeDef, DescribeTapeArchivesInputRequestTypeDef, TapeArchiveTypeDef, DescribeTapeRecoveryPointsInputRequestTypeDef, TapeRecoveryPointInfoTypeDef, DescribeTapesInputRequestTypeDef, TapeTypeDef, DescribeUploadBufferInputRequestTypeDef, DescribeVTLDevicesInputRequestTypeDef, DescribeWorkingStorageInputRequestTypeDef, DetachVolumeInputRequestTypeDef, DeviceiSCSIAttributesTypeDef, DisableGatewayInputRequestTypeDef, DisassociateFileSystemInputRequestTypeDef, DiskTypeDef, FileShareInfoTypeDef, FileSystemAssociationStatusDetailTypeDef, FileSystemAssociationSummaryTypeDef, GatewayInfoTypeDef, JoinDomainInputRequestTypeDef, ListAutomaticTapeCreationPoliciesInputRequestTypeDef, ListFileSharesInputRequestTypeDef, ListFileSystemAssociationsInputRequestTypeDef, ListGatewaysInputRequestTypeDef, ListLocalDisksInputRequestTypeDef, ListTagsForResourceInputRequestTypeDef, ListTapePoolsInputRequestTypeDef, PoolInfoTypeDef, ListTapesInputRequestTypeDef, TapeInfoTypeDef, ListVolumeInitiatorsInputRequestTypeDef, ListVolumeRecoveryPointsInputRequestTypeDef, VolumeRecoveryPointInfoTypeDef, ListVolumesInputRequestTypeDef, VolumeInfoTypeDef, NotifyWhenUploadedInputRequestTypeDef, RefreshCacheInputRequestTypeDef, RemoveTagsFromResourceInputRequestTypeDef, ResetCacheInputRequestTypeDef, RetrieveTapeArchiveInputRequestTypeDef, RetrieveTapeRecoveryPointInputRequestTypeDef, SetLocalConsolePasswordInputRequestTypeDef, SetSMBGuestPasswordInputRequestTypeDef, ShutdownGatewayInputRequestTypeDef, StartAvailabilityMonitorTestInputRequestTypeDef, StartGatewayInputRequestTypeDef, UpdateBandwidthRateLimitInputRequestTypeDef, UpdateChapCredentialsInputRequestTypeDef, UpdateGatewayInformationInputRequestTypeDef, UpdateGatewaySoftwareNowInputRequestTypeDef, UpdateMaintenanceStartTimeInputRequestTypeDef, UpdateSMBFileShareVisibilityInputRequestTypeDef, UpdateSMBSecurityStrategyInputRequestTypeDef, UpdateVTLDeviceTypeInputRequestTypeDef, ActivateGatewayInputRequestTypeDef, AddTagsToResourceInputRequestTypeDef, CreateCachediSCSIVolumeInputRequestTypeDef, CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef, CreateSnapshotInputRequestTypeDef, CreateStorediSCSIVolumeInputRequestTypeDef, CreateTapePoolInputRequestTypeDef, CreateTapeWithBarcodeInputRequestTypeDef, CreateTapesInputRequestTypeDef, UpdateSnapshotScheduleInputRequestTypeDef, ActivateGatewayOutputTypeDef, AddCacheOutputTypeDef, AddTagsToResourceOutputTypeDef, AddUploadBufferOutputTypeDef, AddWorkingStorageOutputTypeDef, AssignTapePoolOutputTypeDef, AssociateFileSystemOutputTypeDef, AttachVolumeOutputTypeDef, CancelArchivalOutputTypeDef, CancelRetrievalOutputTypeDef, CreateCachediSCSIVolumeOutputTypeDef, CreateNFSFileShareOutputTypeDef, CreateSMBFileShareOutputTypeDef, CreateSnapshotFromVolumeRecoveryPointOutputTypeDef, CreateSnapshotOutputTypeDef, CreateStorediSCSIVolumeOutputTypeDef, CreateTapePoolOutputTypeDef, CreateTapeWithBarcodeOutputTypeDef, CreateTapesOutputTypeDef, DeleteAutomaticTapeCreationPolicyOutputTypeDef, DeleteBandwidthRateLimitOutputTypeDef, DeleteChapCredentialsOutputTypeDef, DeleteFileShareOutputTypeDef, DeleteGatewayOutputTypeDef, DeleteSnapshotScheduleOutputTypeDef, DeleteTapeArchiveOutputTypeDef, DeleteTapeOutputTypeDef, DeleteTapePoolOutputTypeDef, DeleteVolumeOutputTypeDef, DescribeAvailabilityMonitorTestOutputTypeDef, DescribeBandwidthRateLimitOutputTypeDef, DescribeCacheOutputTypeDef, DescribeMaintenanceStartTimeOutputTypeDef, DescribeSnapshotScheduleOutputTypeDef, DescribeUploadBufferOutputTypeDef, DescribeWorkingStorageOutputTypeDef, DetachVolumeOutputTypeDef, DisableGatewayOutputTypeDef, DisassociateFileSystemOutputTypeDef, JoinDomainOutputTypeDef, ListTagsForResourceOutputTypeDef, ListVolumeInitiatorsOutputTypeDef, NotifyWhenUploadedOutputTypeDef, RefreshCacheOutputTypeDef, RemoveTagsFromResourceOutputTypeDef, ResetCacheOutputTypeDef, RetrieveTapeArchiveOutputTypeDef, RetrieveTapeRecoveryPointOutputTypeDef, SetLocalConsolePasswordOutputTypeDef, SetSMBGuestPasswordOutputTypeDef, ShutdownGatewayOutputTypeDef, StartAvailabilityMonitorTestOutputTypeDef, StartGatewayOutputTypeDef, UpdateAutomaticTapeCreationPolicyOutputTypeDef, UpdateBandwidthRateLimitOutputTypeDef, UpdateBandwidthRateLimitScheduleOutputTypeDef, UpdateChapCredentialsOutputTypeDef, UpdateFileSystemAssociationOutputTypeDef, UpdateGatewayInformationOutputTypeDef, UpdateGatewaySoftwareNowOutputTypeDef, UpdateMaintenanceStartTimeOutputTypeDef, UpdateNFSFileShareOutputTypeDef, UpdateSMBFileShareOutputTypeDef, UpdateSMBFileShareVisibilityOutputTypeDef, UpdateSMBLocalGroupsOutputTypeDef, UpdateSMBSecurityStrategyOutputTypeDef, UpdateSnapshotScheduleOutputTypeDef, UpdateVTLDeviceTypeOutputTypeDef, CreateSMBFileShareInputRequestTypeDef, SMBFileShareInfoTypeDef, UpdateFileSystemAssociationInputRequestTypeDef, UpdateSMBFileShareInputRequestTypeDef, AssociateFileSystemInputRequestTypeDef, AutomaticTapeCreationPolicyInfoTypeDef, UpdateAutomaticTapeCreationPolicyInputRequestTypeDef, DescribeBandwidthRateLimitScheduleOutputTypeDef, UpdateBandwidthRateLimitScheduleInputRequestTypeDef, CachediSCSIVolumeTypeDef, StorediSCSIVolumeTypeDef, DescribeChapCredentialsOutputTypeDef, CreateNFSFileShareInputRequestTypeDef, NFSFileShareInfoTypeDef, UpdateNFSFileShareInputRequestTypeDef, DescribeGatewayInformationOutputTypeDef, DescribeSMBSettingsOutputTypeDef, UpdateSMBLocalGroupsInputRequestTypeDef, DescribeTapeArchivesInputDescribeTapeArchivesPaginateTypeDef, DescribeTapeRecoveryPointsInputDescribeTapeRecoveryPointsPaginateTypeDef, DescribeTapesInputDescribeTapesPaginateTypeDef, DescribeVTLDevicesInputDescribeVTLDevicesPaginateTypeDef, ListFileSharesInputListFileSharesPaginateTypeDef, ListFileSystemAssociationsInputListFileSystemAssociationsPaginateTypeDef, ListGatewaysInputListGatewaysPaginateTypeDef, ListTagsForResourceInputListTagsForResourcePaginateTypeDef, ListTapePoolsInputListTapePoolsPaginateTypeDef, ListTapesInputListTapesPaginateTypeDef, ListVolumesInputListVolumesPaginateTypeDef, DescribeTapeArchivesOutputTypeDef, DescribeTapeRecoveryPointsOutputTypeDef, DescribeTapesOutputTypeDef, VTLDeviceTypeDef, ListLocalDisksOutputTypeDef, ListFileSharesOutputTypeDef, FileSystemAssociationInfoTypeDef, ListFileSystemAssociationsOutputTypeDef, ListGatewaysOutputTypeDef, ListTapePoolsOutputTypeDef, ListTapesOutputTypeDef, ListVolumeRecoveryPointsOutputTypeDef, ListVolumesOutputTypeDef, DescribeSMBFileSharesOutputTypeDef, ListAutomaticTapeCreationPoliciesOutputTypeDef, DescribeCachediSCSIVolumesOutputTypeDef, DescribeStorediSCSIVolumesOutputTypeDef, DescribeNFSFileSharesOutputTypeDef, DescribeVTLDevicesOutputTypeDef, DescribeFileSystemAssociationsOutputTypeDef, ) def get_structure() -> TagTypeDef: return {...} ``` ## 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 a 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 the documentation (blame `botocore` docs if types are incorrect). - 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. ## What's new ### Implemented features - Fully type annotated `boto3`, `botocore` and `aiobotocore` 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.session` calls - Auto discovery of types for `session.client` and `session.session` 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 ### Latest changes Builder changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases). ## Versioning `mypy-boto3-storagegateway` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. ## 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 ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_storagegateway/) ## 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-storagegateway-1.26.0.post1 %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-storagegateway -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Tue Apr 11 2023 Python_Bot - 1.26.0.post1-1 - Package Spec generated