Glue / Client / list_glossary_terms

list_glossary_terms

Glue.Client.list_glossary_terms(**kwargs)

Lists glossary terms within a business glossary in Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.list_glossary_terms(
    GlossaryIdentifier='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • GlossaryIdentifier (string) –

    [REQUIRED]

    The unique identifier of the glossary whose terms to list.

  • MaxResults (integer) – The maximum number of results to return in the response.

  • NextToken (string) – A continuation token, if this is a continuation call.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Id': 'string',
            'Name': 'string',
            'ShortDescription': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      The list of glossary term items.

      • (dict) –

        A summary of a glossary term.

        • Id (string) –

          The unique identifier of the glossary term.

        • Name (string) –

          The name of the glossary term.

        • ShortDescription (string) –

          The short description of the glossary term.

    • NextToken (string) –

      A continuation token, present if the current segment is not the last.

Exceptions