| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Athena.ListDataCatalogs
Description
Lists the data catalogs in the current Amazon Web Services account.
This operation returns paginated results.
Synopsis
- data ListDataCatalogs = ListDataCatalogs' {}
- newListDataCatalogs :: ListDataCatalogs
- listDataCatalogs_nextToken :: Lens' ListDataCatalogs (Maybe Text)
- listDataCatalogs_maxResults :: Lens' ListDataCatalogs (Maybe Natural)
- data ListDataCatalogsResponse = ListDataCatalogsResponse' {}
- newListDataCatalogsResponse :: Int -> ListDataCatalogsResponse
- listDataCatalogsResponse_dataCatalogsSummary :: Lens' ListDataCatalogsResponse (Maybe [DataCatalogSummary])
- listDataCatalogsResponse_nextToken :: Lens' ListDataCatalogsResponse (Maybe Text)
- listDataCatalogsResponse_httpStatus :: Lens' ListDataCatalogsResponse Int
Creating a Request
data ListDataCatalogs Source #
See: newListDataCatalogs smart constructor.
Constructors
| ListDataCatalogs' | |
Fields
| |
Instances
newListDataCatalogs :: ListDataCatalogs Source #
Create a value of ListDataCatalogs 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:nextToken:ListDataCatalogs', listDataCatalogs_nextToken - A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the previous
page call.
$sel:maxResults:ListDataCatalogs', listDataCatalogs_maxResults - Specifies the maximum number of data catalogs to return.
Request Lenses
listDataCatalogs_nextToken :: Lens' ListDataCatalogs (Maybe Text) Source #
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
listDataCatalogs_maxResults :: Lens' ListDataCatalogs (Maybe Natural) Source #
Specifies the maximum number of data catalogs to return.
Destructuring the Response
data ListDataCatalogsResponse Source #
See: newListDataCatalogsResponse smart constructor.
Constructors
| ListDataCatalogsResponse' | |
Fields
| |
Instances
newListDataCatalogsResponse Source #
Create a value of ListDataCatalogsResponse 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:dataCatalogsSummary:ListDataCatalogsResponse', listDataCatalogsResponse_dataCatalogsSummary - A summary list of data catalogs.
$sel:nextToken:ListDataCatalogs', listDataCatalogsResponse_nextToken - A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the previous
page call.
$sel:httpStatus:ListDataCatalogsResponse', listDataCatalogsResponse_httpStatus - The response's http status code.
Response Lenses
listDataCatalogsResponse_dataCatalogsSummary :: Lens' ListDataCatalogsResponse (Maybe [DataCatalogSummary]) Source #
A summary list of data catalogs.
listDataCatalogsResponse_nextToken :: Lens' ListDataCatalogsResponse (Maybe Text) Source #
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
listDataCatalogsResponse_httpStatus :: Lens' ListDataCatalogsResponse Int Source #
The response's http status code.