S3Tables / Paginator / ListTables

ListTables

class S3Tables.Paginator.ListTables

paginator = client.get_paginator('list_tables')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• tableBucketARN (string) –

  [REQUIRED]

  The Amazon resource Number (ARN) of the table bucket.

• namespace (string) – The namespace of the tables.

• prefix (string) – The prefix of the tables.

• 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': [
        {
            'namespace': [
                'string',
            ],
            'name': 'string',
            'type': 'customer'|'aws',
            'tableARN': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • tables (list) –

    A list of tables.

    • (dict) –

      Contains details about a table.

      • namespace (list) –

        The name of the namespace.

        • (string) –

      • name (string) –

        The name of the table.

      • type (string) –

        The type of the table.

      • tableARN (string) –

        The Amazon Resource Number (ARN) of the table.

      • createdAt (datetime) –

        The date and time the table was created at.

      • modifiedAt (datetime) –

        The date and time the table was last modified at.

  • NextToken (string) –

    A token to resume pagination.