Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

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.

patch/v2/domains/{domainIdentifier}/glossaries/{identifier}

Path parameters

domainIdentifierstring required

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

identifierstring required

The identifier of the business glossary to be updated.

Request body

namestring password

The name to be updated as part of the <code>UpdateGlossary</code> action.

descriptionstring password

The description to be updated as part of the <code>UpdateGlossary</code> action.

status'DISABLED' | 'ENABLED'

The status to be updated as part of the <code>UpdateGlossary</code> action.

clientTokenstring

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

Response

Success

domainIdstring required

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

idstring required

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

namestring password required

The name to be updated as part of the <code>UpdateGlossary</code> action.

owningProjectIdstring required

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

descriptionstring password

The description to be updated as part of the <code>UpdateGlossary</code> action.

status'DISABLED' | 'ENABLED'

The status to be updated as part of the <code>UpdateGlossary</code> action.

usageRestrictionsGlossaryUsageRestriction[]

The usage restriction of the restricted glossary.