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

CreateGlossary

Creates an Amazon DataZone business glossary.

Specifies that this is a create glossary policy.

A galossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.

Prerequisites:

Domain must exist and be in an active state.
Owning project must exist and be accessible by the caller.
The glossary name must be unique within the domain.

Request Syntax


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

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "owningProjectIdentifier": "string",
   "status": "string",
   "usageRestrictions": [ "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

usageRestrictions

The usage restriction of the restricted glossary.

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values: ASSET_GOVERNED_TERMS

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

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

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

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

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 CreateGlossary.

Sample Request



aws datazone create-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerAnalyticsGlossary" \
--owning-project-identifier "prj7nx82mkl"

Sample Response



{
    "domainId": "dzd_53ielnpxktdilj",
    "id": "gls8m3nqx2wkfp",
    "name": "CustomerAnalyticsGlossary",
    "owningProjectId": "prj7nx82mkl",
    "status": "ENABLED"
}

Example

Failure case - duplicate term:

Sample Request



aws datazone create-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerAnalyticsGlossary" \
--owning-project-identifier "prj7nx82mkl"

Sample Response



An error occurred (ConflictException) when calling the CreateGlossary operation: Conflict with businessGlossary gls8m3nqx2wkfp

Example

Failure case - missing required parameter:

Sample Request



aws datazone create-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl"

Sample Response



aws: error: the following arguments are required: --name