Examples

Index > Backup > Examples

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

Client

Implicit type annotations

Can be used with types-boto3[backup] package installed.

Write your Backup code as usual, type checking and code completion should work out of the box.

Client method usage example

# BackupClient usage example

from boto3.session import Session


session = Session()

client = session.client("backup")  # (1)
result = client.associate_backup_vault_mpa_approval_team()  # (2)

1. client: BackupClient
2. result: EmptyResponseMetadataTypeDef

Paginator usage example

# ListBackupAccessPointsByRecoveryPointPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("backup")  # (1)

paginator = client.get_paginator("list_backup_access_points_by_recovery_point")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupClient
2. paginator: ListBackupAccessPointsByRecoveryPointPaginator
3. item: ListBackupAccessPointsByRecoveryPointResponseTypeDef

Explicit type annotations

With types-boto3-lite[backup] or a standalone types_boto3_backup package, you have to explicitly specify client: BackupClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example

# BackupClient usage example with type annotations

from boto3.session import Session

from types_boto3_backup.client import BackupClient
from types_boto3_backup.type_defs import EmptyResponseMetadataTypeDef
from types_boto3_backup.type_defs import AssociateBackupVaultMpaApprovalTeamInputTypeDef


session = Session()

client: BackupClient = session.client("backup")

kwargs: AssociateBackupVaultMpaApprovalTeamInputTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.associate_backup_vault_mpa_approval_team(**kwargs)

Paginator usage example

# ListBackupAccessPointsByRecoveryPointPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_backup.client import BackupClient
from types_boto3_backup.paginator import ListBackupAccessPointsByRecoveryPointPaginator
from types_boto3_backup.type_defs import ListBackupAccessPointsByRecoveryPointResponseTypeDef


session = Session()
client: BackupClient = session.client("backup")

paginator: ListBackupAccessPointsByRecoveryPointPaginator = client.get_paginator("list_backup_access_points_by_recovery_point")
for item in paginator.paginate(...):
    item: ListBackupAccessPointsByRecoveryPointResponseTypeDef
    print(item)