Keyspaces / Paginator / ListTables

ListTables

class Keyspaces.Paginator.ListTables

paginator = client.get_paginator('list_tables')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    keyspaceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• keyspaceName (string) –

  [REQUIRED]

  The name of the keyspace.

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

dict

Returns:

Response Syntax

{
    'tables': [
        {
            'keyspaceName': 'string',
            'tableName': 'string',
            'resourceArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • tables (list) –

    A list of tables.

    • (dict) –

      Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).

      • keyspaceName (string) –

        The name of the keyspace that the table is stored in.

      • tableName (string) –

        The name of the table.

      • resourceArn (string) –

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

  • NextToken (string) –

    A token to resume pagination.