DataZone / Client / get_glossary_term

get_glossary_term

DataZone.Client.get_glossary_term(**kwargs)

Gets a business glossary term in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.get_glossary_term(
    domainIdentifier='string',
    identifier='string'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the Amazon DataZone domain in which this business glossary term exists.

• identifier (string) –

  [REQUIRED]

  The ID of the business glossary term.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'domainId': 'string',
    'glossaryId': 'string',
    'id': 'string',
    'longDescription': 'string',
    'name': 'string',
    'shortDescription': 'string',
    'status': 'ENABLED'|'DISABLED',
    'termRelations': {
        'classifies': [
            'string',
        ],
        'isA': [
            'string',
        ]
    },
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

• (dict) –

  • createdAt (datetime) –

    The timestamp of when the business glossary term was created.

  • createdBy (string) –

    The Amazon DataZone user who created the business glossary.

  • domainId (string) –

    The ID of the Amazon DataZone domain in which this business glossary term exists.

  • glossaryId (string) –

    The ID of the business glossary to which this term belongs.

  • id (string) –

    The ID of the business glossary term.

  • longDescription (string) –

    The long description of the business glossary term.

  • name (string) –

    The name of the business glossary term.

  • shortDescription (string) –

    The short decription of the business glossary term.

  • status (string) –

    The status of the business glossary term.

  • termRelations (dict) –

    The relations of the business glossary term.

    • classifies (list) –

      The classifies of the term relations.

      • (string) –

    • isA (list) –

      The isA property of the term relations.

      • (string) –

  • updatedAt (datetime) –

    The timestamp of when the business glossary term was updated.

  • updatedBy (string) –

    The Amazon DataZone user who updated the business glossary term.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException