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.ListDatabases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the databases in the specified data catalog.

This operation returns paginated results.

Creating a Request

data ListDatabases Source #

See: newListDatabases smart constructor.

Constructors

ListDatabases'

Fields

maxResults :: Maybe Natural
Specifies the maximum number of results 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.
catalogName :: Text
The name of the data catalog that contains the databases to return.

Instances

Instances details

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

newListDatabases Source #

Arguments

:: Text	`ListDatabases`
-> ListDatabases

Create a value of ListDatabases 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:ListDatabases', listDatabases_maxResults - Specifies the maximum number of results to return.

ListDatabases, listDatabases_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.

ListDatabases, listDatabases_catalogName - The name of the data catalog that contains the databases to return.

Request Lenses

listDatabases_maxResults :: Lens' ListDatabases (Maybe Natural) Source #

Specifies the maximum number of results to return.

listDatabases_nextToken :: Lens' ListDatabases (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.

listDatabases_catalogName :: Lens' ListDatabases Text Source #

The name of the data catalog that contains the databases to return.

Destructuring the Response

data ListDatabasesResponse Source #

See: newListDatabasesResponse smart constructor.

Constructors

ListDatabasesResponse'
Fields databaseList :: Maybe [Database] A list of databases from a data catalog. 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 ListDatabasesResponse Source #
Instance details Defined in Amazonka.Athena.ListDatabases Associated Types type Rep ListDatabasesResponse :: Type -> Type # Methods from :: ListDatabasesResponse -> Rep ListDatabasesResponse x # to :: Rep ListDatabasesResponse x -> ListDatabasesResponse #
Read ListDatabasesResponse Source #
Instance details Defined in Amazonka.Athena.ListDatabases Methods readsPrec :: Int -> ReadS ListDatabasesResponse # readList :: ReadS [ListDatabasesResponse] # readPrec :: ReadPrec ListDatabasesResponse # readListPrec :: ReadPrec [ListDatabasesResponse] #
Show ListDatabasesResponse Source #
Instance details Defined in Amazonka.Athena.ListDatabases Methods showsPrec :: Int -> ListDatabasesResponse -> ShowS # show :: ListDatabasesResponse -> String # showList :: [ListDatabasesResponse] -> ShowS #
NFData ListDatabasesResponse Source #
Instance details Defined in Amazonka.Athena.ListDatabases Methods rnf :: ListDatabasesResponse -> () #
Eq ListDatabasesResponse Source #
Instance details Defined in Amazonka.Athena.ListDatabases Methods (==) :: ListDatabasesResponse -> ListDatabasesResponse -> Bool # (/=) :: ListDatabasesResponse -> ListDatabasesResponse -> Bool #
type Rep ListDatabasesResponse Source #
Instance details Defined in Amazonka.Athena.ListDatabases type Rep ListDatabasesResponse = D1 ('MetaData "ListDatabasesResponse" "Amazonka.Athena.ListDatabases" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListDatabasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "databaseList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Database])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDatabasesResponse Source #

Arguments

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

Create a value of ListDatabasesResponse 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:databaseList:ListDatabasesResponse', listDatabasesResponse_databaseList - A list of databases from a data catalog.

ListDatabases, listDatabasesResponse_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:ListDatabasesResponse', listDatabasesResponse_httpStatus - The response's http status code.

Response Lenses

listDatabasesResponse_databaseList :: Lens' ListDatabasesResponse (Maybe [Database]) Source #

A list of databases from a data catalog.

listDatabasesResponse_nextToken :: Lens' ListDatabasesResponse (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.

listDatabasesResponse_httpStatus :: Lens' ListDatabasesResponse Int Source #

The response's http status code.