Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

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.

post/v2/domains/{domainIdentifier}/metadata-generation-runs

Path parameters

domainIdentifierstring required

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

Request body

type'BUSINESS_DESCRIPTIONS' | 'BUSINESS_NAMES' | 'BUSINESS_GLOSSARY_ASSOCIATIONS'

The type of the metadata generation run.

typesMetadataGenerationRunType[]

The types of the metadata generation run.

clientTokenstring

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

owningProjectIdentifierstring required

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

Response

Success

domainIdstring required

The ID of the Amazon DataZone domain in which the metadata generation run was started.

idstring required

The ID of the metadata generation run.

status'SUBMITTED' | 'IN_PROGRESS' | 'CANCELED' | 'SUCCEEDED' | 'FAILED' | 'PARTIALLY_SUCCEEDED'

The status of the metadata generation run.

type'BUSINESS_DESCRIPTIONS' | 'BUSINESS_NAMES' | 'BUSINESS_GLOSSARY_ASSOCIATIONS'

The type of the metadata generation run.This field is going to be deprecated, please use the 'types' field to provide the MetadataGenerationRun types

typesMetadataGenerationRunType[]

The types of the metadata generation run.

createdAtstring date-time

The timestamp at which the metadata generation run was started.

createdBystring

The ID of the user who started the metadata generation run.

owningProjectIdstring

The ID of the project that owns the asset for which the metadata generation run was started.