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.LakeFormation.SearchTablesByLFTags

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared.

This operation returns paginated results.

Synopsis

data SearchTablesByLFTags = SearchTablesByLFTags' {
- catalogId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- expression :: NonEmpty LFTag
}
newSearchTablesByLFTags :: NonEmpty LFTag -> SearchTablesByLFTags
searchTablesByLFTags_catalogId :: Lens' SearchTablesByLFTags (Maybe Text)
searchTablesByLFTags_maxResults :: Lens' SearchTablesByLFTags (Maybe Natural)
searchTablesByLFTags_nextToken :: Lens' SearchTablesByLFTags (Maybe Text)
searchTablesByLFTags_expression :: Lens' SearchTablesByLFTags (NonEmpty LFTag)
data SearchTablesByLFTagsResponse = SearchTablesByLFTagsResponse' {
- nextToken :: Maybe Text
- tableList :: Maybe [TaggedTable]
- httpStatus :: Int
}
newSearchTablesByLFTagsResponse :: Int -> SearchTablesByLFTagsResponse
searchTablesByLFTagsResponse_nextToken :: Lens' SearchTablesByLFTagsResponse (Maybe Text)
searchTablesByLFTagsResponse_tableList :: Lens' SearchTablesByLFTagsResponse (Maybe [TaggedTable])
searchTablesByLFTagsResponse_httpStatus :: Lens' SearchTablesByLFTagsResponse Int

Creating a Request

data SearchTablesByLFTags Source #

See: newSearchTablesByLFTags smart constructor.

Constructors

SearchTablesByLFTags'

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 table resources.

Instances

Instances details

