AWS API Changes

2018/04/30 - Amazon DynamoDB - 2 new api methods

Changes Adds two new APIs UpdateGlobalTableSettings and DescribeGlobalTableSettings. This update introduces new constraints in the CreateGlobalTable and UpdateGlobalTable APIs . Tables must have the same write capacity units. If Global Secondary Indexes exist then they must have the same write capacity units and key schema.

UpdateGlobalTableSettings (new)

Link ¶

Updates settings for a global table.

See also: AWS API Documentation

Request Syntax

client.update_global_table_settings(
    GlobalTableName='string',
    GlobalTableProvisionedWriteCapacityUnits=123,
    GlobalTableGlobalSecondaryIndexSettingsUpdate=[
        {
            'IndexName': 'string',
            'ProvisionedWriteCapacityUnits': 123
        },
    ],
    ReplicaSettingsUpdate=[
        {
            'RegionName': 'string',
            'ReplicaProvisionedReadCapacityUnits': 123,
            'ReplicaGlobalSecondaryIndexSettingsUpdate': [
                {
                    'IndexName': 'string',
                    'ProvisionedReadCapacityUnits': 123
                },
            ]
        },
    ]
)

type GlobalTableName

string

param GlobalTableName

[REQUIRED]

The name of the global table

type GlobalTableProvisionedWriteCapacityUnits

integer

param GlobalTableProvisionedWriteCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

type GlobalTableGlobalSecondaryIndexSettingsUpdate

list

param GlobalTableGlobalSecondaryIndexSettingsUpdate

Represents the settings of a global secondary index for a global table that will be modified.

(dict) --

Represents the settings of a global secondary index for a global table that will be modified.
- IndexName (string) -- [REQUIRED]
  
  The name of the global secondary index. The name must be unique among all other indexes on this table.
- ProvisionedWriteCapacityUnits (integer) --
  
  The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

type ReplicaSettingsUpdate

list

param ReplicaSettingsUpdate

Represents the settings for a global table in a region that will be modified.

(dict) --

Represents the settings for a global table in a region that will be modified.
- RegionName (string) -- [REQUIRED]
  
  The region of the replica to be added.
- ReplicaProvisionedReadCapacityUnits (integer) --
  
  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 .
- ReplicaGlobalSecondaryIndexSettingsUpdate (list) --
  
  Represents the settings of a global secondary index for a global table that will be modified.
  - (dict) --
    
    Represents the settings of a global secondary index for a global table that will be modified.
    - IndexName (string) -- [REQUIRED]
      
      The name of the global secondary index. The name must be unique among all other indexes on this table.
    - ProvisionedReadCapacityUnits (integer) --
      
      The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException .

rtype

dict

returns

Response Syntax

{
    'GlobalTableName': 'string',
    'ReplicaSettings': [
        {
            'RegionName': 'string',
            'ReplicaStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
            'ReplicaProvisionedReadCapacityUnits': 123,
            'ReplicaProvisionedWriteCapacityUnits': 123,
            'ReplicaGlobalSecondaryIndexSettings': [
                {
                    'IndexName': 'string',
                    'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
                    'ProvisionedReadCapacityUnits': 123,
                    'ProvisionedWriteCapacityUnits': 123
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- GlobalTableName (string) --
  
  The name of the global table.
- ReplicaSettings (list) --
  
  The region specific settings for the global table.
  - (dict) --
    
    Represents the properties of a replica.
    - RegionName (string) --
      
      The region name of the replica.
    - ReplicaStatus (string) --
      
      The current state of the region:
      - CREATING - The region is being created.
      - UPDATING - The region is being updated.
      - DELETING - The region is being deleted.
      - ACTIVE - The region is ready for use.
    - ReplicaProvisionedReadCapacityUnits (integer) --
      
      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 .
    - ReplicaProvisionedWriteCapacityUnits (integer) --
      
      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 .
    - ReplicaGlobalSecondaryIndexSettings (list) --
      
      Replica global secondary index settings for the global table.
      - (dict) --
        
        Represents the properties of a global secondary index.
        
        IndexName (string) --
        
        The name of the global secondary index. The name must be unique among all other indexes on this table.
        
        IndexStatus (string) --
        
        The current status of the global secondary index:
        
        CREATING - The global secondary index is being created.
        
        UPDATING - The global secondary index is being updated.
        
        DELETING - The global secondary index is being deleted.
        
        ACTIVE - The global secondary index is ready for use.
        
        ProvisionedReadCapacityUnits (integer) --
        
        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException .
        
        ProvisionedWriteCapacityUnits (integer) --
        
        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException .

DescribeGlobalTableSettings (new)