LakeFormation / Client / get_lf_tag_expression

get_lf_tag_expression#

LakeFormation.Client.get_lf_tag_expression(**kwargs)#

Returns the details about the LF-Tag expression. The caller must be a data lake admin or must have DESCRIBE permission on the LF-Tag expression resource.

See also: AWS API Documentation

Request Syntax

response = client.get_lf_tag_expression(
    Name='string',
    CatalogId='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name for the LF-Tag expression

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Name (string) –

      The name for the LF-Tag expression.

    • Description (string) –

      The description with information about the LF-Tag expression.

    • CatalogId (string) –

      The identifier for the Data Catalog. By default, the account ID in which the LF-Tag expression is saved.

    • Expression (list) –

      The body of the LF-Tag expression. It is composed of one or more LF-Tag key-value pairs.

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

Exceptions

  • LakeFormation.Client.exceptions.EntityNotFoundException

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.AccessDeniedException