Amazonka.Glue.GetDatabases

Retrieves all databases defined in a given Data Catalog.

This operation returns paginated results.

Creating a Request

data GetDatabases

See: newGetDatabases smart constructor.

Constructors

GetDatabases'

Fields

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

• maxResults :: Maybe Natural

  The maximum number of databases to return in one response.

• nextToken :: Maybe Text

  A continuation token, if this is a continuation call.

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

Instances

ToJSON GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

toJSON :: GetDatabases -> Value

toEncoding :: GetDatabases -> Encoding

toJSONList :: [GetDatabases] -> Value

toEncodingList :: [GetDatabases] -> Encoding

ToHeaders GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

toHeaders :: GetDatabases -> [Header]

ToPath GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

toPath :: GetDatabases -> ByteString

ToQuery GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

toQuery :: GetDatabases -> QueryString

AWSPager GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

page :: GetDatabases -> AWSResponse GetDatabases -> Maybe GetDatabases

AWSRequest GetDatabases

Defined in Amazonka.Glue.GetDatabases

Associated Types

type AWSResponse GetDatabases

Methods

request :: (Service -> Service) -> GetDatabases -> Request GetDatabases

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDatabases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDatabases)))

Generic GetDatabases

Defined in Amazonka.Glue.GetDatabases

Associated Types

type Rep GetDatabases :: Type -> Type

Methods

from :: GetDatabases -> Rep GetDatabases x

to :: Rep GetDatabases x -> GetDatabases

Read GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

readsPrec :: Int -> ReadS GetDatabases

readList :: ReadS [GetDatabases]

readPrec :: ReadPrec GetDatabases

readListPrec :: ReadPrec [GetDatabases]

Show GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

showsPrec :: Int -> GetDatabases -> ShowS

show :: GetDatabases -> String

showList :: [GetDatabases] -> ShowS

NFData GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

rnf :: GetDatabases -> ()

Eq GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

(==) :: GetDatabases -> GetDatabases -> Bool

(/=) :: GetDatabases -> GetDatabases -> Bool

Hashable GetDatabases

Defined in Amazonka.Glue.GetDatabases

Methods

hashWithSalt :: Int -> GetDatabases -> Int

hash :: GetDatabases -> Int

type AWSResponse GetDatabases

Defined in Amazonka.Glue.GetDatabases

type AWSResponse GetDatabases = GetDatabasesResponse

type Rep GetDatabases

Defined in Amazonka.Glue.GetDatabases

type Rep GetDatabases = D1 ('MetaData "GetDatabases" "Amazonka.Glue.GetDatabases" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetDatabases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceShareType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceShareType)))))

newGetDatabases :: GetDatabases

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:

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:maxResults:GetDatabases', getDatabases_maxResults - The maximum number of databases to return in one response.

GetDatabases, getDatabases_nextToken - A continuation token, if this is a continuation call.

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

Request Lenses

getDatabases_catalogId :: Lens' GetDatabases (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.

getDatabases_maxResults :: Lens' GetDatabases (Maybe Natural)

The maximum number of databases to return in one response.

getDatabases_nextToken :: Lens' GetDatabases (Maybe Text)

A continuation token, if this is a continuation call.

getDatabases_resourceShareType :: Lens' GetDatabases (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.

Destructuring the Response

data GetDatabasesResponse

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

Generic GetDatabasesResponse

Defined in Amazonka.Glue.GetDatabases

Associated Types

type Rep GetDatabasesResponse :: Type -> Type

Methods

from :: GetDatabasesResponse -> Rep GetDatabasesResponse x

to :: Rep GetDatabasesResponse x -> GetDatabasesResponse

Read GetDatabasesResponse

Defined in Amazonka.Glue.GetDatabases

Methods

readsPrec :: Int -> ReadS GetDatabasesResponse

readList :: ReadS [GetDatabasesResponse]

readPrec :: ReadPrec GetDatabasesResponse

readListPrec :: ReadPrec [GetDatabasesResponse]

Show GetDatabasesResponse

Defined in Amazonka.Glue.GetDatabases

Methods

showsPrec :: Int -> GetDatabasesResponse -> ShowS

show :: GetDatabasesResponse -> String

showList :: [GetDatabasesResponse] -> ShowS

NFData GetDatabasesResponse

Defined in Amazonka.Glue.GetDatabases

Methods

rnf :: GetDatabasesResponse -> ()

Eq GetDatabasesResponse

Defined in Amazonka.Glue.GetDatabases

Methods

(==) :: GetDatabasesResponse -> GetDatabasesResponse -> Bool

(/=) :: GetDatabasesResponse -> GetDatabasesResponse -> Bool

type Rep GetDatabasesResponse

Defined in Amazonka.Glue.GetDatabases

type Rep GetDatabasesResponse = D1 ('MetaData "GetDatabasesResponse" "Amazonka.Glue.GetDatabases" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" '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

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:

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)

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

The response's http status code.

getDatabasesResponse_databaseList :: Lens' GetDatabasesResponse [Database]

A list of Database objects from the specified catalog.