UpdateGlossaryCommand

Suggest an Edit

Updates the business glossary in Amazon DataZone.

Example Syntax

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

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

UpdateGlossaryCommand Input

See UpdateGlossaryCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

identifier
Required
string | undefined

The identifier of the business glossary to be updated.

clientToken
string | undefined

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

description
string | undefined

The description to be updated as part of the UpdateGlossary action.

name
string | undefined

The name to be updated as part of the UpdateGlossary action.

status
GlossaryStatus | undefined

The status to be updated as part of the UpdateGlossary action.

UpdateGlossaryCommand Output

See UpdateGlossaryCommandOutput for details

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

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

id
Required
string | undefined

The identifier of the business glossary that is to be updated.

name
Required
string | undefined

The name to be updated as part of the UpdateGlossary action.

owningProjectId
Required
string | undefined

The identifier of the project in which to update a business glossary.

description
string | undefined

The description to be updated as part of the UpdateGlossary action.

status
GlossaryStatus | undefined

The status to be updated as part of the UpdateGlossary action.

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.

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.