DataZone / Client / create_glossary_term

create_glossary_term#

DataZone.Client.create_glossary_term(**kwargs)#

Creates a business glossary term.

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',
        ]
    }
}

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

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