Amazon Keyspaces

{'replicationSpecification': {'regionList': ['string'],
                              'replicationStrategy': 'SINGLE_REGION | '
                                                     'MULTI_REGION'}}

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.

CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation.

For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.

See also: AWS API Documentation

Request Syntax

client.create_keyspace(
    keyspaceName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    replicationSpecification={
        'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION',
        'regionList': [
            'string',
        ]
    }
)

type keyspaceName:

string

param keyspaceName:

[REQUIRED]

The name of the keyspace to be created.

type tags:

list

param tags:

A list of key-value pair tags to be attached to the keyspace.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

• (dict) --

  Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.

  Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.

  For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

  • key (string) -- [REQUIRED]

    The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

  • value (string) -- [REQUIRED]

    The value of the tag. Tag values are case-sensitive and can be null.

type replicationSpecification:

dict

param replicationSpecification:

The replication specification of the keyspace includes:

• replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.

• regionList - if the replicationStrategy is MULTI_REGION, the regionList requires the current Region and at least one additional Amazon Web Services Region where the keyspace is going to be replicated in. The maximum number of supported replication Regions including the current Region is six.

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

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

{'replicationRegions': ['string'],
 'replicationStrategy': 'SINGLE_REGION | MULTI_REGION'}

Returns the name and the Amazon Resource Name (ARN) of the specified table.

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',
    ]
}

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

{'keyspaces': {'replicationRegions': ['string'],
               'replicationStrategy': 'SINGLE_REGION | MULTI_REGION'}}

Returns a list of keyspaces.

See also: AWS API Documentation

Request Syntax

client.list_keyspaces(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

type maxResults:

integer

param maxResults:

The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'keyspaces': [
        {
            'keyspaceName': 'string',
            'resourceArn': 'string',
            'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION',
            'replicationRegions': [
                'string',
            ]
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

  • keyspaces (list) --

    A list of keyspaces.

    • (dict) --

      Represents the properties of a keyspace.

      • keyspaceName (string) --

        The name of the keyspace.

      • resourceArn (string) --

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

      • replicationStrategy (string) --

        This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values 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) --