Skip to content

Create Glossary Term

datazone_create_glossary_term R Documentation

Creates a business glossary term

Description

Creates a business glossary term.

A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.

Prerequisites:

  • Domain must exist.

  • Glossary must exist.

  • The term name must be unique within the glossary.

  • Ensure term does not conflict with existing terms in hierarchy.

Usage

datazone_create_glossary_term(domainIdentifier, glossaryIdentifier,
  name, status, shortDescription, longDescription, termRelations,
  clientToken)

Arguments

domainIdentifier

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

[required] The ID of the business glossary in which this term is created.
name

[required] The name of this business glossary term.
status

The status of this business glossary term.
shortDescription

The short description of this business glossary term.
longDescription

The long description of this business glossary term.
termRelations

The term relations of this business glossary term.
clientToken

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

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$create_glossary_term(
  domainIdentifier = "string",
  glossaryIdentifier = "string",
  name = "string",
  status = "ENABLED"|"DISABLED",
  shortDescription = "string",
  longDescription = "string",
  termRelations = list(
    isA = list(
      "string"
    ),
    classifies = list(
      "string"
    )
  ),
  clientToken = "string"
)