Skip to content

Updates the business glossary in Amazon DataZone

Description

Updates the business glossary in Amazon DataZone.

Prerequisites:

  • The glossary must exist in the given domain.
  • The caller must have the datazone:UpdateGlossary permission to update it.
  • When updating the name, the new name must be unique within the domain.
  • The glossary must not be deleted or in a terminal state.

Usage

datazone_update_glossary(domainIdentifier, identifier, name,
  description, status, clientToken)

Arguments

  • domainIdentifier

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

  • identifier

[required] The identifier of the business glossary to be updated.

  • name

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

  • description

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

  • status

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

  • clientToken

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

Value

A list with the following syntax:

list(
  domainId = "string",
  id = "string",
  name = "string",
  owningProjectId = "string",
  description = "string",
  status = "DISABLED"|"ENABLED",
  usageRestrictions = list(
    "ASSET_GOVERNED_TERMS"
  )
)

Request syntax

svc$update_glossary(
  domainIdentifier = "string",
  identifier = "string",
  name = "string",
  description = "string",
  status = "DISABLED"|"ENABLED",
  clientToken = "string"
)