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

Description

Lists LF-tags that the requester has permission to view.

This operation returns paginated results.

Synopsis

Creating a Request

data ListLFTags Source #

See: newListLFTags smart constructor.

Constructors

ListLFTags' 

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.

  • resourceShareType :: Maybe ResourceShareType

    If resource share type is ALL, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is FOREIGN, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.

Instances

Instances details
ToJSON ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

toJSON :: ListLFTags -> Value #

toEncoding :: ListLFTags -> Encoding #

toJSONList :: [ListLFTags] -> Value #

toEncodingList :: [ListLFTags] -> Encoding #

ToHeaders ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

toHeaders :: ListLFTags -> [Header] #

ToPath ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

toPath :: ListLFTags -> ByteString #

ToQuery ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

toQuery :: ListLFTags -> QueryString #

AWSPager ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

page :: ListLFTags -> AWSResponse ListLFTags -> Maybe ListLFTags #

AWSRequest ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Associated Types

type AWSResponse ListLFTags #

Methods

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

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

Generic ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Associated Types

type Rep ListLFTags :: Type -> Type #

Methods

from :: ListLFTags -> Rep ListLFTags x #

to :: Rep ListLFTags x -> ListLFTags #

Read ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

readsPrec :: Int -> ReadS ListLFTags #

readList :: ReadS [ListLFTags] #

readPrec :: ReadPrec ListLFTags #

readListPrec :: ReadPrec [ListLFTags] #

Show ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

showsPrec :: Int -> ListLFTags -> ShowS #

show :: ListLFTags -> String #

showList :: [ListLFTags] -> ShowS #

NFData ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

rnf :: ListLFTags -> () #

Eq ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

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

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

Hashable ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

hashWithSalt :: Int -> ListLFTags -> Int #

hash :: ListLFTags -> Int #

type AWSResponse ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

type AWSResponse ListLFTags = ListLFTagsResponse
type Rep ListLFTags Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

type Rep ListLFTags = D1 ('MetaData "ListLFTags" "Amazonka.LakeFormation.ListLFTags" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "ListLFTags'" '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)))))

newListLFTags :: ListLFTags Source #

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

ListLFTags, listLFTags_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:ListLFTags', listLFTags_maxResults - The maximum number of results to return.

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

$sel:resourceShareType:ListLFTags', listLFTags_resourceShareType - If resource share type is ALL, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is FOREIGN, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.

Request Lenses

listLFTags_catalogId :: Lens' ListLFTags (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.

listLFTags_maxResults :: Lens' ListLFTags (Maybe Natural) Source #

The maximum number of results to return.

listLFTags_nextToken :: Lens' ListLFTags (Maybe Text) Source #

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

listLFTags_resourceShareType :: Lens' ListLFTags (Maybe ResourceShareType) Source #

If resource share type is ALL, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is FOREIGN, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.

Destructuring the Response

data ListLFTagsResponse Source #

See: newListLFTagsResponse smart constructor.

Constructors

ListLFTagsResponse' 

Fields

Instances

Instances details
Generic ListLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Associated Types

type Rep ListLFTagsResponse :: Type -> Type #

Methods

from :: ListLFTagsResponse -> Rep ListLFTagsResponse x #

to :: Rep ListLFTagsResponse x -> ListLFTagsResponse #

Read ListLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

readsPrec :: Int -> ReadS ListLFTagsResponse #

readList :: ReadS [ListLFTagsResponse] #

readPrec :: ReadPrec ListLFTagsResponse #

readListPrec :: ReadPrec [ListLFTagsResponse] #

Show ListLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

showsPrec :: Int -> ListLFTagsResponse -> ShowS #

show :: ListLFTagsResponse -> String #

showList :: [ListLFTagsResponse] -> ShowS #

NFData ListLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

rnf :: ListLFTagsResponse -> () #

Eq ListLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

Methods

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

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

type Rep ListLFTagsResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.ListLFTags

type Rep ListLFTagsResponse = D1 ('MetaData "ListLFTagsResponse" "Amazonka.LakeFormation.ListLFTags" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "ListLFTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lFTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty LFTagPair))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListLFTagsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListLFTagsResponse'

-> ListLFTagsResponse 

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

ListLFTagsResponse, listLFTagsResponse_lFTags - A list of LF-tags that the requested has permission to view.

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

$sel:httpStatus:ListLFTagsResponse', listLFTagsResponse_httpStatus - The response's http status code.

Response Lenses

listLFTagsResponse_lFTags :: Lens' ListLFTagsResponse (Maybe (NonEmpty LFTagPair)) Source #

A list of LF-tags that the requested has permission to view.

listLFTagsResponse_nextToken :: Lens' ListLFTagsResponse (Maybe Text) Source #

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

listLFTagsResponse_httpStatus :: Lens' ListLFTagsResponse Int Source #

The response's http status code.