v1

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

Creates a business glossary term.

A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.

Prerequisites:

  • Domain must exist.

  • Glossary must exist.

  • The term name must be unique within the glossary.

  • Ensure term does not conflict with existing terms in hierarchy.

post/v2/domains/{domainIdentifier}/glossary-terms

Path parameters

domainIdentifierstring required

The ID of the Amazon DataZone domain in which this business glossary term is created.

Request body

glossaryIdentifierstring required

The ID of the business glossary in which this term is created.

namestring password required

The name of this business glossary term.

status'ENABLED' | 'DISABLED'

The status of this business glossary term.

shortDescriptionstring password

The short description of this business glossary term.

longDescriptionstring password

The long description of this business glossary term.

clientTokenstring

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

Response

Success

idstring required

The ID of this business glossary term.

domainIdstring required

The ID of the Amazon DataZone domain in which this business glossary term is created.

glossaryIdstring required

The ID of the business glossary in which this term is created.

namestring password required

The name of this business glossary term.

status'ENABLED' | 'DISABLED' required

The status of this business glossary term.

shortDescriptionstring password

The short description of this business glossary term.

longDescriptionstring password

The long description of this business glossary term.

usageRestrictionsGlossaryUsageRestriction[]

The usage restriction of the restricted glossary.