DataZone / Client / update_glossary

update_glossary

DataZone.Client.update_glossary(**kwargs)

Updates the business glossary in Amazon DataZone.

Prerequisites:

  • The glossary must exist in the given domain.

  • The caller must have the datazone:UpdateGlossary permission to update it.

  • When updating the name, the new name must be unique within the domain.

  • The glossary must not be deleted or in a terminal state.

See also: AWS API Documentation

Request Syntax

response = client.update_glossary(
    clientToken='string',
    description='string',
    domainIdentifier='string',
    identifier='string',
    name='string',
    status='DISABLED'|'ENABLED'
)
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.

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

  • domainIdentifier (string) –

    [REQUIRED]

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

  • identifier (string) –

    [REQUIRED]

    The identifier of the business glossary to be updated.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'description': 'string',
    'domainId': 'string',
    'id': 'string',
    'name': 'string',
    'owningProjectId': 'string',
    'status': 'DISABLED'|'ENABLED',
    'usageRestrictions': [
        'ASSET_GOVERNED_TERMS',
    ]
}

Response Structure

  • (dict) –

    • description (string) –

      The description to be updated as part of the UpdateGlossary action.

    • domainId (string) –

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

    • id (string) –

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

    • name (string) –

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

    • owningProjectId (string) –

      The identifier of the project in which to update a business glossary.

    • status (string) –

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

    • usageRestrictions (list) –

      The usage restriction of the restricted glossary.

      • (string) –

Exceptions