Skip to content

DynamoDB  >  Operations  >  restore_table_from_backup

restore_table_from_backup

Operation

restore_table_from_backup async 

restore_table_from_backup(input: RestoreTableFromBackupInput, plugins: list[Plugin] | None = None) -> RestoreTableFromBackupOutput

Creates a new table from an existing backup. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.

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

You must manually set up the following on the restored table:

  • Auto scaling policies

  • IAM policies

  • Amazon CloudWatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

Parameters:

Name Type Description Default
input RestoreTableFromBackupInput

An instance of RestoreTableFromBackupInput.

 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
RestoreTableFromBackupOutput

An instance of RestoreTableFromBackupOutput.

Input

RestoreTableFromBackupInput dataclass

Dataclass for RestoreTableFromBackupInput structure.

Attributes

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

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

billing_mode_override class-attribute instance-attribute 
billing_mode_override: BillingMode | None = None

The billing mode of the restored table.

global_secondary_index_override class-attribute instance-attribute 
global_secondary_index_override: list[GlobalSecondaryIndex] | None = None

List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

local_secondary_index_override class-attribute instance-attribute 
local_secondary_index_override: list[LocalSecondaryIndex] | None = None

List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

on_demand_throughput_override class-attribute instance-attribute 
on_demand_throughput_override: OnDemandThroughput | None = None

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

provisioned_throughput_override class-attribute instance-attribute 
provisioned_throughput_override: ProvisionedThroughput | None = None

Provisioned throughput settings for the restored table.

sse_specification_override class-attribute instance-attribute 
sse_specification_override: SSESpecification | None = None

The new server-side encryption settings for the restored table.

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

The name of the new table to which the backup must be restored.

vector_index_override class-attribute instance-attribute 
vector_index_override: list[VectorIndex] | None = None

The vector indexes for the restored table. If not specified, all vector indexes from the backup are restored. The indexes provided must match existing vector indexes from the backup. You can choose to exclude some or all of the vector indexes at the time of restore.

Output

RestoreTableFromBackupOutput dataclass

Dataclass for RestoreTableFromBackupOutput structure.

Attributes

table_description class-attribute instance-attribute 
table_description: TableDescription | None = None

The description of the table created from an existing backup.