Keyspaces / Client / list_keyspaces

list_keyspaces#

Keyspaces.Client.list_keyspaces(**kwargs)#

Returns a list of keyspaces.

See also: AWS API Documentation

Request Syntax

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

  • nextToken (string) – The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • maxResults (integer) – 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.

Return type:

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

Exceptions