libZSservicesZSamazonka-lakeformationZSamazonka-lakeformation
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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.

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 AWS Lake Formation environment.

  • nextToken :: Maybe Text

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

  • maxResults :: Maybe Natural

    The maximum number of results to return.

  • expression :: NonEmpty LFTag

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

Instances

Instances details
Eq SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Read SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Show SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Generic SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Associated Types

type Rep SearchDatabasesByLFTags :: Type -> Type #

NFData SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Methods

rnf :: SearchDatabasesByLFTags -> () #

Hashable SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

ToJSON SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

AWSRequest SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

ToHeaders SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

ToPath SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

ToQuery SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

type Rep SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

type Rep SearchDatabasesByLFTags = D1 ('MetaData "SearchDatabasesByLFTags" "Amazonka.LakeFormation.SearchDatabasesByLFTags" "libZSservicesZSamazonka-lakeformationZSamazonka-lakeformation" 'False) (C1 ('MetaCons "SearchDatabasesByLFTags'" 'PrefixI 'True) ((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)) :*: S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty LFTag)))))
type AWSResponse SearchDatabasesByLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

newSearchDatabasesByLFTags Source #

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:

$sel:catalogId: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 AWS Lake Formation environment.

$sel:nextToken:SearchDatabasesByLFTags', searchDatabasesByLFTags_nextToken - A continuation token, if this is not the first call to retrieve this list.

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

$sel:expression: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 AWS Lake Formation environment.

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
Eq SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Read SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Show SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Generic SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

Associated Types

type Rep SearchDatabasesByLFTagsResponse :: Type -> Type #

NFData SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

type Rep SearchDatabasesByLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.SearchDatabasesByLFTags

type Rep SearchDatabasesByLFTagsResponse = D1 ('MetaData "SearchDatabasesByLFTagsResponse" "Amazonka.LakeFormation.SearchDatabasesByLFTags" "libZSservicesZSamazonka-lakeformationZSamazonka-lakeformation" '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 #

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 tag conditions.

$sel:nextToken: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_nextToken :: Lens' SearchDatabasesByLFTagsResponse (Maybe Text) Source #

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