Honeycode / Paginator / ListTables

ListTables

class Honeycode.Paginator.ListTables

paginator = client.get_paginator('list_tables')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• workbookId (string) –

  [REQUIRED]

  The ID of the workbook whose tables are being retrieved.

  If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

• 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': [
        {
            'tableId': 'string',
            'tableName': 'string'
        },
    ],
    'workbookCursor': 123,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • tables (list) –

    The list of tables in the workbook.

    • (dict) –

      An object representing the properties of a table in a workbook.

      • tableId (string) –

        The id of the table.

      • tableName (string) –

        The name of the table.

  • workbookCursor (integer) –

    Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

  • NextToken (string) –

    A token to resume pagination.