S3Tables / Paginator / ListTableBuckets

ListTableBuckets

class S3Tables.Paginator.ListTableBuckets

paginator = client.get_paginator('list_table_buckets')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• prefix (string) – The prefix of the table buckets.

• 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

{
    'tableBuckets': [
        {
            'arn': 'string',
            'name': 'string',
            'ownerAccountId': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • tableBuckets (list) –

    A list of table buckets.

    • (dict) –

      Contains details about a table bucket.

      • arn (string) –

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

      • name (string) –

        The name of the table bucket.

      • ownerAccountId (string) –

        The ID of the account that owns the table bucket.

      • createdAt (datetime) –

        The date and time the table bucket was created at.

  • NextToken (string) –

    A token to resume pagination.