Sign in

v1

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

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.

patch/v2/domains/{domainIdentifier}/glossary-terms/{identifier}

Path parameters

domainIdentifierstring required

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

identifierstring required

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

Request body

glossaryIdentifierstring

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

namestring password

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

shortDescriptionstring password

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

longDescriptionstring password

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

status'ENABLED' | 'DISABLED'

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

Response

Success

idstring required

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

domainIdstring required

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

glossaryIdstring required

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

namestring password required

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

status'ENABLED' | 'DISABLED' required

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

shortDescriptionstring password

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

longDescriptionstring password

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

usageRestrictionsGlossaryUsageRestriction[]

The usage restriction of a term within a restricted glossary.