Table / Action / update

update#

DynamoDB.Table.update(**kwargs)#

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

Warning

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

You can only perform one of the following operations at once:

Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it’s executing, the table status changes from ACTIVE to UPDATING. While it’s UPDATING, you can’t issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

Request Syntax

table = table.update(
    AttributeDefinitions=[
        {
            'AttributeName': 'string',
            'AttributeType': 'S'|'N'|'B'
        },
    ],
    BillingMode='PROVISIONED'|'PAY_PER_REQUEST',
    ProvisionedThroughput={
        'ReadCapacityUnits': 123,
        'WriteCapacityUnits': 123
    },
    GlobalSecondaryIndexUpdates=[
        {
            'Update': {
                'IndexName': 'string',
                'ProvisionedThroughput': {
                    'ReadCapacityUnits': 123,
                    'WriteCapacityUnits': 123
                },
                'OnDemandThroughput': {
                    'MaxReadRequestUnits': 123,
                    'MaxWriteRequestUnits': 123
                },
                'WarmThroughput': {
                    'ReadUnitsPerSecond': 123,
                    'WriteUnitsPerSecond': 123
                }
            },
            'Create': {
                'IndexName': 'string',
                'KeySchema': [
                    {
                        'AttributeName': 'string',
                        'KeyType': 'HASH'|'RANGE'
                    },
                ],
                'Projection': {
                    'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
                    'NonKeyAttributes': [
                        'string',
                    ]
                },
                'ProvisionedThroughput': {
                    'ReadCapacityUnits': 123,
                    'WriteCapacityUnits': 123
                },
                'OnDemandThroughput': {
                    'MaxReadRequestUnits': 123,
                    'MaxWriteRequestUnits': 123
                },
                'WarmThroughput': {
                    'ReadUnitsPerSecond': 123,
                    'WriteUnitsPerSecond': 123
                }
            },
            'Delete': {
                'IndexName': 'string'
            }
        },
    ],
    StreamSpecification={
        'StreamEnabled': True|False,
        'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
    },
    SSESpecification={
        'Enabled': True|False,
        'SSEType': 'AES256'|'KMS',
        'KMSMasterKeyId': 'string'
    },
    ReplicaUpdates=[
        {
            'Create': {
                'RegionName': 'string',
                'KMSMasterKeyId': 'string',
                'ProvisionedThroughputOverride': {
                    'ReadCapacityUnits': 123
                },
                'OnDemandThroughputOverride': {
                    'MaxReadRequestUnits': 123
                },
                'GlobalSecondaryIndexes': [
                    {
                        'IndexName': 'string',
                        'ProvisionedThroughputOverride': {
                            'ReadCapacityUnits': 123
                        },
                        'OnDemandThroughputOverride': {
                            'MaxReadRequestUnits': 123
                        }
                    },
                ],
                'TableClassOverride': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS'
            },
            'Update': {
                'RegionName': 'string',
                'KMSMasterKeyId': 'string',
                'ProvisionedThroughputOverride': {
                    'ReadCapacityUnits': 123
                },
                'OnDemandThroughputOverride': {
                    'MaxReadRequestUnits': 123
                },
                'GlobalSecondaryIndexes': [
                    {
                        'IndexName': 'string',
                        'ProvisionedThroughputOverride': {
                            'ReadCapacityUnits': 123
                        },
                        'OnDemandThroughputOverride': {
                            'MaxReadRequestUnits': 123
                        }
                    },
                ],
                'TableClassOverride': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS'
            },
            'Delete': {
                'RegionName': 'string'
            }
        },
    ],
    TableClass='STANDARD'|'STANDARD_INFREQUENT_ACCESS',
    DeletionProtectionEnabled=True|False,
    MultiRegionConsistency='EVENTUAL'|'STRONG',
    OnDemandThroughput={
        'MaxReadRequestUnits': 123,
        'MaxWriteRequestUnits': 123
    },
    WarmThroughput={
        'ReadUnitsPerSecond': 123,
        'WriteUnitsPerSecond': 123
    }
)

Parameters:

AttributeDefinitions (list) –
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
- (dict) –
  
  Represents an attribute for describing the schema for the table and indexes.
  - AttributeName (string) – [REQUIRED]
    
    A name for the attribute.
  - AttributeType (string) – [REQUIRED]
    
    The data type for the attribute, where:
    - S - the attribute is of type String
    - N - the attribute is of type Number
    - B - the attribute is of type Binary
BillingMode (string) –
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
- PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
- PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
ProvisionedThroughput (dict) –
The new provisioned throughput settings for the specified table or index.
- ReadCapacityUnits (integer) – [REQUIRED]
  
  The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
  
  If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
