Keyspaces / Client / update_keyspace

update_keyspace#

Keyspaces.Client.update_keyspace(**kwargs)#

Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. The new replica Region is applied to all tables in the keyspace. For more information, see Add an Amazon Web Services Region to a keyspace in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

To change a single-Region to a multi-Region keyspace, you have to enable client-side timestamps for all tables in the keyspace. For more information, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_keyspace(
    keyspaceName='string',
    replicationSpecification={
        'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION',
        'regionList': [
            'string',
        ]
    },
    clientSideTimestamps={
        'status': 'ENABLED'
    }
)
Parameters:

  • keyspaceName (string) –

    [REQUIRED]

    The name of the keyspace.

  • replicationSpecification (dict) –

    [REQUIRED]

    The replication specification of the keyspace includes:

    • regionList - up to six Amazon Web Services Regions where the keyspace is replicated in.

    • replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.

    • replicationStrategy (string) – [REQUIRED]

      The replicationStrategy of a keyspace, the required value is SINGLE_REGION or MULTI_REGION.

    • regionList (list) –

      The regionList can contain up to six Amazon Web Services Regions where the keyspace is replicated in.

      • (string) –

  • clientSideTimestamps (dict) –

    The client-side timestamp setting of the table.

    For more information, see How it works: Amazon Keyspaces client-side timestamps in the Amazon Keyspaces Developer Guide.

    • status (string) – [REQUIRED]

      Shows how to enable client-side timestamps settings for the specified table.

Return type:

dict

Returns:

Response Syntax

{
    'resourceArn': 'string'
}

Response Structure

  • (dict) –

    • resourceArn (string) –

      The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).

Exceptions