LakeFormation / Client / list_lf_tags

list_lf_tags#

LakeFormation.Client.list_lf_tags(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_lf_tags(
    CatalogId='string',
    ResourceShareType='FOREIGN'|'ALL',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • CatalogId (string) – 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.

  • ResourceShareType (string) – 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.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – A continuation token, if this is not the first call to retrieve this list.

Return type:

dict

Returns:

Response Syntax

{
    'LFTags': [
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • LFTags (list) –

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

      • (dict) –

        A structure containing an LF-tag key-value pair.

        • CatalogId (string) –

          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.

        • TagKey (string) –

          The key-name for the LF-tag.

        • TagValues (list) –

          A list of possible values an attribute can take.

          • (string) –

    • NextToken (string) –

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

Exceptions