Skip to content

StorageGateway module#

Index > StorageGateway

Auto-generated documentation for StorageGateway type annotations stubs module mypy-boto3-storagegateway.

How to install#

VSCode extension#

Add AWS Boto3 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.

# 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#

python -m pip uninstall -y mypy-boto3-storagegateway

Usage#

Code samples can be found in Examples.

StorageGatewayClient#

Type annotations and code completion for boto3.client("storagegateway") as StorageGatewayClient boto3 documentation

# StorageGatewayClient usage example

from boto3.session import Session

from mypy_boto3_storagegateway.client import StorageGatewayClient

def get_client() -> StorageGatewayClient:
    return Session().client("storagegateway")

Paginators#

Type annotations and code completion for paginators from boto3.client("storagegateway").get_paginator("...").

# DescribeTapeArchivesPaginator usage example

from boto3.session import Session

from mypy_boto3_storagegateway.paginator import DescribeTapeArchivesPaginator

def get_describe_tape_archives_paginator() -> DescribeTapeArchivesPaginator:
    return Session().client("storagegateway").get_paginator("describe_tape_archives"))

Literals#

Type annotations for literals used in methods and schemas.

# ActiveDirectoryStatusType usage example

from mypy_boto3_storagegateway.literals import ActiveDirectoryStatusType

def get_value() -> ActiveDirectoryStatusType:
    return "ACCESS_DENIED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# TagTypeDef usage example

from mypy_boto3_storagegateway.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }