CreateGlossaryTerm - Amazon DataZone
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsExamplesSee Also

CreateGlossaryTerm

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 and be in an ENABLED state.

  • The term name must be unique within the glossary.

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

Request Syntax

POST /v2/domains/domainIdentifier/glossary-terms HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "glossaryIdentifier": "string",
   "longDescription": "string",
   "name": "string",
   "shortDescription": "string",
   "status": "string",
   "termRelations": { 
      "classifies": [ "string" ],
      "isA": [ "string" ]
   }
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x21-\x7E]+

Required: No

glossaryIdentifier

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

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

longDescription

The long description of this business glossary term.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

name

The name of this business glossary term.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

shortDescription

The short description of this business glossary term.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

status

The status of this business glossary term.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

termRelations

The term relations of this business glossary term.

Type: TermRelations object

Required: No

Response Syntax

HTTP/1.1 201
Content-type: application/json

{
   "domainId": "string",
   "glossaryId": "string",
   "id": "string",
   "longDescription": "string",
   "name": "string",
   "shortDescription": "string",
   "status": "string",
   "termRelations": { 
      "classifies": [ "string" ],
      "isA": [ "string" ]
   },
   "usageRestrictions": [ "string" ]
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

domainId

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

Type: String

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

glossaryId

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

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

id

The ID of this business glossary term.

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

longDescription

The long description of this business glossary term.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

name

The name of this business glossary term.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

shortDescription

The short description of this business glossary term.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

status

The status of this business glossary term.

Type: String

Valid Values: ENABLED | DISABLED

termRelations

The term relations of this business glossary term.

Type: TermRelations object

usageRestrictions

The usage restriction of the restricted glossary.

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values: ASSET_GOVERNED_TERMS

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateGlossaryTerm.

Sample Request


aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--glossary-identifier "gls8m3nqx2wkfp" \
--name "CustomerLifetimeValue"

Sample Response


{
    "domainId": "dzd_53ielnpxktdilj",
    "glossaryId": "gls8m3nqx2wkfp",
    "id": "trm9k4pq7xwnmh",
    "name": "CustomerLifetimeValue",
    "status": "ENABLED"
}

Example

Failure case - missing required parameter:

Sample Request


aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerLifetimeValue"

Sample Response


aws: error: the following arguments are required: —glossary-identifier

Example

Failure case - glossary does not exist:

Sample Request


    aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--glossary-identifier "gls_nonexistent" \
--name "CustomerLifetimeValue"

Sample Response


An error occurred (ResourceNotFoundException) when calling the CreateGlossaryTerm operation: The given Glossary doesn't exist. Try creating Glossary before accessing it.

Example

Failure case - duplicate term:

Sample Request


aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--glossary-identifier "gls8m3nqx2wkfp" \
--name "CustomerLifetimeValue"

Sample Response


An error occurred (ResourceNotFoundException) when calling the CreateGlossaryTerm operation: The given Glossary doesn't exist. Try creating Glossary before accessing it.

Example

Failure case - delete related resources

Sample Request


 aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--glossary-identifier "gls8m3nqx2wkfp" \
--name "CustomerLifetimeValue"

Sample Response


An error occurred (ConflictException) when calling the CreateGlossaryTerm operation: Conflict with glossaryTerm trm9k4pq7xwnmh

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: