Keyspaces / Client / restore_table

restore_table#

Keyspaces.Client.restore_table(**kwargs)#

Restores the specified 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, encryption, 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 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:

Automatic scaling policies (for tables that use provisioned capacity mode)
Identity and Access Management (IAM) policies
Amazon CloudWatch metrics and alarms

Request Syntax

response = client.restore_table(
    sourceKeyspaceName='string',
    sourceTableName='string',
    targetKeyspaceName='string',
    targetTableName='string',
    restoreTimestamp=datetime(2015, 1, 1),
    capacitySpecificationOverride={
        'throughputMode': 'PAY_PER_REQUEST'|'PROVISIONED',
        'readCapacityUnits': 123,
        'writeCapacityUnits': 123
    },
    encryptionSpecificationOverride={
        'type': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
        'kmsKeyIdentifier': 'string'
    },
    pointInTimeRecoveryOverride={
        'status': 'ENABLED'|'DISABLED'
    },
    tagsOverride=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

sourceKeyspaceName (string) –
[REQUIRED]

The keyspace name of the source table.
sourceTableName (string) –
[REQUIRED]

The name of the source table.
targetKeyspaceName (string) –
[REQUIRED]

The name of the target keyspace.
targetTableName (string) –
[REQUIRED]

The name of the target table.
restoreTimestamp (datetime) – The restore timestamp in ISO 8601 format.
capacitySpecificationOverride (dict) –
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.
- throughputMode (string) – [REQUIRED]
  
  The read/write throughput capacity mode for a table. The options are:
  - throughputMode:PAY_PER_REQUEST and
  - 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.
- readCapacityUnits (integer) –
  
  The throughput capacity specified for read operations defined in read capacity units (RCUs).
- writeCapacityUnits (integer) –
  
  The throughput capacity specified for write operations defined in write capacity units (WCUs).
encryptionSpecificationOverride (dict) –
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 (string) – [REQUIRED]
  
  The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):
  - 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.
- kmsKeyIdentifier (string) –
  
  The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.
pointInTimeRecoveryOverride (dict) –
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.
- status (string) – [REQUIRED]
  
  The options are:
  - status=ENABLED
  - status=DISABLED
tagsOverride (list) –
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.
- (dict) –
  
  Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.
  
  Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.
  
  For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
  - key (string) – [REQUIRED]
    
    The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
  - value (string) – [REQUIRED]
    
    The value of the tag. Tag values are case-sensitive and can be null.

Return type:

dict

Returns:

Response Syntax

{
    'restoredTableARN': 'string'
}

Response Structure

(dict) –
- restoredTableARN (string) –
  
  The Amazon Resource Name (ARN) of the restored table.

Exceptions

Keyspaces.Client.exceptions.ValidationException
Keyspaces.Client.exceptions.ServiceQuotaExceededException
Keyspaces.Client.exceptions.InternalServerException
Keyspaces.Client.exceptions.ConflictException
Keyspaces.Client.exceptions.AccessDeniedException
Keyspaces.Client.exceptions.ResourceNotFoundException