Honeycode / Paginator / ListTableColumns
ListTableColumns#
- class Honeycode.Paginator.ListTableColumns#
paginator = client.get_paginator('list_table_columns')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Honeycode.Client.list_table_columns()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( workbookId='string', tableId='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } )
- Parameters:
workbookId (string) –
[REQUIRED]
The ID of the workbook that contains the table whose columns are being retrieved.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
tableId (string) –
[REQUIRED]
The ID of the table whose columns are being retrieved.
If a table 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.StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'tableColumns': [ { 'tableColumnId': 'string', 'tableColumnName': 'string', 'format': 'AUTO'|'NUMBER'|'CURRENCY'|'DATE'|'TIME'|'DATE_TIME'|'PERCENTAGE'|'TEXT'|'ACCOUNTING'|'CONTACT'|'ROWLINK'|'ROWSET' }, ], 'workbookCursor': 123, 'NextToken': 'string' }
Response Structure
(dict) –
tableColumns (list) –
The list of columns in the table.
(dict) –
An object that contains attributes about a single column in a table
tableColumnId (string) –
The id of the column in the table.
tableColumnName (string) –
The name of the column in the table.
format (string) –
The column level format that is applied in the table. An empty value in this field means that the column format is the default value ‘AUTO’.
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.