LakeFormation / Client / get_lf_tag

get_lf_tag#

LakeFormation.Client.get_lf_tag(**kwargs)#

Returns an LF-tag definition.

See also: AWS API Documentation

Request Syntax

response = client.get_lf_tag(
    CatalogId='string',
    TagKey='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.

  • TagKey (string) –

    [REQUIRED]

    The key-name for the LF-tag.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

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

Exceptions

  • LakeFormation.Client.exceptions.EntityNotFoundException

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.AccessDeniedException