Amazon Keyspaces

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

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

type keyspaceName:

string

param keyspaceName:

[REQUIRED]

The name of the keyspace.

type replicationSpecification:

dict

param replicationSpecification:

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

type clientSideTimestamps:

dict

param clientSideTimestamps:

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.

rtype:

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

{'replicationGroupStatuses': [{'keyspaceStatus': 'ACTIVE | CREATING | UPDATING '
                                                 '| DELETING',
                               'region': 'string',
                               'tablesReplicationProgress': 'string'}]}

Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an UpdateKeyspace operation.

See also: AWS API Documentation

Request Syntax

client.get_keyspace(
    keyspaceName='string'
)

type keyspaceName:

string

param keyspaceName:

[REQUIRED]

The name of the keyspace.

rtype:

dict

returns:

Response Syntax

{
    'keyspaceName': 'string',
    'resourceArn': 'string',
    'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION',
    'replicationRegions': [
        'string',
    ],
    'replicationGroupStatuses': [
        {
            'region': 'string',
            'keyspaceStatus': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING',
            'tablesReplicationProgress': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • keyspaceName (string) --

    The name of the keyspace.

  • resourceArn (string) --

    Returns the ARN of the keyspace.

  • replicationStrategy (string) --

    Returns the replication strategy of the keyspace. The options are SINGLE_REGION or MULTI_REGION.

  • replicationRegions (list) --

    If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.

    • (string) --

  • replicationGroupStatuses (list) --

    A list of all Regions the keyspace is replicated in after the update keyspace operation and their status.

    • (dict) --

      This shows the summary status of the keyspace after a new Amazon Web Services Region was added.

      • region (string) --

        The name of the Region that was added to the keyspace.

      • keyspaceStatus (string) --

        The status of the keyspace.

      • tablesReplicationProgress (string) --

        This shows the replication progress of tables in the keyspace. The value is expressed as a percentage of the newly replicated tables with status Active compared to the total number of tables in the keyspace.