- WriteCapacityUnits (integer) – [REQUIRED]
  
  The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
  
  If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
GlobalSecondaryIndexUpdates (list) –
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
- Create - add a new global secondary index to the table.
- Update - modify the provisioned throughput settings of an existing global secondary index.
- Delete - remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
- (dict) –
  
  Represents one of the following:
  - A new global secondary index to be added to an existing table.
  - New provisioned throughput parameters for an existing global secondary index.
  - An existing global secondary index to be removed from an existing table.
  - Update (dict) –
    
    The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
    - IndexName (string) – [REQUIRED]
      
      The name of the global secondary index to be updated.
    - ProvisionedThroughput (dict) –
      
      Represents the provisioned throughput settings for the specified global secondary index.
      
      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
      - ReadCapacityUnits (integer) – [REQUIRED]
        
        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
        
        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
      - WriteCapacityUnits (integer) – [REQUIRED]
        
        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
        
        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
    - OnDemandThroughput (dict) –
      
      Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
      - MaxReadRequestUnits (integer) –
        
        Maximum number of read request units for the specified table.
        
        To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
      - MaxWriteRequestUnits (integer) –
        
        Maximum number of write request units for the specified table.
        
        To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
    - WarmThroughput (dict) –
      
      Represents the warm throughput value of the new provisioned throughput settings to be applied to a global secondary index.
      - ReadUnitsPerSecond (integer) –
        
        Represents the number of read operations your base table can instantaneously support.
      - WriteUnitsPerSecond (integer) –
        
        Represents the number of write operations your base table can instantaneously support.
  - Create (dict) –
    
    The parameters required for creating a global secondary index on an existing table:
    - IndexName
    - KeySchema
    - AttributeDefinitions
    - Projection
    - ProvisionedThroughput
    - IndexName (string) – [REQUIRED]
      
      The name of the global secondary index to be created.
    - KeySchema (list) – [REQUIRED]
      
      The key schema for the global secondary index.
      - (dict) –
        
        Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
        
        A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
        
        A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
        
        AttributeName (string) – [REQUIRED]
        
        The name of a key attribute.
        
        KeyType (string) – [REQUIRED]
        
        The role that this key attribute will assume:
        
        HASH - partition key
        
        RANGE - sort key
        
        Note
        The partition key of an item is also known as its hash attribute. The term “hash attribute” derives from DynamoDB’s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
        
        The sort key of an item is also known as its range attribute. The term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    - Projection (dict) – [REQUIRED]
      
      Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
      - ProjectionType (string) –
        
        The set of attributes that are projected into the index:
        
        KEYS_ONLY - Only the index and primary keys are projected into the index.
        
        INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
        
        ALL - All of the table attributes are projected into the index.
        
        When using the DynamoDB console, ALL is selected by default.
      - NonKeyAttributes (list) –
        
        Represents the non-key attribute names which will be projected into the index.
        
        For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
        
        (string) –
    - ProvisionedThroughput (dict) –
      
      Represents the provisioned throughput settings for the specified global secondary index.
      
      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
      - ReadCapacityUnits (integer) – [REQUIRED]
        
        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
        
        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
      - WriteCapacityUnits (integer) – [REQUIRED]
        
        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
        
        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
    - OnDemandThroughput (dict) –
      
      The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
      - MaxReadRequestUnits (integer) –
        
        Maximum number of read request units for the specified table.
        
        To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
      - MaxWriteRequestUnits (integer) –
        
        Maximum number of write request units for the specified table.
        
        To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
    - WarmThroughput (dict) –
      
      Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.
      - ReadUnitsPerSecond (integer) –
        
        Represents the number of read operations your base table can instantaneously support.
      - WriteUnitsPerSecond (integer) –
        
        Represents the number of write operations your base table can instantaneously support.
  - Delete (dict) –
    
    The name of an existing global secondary index to be removed.
    - IndexName (string) – [REQUIRED]
      
      The name of the global secondary index to be deleted.
StreamSpecification (dict) –
Represents the DynamoDB Streams configuration for the table.

Note
You receive a ValidationException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn’t have a stream.
- StreamEnabled (boolean) – [REQUIRED]
  
  Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
- StreamViewType (string) –
  
  When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
  - KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
  - NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
  - OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
  - NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
SSESpecification (dict) –
The new server-side encryption settings for the specified table.
- Enabled (boolean) –
  
  Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
- SSEType (string) –
  
  Server-side encryption type. The only supported value is:
  - KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
- KMSMasterKeyId (string) –
  
  The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
ReplicaUpdates (list) –
A list of replica update actions (create, delete, or update) for the table.

