DescribeContinuousBackups
Checks the status of continuous backups and point in time recovery on the specified
table. Continuous backups are ENABLED
on all tables at table creation. If
point in time recovery is enabled, PointInTimeRecoveryStatus
will be set to
ENABLED.
After continuous backups and point in time recovery are enabled, you can restore to
any point in time within EarliestRestorableDateTime
and
LatestRestorableDateTime
.
LatestRestorableDateTime
is typically 5 minutes before the current time.
You can restore your table to any point in time during the last 35 days.
You can call DescribeContinuousBackups
at a maximum rate of 10 times per
second.
Request Syntax
{
"TableName": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- TableName
-
Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.
You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
Response Syntax
{
"ContinuousBackupsDescription": {
"ContinuousBackupsStatus": "string",
"PointInTimeRecoveryDescription": {
"EarliestRestorableDateTime": number,
"LatestRestorableDateTime": number,
"PointInTimeRecoveryStatus": "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.
- ContinuousBackupsDescription
-
Represents the continuous backups and point in time recovery settings on the table.
Type: ContinuousBackupsDescription 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
- 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: