Skip to content

DynamoDB  >  Operations  >  describe_backup

describe_backup

Operation

describe_backup async

describe_backup(input: DescribeBackupInput, plugins: list[Plugin] | None = None) -> DescribeBackupOutput

Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

Parameters:

Name Type Description Default
input DescribeBackupInput

An instance of DescribeBackupInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeBackupOutput

An instance of DescribeBackupOutput.

Input

DescribeBackupInput dataclass

Dataclass for DescribeBackupInput structure.

Attributes

backup_arn class-attribute instance-attribute
backup_arn: str | None = None

The Amazon Resource Name (ARN) associated with the backup.

Output

DescribeBackupOutput dataclass

Dataclass for DescribeBackupOutput structure.

Attributes

backup_description class-attribute instance-attribute
backup_description: BackupDescription | None = None

Contains the description of the backup created for the table.