Note
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
- (dict) –
  
  Represents one of the following:
  - A new replica to be added to an existing regional table or global table. This request invokes the CreateTableReplica action in the destination Region.
  - New parameters for an existing replica. This request invokes the UpdateTable action in the destination Region.
  - An existing replica to be deleted. The request invokes the DeleteTableReplica action in the destination Region, deleting the replica and all if its items in the destination Region.
  Note
  When you manually remove a table or global table replica, you do not automatically remove any associated scalable targets, scaling policies, or CloudWatch alarms.
  - Create (dict) –
    
    The parameters required for creating a replica for the table.
    - RegionName (string) – [REQUIRED]
      
      The Region where the new replica will be created.
    - KMSMasterKeyId (string) –
      
      The KMS key that should be used for KMS encryption in the new replica. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS key alias/aws/dynamodb.
    - ProvisionedThroughputOverride (dict) –
      
      Replica-specific provisioned throughput. If not specified, uses the source table’s provisioned throughput settings.
      - ReadCapacityUnits (integer) –
        
        Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
    - OnDemandThroughputOverride (dict) –
      
      The maximum on-demand throughput settings for the specified replica table being created. You can only modify MaxReadRequestUnits, because you can’t modify MaxWriteRequestUnits for individual replica tables.
      - MaxReadRequestUnits (integer) –
        
        Maximum number of read request units for the specified replica table.
    - GlobalSecondaryIndexes (list) –
      
      Replica-specific global secondary index settings.
      - (dict) –
        
        Represents the properties of a replica global secondary index.
        
        IndexName (string) – [REQUIRED]
        
        The name of the global secondary index.
        
        ProvisionedThroughputOverride (dict) –
        
        Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI’s read capacity settings.
        
        ReadCapacityUnits (integer) –
        
        Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
        
        OnDemandThroughputOverride (dict) –
        
        Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
        
        MaxReadRequestUnits (integer) –
        
        Maximum number of read request units for the specified replica table.
    - TableClassOverride (string) –
      
      Replica-specific table class. If not specified, uses the source table’s table class.
  - Update (dict) –
    
    The parameters required for updating a replica for the table.
    - RegionName (string) – [REQUIRED]
      
      The Region where the replica exists.
    - KMSMasterKeyId (string) –
      
      The KMS key of the replica that should be used for KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS key alias/aws/dynamodb.
    - ProvisionedThroughputOverride (dict) –
      
      Replica-specific provisioned throughput. If not specified, uses the source table’s provisioned throughput settings.
      - ReadCapacityUnits (integer) –
        
        Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
    - OnDemandThroughputOverride (dict) –
      
      Overrides the maximum on-demand throughput for the replica table.
      - MaxReadRequestUnits (integer) –
        
        Maximum number of read request units for the specified replica table.
    - GlobalSecondaryIndexes (list) –
      
      Replica-specific global secondary index settings.
      - (dict) –
        
        Represents the properties of a replica global secondary index.
        
        IndexName (string) – [REQUIRED]
        
        The name of the global secondary index.
        
        ProvisionedThroughputOverride (dict) –
        
        Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI’s read capacity settings.
        
        ReadCapacityUnits (integer) –
        
        Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
        
        OnDemandThroughputOverride (dict) –
        
        Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
        
        MaxReadRequestUnits (integer) –
        
        Maximum number of read request units for the specified replica table.
    - TableClassOverride (string) –
      
      Replica-specific table class. If not specified, uses the source table’s table class.
  - Delete (dict) –
    
    The parameters required for deleting a replica for the table.
    - RegionName (string) – [REQUIRED]
      
      The Region where the replica exists.
TableClass (string) – The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
DeletionProtectionEnabled (boolean) – Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
MultiRegionConsistency (string) –
Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

You can specify one of the following consistency modes:
- EVENTUAL: Configures a new global table for multi-Region eventual consistency. This is the default consistency mode for global tables.
- STRONG: Configures a new global table for multi-Region strong consistency (preview).
Note
Multi-Region strong consistency (MRSC) is a new DynamoDB global tables capability currently available in preview mode. For more information, see Global tables multi-Region strong consistency.

If you don’t specify this parameter, the global table consistency mode defaults to EVENTUAL.
OnDemandThroughput (dict) –
Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
- MaxReadRequestUnits (integer) –
  
  Maximum number of read request units for the specified table.
  
  To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
- MaxWriteRequestUnits (integer) –
  
  Maximum number of write request units for the specified table.
  
  To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) –
Represents the warm throughput (in read units per second and write units per second) for updating a table.
- ReadUnitsPerSecond (integer) –
  
  Represents the number of read operations your base table can instantaneously support.
- WriteUnitsPerSecond (integer) –
  
  Represents the number of write operations your base table can instantaneously support.

Return type:

dynamodb.Table

Returns:

Table resource