Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateGlossaryTerm

Creates a business glossary term.

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" ]
   }
}

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

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