DataZone / Client / update_glossary_term

update_glossary_term

DataZone.Client.update_glossary_term(**kwargs)

Updates a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term must exist in the specified domain.

  • New name must not conflict with existing terms in the same glossary.

  • User must have permissions on the term.

  • The term must not be in DELETED status.

See also: AWS API Documentation

Request Syntax

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

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

  • glossaryIdentifier (string) – The identifier of the business glossary in which a term is to be updated.

  • identifier (string) –

    [REQUIRED]

    The identifier of the business glossary term that is to be updated.

  • longDescription (string) – The long description to be updated as part of the UpdateGlossaryTerm action.

  • name (string) – The name to be updated as part of the UpdateGlossaryTerm action.

  • shortDescription (string) – The short description to be updated as part of the UpdateGlossaryTerm action.

  • status (string) – The status to be updated as part of the UpdateGlossaryTerm action.

  • termRelations (dict) –

    The term relations to be updated as part of the UpdateGlossaryTerm action.

    • 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 identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

    • glossaryId (string) –

      The identifier of the business glossary in which a term is to be updated.

    • id (string) –

      The identifier of the business glossary term that is to be updated.

    • longDescription (string) –

      The long description to be updated as part of the UpdateGlossaryTerm action.

    • name (string) –

      The name to be updated as part of the UpdateGlossaryTerm action.

    • shortDescription (string) –

      The short description to be updated as part of the UpdateGlossaryTerm action.

    • status (string) –

      The status to be updated as part of the UpdateGlossaryTerm action.

    • termRelations (dict) –

      The term relations to be updated as part of the UpdateGlossaryTerm action.

      • 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 a term within a restricted glossary.

      • (string) –

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.ResourceNotFoundException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ConflictException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException