GetGlossaryCommand

Gets a business glossary in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, GetGlossaryCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetGlossaryCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetGlossaryInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new GetGlossaryCommand(input);
const response = await client.send(command);
// { // GetGlossaryOutput
//   domainId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   owningProjectId: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   status: "DISABLED" || "ENABLED", // required
//   createdAt: new Date("TIMESTAMP"),
//   createdBy: "STRING_VALUE",
//   updatedAt: new Date("TIMESTAMP"),
//   updatedBy: "STRING_VALUE",
// };

GetGlossaryCommand Input

See GetGlossaryCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

identifier
Required
string | undefined

The ID of the business glossary.

GetGlossaryCommand Output

See GetGlossaryCommandOutput for details

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

id
Required
string | undefined

The ID of the business glossary.

name
Required
string | undefined

The name of the business glossary.

owningProjectId
Required
string | undefined

The ID of the project that owns this business glossary.

status
Required
GlossaryStatus | undefined

The status of the business glossary.

createdAt
Date | undefined

The timestamp of when this business glossary was created.

createdBy
string | undefined

The Amazon DataZone user who created this business glossary.

description
string | undefined

The description of the business glossary.

updatedAt
Date | undefined

The timestamp of when the business glossary was updated.

updatedBy
string | undefined

The Amazon DataZone user who updated the business glossary.

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.