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.Athena.ListDataCatalogs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the data catalogs in the current Amazon Web Services account.

This operation returns paginated results.

Creating a Request

data ListDataCatalogs Source #

See: newListDataCatalogs smart constructor.

Constructors

ListDataCatalogs'
Fields maxResults :: Maybe Natural Specifies the maximum number of data catalogs to return. nextToken :: Maybe Text 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.

Instances

Instances details

ToJSON ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods toJSON :: ListDataCatalogs -> Value # toEncoding :: ListDataCatalogs -> Encoding # toJSONList :: [ListDataCatalogs] -> Value # toEncodingList :: [ListDataCatalogs] -> Encoding #
ToHeaders ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods toHeaders :: ListDataCatalogs -> [Header] #
ToPath ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods toPath :: ListDataCatalogs -> ByteString #
ToQuery ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods toQuery :: ListDataCatalogs -> QueryString #
AWSPager ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods page :: ListDataCatalogs -> AWSResponse ListDataCatalogs -> Maybe ListDataCatalogs #
AWSRequest ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Associated Types type AWSResponse ListDataCatalogs # Methods request :: (Service -> Service) -> ListDataCatalogs -> Request ListDataCatalogs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDataCatalogs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDataCatalogs))) #
Generic ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Associated Types type Rep ListDataCatalogs :: Type -> Type # Methods from :: ListDataCatalogs -> Rep ListDataCatalogs x # to :: Rep ListDataCatalogs x -> ListDataCatalogs #
Read ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods readsPrec :: Int -> ReadS ListDataCatalogs # readList :: ReadS [ListDataCatalogs] # readPrec :: ReadPrec ListDataCatalogs # readListPrec :: ReadPrec [ListDataCatalogs] #
Show ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods showsPrec :: Int -> ListDataCatalogs -> ShowS # show :: ListDataCatalogs -> String # showList :: [ListDataCatalogs] -> ShowS #
NFData ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods rnf :: ListDataCatalogs -> () #
Eq ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods (==) :: ListDataCatalogs -> ListDataCatalogs -> Bool # (/=) :: ListDataCatalogs -> ListDataCatalogs -> Bool #
Hashable ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods hashWithSalt :: Int -> ListDataCatalogs -> Int # hash :: ListDataCatalogs -> Int #
type AWSResponse ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs type AWSResponse ListDataCatalogs = ListDataCatalogsResponse
type Rep ListDataCatalogs Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs type Rep ListDataCatalogs = D1 ('MetaData "ListDataCatalogs" "Amazonka.Athena.ListDataCatalogs" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListDataCatalogs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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:maxResults:ListDataCatalogs', listDataCatalogs_maxResults - Specifies the maximum number of data catalogs to return.

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.

Request Lenses

listDataCatalogs_maxResults :: Lens' ListDataCatalogs (Maybe Natural) Source #

Specifies the maximum number of data catalogs to return.

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.

Destructuring the Response

data ListDataCatalogsResponse Source #

See: newListDataCatalogsResponse smart constructor.

Constructors

ListDataCatalogsResponse'
Fields dataCatalogsSummary :: Maybe [DataCatalogSummary] A summary list of data catalogs. nextToken :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListDataCatalogsResponse Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Associated Types type Rep ListDataCatalogsResponse :: Type -> Type # Methods from :: ListDataCatalogsResponse -> Rep ListDataCatalogsResponse x # to :: Rep ListDataCatalogsResponse x -> ListDataCatalogsResponse #
Read ListDataCatalogsResponse Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods readsPrec :: Int -> ReadS ListDataCatalogsResponse # readList :: ReadS [ListDataCatalogsResponse] # readPrec :: ReadPrec ListDataCatalogsResponse # readListPrec :: ReadPrec [ListDataCatalogsResponse] #
Show ListDataCatalogsResponse Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods showsPrec :: Int -> ListDataCatalogsResponse -> ShowS # show :: ListDataCatalogsResponse -> String # showList :: [ListDataCatalogsResponse] -> ShowS #
NFData ListDataCatalogsResponse Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods rnf :: ListDataCatalogsResponse -> () #
Eq ListDataCatalogsResponse Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs Methods (==) :: ListDataCatalogsResponse -> ListDataCatalogsResponse -> Bool # (/=) :: ListDataCatalogsResponse -> ListDataCatalogsResponse -> Bool #
type Rep ListDataCatalogsResponse Source #
Instance details Defined in Amazonka.Athena.ListDataCatalogs type Rep ListDataCatalogsResponse = D1 ('MetaData "ListDataCatalogsResponse" "Amazonka.Athena.ListDataCatalogs" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListDataCatalogsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataCatalogsSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataCatalogSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDataCatalogsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDataCatalogsResponse'`
-> ListDataCatalogsResponse

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.

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.