mypy-boto3-storagegateway 1.13.24.2

Type annotations for boto3.StorageGateway 1.13.24 service, generated by mypy-boto3-buider 1.1.1

mypy-boto3-storagegateway

Type annotations for boto3.StorageGateway 1.13.24 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 1.1.1.

More information can be found on boto3-stubs page.

• mypy-boto3-storagegateway
  • How to use
    • Type checking
  • How it works

How to use

Type checking

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for StorageGateway service.

python -m pip install boto3-stubs[storagegateway]

# update installed packages index
mypy_boto3

Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3 import storagegateway
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_storagegateway as storagegateway

# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("storagegateway")
client: storagegateway.StorageGatewayClient = boto3.client("storagegateway")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: storagegateway.StorageGatewayClient = session.client("storagegateway")


# Paginators need type annotation on creation
describe_tape_archives_paginator: storagegateway.DescribeTapeArchivesPaginator = client.get_paginator("describe_tape_archives")
describe_tape_recovery_points_paginator: storagegateway.DescribeTapeRecoveryPointsPaginator = client.get_paginator("describe_tape_recovery_points")
describe_tapes_paginator: storagegateway.DescribeTapesPaginator = client.get_paginator("describe_tapes")
describe_vtl_devices_paginator: storagegateway.DescribeVTLDevicesPaginator = client.get_paginator("describe_vtl_devices")
list_file_shares_paginator: storagegateway.ListFileSharesPaginator = client.get_paginator("list_file_shares")
list_gateways_paginator: storagegateway.ListGatewaysPaginator = client.get_paginator("list_gateways")
list_tags_for_resource_paginator: storagegateway.ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
list_tapes_paginator: storagegateway.ListTapesPaginator = client.get_paginator("list_tapes")
list_volumes_paginator: storagegateway.ListVolumesPaginator = client.get_paginator("list_volumes")

How it works

Fully automated 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 for readability.