StartMetadataGenerationRun - Amazon DataZone

StartMetadataGenerationRun

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., AWS Glue table).

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

  • Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES.

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

Request Syntax

POST /v2/domains/domainIdentifier/metadata-generation-runs HTTP/1.1 Content-type: application/json { "clientToken": "string", "owningProjectIdentifier": "string", "target": { "identifier": "string", "revision": "string", "type": "string" }, "type": "string" }

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x21-\x7E]+

Required: No

owningProjectIdentifier

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

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

target

The asset for which you want to start a metadata generation run.

Type: MetadataGenerationRunTarget object

Required: Yes

type

The type of the metadata generation run.

Type: String

Valid Values: BUSINESS_DESCRIPTIONS

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "createdAt": number, "createdBy": "string", "domainId": "string", "id": "string", "owningProjectId": "string", "status": "string", "type": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp at which the metadata generation run was started.

Type: Timestamp

createdBy

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

Type: String

domainId

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

Type: String

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

id

The ID of the metadata generation run.

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

owningProjectId

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

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

status

The status of the metadata generation run.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | CANCELED | SUCCEEDED | FAILED

type

The type of the metadata generation run.

Type: String

Valid Values: BUSINESS_DESCRIPTIONS

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of StartMetadataGenerationRun.

Sample Request

aws datazone start-metadata-generation-run \ --domain-identifier "dzd_53ielnpxktdilj" \ --owning-project-identifier "prj7nx82mkl" \ --target '{ "identifier": "ast6br2md6v9h", "revision": "1", "type": "ASSET" }' \ --type "BUSINESS_DESCRIPTIONS"

Sample Response

{ "createdAt": 1752644436.666, "createdBy": "usr7nx82mkl", "domainId": "dzd_53ielnpxktdilj", "id": "mgr5g0fy285m1q", "owningProjectId": "prj7nx82mkl", "status": "SUBMITTED", "type": "BUSINESS_DESCRIPTIONS" }

Example

Failure case - missing parameter:

Sample Request

aws datazone start-metadata-generation-run \ --domain-identifier "dzd_53ielnpxktdilj"

Sample Response

aws: error: the following arguments are required: —owning-project-identifier, —target, —type

Example

Failure case - invalid JSON:

Sample Request

aws datazone start-metadata-generation-run \ --domain-identifier "dzd_53ielnpxktdilj" \ --owning-project-identifier "prj7nx82mkl" \ --target '{"identifier": "ast7k9mpq2xvn4", "revision": "1", "type": "ASSET"' \ --type "BUSINESS_DESCRIPTIONS"

Sample Response

Error parsing parameter '--target': Invalid JSON: Expecting ',' delimiter: line 1 column 58 (char 57) JSON received: {"identifier": "ast7k9mpq2xvn4", "revision": "1", "type": "ASSET"

Example

Failuse case - invalid input:

Sample Request

aws datazone start-metadata-generation-run \ --domain-identifier "dzd_53ielnpxktdilj" \ --owning-project-identifier "prj7nx82mkl" \ --target '{"identifier": "ast7k9mpq2xvn4", "revision": "1", "type": "ASSET"}' \ --type "INVALID_TYPE"

Sample Response

An error occurred (ValidationException) when calling the StartMetadataGenerationRun operation: 1 validation error detected: Value at 'type' failed to satisfy constraint: Member must satisfy enum value set: [BUSINESS_NAMES, BUSINESS_DESCRIPTIONS]

Example

Failure case - resource not found:

Sample Request

aws datazone start-metadata-generation-run \ --domain-identifier "dzd_53ielnpxktdilj" \ --owning-project-identifier "prj7nx82mkl" \ --target '{"identifier": "ast_nonexistent", "revision": "1", "type": "ASSET"}' \ --type "BUSINESS_DESCRIPTIONS"

Sample Response

An error occurred (ResourceNotFoundException) when calling the StartMetadataGenerationRun operation: The given Asset doesn't exist. Try creating Asset before accessing it.

Example

Failure case - not supported data type:

Sample Request

aws datazone start-metadata-generation-run \ --domain-identifier "dzd_53ielnpxktdilj" \ --owning-project-identifier "prj7nx82mkl" \ --target '{ "identifier": "ast7k9mpq2xvn4", "revision": "1", "type": "ASSET" }' \ --type "BUSINESS_DESCRIPTIONS"

Sample Response

An error occurred (ValidationException) when calling the StartMetadataGenerationRun operation: Metadata Descriptions Generation is not supported for input asset type

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: