| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.HoneyCode.ListTables
Description
The ListTables API allows you to retrieve a list of all the tables in a workbook.
This operation returns paginated results.
Synopsis
- data ListTables = ListTables' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- workbookId :: Text
- newListTables :: Text -> ListTables
- listTables_maxResults :: Lens' ListTables (Maybe Natural)
- listTables_nextToken :: Lens' ListTables (Maybe Text)
- listTables_workbookId :: Lens' ListTables Text
- data ListTablesResponse = ListTablesResponse' {
- nextToken :: Maybe Text
- workbookCursor :: Maybe Integer
- httpStatus :: Int
- tables :: [Table]
- newListTablesResponse :: Int -> ListTablesResponse
- listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text)
- listTablesResponse_workbookCursor :: Lens' ListTablesResponse (Maybe Integer)
- listTablesResponse_httpStatus :: Lens' ListTablesResponse Int
- listTablesResponse_tables :: Lens' ListTablesResponse [Table]
Creating a Request
data ListTables Source #
See: newListTables smart constructor.
Constructors
| ListTables' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListTables |
Create a value of ListTables with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTables', listTables_maxResults - The maximum number of tables to return in each page of the results.
ListTables, listTables_nextToken - 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.
$sel:workbookId:ListTables', listTables_workbookId - 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.
Request Lenses
listTables_maxResults :: Lens' ListTables (Maybe Natural) Source #
The maximum number of tables to return in each page of the results.
listTables_nextToken :: Lens' ListTables (Maybe Text) Source #
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.
listTables_workbookId :: Lens' ListTables Text Source #
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.
Destructuring the Response
data ListTablesResponse Source #
See: newListTablesResponse smart constructor.
Constructors
| ListTablesResponse' | |
Fields
| |
Instances
newListTablesResponse Source #
Arguments
| :: Int | |
| -> ListTablesResponse |
Create a value of ListTablesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTables, listTablesResponse_nextToken - 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.
$sel:workbookCursor:ListTablesResponse', listTablesResponse_workbookCursor - 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.
$sel:httpStatus:ListTablesResponse', listTablesResponse_httpStatus - The response's http status code.
$sel:tables:ListTablesResponse', listTablesResponse_tables - The list of tables in the workbook.
Response Lenses
listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text) Source #
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.
listTablesResponse_workbookCursor :: Lens' ListTablesResponse (Maybe Integer) Source #
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.
listTablesResponse_httpStatus :: Lens' ListTablesResponse Int Source #
The response's http status code.
listTablesResponse_tables :: Lens' ListTablesResponse [Table] Source #
The list of tables in the workbook.