Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

RestoreTable

Restores the table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.

Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.

In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.

You can also overwrite these settings during restore:

Read/write capacity mode
Provisioned throughput capacity units
Auto scaling settings
Point-in-time (PITR) settings
Tags

For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.

Note that the following settings are not restored, and you must configure them manually for the new table:

AWS Identity and Access Management (IAM) policies
Amazon CloudWatch metrics and alarms

Request Syntax


{
   "autoScalingSpecification": { 
      "readCapacityAutoScaling": { 
         "autoScalingDisabled": boolean,
         "maximumUnits": number,
         "minimumUnits": number,
         "scalingPolicy": { 
            "targetTrackingScalingPolicyConfiguration": { 
               "disableScaleIn": boolean,
               "scaleInCooldown": number,
               "scaleOutCooldown": number,
               "targetValue": number
            }
         }
      },
      "writeCapacityAutoScaling": { 
         "autoScalingDisabled": boolean,
         "maximumUnits": number,
         "minimumUnits": number,
         "scalingPolicy": { 
            "targetTrackingScalingPolicyConfiguration": { 
               "disableScaleIn": boolean,
               "scaleInCooldown": number,
               "scaleOutCooldown": number,
               "targetValue": number
            }
         }
      }
   },
   "capacitySpecificationOverride": { 
      "readCapacityUnits": number,
      "throughputMode": "string",
      "writeCapacityUnits": number
   },
   "encryptionSpecificationOverride": { 
      "kmsKeyIdentifier": "string",
      "type": "string"
   },
   "pointInTimeRecoveryOverride": { 
      "status": "string"
   },
   "replicaSpecifications": [ 
      { 
         "readCapacityAutoScaling": { 
            "autoScalingDisabled": boolean,
            "maximumUnits": number,
            "minimumUnits": number,
            "scalingPolicy": { 
               "targetTrackingScalingPolicyConfiguration": { 
                  "disableScaleIn": boolean,
                  "scaleInCooldown": number,
                  "scaleOutCooldown": number,
                  "targetValue": number
               }
            }
         },
         "readCapacityUnits": number,
         "region": "string"
      }
   ],
   "restoreTimestamp": number,
   "sourceKeyspaceName": "string",
   "sourceTableName": "string",
   "tagsOverride": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "targetKeyspaceName": "string",
   "targetTableName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

autoScalingSpecification

The optional auto scaling settings for the restored table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

Type: AutoScalingSpecification object

Required: No

capacitySpecificationOverride

Specifies the read/write throughput capacity mode for the target table. The options are:

throughputMode:PAY_PER_REQUEST
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

Type: CapacitySpecification object

Required: No

encryptionSpecificationOverride

Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):

type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

Type: EncryptionSpecification object

Required: No

pointInTimeRecoveryOverride

Specifies the pointInTimeRecovery settings for the target table. The options are:

status=ENABLED
status=DISABLED

If it's not specified, the default is status=DISABLED.

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

Type: PointInTimeRecovery object

Required: No

replicaSpecifications

The optional Region specific settings of a multi-Regional table.

Type: Array of ReplicaSpecification objects

Array Members: Minimum number of 1 item.

Required: No

restoreTimestamp

The restore timestamp in ISO 8601 format.

Type: Timestamp

Required: No

sourceKeyspaceName

The keyspace name of the source table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_]{0,47}

Required: Yes

sourceTableName

The name of the source table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_]{0,47}

Required: Yes

tagsOverride

A list of key-value pair tags to be attached to the restored table.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 60 items.

Required: No

targetKeyspaceName

The name of the target keyspace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_]{0,47}

Required: Yes

targetTableName

The name of the target table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_]{0,47}

Required: Yes

Response Syntax


{
   "restoredTableARN": "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.

restoredTableARN

The Amazon Resource Name (ARN) of the restored table.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1000.

Pattern: arn:(aws[a-zA-Z0-9-]*):cassandra:.+.*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access permissions to perform this action.

HTTP Status Code: 400

ConflictException

Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.

HTTP Status Code: 400

InternalServerException

Amazon Keyspaces was unable to fully process this request because of an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.

HTTP Status Code: 400

ServiceQuotaExceededException

The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.

HTTP Status Code: 400

ValidationException

The operation failed due to an invalid or malformed request.

HTTP Status Code: 400