restore_table_from_backup¶
Operation¶
restore_table_from_backup
¶
restore_table_from_backup(request: RestoreTableFromBackupInput | RestoreTableFromBackupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreTableFromBackupInputDict]) -> 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 |
|---|---|---|---|
request
|
RestoreTableFromBackupInput | RestoreTableFromBackupInputDict | 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[RestoreTableFromBackupInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RestoreTableFromBackupOutput
|
An instance of |
restore_table_from_backup
async
¶
restore_table_from_backup(request: RestoreTableFromBackupInput | RestoreTableFromBackupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreTableFromBackupInputDict]) -> 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 |
|---|---|---|---|
request
|
RestoreTableFromBackupInput | RestoreTableFromBackupInputDict | 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[RestoreTableFromBackupInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RestoreTableFromBackupOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
RestoreTableFromBackupInputDict
¶
Bases: TypedDict
Dictionary form of RestoreTableFromBackupInput.
Attributes¶
backup_arn
instance-attribute
¶
The Amazon Resource Name (ARN) associated with the backup.
billing_mode_override
instance-attribute
¶
billing_mode_override: str | None
The billing mode of the restored table.
global_secondary_index_override
instance-attribute
¶
global_secondary_index_override: Sequence[GlobalSecondaryIndex | GlobalSecondaryIndexDict] | 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
instance-attribute
¶
local_secondary_index_override: Sequence[LocalSecondaryIndex | LocalSecondaryIndexDict] | 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
instance-attribute
¶
on_demand_throughput_override: OnDemandThroughput | OnDemandThroughputDict | 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
instance-attribute
¶
provisioned_throughput_override: ProvisionedThroughput | ProvisionedThroughputDict | None
Provisioned throughput settings for the restored table.
sse_specification_override
instance-attribute
¶
sse_specification_override: SSESpecification | SSESpecificationDict | None
The new server-side encryption settings for the restored table.
target_table_name
instance-attribute
¶
The name of the new table to which the backup must be restored.
vector_index_override
instance-attribute
¶
vector_index_override: Sequence[VectorIndex | VectorIndexDict] | 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.
RestoreTableFromBackupInput
dataclass
¶
Bases: _SerdeShape
Dataclass for RestoreTableFromBackupInput structure.
Attributes¶
backup_arn
class-attribute
instance-attribute
¶
backup_arn: str | None = ...
The Amazon Resource Name (ARN) associated with the backup.
billing_mode_override
class-attribute
instance-attribute
¶
billing_mode_override: str | None = ...
The billing mode of the restored table.
global_secondary_index_override
class-attribute
instance-attribute
¶
global_secondary_index_override: list[GlobalSecondaryIndex] | 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 = ...
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 = ...
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 = ...
Provisioned throughput settings for the restored table.
sse_specification_override
class-attribute
instance-attribute
¶
sse_specification_override: SSESpecification | None = ...
The new server-side encryption settings for the restored table.
target_table_name
class-attribute
instance-attribute
¶
target_table_name: str | 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 = ...
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
¶
Bases: _SerdeShape
Dataclass for RestoreTableFromBackupOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
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.
table_description
class-attribute
instance-attribute
¶
table_description: TableDescription | None = ...
The description of the table created from an existing backup.