- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateGlossaryTermCommand
Updates 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, UpdateGlossaryTermCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateGlossaryTermCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateGlossaryTermInput
domainIdentifier: "STRING_VALUE", // required
glossaryIdentifier: "STRING_VALUE",
identifier: "STRING_VALUE", // required
name: "STRING_VALUE",
shortDescription: "STRING_VALUE",
longDescription: "STRING_VALUE",
termRelations: { // TermRelations
isA: [ // GlossaryTerms
"STRING_VALUE",
],
classifies: [
"STRING_VALUE",
],
},
status: "ENABLED" || "DISABLED",
};
const command = new UpdateGlossaryTermCommand(input);
const response = await client.send(command);
// { // UpdateGlossaryTermOutput
// 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",
// ],
// },
// };
UpdateGlossaryTermCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The identifier of the Amazon DataZone domain in which a business glossary term is to be updated. |
identifier Required | string | undefined | The identifier of the business glossary term that is to be updated. |
glossaryIdentifier | string | undefined | The identifier of the business glossary in which a term is to be updated. |
longDescription | string | undefined | The long description to be updated as part of the |
name | string | undefined | The name to be updated as part of the |
shortDescription | string | undefined | The short description to be updated as part of the |
status | GlossaryTermStatus | undefined | The status to be updated as part of the |
termRelations | TermRelations | undefined | The term relations to be updated as part of the |
UpdateGlossaryTermCommand Output
Parameter | Type | Description |
---|
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 term is to be updated. |
glossaryId Required | string | undefined | The identifier of the business glossary in which a term is to be updated. |
id Required | string | undefined | The identifier of the business glossary term that is to be updated. |
name Required | string | undefined | The name to be updated as part of the |
status Required | GlossaryTermStatus | undefined | The status to be updated as part of the |
longDescription | string | undefined | The long description to be updated as part of the |
shortDescription | string | undefined | The short description to be updated as part of the |
termRelations | TermRelations | undefined | The term relations to be updated as part of the |
Throws
Name | Fault | Details |
---|
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. |