CreateGlossaryTermCommand

Creates a business glossary term.

Example Syntax

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

import { DataZoneClient, CreateGlossaryTermCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateGlossaryTermCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateGlossaryTermInput
  domainIdentifier: "STRING_VALUE", // required
  glossaryIdentifier: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
  status: "ENABLED" || "DISABLED",
  shortDescription: "STRING_VALUE",
  longDescription: "STRING_VALUE",
  termRelations: { // TermRelations
    isA: [ // GlossaryTerms
      "STRING_VALUE",
    ],
    classifies: [
      "STRING_VALUE",
    ],
  },
  clientToken: "STRING_VALUE",
};
const command = new CreateGlossaryTermCommand(input);
const response = await client.send(command);
// { // CreateGlossaryTermOutput
//   id: "STRING_VALUE", // required
//   domainId: "STRING_VALUE", // required
//   glossaryId: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   status: "ENABLED" || "DISABLED", // required
//   shortDescription: "STRING_VALUE",
//   longDescription: "STRING_VALUE",
//   termRelations: { // TermRelations
//     isA: [ // GlossaryTerms
//       "STRING_VALUE",
//     ],
//     classifies: [
//       "STRING_VALUE",
//     ],
//   },
// };

CreateGlossaryTermCommand Input

See CreateGlossaryTermCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

glossaryIdentifier
Required
string | undefined

The ID of the business glossary in which this term is created.

name
Required
string | undefined

The name of this business glossary term.

clientToken
string | undefined

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

longDescription
string | undefined

The long description of this business glossary term.

shortDescription
string | undefined

The short description of this business glossary term.

status
GlossaryTermStatus | undefined

The status of this business glossary term.

termRelations
TermRelations | undefined

The term relations of this business glossary term.

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

glossaryId
Required
string | undefined

The ID of the business glossary in which this term is created.

id
Required
string | undefined

The ID of this business glossary term.

name
Required
string | undefined

The name of this business glossary term.

status
Required
GlossaryTermStatus | undefined

The status of this business glossary term.

longDescription
string | undefined

The long description of this business glossary term.

shortDescription
string | undefined

The short description of this business glossary term.

termRelations
TermRelations | undefined

The term relations of this business glossary term.

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.

ResourceNotFoundException
client

The specified resource cannot be found.

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.