GetGlossaryTermCommand

Gets a business glossary term in Amazon DataZone.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, GetGlossaryTermCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetGlossaryTermCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetGlossaryTermInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new GetGlossaryTermCommand(input);
const response = await client.send(command);
// { // GetGlossaryTermOutput
//   domainId: "STRING_VALUE", // required
//   glossaryId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   shortDescription: "STRING_VALUE",
//   longDescription: "STRING_VALUE",
//   termRelations: { // TermRelations
//     isA: [ // GlossaryTerms
//       "STRING_VALUE",
//     ],
//     classifies: [
//       "STRING_VALUE",
//     ],
//   },
//   status: "ENABLED" || "DISABLED", // required
//   createdAt: new Date("TIMESTAMP"),
//   createdBy: "STRING_VALUE",
//   updatedAt: new Date("TIMESTAMP"),
//   updatedBy: "STRING_VALUE",
// };

GetGlossaryTermCommand Input

See GetGlossaryTermCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

identifier
Required
string | undefined

The ID of the business glossary term.

GetGlossaryTermCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainId
Required
string | undefined

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

glossaryId
Required
string | undefined

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

id
Required
string | undefined

The ID of the business glossary term.

name
Required
string | undefined

The name of the business glossary term.

status
Required
GlossaryTermStatus | undefined

The status of the business glossary term.

createdAt
Date | undefined

The timestamp of when the business glossary term was created.

createdBy
string | undefined

The Amazon DataZone user who created the business glossary.

longDescription
string | undefined

The long description of the business glossary term.

shortDescription
string | undefined

The short decription of the business glossary term.

termRelations
TermRelations | undefined

The relations of the business glossary term.

updatedAt
Date | undefined

The timestamp of when the business glossary term was updated.

updatedBy
string | undefined

The Amazon DataZone user who updated the business glossary term.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.