LakeFormation / Client / list_lf_tag_expressions

list_lf_tag_expressions#

LakeFormation.Client.list_lf_tag_expressions(**kwargs)#

Returns the LF-Tag expressions in caller’s account filtered based on caller’s permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.

See also: AWS API Documentation

Request Syntax

response = client.list_lf_tag_expressions(
    CatalogId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • CatalogId (string) – The identifier for the Data Catalog. By default, the account ID.

  • 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

{
    'LFTagExpressions': [
        {
            'Name': 'string',
            'Description': 'string',
            'CatalogId': 'string',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'NextToken': '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) –

    • NextToken (string) –

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

Exceptions

  • LakeFormation.Client.exceptions.EntityNotFoundException

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.AccessDeniedException