Skip to content

BackupStorage module#

Index > BackupStorage

Auto-generated documentation for BackupStorage type annotations stubs module mypy-boto3-backupstorage.

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 BackupStorage.

From PyPI with pip#

Install boto3-stubs for BackupStorage service.

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


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


# standalone installation
python -m pip install mypy-boto3-backupstorage

How to uninstall#

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

Usage#

Code samples can be found in Examples.

BackupStorageClient#

Type annotations and code completion for boto3.client("backupstorage") as BackupStorageClient boto3 documentation

# BackupStorageClient usage example

from boto3.session import Session

from mypy_boto3_backupstorage.client import BackupStorageClient

def get_client() -> BackupStorageClient:
    return Session().client("backupstorage")

Literals#

Type annotations for literals used in methods and schemas.

# DataChecksumAlgorithmType usage example

from mypy_boto3_backupstorage.literals import DataChecksumAlgorithmType

def get_value() -> DataChecksumAlgorithmType:
    return "SHA256"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# BackupObjectTypeDef usage example

from mypy_boto3_backupstorage.type_defs import BackupObjectTypeDef

def get_value() -> BackupObjectTypeDef:
    return {
        "Name": ...,
        "ObjectChecksum": ...,
        "ObjectChecksumAlgorithm": ...,
        "ObjectToken": ...,
    }