amazonka-lakeformation-2.0: Amazon Lake Formation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LakeFormation.SearchDatabasesByLFTags

Description

This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchDatabasesByLFTags Source #

See: newSearchDatabasesByLFTags smart constructor.

Constructors

SearchDatabasesByLFTags' 

Fields

  • catalogId :: Maybe Text

    The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

  • maxResults :: Maybe Natural

    The maximum number of results to return.

  • nextToken :: Maybe Text

    A continuation token, if this is not the first call to retrieve this list.

  • expression :: NonEmpty LFTag

    A list of conditions (LFTag structures) to search for in database resources.

Instances

Instances details
ToJSON SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

toJSON :: SearchDatabasesByLFTags -> Value #

toEncoding :: SearchDatabasesByLFTags -> Encoding #

toJSONList :: [SearchDatabasesByLFTags] -> Value #

toEncodingList :: [SearchDatabasesByLFTags] -> Encoding #

ToHeaders SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

toHeaders :: SearchDatabasesByLFTags -> [Header] #

ToPath SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

toPath :: SearchDatabasesByLFTags -> ByteString #

ToQuery SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

toQuery :: SearchDatabasesByLFTags -> QueryString #

AWSPager SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

page :: SearchDatabasesByLFTags -> AWSResponse SearchDatabasesByLFTags -> Maybe SearchDatabasesByLFTags #

AWSRequest SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Associated Types

type AWSResponse SearchDatabasesByLFTags #

Methods

request :: (Service -> Service) -> SearchDatabasesByLFTags -> Request SearchDatabasesByLFTags #

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

Generic SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Associated Types

type Rep SearchDatabasesByLFTags :: Type -> Type #

Methods

from :: SearchDatabasesByLFTags -> Rep SearchDatabasesByLFTags x #

to :: Rep SearchDatabasesByLFTags x -> SearchDatabasesByLFTags #

Read SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

readsPrec :: Int -> ReadS SearchDatabasesByLFTags #

readList :: ReadS [SearchDatabasesByLFTags] #

readPrec :: ReadPrec SearchDatabasesByLFTags #

readListPrec :: ReadPrec [SearchDatabasesByLFTags] #

Show SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

showsPrec :: Int -> SearchDatabasesByLFTags -> ShowS #

show :: SearchDatabasesByLFTags -> String #

showList :: [SearchDatabasesByLFTags] -> ShowS #

NFData SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

rnf :: SearchDatabasesByLFTags -> () #

Eq SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

(==) :: SearchDatabasesByLFTags -> SearchDatabasesByLFTags -> Bool #

(/=) :: SearchDatabasesByLFTags -> SearchDatabasesByLFTags -> Bool #

Hashable SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

hashWithSalt :: Int -> SearchDatabasesByLFTags -> Int #

hash :: SearchDatabasesByLFTags -> Int #

type AWSResponse SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

type AWSResponse SearchDatabasesByLFTags = SearchDatabasesByLFTagsResponse
type Rep SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

type Rep SearchDatabasesByLFTags = D1 ('MetaData "SearchDatabasesByLFTags" "Amazonka.LakeFormation.SearchDatabasesByLFTags" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "SearchDatabasesByLFTags'" '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 "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty LFTag)))))

newSearchDatabasesByLFTags Source #

Arguments

:: NonEmpty LFTag

SearchDatabasesByLFTags

-> SearchDatabasesByLFTags 

Create a value of SearchDatabasesByLFTags 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:

SearchDatabasesByLFTags, searchDatabasesByLFTags_catalogId - The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

$sel:maxResults:SearchDatabasesByLFTags', searchDatabasesByLFTags_maxResults - The maximum number of results to return.

SearchDatabasesByLFTags, searchDatabasesByLFTags_nextToken - A continuation token, if this is not the first call to retrieve this list.

SearchDatabasesByLFTags, searchDatabasesByLFTags_expression - A list of conditions (LFTag structures) to search for in database resources.

Request Lenses

searchDatabasesByLFTags_catalogId :: Lens' SearchDatabasesByLFTags (Maybe Text) Source #

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

searchDatabasesByLFTags_maxResults :: Lens' SearchDatabasesByLFTags (Maybe Natural) Source #

The maximum number of results to return.

searchDatabasesByLFTags_nextToken :: Lens' SearchDatabasesByLFTags (Maybe Text) Source #

A continuation token, if this is not the first call to retrieve this list.

searchDatabasesByLFTags_expression :: Lens' SearchDatabasesByLFTags (NonEmpty LFTag) Source #

A list of conditions (LFTag structures) to search for in database resources.

Destructuring the Response

data SearchDatabasesByLFTagsResponse Source #

See: newSearchDatabasesByLFTagsResponse smart constructor.

Constructors

SearchDatabasesByLFTagsResponse' 

Fields

Instances

Instances details
Generic SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Associated Types

type Rep SearchDatabasesByLFTagsResponse :: Type -> Type #

Methods

from :: SearchDatabasesByLFTagsResponse -> Rep SearchDatabasesByLFTagsResponse x #

to :: Rep SearchDatabasesByLFTagsResponse x -> SearchDatabasesByLFTagsResponse #

Read SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

readsPrec :: Int -> ReadS SearchDatabasesByLFTagsResponse #

readList :: ReadS [SearchDatabasesByLFTagsResponse] #

readPrec :: ReadPrec SearchDatabasesByLFTagsResponse #

readListPrec :: ReadPrec [SearchDatabasesByLFTagsResponse] #

Show SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

showsPrec :: Int -> SearchDatabasesByLFTagsResponse -> ShowS #

show :: SearchDatabasesByLFTagsResponse -> String #

showList :: [SearchDatabasesByLFTagsResponse] -> ShowS #

NFData SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

rnf :: SearchDatabasesByLFTagsResponse -> () #

Eq SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

(==) :: SearchDatabasesByLFTagsResponse -> SearchDatabasesByLFTagsResponse -> Bool #

(/=) :: SearchDatabasesByLFTagsResponse -> SearchDatabasesByLFTagsResponse -> Bool #

type Rep SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

type Rep SearchDatabasesByLFTagsResponse = D1 ('MetaData "SearchDatabasesByLFTagsResponse" "Amazonka.LakeFormation.SearchDatabasesByLFTags" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "SearchDatabasesByLFTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "databaseList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaggedDatabase])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchDatabasesByLFTagsResponse Source #

Arguments

:: Int

$sel:httpStatus:SearchDatabasesByLFTagsResponse'

-> SearchDatabasesByLFTagsResponse 

Create a value of SearchDatabasesByLFTagsResponse 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:SearchDatabasesByLFTagsResponse', searchDatabasesByLFTagsResponse_databaseList - A list of databases that meet the LF-tag conditions.

SearchDatabasesByLFTags, searchDatabasesByLFTagsResponse_nextToken - A continuation token, present if the current list segment is not the last.

$sel:httpStatus:SearchDatabasesByLFTagsResponse', searchDatabasesByLFTagsResponse_httpStatus - The response's http status code.

Response Lenses

searchDatabasesByLFTagsResponse_databaseList :: Lens' SearchDatabasesByLFTagsResponse (Maybe [TaggedDatabase]) Source #

A list of databases that meet the LF-tag conditions.

searchDatabasesByLFTagsResponse_nextToken :: Lens' SearchDatabasesByLFTagsResponse (Maybe Text) Source #

A continuation token, present if the current list segment is not the last.

searchDatabasesByLFTagsResponse_httpStatus :: Lens' SearchDatabasesByLFTagsResponse Int Source #

The response's http status code.