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

GetGlossaryTerm

Gets a business glossary term in Amazon DataZone.

Prerequisites:

Glossary term with identifier must exist in the domain.
User must have permission on the glossary term.
Domain must be accessible and active.

Request Syntax


GET /v2/domains/domainIdentifier/glossary-terms/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 term exists.

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

Required: Yes

identifier

The ID of the business glossary term.

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",
   "domainId": "string",
   "glossaryId": "string",
   "id": "string",
   "longDescription": "string",
   "name": "string",
   "shortDescription": "string",
   "status": "string",
   "termRelations": { 
      "classifies": [ "string" ],
      "isA": [ "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 the business glossary term was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created the business glossary.

Type: String

domainId

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

Type: String

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

glossaryId

The ID of the business glossary to which this term belongs.

Type: String

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

id

The ID of the business glossary term.

Type: String

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

longDescription

The long description of the business glossary term.

Type: String

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

name

The name of the business glossary term.

Type: String

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

shortDescription

The short decription of the business glossary term.

Type: String

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

status

The status of the business glossary term.

Type: String

Valid Values: ENABLED | DISABLED

termRelations

The relations of the business glossary term.

Type: TermRelations object

updatedAt

The timestamp of when the business glossary term was updated.

Type: Timestamp

updatedBy

The Amazon DataZone user who updated the business glossary term.

Type: String

usageRestrictions

The usage restriction of a term within a 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 GetGlossaryTerm.

Sample Request




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

Sample Response



{
    "createdAt": 1752575686.928,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "glossaryId": "gls8m3nqx2wkfp",
    "id": "trm9k4pq7xwnmh",
    "longDescription": "The total value a customer is expected to generate over their entire relationship with the business.",
    "name": "CustomerLifetimeValue",
    "shortDescription": "Predicted net profit from a customer relationship",
    "status": "ENABLED",
    "updatedAt": 1752575686.928,
    "updatedBy": "usr7nx82mkl"
}

Example

Failure case - resource does not exist:

Sample Request



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

Sample Response



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

Example

Failure case - missing parameter:

Sample Request



aws datazone get-glossary-term \
--identifier "trm9k4pq7xwnmh"

Sample Response



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