CreateGlossaryCommand

Creates an Amazon DataZone business glossary.

Example Syntax

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

import { DataZoneClient, CreateGlossaryCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateGlossaryCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateGlossaryInput
  domainIdentifier: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
  owningProjectIdentifier: "STRING_VALUE", // required
  description: "STRING_VALUE",
  status: "DISABLED" || "ENABLED",
  clientToken: "STRING_VALUE",
};
const command = new CreateGlossaryCommand(input);
const response = await client.send(command);
// { // CreateGlossaryOutput
//   domainId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   owningProjectId: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   status: "DISABLED" || "ENABLED",
// };

CreateGlossaryCommand Input

See CreateGlossaryCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

name
Required
string | undefined

The name of this business glossary.

owningProjectIdentifier
Required
string | undefined

The ID of the project that currently owns business glossary.

clientToken
string | undefined

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

description
string | undefined

The description of this business glossary.

status
GlossaryStatus | undefined

The status of this business glossary.

CreateGlossaryCommand 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 is created.

id
Required
string | undefined

The ID of this business glossary.

name
Required
string | undefined

The name of this business glossary.

owningProjectId
Required
string | undefined

The ID of the project that currently owns this business glossary.

description
string | undefined

The description of this business glossary.

status
GlossaryStatus | undefined

The status of this business glossary.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

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

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

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.