LakeFormation / Paginator / ListLFTagExpressions

ListLFTagExpressions#

class LakeFormation.Paginator.ListLFTagExpressions#

paginator = client.get_paginator('list_lf_tag_expressions')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    CatalogId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

CatalogId (string) – The identifier for the Data Catalog. By default, the account ID.
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

{
    'LFTagExpressions': [
        {
            'Name': 'string',
            'Description': 'string',
            'CatalogId': 'string',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        },
    ],

}

Response Structure

(dict) –
- LFTagExpressions (list) –
  
  Logical expressions composed of one more LF-Tag key-value pairs.
  - (dict) –
    
    A structure consists LF-Tag expression name and catalog ID.
    - Name (string) –
      
      The name for saved the LF-Tag expression.
    - Description (string) –
      
      A structure that contains information about the LF-Tag expression.
    - CatalogId (string) –
      
      The identifier for the Data Catalog. By default, the account ID.
    - Expression (list) –
      
      A logical expression composed of one or more LF-Tags.
      - (dict) –
        
        A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag ‘PII’ in tables that have the LF-tag ‘Prod’.
        
        TagKey (string) –
        
        The key-name for the LF-tag.
        
        TagValues (list) –
        
        A list of possible values an attribute can take.
        
        The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.
        
        (string) –