RestoreTableToPointInTimeCommand

Suggest an Edit

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

    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

Example Syntax

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

import { DynamoDBClient, RestoreTableToPointInTimeCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, RestoreTableToPointInTimeCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // RestoreTableToPointInTimeInput
  SourceTableArn: "STRING_VALUE",
  SourceTableName: "STRING_VALUE",
  TargetTableName: "STRING_VALUE", // required
  UseLatestRestorableTime: true || false,
  RestoreDateTime: new Date("TIMESTAMP"),
  BillingModeOverride: "PROVISIONED" || "PAY_PER_REQUEST",
  GlobalSecondaryIndexOverride: [ // GlobalSecondaryIndexList
    { // GlobalSecondaryIndex
      IndexName: "STRING_VALUE", // required
      KeySchema: [ // KeySchema // required
        { // KeySchemaElement
          AttributeName: "STRING_VALUE", // required
          KeyType: "HASH" || "RANGE", // required
        },
      ],
      Projection: { // Projection
        ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
        NonKeyAttributes: [ // NonKeyAttributeNameList
          "STRING_VALUE",
        ],
      },
      ProvisionedThroughput: { // ProvisionedThroughput
        ReadCapacityUnits: Number("long"), // required
        WriteCapacityUnits: Number("long"), // required
      },
      OnDemandThroughput: { // OnDemandThroughput
        MaxReadRequestUnits: Number("long"),
        MaxWriteRequestUnits: Number("long"),
      },
      WarmThroughput: { // WarmThroughput
        ReadUnitsPerSecond: Number("long"),
        WriteUnitsPerSecond: Number("long"),
      },
    },
  ],
  LocalSecondaryIndexOverride: [ // LocalSecondaryIndexList
    { // LocalSecondaryIndex
      IndexName: "STRING_VALUE", // required
      KeySchema: [ // required
        {
          AttributeName: "STRING_VALUE", // required
          KeyType: "HASH" || "RANGE", // required
        },
      ],
      Projection: {
        ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
        NonKeyAttributes: [
          "STRING_VALUE",
        ],
      },
    },
  ],
  ProvisionedThroughputOverride: {
    ReadCapacityUnits: Number("long"), // required
    WriteCapacityUnits: Number("long"), // required
  },
  OnDemandThroughputOverride: {
    MaxReadRequestUnits: Number("long"),
    MaxWriteRequestUnits: Number("long"),
  },
  SSESpecificationOverride: { // SSESpecification
    Enabled: true || false,
    SSEType: "AES256" || "KMS",
    KMSMasterKeyId: "STRING_VALUE",
  },
};
const command = new RestoreTableToPointInTimeCommand(input);
const response = await client.send(command);
// { // RestoreTableToPointInTimeOutput
//   TableDescription: { // TableDescription
//     AttributeDefinitions: [ // AttributeDefinitions
//       { // AttributeDefinition
//         AttributeName: "STRING_VALUE", // required
//         AttributeType: "S" || "N" || "B", // required
//       },
//     ],
//     TableName: "STRING_VALUE",
//     KeySchema: [ // KeySchema
//       { // KeySchemaElement
//         AttributeName: "STRING_VALUE", // required
//         KeyType: "HASH" || "RANGE", // required
//       },
//     ],
//     TableStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
//     CreationDateTime: new Date("TIMESTAMP"),
//     ProvisionedThroughput: { // ProvisionedThroughputDescription
//       LastIncreaseDateTime: new Date("TIMESTAMP"),
//       LastDecreaseDateTime: new Date("TIMESTAMP"),
//       NumberOfDecreasesToday: Number("long"),
//       ReadCapacityUnits: Number("long"),
//       WriteCapacityUnits: Number("long"),
//     },
//     TableSizeBytes: Number("long"),
//     ItemCount: Number("long"),
//     TableArn: "STRING_VALUE",
//     TableId: "STRING_VALUE",
//     BillingModeSummary: { // BillingModeSummary
//       BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
//       LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"),
//     },
//     LocalSecondaryIndexes: [ // LocalSecondaryIndexDescriptionList
//       { // LocalSecondaryIndexDescription
//         IndexName: "STRING_VALUE",
//         KeySchema: [
//           {
//             AttributeName: "STRING_VALUE", // required
//             KeyType: "HASH" || "RANGE", // required
//           },
//         ],
//         Projection: { // Projection
//           ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
//           NonKeyAttributes: [ // NonKeyAttributeNameList
//             "STRING_VALUE",
//           ],
//         },
//         IndexSizeBytes: Number("long"),
//         ItemCount: Number("long"),
//         IndexArn: "STRING_VALUE",
//       },
//     ],
//     GlobalSecondaryIndexes: [ // GlobalSecondaryIndexDescriptionList
//       { // GlobalSecondaryIndexDescription
//         IndexName: "STRING_VALUE",
//         KeySchema: [
//           {
//             AttributeName: "STRING_VALUE", // required
//             KeyType: "HASH" || "RANGE", // required
//           },
//         ],
//         Projection: {
//           ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
//           NonKeyAttributes: [
//             "STRING_VALUE",
//           ],
//         },
//         IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
//         Backfilling: true || false,
//         ProvisionedThroughput: {
//           LastIncreaseDateTime: new Date("TIMESTAMP"),
//           LastDecreaseDateTime: new Date("TIMESTAMP"),
//           NumberOfDecreasesToday: Number("long"),
//           ReadCapacityUnits: Number("long"),
//           WriteCapacityUnits: Number("long"),
//         },
//         IndexSizeBytes: Number("long"),
//         ItemCount: Number("long"),
//         IndexArn: "STRING_VALUE",
//         OnDemandThroughput: { // OnDemandThroughput
//           MaxReadRequestUnits: Number("long"),
//           MaxWriteRequestUnits: Number("long"),
//         },
//         WarmThroughput: { // GlobalSecondaryIndexWarmThroughputDescription
//           ReadUnitsPerSecond: Number("long"),
//           WriteUnitsPerSecond: Number("long"),
//           Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
//         },
//       },
//     ],
//     StreamSpecification: { // StreamSpecification
//       StreamEnabled: true || false, // required
//       StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
//     },
//     LatestStreamLabel: "STRING_VALUE",
//     LatestStreamArn: "STRING_VALUE",
//     GlobalTableVersion: "STRING_VALUE",
//     Replicas: [ // ReplicaDescriptionList
//       { // ReplicaDescription
//         RegionName: "STRING_VALUE",
//         ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
//         ReplicaStatusDescription: "STRING_VALUE",
//         ReplicaStatusPercentProgress: "STRING_VALUE",
//         KMSMasterKeyId: "STRING_VALUE",
//         ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
//           ReadCapacityUnits: Number("long"),
//         },
//         OnDemandThroughputOverride: { // OnDemandThroughputOverride
//           MaxReadRequestUnits: Number("long"),
//         },
//         WarmThroughput: { // TableWarmThroughputDescription
//           ReadUnitsPerSecond: Number("long"),
//           WriteUnitsPerSecond: Number("long"),
//           Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
//         },
//         GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
//           { // ReplicaGlobalSecondaryIndexDescription
//             IndexName: "STRING_VALUE",
//             ProvisionedThroughputOverride: {
//               ReadCapacityUnits: Number("long"),
//             },
//             OnDemandThroughputOverride: {
//               MaxReadRequestUnits: Number("long"),
//             },
//             WarmThroughput: {
//               ReadUnitsPerSecond: Number("long"),
//               WriteUnitsPerSecond: Number("long"),
//               Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
//             },
//           },
//         ],
//         ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
//         ReplicaTableClassSummary: { // TableClassSummary
//           TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
//           LastUpdateDateTime: new Date("TIMESTAMP"),
//         },
//       },
//     ],
//     RestoreSummary: { // RestoreSummary
//       SourceBackupArn: "STRING_VALUE",
//       SourceTableArn: "STRING_VALUE",
//       RestoreDateTime: new Date("TIMESTAMP"), // required
//       RestoreInProgress: true || false, // required
//     },
//     SSEDescription: { // SSEDescription
//       Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "UPDATING",
//       SSEType: "AES256" || "KMS",
//       KMSMasterKeyArn: "STRING_VALUE",
//       InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
//     },
//     ArchivalSummary: { // ArchivalSummary
//       ArchivalDateTime: new Date("TIMESTAMP"),
//       ArchivalReason: "STRING_VALUE",
//       ArchivalBackupArn: "STRING_VALUE",
//     },
//     TableClassSummary: {
//       TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
//       LastUpdateDateTime: new Date("TIMESTAMP"),
//     },
//     DeletionProtectionEnabled: true || false,
//     OnDemandThroughput: {
//       MaxReadRequestUnits: Number("long"),
//       MaxWriteRequestUnits: Number("long"),
//     },
//     WarmThroughput: {
//       ReadUnitsPerSecond: Number("long"),
//       WriteUnitsPerSecond: Number("long"),
//       Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
//     },
//     MultiRegionConsistency: "EVENTUAL" || "STRONG",
//   },
// };

