Honeycode / Client / list_table_columns
list_table_columns#
- Honeycode.Client.list_table_columns(**kwargs)#
The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
See also: AWS API Documentation
Request Syntax
response = client.list_table_columns( workbookId='string', tableId='string', nextToken='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.
nextToken (string) –
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
- 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' }, ], 'nextToken': 'string', 'workbookCursor': 123 }
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’.
nextToken (string) –
Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.
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.
Exceptions