LakeFormation / Paginator / ListLFTags

ListLFTags#

class LakeFormation.Paginator.ListLFTags#
paginator = client.get_paginator('list_lf_tags')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from LakeFormation.Client.list_lf_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CatalogId='string',
    ResourceShareType='FOREIGN'|'ALL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'LFTags': [
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                '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) –