Skip to content

Start Metadata Generation Run

datazone_start_metadata_generation_run R Documentation

Starts the metadata generation run

Description

Starts the metadata generation run.

Prerequisites:

  • Asset must be created and belong to the specified domain and project.

  • Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).

  • Asset must have a structured schema with valid rows and columns.

  • Valid values for –type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS.

  • The user must have permission to run metadata generation in the domain/project.

Usage

datazone_start_metadata_generation_run(domainIdentifier, type, types,
  target, clientToken, owningProjectIdentifier)

Arguments

domainIdentifier

[required] The ID of the Amazon DataZone domain where you want to start a metadata generation run.
type

The type of the metadata generation run.
types

The types of the metadata generation run.
target

[required] The asset for which you want to start a metadata generation run.
clientToken

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
owningProjectIdentifier

[required] The ID of the project that owns the asset for which you want to start a metadata generation run.

Value

A list with the following syntax:

list(
  domainId = "string",
  id = "string",
  status = "SUBMITTED"|"IN_PROGRESS"|"CANCELED"|"SUCCEEDED"|"FAILED"|"PARTIALLY_SUCCEEDED",
  type = "BUSINESS_DESCRIPTIONS"|"BUSINESS_NAMES"|"BUSINESS_GLOSSARY_ASSOCIATIONS",
  types = list(
    "BUSINESS_DESCRIPTIONS"|"BUSINESS_NAMES"|"BUSINESS_GLOSSARY_ASSOCIATIONS"
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  owningProjectId = "string"
)

Request syntax

svc$start_metadata_generation_run(
  domainIdentifier = "string",
  type = "BUSINESS_DESCRIPTIONS"|"BUSINESS_NAMES"|"BUSINESS_GLOSSARY_ASSOCIATIONS",
  types = list(
    "BUSINESS_DESCRIPTIONS"|"BUSINESS_NAMES"|"BUSINESS_GLOSSARY_ASSOCIATIONS"
  ),
  target = list(
    type = "ASSET",
    identifier = "string",
    revision = "string"
  ),
  clientToken = "string",
  owningProjectIdentifier = "string"
)