Skip to content

describe_backup

Operation

describe_backup

describe_backup(request: DescribeBackupInput | DescribeBackupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeBackupInputDict]) -> 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
request DescribeBackupInput | DescribeBackupInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeBackupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeBackupOutput

An instance of DescribeBackupOutput.

describe_backup async

describe_backup(request: DescribeBackupInput | DescribeBackupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeBackupInputDict]) -> 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
request DescribeBackupInput | DescribeBackupInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeBackupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeBackupOutput

An instance of DescribeBackupOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeBackupInputDict

Bases: TypedDict

Dictionary form of DescribeBackupInput.

Attributes

backup_arn instance-attribute
backup_arn: Required[str]

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

DescribeBackupInput dataclass

Bases: _SerdeShape

Dataclass for DescribeBackupInput structure.

Attributes

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

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

Output

DescribeBackupOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeBackupOutput structure.

Attributes

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

Contains the description of the backup created for the table.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.