Keyspaces / Client / restore_table

restore_table#

Keyspaces.Client.restore_table(**kwargs)#

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:

  • Identity and Access Management (IAM) policies

  • Amazon CloudWatch metrics and alarms

See also: AWS API Documentation

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'
        },
    ],
    autoScalingSpecification={
        'writeCapacityAutoScaling': {
            'autoScalingDisabled': True|False,
            'minimumUnits': 123,
            'maximumUnits': 123,
            'scalingPolicy': {
                'targetTrackingScalingPolicyConfiguration': {
                    'disableScaleIn': True|False,
                    'scaleInCooldown': 123,
                    'scaleOutCooldown': 123,
                    'targetValue': 123.0
                }
            }
        },
        'readCapacityAutoScaling': {
            'autoScalingDisabled': True|False,
            'minimumUnits': 123,
            'maximumUnits': 123,
            'scalingPolicy': {
                'targetTrackingScalingPolicyConfiguration': {
                    'disableScaleIn': True|False,
                    'scaleInCooldown': 123,
                    'scaleOutCooldown': 123,
                    'targetValue': 123.0
                }
            }
        }
    },
    replicaSpecifications=[
        {
            'region': 'string',
            'readCapacityUnits': 123,
            'readCapacityAutoScaling': {
                'autoScalingDisabled': True|False,
                'minimumUnits': 123,
                'maximumUnits': 123,
                'scalingPolicy': {
                    'targetTrackingScalingPolicyConfiguration': {
                        'disableScaleIn': True|False,
                        'scaleInCooldown': 123,
                        'scaleOutCooldown': 123,
                        'targetValue': 123.0
                    }
                }
            }
        },
    ]
)
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.

  • autoScalingSpecification (dict) –

    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.

    • writeCapacityAutoScaling (dict) –

      The auto scaling settings for the table’s write capacity.

      • autoScalingDisabled (boolean) –

        This optional parameter enables auto scaling for the table if set to false.

      • minimumUnits (integer) –

        The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • maximumUnits (integer) –

        Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • scalingPolicy (dict) –

        Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table’s ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

        • targetTrackingScalingPolicyConfiguration (dict) –

          Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A double between 20 and 90.

          • disableScaleIn (boolean) –

            Specifies if scale-in is enabled.

            When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can’t scale in the table lower than its minimum capacity.

          • scaleInCooldown (integer) –

            Specifies a scale-in cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • scaleOutCooldown (integer) –

            Specifies a scale out cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • targetValue (float) – [REQUIRED]

            Specifies the target value for the target tracking auto scaling policy.

            Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

    • readCapacityAutoScaling (dict) –

      The auto scaling settings for the table’s read capacity.

      • autoScalingDisabled (boolean) –

        This optional parameter enables auto scaling for the table if set to false.

      • minimumUnits (integer) –

        The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • maximumUnits (integer) –

        Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • scalingPolicy (dict) –

        Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table’s ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

        • targetTrackingScalingPolicyConfiguration (dict) –

          Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A double between 20 and 90.

          • disableScaleIn (boolean) –

            Specifies if scale-in is enabled.

            When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can’t scale in the table lower than its minimum capacity.

          • scaleInCooldown (integer) –

            Specifies a scale-in cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • scaleOutCooldown (integer) –

            Specifies a scale out cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • targetValue (float) – [REQUIRED]

            Specifies the target value for the target tracking auto scaling policy.

            Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

  • replicaSpecifications (list) –

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

    • (dict) –

      The Amazon Web Services Region specific settings of a multi-Region table.

      For a multi-Region table, you can configure the table’s read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters.

      • region: The Region where these settings are applied. (Required)

      • readCapacityUnits: The provisioned read capacity units. (Optional)

      • readCapacityAutoScaling: The read capacity auto scaling settings for the table. (Optional)

      • region (string) – [REQUIRED]

        The Amazon Web Services Region.

      • readCapacityUnits (integer) –

        The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region.

      • readCapacityAutoScaling (dict) –

        The read capacity auto scaling settings for the multi-Region table in the specified Amazon Web Services Region.

        • autoScalingDisabled (boolean) –

          This optional parameter enables auto scaling for the table if set to false.

        • minimumUnits (integer) –

          The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

        • maximumUnits (integer) –

          Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

        • scalingPolicy (dict) –

          Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table’s ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

          • targetTrackingScalingPolicyConfiguration (dict) –

            Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A double between 20 and 90.

            • disableScaleIn (boolean) –

              Specifies if scale-in is enabled.

              When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can’t scale in the table lower than its minimum capacity.

            • scaleInCooldown (integer) –

              Specifies a scale-in cool down period.

              A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

            • scaleOutCooldown (integer) –

              Specifies a scale out cool down period.

              A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

            • targetValue (float) – [REQUIRED]

              Specifies the target value for the target tracking auto scaling policy.

              Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

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