Keyspaces / Client / update_table

update_table#

Keyspaces.Client.update_table(**kwargs)#

Adds new columns to the table or updates one of the table’s settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.

Request Syntax

response = client.update_table(
    keyspaceName='string',
    tableName='string',
    addColumns=[
        {
            'name': 'string',
            'type': 'string'
        },
    ],
    capacitySpecification={
        'throughputMode': 'PAY_PER_REQUEST'|'PROVISIONED',
        'readCapacityUnits': 123,
        'writeCapacityUnits': 123
    },
    encryptionSpecification={
        'type': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
        'kmsKeyIdentifier': 'string'
    },
    pointInTimeRecovery={
        'status': 'ENABLED'|'DISABLED'
    },
    ttl={
        'status': 'ENABLED'
    },
    defaultTimeToLive=123,
    clientSideTimestamps={
        'status': 'ENABLED'
    },
    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:

keyspaceName (string) –
[REQUIRED]

The name of the keyspace the specified table is stored in.
tableName (string) –
[REQUIRED]

The name of the table.
addColumns (list) –
For each column to be added to the specified table:
- name - The name of the column.
- type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.
- (dict) –
  
  The names and data types of regular columns.
  - name (string) – [REQUIRED]
    
    The name of the column.
  - type (string) – [REQUIRED]
    
    The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.
capacitySpecification (dict) –
Modifies the read/write throughput capacity mode for the 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.
- 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).
encryptionSpecification (dict) –
Modifies the encryption settings of the 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 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.
pointInTimeRecovery (dict) –
Modifies the pointInTimeRecovery settings of the 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
ttl (dict) –
Modifies Time to Live custom settings for the table. The options are:
- status:enabled
- status:disabled
The default is status:disabled. After ttl is enabled, you can’t disable it for the table.

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
- status (string) – [REQUIRED]
  
  Shows how to enable custom Time to Live (TTL) settings for the specified table.
defaultTimeToLive (integer) –
The default Time to Live setting in seconds for the table.

For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
clientSideTimestamps (dict) –
Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:
- status: "enabled"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
- status (string) – [REQUIRED]
  
  Shows how to enable client-side timestamps settings for the specified table.
autoScalingSpecification (dict) –
The optional auto scaling settings to update for a 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.

If auto scaling is already enabled for the table, you can use UpdateTable to update the minimum and maximum values or the auto scaling policy settings independently.

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 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

{
    'resourceArn': 'string'
}

Response Structure

(dict) –
- resourceArn (string) –
  
  The Amazon Resource Name (ARN) of the modified 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