RestoreTableToPointInTime
Restores the specified table to the specified point in time within
EarliestRestorableDateTime
and LatestRestorableDateTime
.
You can restore your table to any point in time during the last 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
Important
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
Request Syntax
{
"BillingModeOverride": "string
",
"GlobalSecondaryIndexOverride": [
{
"IndexName": "string
",
"KeySchema": [
{
"AttributeName": "string
",
"KeyType": "string
"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number
,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string
" ],
"ProjectionType": "string
"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number
,
"WriteCapacityUnits": number
}
}
],
"LocalSecondaryIndexOverride": [
{
"IndexName": "string
",
"KeySchema": [
{
"AttributeName": "string
",
"KeyType": "string
"
}
],
"Projection": {
"NonKeyAttributes": [ "string
" ],
"ProjectionType": "string
"
}
}
],
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
,
"WriteCapacityUnits": number
},
"RestoreDateTime": number
,
"SourceTableArn": "string
",
"SourceTableName": "string
",
"SSESpecificationOverride": {
"Enabled": boolean
,
"KMSMasterKeyId": "string
",
"SSEType": "string
"
},
"TargetTableName": "string
",
"UseLatestRestorableTime": boolean
}
Request Parameters
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- TargetTableName
-
The name of the new table to which it must be restored to.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Required: Yes
- BillingModeOverride
-
The billing mode of the restored table.
Type: String
Valid Values:
PROVISIONED | PAY_PER_REQUEST
Required: No
- GlobalSecondaryIndexOverride
-
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.
Type: Array of GlobalSecondaryIndex objects
Required: No
- LocalSecondaryIndexOverride
-
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.
Type: Array of LocalSecondaryIndex objects
Required: No
- OnDemandThroughputOverride
-
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.Type: OnDemandThroughput object
Required: No
- ProvisionedThroughputOverride
-
Provisioned throughput settings for the restored table.
Type: ProvisionedThroughput object
Required: No
- RestoreDateTime
-
Time in the past to restore the table to.
Type: Timestamp
Required: No
- SourceTableArn
-
The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- SourceTableName
-
Name of the source table that is being restored.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Required: No
- SSESpecificationOverride
-
The new server-side encryption settings for the restored table.
Type: SSESpecification object
Required: No
- UseLatestRestorableTime
-
Restore the table to the latest possible time.
LatestRestorableDateTime
is typically 5 minutes before the current time.Type: Boolean
Required: No
Response Syntax
{
"TableDescription": {
"ArchivalSummary": {
"ArchivalBackupArn": "string",
"ArchivalDateTime": number,
"ArchivalReason": "string"
},
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"CreationDateTime": number,
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
}
],
"GlobalTableVersion": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
}
}
],
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
}
}
],
"RestoreSummary": {
"RestoreDateTime": number,
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableArn": "string",
"TableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- TableDescription
-
Represents the properties of a table.
Type: TableDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidRestoreTimeException
-
An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
HTTP Status Code: 400
- LimitExceededException
-
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
HTTP Status Code: 400
- PointInTimeRecoveryUnavailableException
-
Point in time recovery has not yet been enabled for this source table.
HTTP Status Code: 400
- TableAlreadyExistsException
-
A target table with the specified name already exists.
HTTP Status Code: 400
- TableInUseException
-
A target table with the specified name is either being created or deleted.
HTTP Status Code: 400
- TableNotFoundException
-
A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong AWS Region.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: