Sign in

v1

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

Gets a metadata generation run in Amazon DataZone.

Prerequisites:

  • Valid domain and run identifier.

  • The metadata generation run must exist.

  • User must have read access to the metadata run.

get/v2/domains/{domainIdentifier}/metadata-generation-runs/{identifier}

Path parameters

domainIdentifierstring required

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

identifierstring required

The identifier of the metadata generation run.

Query parameters

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

The type of the metadata generation run.

Response

Success

domainIdstring required

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

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 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 of when the metadata generation run was start.

createdBystring

The Amazon DataZone user who started the metadata generation run.

owningProjectIdstring required

The ID of the project that owns the assets for which you're running metadata generation.