DataZone / Client / create_glossary_term

create_glossary_term

DataZone.Client.create_glossary_term(**kwargs)

Creates a business glossary term.

A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.

Prerequisites:

• Domain must exist.

• Glossary must exist and be in an ENABLED state.

• The term name must be unique within the glossary.

• Ensure term does not conflict with existing terms in hierarchy.

See also: AWS API Documentation

Request Syntax

response = client.create_glossary_term(
    clientToken='string',
    domainIdentifier='string',
    glossaryIdentifier='string',
    longDescription='string',
    name='string',
    shortDescription='string',
    status='ENABLED'|'DISABLED',
    termRelations={
        'classifies': [
            'string',
        ],
        'isA': [
            'string',
        ]
    }
)

Parameters:

• clientToken (string) –

  A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

  This field is autopopulated if not provided.

• domainIdentifier (string) –

  [REQUIRED]

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

• glossaryIdentifier (string) –

  [REQUIRED]

  The ID of the business glossary in which this term is created.

• longDescription (string) – The long description of this business glossary term.

• name (string) –

  [REQUIRED]

  The name of this business glossary term.

• shortDescription (string) – The short description of this business glossary term.

• status (string) – The status of this business glossary term.

• termRelations (dict) –

  The term relations of this business glossary term.

  • classifies (list) –

    The classifies of the term relations.

    • (string) –

  • isA (list) –

    The isA property of the term relations.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'domainId': 'string',
    'glossaryId': 'string',
    'id': 'string',
    'longDescription': 'string',
    'name': 'string',
    'shortDescription': 'string',
    'status': 'ENABLED'|'DISABLED',
    'termRelations': {
        'classifies': [
            'string',
        ],
        'isA': [
            'string',
        ]
    },
    'usageRestrictions': [
        'ASSET_GOVERNED_TERMS',
    ]
}

Response Structure

• (dict) –

  • domainId (string) –

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

  • glossaryId (string) –

    The ID of the business glossary in which this term is created.

  • id (string) –

    The ID of this business glossary term.

  • longDescription (string) –

    The long description of this business glossary term.

  • name (string) –

    The name of this business glossary term.

  • shortDescription (string) –

    The short description of this business glossary term.

  • status (string) –

    The status of this business glossary term.

  • termRelations (dict) –

    The term relations of this business glossary term.

    • classifies (list) –

      The classifies of the term relations.

      • (string) –

    • isA (list) –

      The isA property of the term relations.

      • (string) –

  • usageRestrictions (list) –

    The usage restriction of the restricted glossary.

    • (string) –

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ServiceQuotaExceededException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException