Skip to content

Update Glossary Term

datazone_update_glossary_term R Documentation

Updates a business glossary term in Amazon DataZone

Description

Updates a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term must exist in the specified domain.

  • New name must not conflict with existing terms in the same glossary.

  • User must have permissions on the term.

  • The term must not be in DELETED status.

Usage

datazone_update_glossary_term(domainIdentifier, glossaryIdentifier,
  identifier, name, shortDescription, longDescription, termRelations,
  status)

Arguments

domainIdentifier

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

The identifier of the business glossary in which a term is to be updated.
identifier

[required] The identifier of the business glossary term that is to be updated.
name

The name to be updated as part of the update_glossary_term action.
shortDescription

The short description to be updated as part of the update_glossary_term action.
longDescription

The long description to be updated as part of the update_glossary_term action.
termRelations

The term relations to be updated as part of the update_glossary_term action.
status

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

Value

A list with the following syntax:

list(
  id = "string",
  domainId = "string",
  glossaryId = "string",
  name = "string",
  status = "ENABLED"|"DISABLED",
  shortDescription = "string",
  longDescription = "string",
  termRelations = list(
    isA = list(
      "string"
    ),
    classifies = list(
      "string"
    )
  ),
  usageRestrictions = list(
    "ASSET_GOVERNED_TERMS"
  )
)

Request syntax

svc$update_glossary_term(
  domainIdentifier = "string",
  glossaryIdentifier = "string",
  identifier = "string",
  name = "string",
  shortDescription = "string",
  longDescription = "string",
  termRelations = list(
    isA = list(
      "string"
    ),
    classifies = list(
      "string"
    )
  ),
  status = "ENABLED"|"DISABLED"
)