DescribeContinuousBackupsCommand

Suggest an Edit

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 in the last 35 days. You can set the recovery period to any value between 1 and 35 days.

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DynamoDBClient, DescribeContinuousBackupsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DescribeContinuousBackupsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // DescribeContinuousBackupsInput
  TableName: "STRING_VALUE", // required
};
const command = new DescribeContinuousBackupsCommand(input);
const response = await client.send(command);
// { // DescribeContinuousBackupsOutput
//   ContinuousBackupsDescription: { // ContinuousBackupsDescription
//     ContinuousBackupsStatus: "ENABLED" || "DISABLED", // required
//     PointInTimeRecoveryDescription: { // PointInTimeRecoveryDescription
//       PointInTimeRecoveryStatus: "ENABLED" || "DISABLED",
//       RecoveryPeriodInDays: Number("int"),
//       EarliestRestorableDateTime: new Date("TIMESTAMP"),
//       LatestRestorableDateTime: new Date("TIMESTAMP"),
//     },
//   },
// };

DescribeContinuousBackupsCommand Input

See DescribeContinuousBackupsCommandInput for more details

Parameter
Type
Description
TableName
Required
string | undefined

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.

DescribeContinuousBackupsCommand Output

See DescribeContinuousBackupsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ContinuousBackupsDescription
ContinuousBackupsDescription | undefined

Represents the continuous backups and point in time recovery settings on the table.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

InvalidEndpointException
client
TableNotFoundException
client

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

DynamoDBServiceException
Base exception class for all service exceptions from DynamoDB service.