Skip to content

Creates an Amazon DataZone business glossary

Description

Creates an Amazon DataZone business glossary.

Specifies that this is a create glossary policy.

A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.

Prerequisites:

  • Domain must exist and be in an active state.
  • Owning project must exist and be accessible by the caller.
  • The glossary name must be unique within the domain.

Usage

datazone_create_glossary(domainIdentifier, name,
  owningProjectIdentifier, description, status, usageRestrictions,
  clientToken)

Arguments

  • domainIdentifier

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

  • name

    [required] The name of this business glossary.

  • owningProjectIdentifier

    [required] The ID of the project that currently owns business glossary.

  • description

    The description of this business glossary.

  • status

    The status of this business glossary.

  • usageRestrictions

    The usage restriction of the restricted glossary.

  • 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$create_glossary(
  domainIdentifier = "string",
  name = "string",
  owningProjectIdentifier = "string",
  description = "string",
  status = "DISABLED"|"ENABLED",
  usageRestrictions = list(
    "ASSET_GOVERNED_TERMS"
  ),
  clientToken = "string"
)