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

CreateGlossary

Creates an Amazon DataZone business glossary.

Request Syntax


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

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "owningProjectIdentifier": "string",
   "status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain in which this business glossary 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

description

The description of this business glossary.

Type: String

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

Required: No

name

The name of this business glossary.

Type: String

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

Required: Yes

owningProjectIdentifier

The ID of the project that currently owns business glossary.

Type: String

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

Required: Yes

status

The status of this business glossary.

Type: String

Valid Values: DISABLED | ENABLED

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "id": "string",
   "name": "string",
   "owningProjectId": "string",
   "status": "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.

description

The description of this business glossary.

Type: String

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

domainId

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

Type: String

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

id

The ID of this business glossary.

Type: String

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

name

The name of this business glossary.

Type: String

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

owningProjectId

The ID of the project that currently owns this business glossary.

Type: String

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

status

The status of this business glossary.

Type: String

Valid Values: DISABLED | ENABLED

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

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