restore_table_to_point_in_time¶
Operation¶
async
¶
restore_table_to_point_in_time(input: RestoreTableToPointInTimeInput, plugins: list[Plugin] | None = None) -> RestoreTableToPointInTimeOutput
Restores the specified table to the specified point in time within
EarliestRestorableDateTime and LatestRestorableDateTime. You can
restore your table to any point in time in the last 35 days. You can set
the recovery period to any value between 1 and 35 days. Any number of
users can execute up to 50 concurrent restores (any type of restore) in
a given account.
When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.
Along with data, the following are also included on the new restored table using point in time recovery:
-
Global secondary indexes (GSIs)
-
Local secondary indexes (LSIs)
-
Provisioned read and write capacity
-
Encryption settings
Warning: All these settings come from the current settings of the source table at the time of restore.
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
-
Point in time recovery settings
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RestoreTableToPointInTimeInput
|
An instance of |
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 |
|---|---|
RestoreTableToPointInTimeOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for RestoreTableToPointInTimeInput structure.
Attributes¶
class-attribute
instance-attribute
¶
billing_mode_override: BillingMode | None = None
The billing mode of the restored table.
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.
The WarmThroughput setting is not supported on global secondary
indexes when you use RestoreTableToPointInTime. Although
WarmThroughput appears in the shared index definition, including it in
a GlobalSecondaryIndexOverride entry causes the request to fail with a
validation error.
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.
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.
class-attribute
instance-attribute
¶
provisioned_throughput_override: ProvisionedThroughput | None = None
Provisioned throughput settings for the restored table.
class-attribute
instance-attribute
¶
restore_date_time: datetime | None = None
Time in the past to restore the table to.
class-attribute
instance-attribute
¶
source_table_arn: str | None = None
The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).
class-attribute
instance-attribute
¶
source_table_name: str | None = None
Name of the source table that is being restored.
class-attribute
instance-attribute
¶
sse_specification_override: SSESpecification | None = None
The new server-side encryption settings for the restored table.
class-attribute
instance-attribute
¶
target_table_name: str | None = None
The name of the new table to which it must be restored to.
class-attribute
instance-attribute
¶
use_latest_restorable_time: bool | None = None
Restore the table to the latest possible time.
LatestRestorableDateTime is typically 5 minutes before the current
time.
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 source table are restored. The indexes provided must match existing vector indexes from the source table. You can choose to exclude some or all of the vector indexes at the time of restore.
Output¶
dataclass
¶
Dataclass for RestoreTableToPointInTimeOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
table_description: TableDescription | None = None
Represents the properties of a table.