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.Glue.GetDatabases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves all databases defined in a given Data Catalog.

This operation returns paginated results.

Creating a Request

data GetDatabases Source #

See: newGetDatabases smart constructor.

Constructors

GetDatabases'

Fields

resourceShareType :: Maybe ResourceShareType
Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.
- If set to FOREIGN, will list the databases shared with your account.
- If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.
catalogId :: Maybe Text
The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.
nextToken :: Maybe Text
A continuation token, if this is a continuation call.
maxResults :: Maybe Natural
The maximum number of databases to return in one response.

Instances

Instances details

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

newGetDatabases :: GetDatabases Source #

Create a value of GetDatabases 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:resourceShareType:GetDatabases', getDatabases_resourceShareType - Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.

If set to FOREIGN, will list the databases shared with your account.
If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

$sel:catalogId:GetDatabases', getDatabases_catalogId - The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.

$sel:nextToken:GetDatabases', getDatabases_nextToken - A continuation token, if this is a continuation call.

$sel:maxResults:GetDatabases', getDatabases_maxResults - The maximum number of databases to return in one response.

Request Lenses

getDatabases_resourceShareType :: Lens' GetDatabases (Maybe ResourceShareType) Source #

Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.

If set to FOREIGN, will list the databases shared with your account.
If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

getDatabases_catalogId :: Lens' GetDatabases (Maybe Text) Source #

The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.

getDatabases_nextToken :: Lens' GetDatabases (Maybe Text) Source #

A continuation token, if this is a continuation call.

getDatabases_maxResults :: Lens' GetDatabases (Maybe Natural) Source #

The maximum number of databases to return in one response.

Destructuring the Response

data GetDatabasesResponse Source #

See: newGetDatabasesResponse smart constructor.

Constructors

GetDatabasesResponse'
Fields nextToken :: Maybe Text A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last. httpStatus :: Int The response's http status code. databaseList :: [Database] A list of `Database` objects from the specified catalog.

Instances

Instances details

Eq GetDatabasesResponse Source #
Instance details Defined in Amazonka.Glue.GetDatabases Methods (==) :: GetDatabasesResponse -> GetDatabasesResponse -> Bool # (/=) :: GetDatabasesResponse -> GetDatabasesResponse -> Bool #
Read GetDatabasesResponse Source #
Instance details Defined in Amazonka.Glue.GetDatabases Methods readsPrec :: Int -> ReadS GetDatabasesResponse # readList :: ReadS [GetDatabasesResponse] # readPrec :: ReadPrec GetDatabasesResponse # readListPrec :: ReadPrec [GetDatabasesResponse] #
Show GetDatabasesResponse Source #
Instance details Defined in Amazonka.Glue.GetDatabases Methods showsPrec :: Int -> GetDatabasesResponse -> ShowS # show :: GetDatabasesResponse -> String # showList :: [GetDatabasesResponse] -> ShowS #
Generic GetDatabasesResponse Source #
Instance details Defined in Amazonka.Glue.GetDatabases Associated Types type Rep GetDatabasesResponse :: Type -> Type # Methods from :: GetDatabasesResponse -> Rep GetDatabasesResponse x # to :: Rep GetDatabasesResponse x -> GetDatabasesResponse #
NFData GetDatabasesResponse Source #
Instance details Defined in Amazonka.Glue.GetDatabases Methods rnf :: GetDatabasesResponse -> () #
type Rep GetDatabasesResponse Source #
Instance details Defined in Amazonka.Glue.GetDatabases type Rep GetDatabasesResponse = D1 ('MetaData "GetDatabasesResponse" "Amazonka.Glue.GetDatabases" "libZSservicesZSamazonka-glueZSamazonka-glue" 'False) (C1 ('MetaCons "GetDatabasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "databaseList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Database]))))

newGetDatabasesResponse Source #

Arguments

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

Create a value of GetDatabasesResponse 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:GetDatabases', getDatabasesResponse_nextToken - A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

$sel:httpStatus:GetDatabasesResponse', getDatabasesResponse_httpStatus - The response's http status code.

$sel:databaseList:GetDatabasesResponse', getDatabasesResponse_databaseList - A list of Database objects from the specified catalog.

Response Lenses

getDatabasesResponse_nextToken :: Lens' GetDatabasesResponse (Maybe Text) Source #

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

getDatabasesResponse_httpStatus :: Lens' GetDatabasesResponse Int Source #

The response's http status code.

getDatabasesResponse_databaseList :: Lens' GetDatabasesResponse [Database] Source #

A list of Database objects from the specified catalog.