Skip to content

BackupGateway module#

Index > BackupGateway

Auto-generated documentation for BackupGateway type annotations stubs module mypy-boto3-backup-gateway.

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.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add BackupGateway 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 BackupGateway.

From PyPI with pip#

Install boto3-stubs for BackupGateway service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[backup-gateway]'

# 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[backup-gateway]'

# standalone installation
python -m pip install mypy-boto3-backup-gateway

How to uninstall#

python -m pip uninstall -y mypy-boto3-backup-gateway

Usage#

Code samples can be found in Examples.

BackupGatewayClient#

Type annotations and code completion for boto3.client("backup-gateway") as BackupGatewayClient boto3 documentation

# BackupGatewayClient usage example

from boto3.session import Session

from mypy_boto3_backup_gateway.client import BackupGatewayClient

def get_client() -> BackupGatewayClient:
    return Session().client("backup-gateway")

Paginators#

Type annotations and code completion for paginators from boto3.client("backup-gateway").get_paginator("...").

# ListGatewaysPaginator usage example

from boto3.session import Session

from mypy_boto3_backup_gateway.paginator import ListGatewaysPaginator

def get_list_gateways_paginator() -> ListGatewaysPaginator:
    return Session().client("backup-gateway").get_paginator("list_gateways"))

Literals#

Type annotations for literals used in methods and schema.

# GatewayTypeType usage example

from mypy_boto3_backup_gateway.literals import GatewayTypeType

def get_value() -> GatewayTypeType:
    return "BACKUP_VM"

Type definitions#

Type annotations for type definitions used in methods and schema.