Skip to content

create_backup

Operation

create_backup

create_backup(request: CreateBackupInput | CreateBackupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBackupInputDict]) -> CreateBackupOutput

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

  • Global secondary indexes (GSIs)

  • Local secondary indexes (LSIs)

  • Streams

  • Provisioned read and write capacity

Parameters:

Name Type Description Default
request CreateBackupInput | CreateBackupInputDict | 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[CreateBackupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateBackupOutput

An instance of CreateBackupOutput.

create_backup async

create_backup(request: CreateBackupInput | CreateBackupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBackupInputDict]) -> CreateBackupOutput

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

  • Global secondary indexes (GSIs)

  • Local secondary indexes (LSIs)

  • Streams

  • Provisioned read and write capacity

Parameters:

Name Type Description Default
request CreateBackupInput | CreateBackupInputDict | 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[CreateBackupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateBackupOutput

An instance of CreateBackupOutput.

Input

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

CreateBackupInputDict

Bases: TypedDict

Dictionary form of CreateBackupInput.

Attributes

backup_name instance-attribute
backup_name: Required[str]

Specified name for the backup.

table_name instance-attribute
table_name: Required[str]

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

CreateBackupInput dataclass

Bases: _SerdeShape

Dataclass for CreateBackupInput structure.

Attributes

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

Specified name for the backup.

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

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Output

CreateBackupOutput dataclass

Bases: _SerdeShape

Dataclass for CreateBackupOutput structure.

Attributes

backup_details class-attribute instance-attribute
backup_details: BackupDetails | None = ...

Contains the details 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.