ToJSON SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods toJSON :: SearchTablesByLFTags -> Value # toEncoding :: SearchTablesByLFTags -> Encoding # toJSONList :: [SearchTablesByLFTags] -> Value # toEncodingList :: [SearchTablesByLFTags] -> Encoding #
ToHeaders SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods toHeaders :: SearchTablesByLFTags -> [Header] #
ToPath SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods toPath :: SearchTablesByLFTags -> ByteString #
ToQuery SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods toQuery :: SearchTablesByLFTags -> QueryString #
AWSPager SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods page :: SearchTablesByLFTags -> AWSResponse SearchTablesByLFTags -> Maybe SearchTablesByLFTags #
AWSRequest SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Associated Types type AWSResponse SearchTablesByLFTags # Methods request :: (Service -> Service) -> SearchTablesByLFTags -> Request SearchTablesByLFTags # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchTablesByLFTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchTablesByLFTags))) #
Generic SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Associated Types type Rep SearchTablesByLFTags :: Type -> Type # Methods from :: SearchTablesByLFTags -> Rep SearchTablesByLFTags x # to :: Rep SearchTablesByLFTags x -> SearchTablesByLFTags #
Read SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods readsPrec :: Int -> ReadS SearchTablesByLFTags # readList :: ReadS [SearchTablesByLFTags] # readPrec :: ReadPrec SearchTablesByLFTags # readListPrec :: ReadPrec [SearchTablesByLFTags] #
Show SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods showsPrec :: Int -> SearchTablesByLFTags -> ShowS # show :: SearchTablesByLFTags -> String # showList :: [SearchTablesByLFTags] -> ShowS #
NFData SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods rnf :: SearchTablesByLFTags -> () #
Eq SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods (==) :: SearchTablesByLFTags -> SearchTablesByLFTags -> Bool # (/=) :: SearchTablesByLFTags -> SearchTablesByLFTags -> Bool #
Hashable SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods hashWithSalt :: Int -> SearchTablesByLFTags -> Int # hash :: SearchTablesByLFTags -> Int #
type AWSResponse SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags type AWSResponse SearchTablesByLFTags = SearchTablesByLFTagsResponse
type Rep SearchTablesByLFTags Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags type Rep SearchTablesByLFTags = D1 ('MetaData "SearchTablesByLFTags" "Amazonka.LakeFormation.SearchTablesByLFTags" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "SearchTablesByLFTags'" '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)))))

newSearchTablesByLFTags Source #

Arguments

:: NonEmpty LFTag	`SearchTablesByLFTags`
-> SearchTablesByLFTags

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

SearchTablesByLFTags, searchTablesByLFTags_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:SearchTablesByLFTags', searchTablesByLFTags_maxResults - The maximum number of results to return.

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

SearchTablesByLFTags, searchTablesByLFTags_expression - A list of conditions (LFTag structures) to search for in table resources.

Request Lenses

searchTablesByLFTags_catalogId :: Lens' SearchTablesByLFTags (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.

searchTablesByLFTags_maxResults :: Lens' SearchTablesByLFTags (Maybe Natural) Source #

The maximum number of results to return.

searchTablesByLFTags_nextToken :: Lens' SearchTablesByLFTags (Maybe Text) Source #

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

searchTablesByLFTags_expression :: Lens' SearchTablesByLFTags (NonEmpty LFTag) Source #

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

Destructuring the Response

data SearchTablesByLFTagsResponse Source #

See: newSearchTablesByLFTagsResponse smart constructor.

Constructors

SearchTablesByLFTagsResponse'
Fields nextToken :: Maybe Text A continuation token, present if the current list segment is not the last. tableList :: Maybe [TaggedTable] A list of tables that meet the LF-tag conditions. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchTablesByLFTagsResponse Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Associated Types type Rep SearchTablesByLFTagsResponse :: Type -> Type # Methods from :: SearchTablesByLFTagsResponse -> Rep SearchTablesByLFTagsResponse x # to :: Rep SearchTablesByLFTagsResponse x -> SearchTablesByLFTagsResponse #
Read SearchTablesByLFTagsResponse Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods readsPrec :: Int -> ReadS SearchTablesByLFTagsResponse # readList :: ReadS [SearchTablesByLFTagsResponse] # readPrec :: ReadPrec SearchTablesByLFTagsResponse # readListPrec :: ReadPrec [SearchTablesByLFTagsResponse] #
Show SearchTablesByLFTagsResponse Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods showsPrec :: Int -> SearchTablesByLFTagsResponse -> ShowS # show :: SearchTablesByLFTagsResponse -> String # showList :: [SearchTablesByLFTagsResponse] -> ShowS #
NFData SearchTablesByLFTagsResponse Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods rnf :: SearchTablesByLFTagsResponse -> () #
Eq SearchTablesByLFTagsResponse Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags Methods (==) :: SearchTablesByLFTagsResponse -> SearchTablesByLFTagsResponse -> Bool # (/=) :: SearchTablesByLFTagsResponse -> SearchTablesByLFTagsResponse -> Bool #
type Rep SearchTablesByLFTagsResponse Source #
Instance details Defined in Amazonka.LakeFormation.SearchTablesByLFTags type Rep SearchTablesByLFTagsResponse = D1 ('MetaData "SearchTablesByLFTagsResponse" "Amazonka.LakeFormation.SearchTablesByLFTags" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "SearchTablesByLFTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tableList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaggedTable])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchTablesByLFTagsResponse Source #

Arguments

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

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

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

$sel:tableList:SearchTablesByLFTagsResponse', searchTablesByLFTagsResponse_tableList - A list of tables that meet the LF-tag conditions.

$sel:httpStatus:SearchTablesByLFTagsResponse', searchTablesByLFTagsResponse_httpStatus - The response's http status code.

Response Lenses

searchTablesByLFTagsResponse_nextToken :: Lens' SearchTablesByLFTagsResponse (Maybe Text) Source #

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

searchTablesByLFTagsResponse_tableList :: Lens' SearchTablesByLFTagsResponse (Maybe [TaggedTable]) Source #

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

searchTablesByLFTagsResponse_httpStatus :: Lens' SearchTablesByLFTagsResponse Int Source #

The response's http status code.