RestoreTableToPointInTimeCommand Input

See RestoreTableToPointInTimeCommandInput for more details

Parameter
Type
Description
TargetTableName
Required
string | undefined

The name of the new table to which it must be restored to.

BillingModeOverride
BillingMode | undefined

The billing mode of the restored table.

GlobalSecondaryIndexOverride
GlobalSecondaryIndex[] | undefined

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.

LocalSecondaryIndexOverride
LocalSecondaryIndex[] | undefined

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.

OnDemandThroughputOverride
OnDemandThroughput | undefined

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.

ProvisionedThroughputOverride
ProvisionedThroughput | undefined

Provisioned throughput settings for the restored table.

RestoreDateTime
Date | undefined

Time in the past to restore the table to.

SSESpecificationOverride
SSESpecification | undefined

The new server-side encryption settings for the restored table.

SourceTableArn
string | undefined

The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).

SourceTableName
string | undefined

Name of the source table that is being restored.

UseLatestRestorableTime
boolean | undefined

Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.

RestoreTableToPointInTimeCommand Output

See RestoreTableToPointInTimeCommandOutput for details

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

Represents the properties of a table.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

InvalidEndpointException
client
InvalidRestoreTimeException
client

An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.

LimitExceededException
client

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, and RestoreTableToPointInTime.

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.

PointInTimeRecoveryUnavailableException
client

Point in time recovery has not yet been enabled for this source table.

TableAlreadyExistsException
client

A target table with the specified name already exists.

TableInUseException
client

A target table with the specified name is either being created or deleted.

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.