Keyspaces / Paginator / ListKeyspaces


class Keyspaces.Paginator.ListKeyspaces#
paginator = client.get_paginator('list_keyspaces')

Creates an iterator that will paginate through responses from Keyspaces.Client.list_keyspaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:



Response Syntax

    'keyspaces': [
            'keyspaceName': 'string',
            'resourceArn': 'string',
            'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION',
            'replicationRegions': [
    'NextToken': 'string'

Response Structure

  • (dict) –

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

    • NextToken (string) –

      A token to resume pagination.