Skip to content

Get Glossary Term

datazone_get_glossary_term R Documentation

Gets a business glossary term in Amazon DataZone

Description

Gets a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term with identifier must exist in the domain.

  • User must have permission on the glossary term.

  • Domain must be accessible and active.

Usage

datazone_get_glossary_term(domainIdentifier, identifier)

Arguments

domainIdentifier

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

identifier

[required] The ID of the business glossary term.

Value

A list with the following syntax:

list(
  domainId = "string",
  glossaryId = "string",
  id = "string",
  name = "string",
  shortDescription = "string",
  longDescription = "string",
  termRelations = list(
    isA = list(
      "string"
    ),
    classifies = list(
      "string"
    )
  ),
  status = "ENABLED"|"DISABLED",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedBy = "string",
  usageRestrictions = list(
    "ASSET_GOVERNED_TERMS"
  )
)

Request syntax

svc$get_glossary_term(
  domainIdentifier = "string",
  identifier = "string"
)