Skip to content

Backup module#

Index > Backup

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

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

From PyPI with pip#

Install boto3-stubs for Backup service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

BackupClient#

Type annotations and code completion for boto3.client("backup") as BackupClient boto3 documentation

# BackupClient usage example

from boto3.session import Session

from mypy_boto3_backup.client import BackupClient

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

Paginators#

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

# ListBackupJobsPaginator usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupJobsPaginator

def get_list_backup_jobs_paginator() -> ListBackupJobsPaginator:
    return Session().client("backup").get_paginator("list_backup_jobs"))

Literals#

Type annotations for literals used in methods and schemas.

# BackupJobStateType usage example

from mypy_boto3_backup.literals import BackupJobStateType

def get_value() -> BackupJobStateType:
    return "ABORTED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AdvancedBackupSettingTypeDef usage example

from mypy_boto3_backup.type_defs import AdvancedBackupSettingTypeDef

def get_value() -> AdvancedBackupSettingTypeDef:
    return {
        "ResourceType": ...,
    }