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

GetGlossary

Gets a business glossary in Amazon DataZone.

Prerequisites:

The specified glossary ID must exist and be associated with the given domain.
The caller must have the datazone:GetGlossary permission on the domain.

Request Syntax


GET /v2/domains/domainIdentifier/glossaries/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

identifier

The ID of the business glossary.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "id": "string",
   "name": "string",
   "owningProjectId": "string",
   "status": "string",
   "updatedAt": number,
   "updatedBy": "string",
   "usageRestrictions": [ "string" ]
}

Response Elements

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

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

createdAt

The timestamp of when this business glossary was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created this business glossary.

Type: String

description

The description of the 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 exists.

Type: String

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

id

The ID of the business glossary.

Type: String

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

name

The name of the business glossary.

Type: String

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

owningProjectId

The ID of the project that owns this business glossary.

Type: String

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

status

The status of the business glossary.

Type: String

Valid Values: DISABLED | ENABLED

updatedAt

The timestamp of when the business glossary was updated.

Type: Timestamp

updatedBy

The Amazon DataZone user who updated the business glossary.

Type: String

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

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

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

Sample Request



aws datazone get-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp"

Sample Response



{
    "createdAt": 1752573775.274,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "id": "gls8m3nqx2wkfp",
    "name": "CustomerAnalyticsGlossary",
    "owningProjectId": "prj7nx82mkl",
    "status": "ENABLED",
    "updatedAt": 1752573775.274,
    "updatedBy": "usr7nx82mkl"
}

Example

Failure case - missing required parameter:

Sample Request



aws datazone get-glossary \
--domain-identifier "dzd_53ielnpxktdilj"

Sample Response



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

Example

Failure case - resource does not exist:

Sample Request



aws datazone get-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls_nonexistent"

Sample Response



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