Skip to content

StorageGateway module#

Index > StorageGateway

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

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.26' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add StorageGateway service.
  4. Use provided commands to install generated packages.

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 types-boto3 for StorageGateway service.

# install with boto3 type annotations
python -m pip install 'types-boto3[storagegateway]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[storagegateway]'

# standalone installation
python -m pip install types-boto3-storagegateway

How to uninstall#

python -m pip uninstall -y types-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 types_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 types_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 schema.

# ActiveDirectoryStatusType usage example

from types_boto3_storagegateway.literals import ActiveDirectoryStatusType

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

Type definitions#

Type annotations for type definitions used in methods and schema.