Honeycode / Client / list_tables
list_tables#
- Honeycode.Client.list_tables(**kwargs)#
The ListTables API allows you to retrieve a list of all the tables in a workbook.
See also: AWS API Documentation
Request Syntax
response = client.list_tables( workbookId='string', maxResults=123, nextToken='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.
maxResults (integer) – The maximum number of tables to return in each page of the results.
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
{ 'tables': [ { 'tableId': 'string', 'tableName': 'string' }, ], 'nextToken': 'string', 'workbookCursor': 123 }
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.
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