Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListMetadataGenerationRuns

Lists all metadata generation runs.

Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.

Prerequisites:

Valid domain identifier.
User must have access to metadata generation runs in the domain.

Request Syntax


GET /v2/domains/domainIdentifier/metadata-generation-runs?maxResults=maxResults&nextToken=nextToken&status=status&type=type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain where you want to list metadata generation runs.

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

Required: Yes

maxResults

The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

Valid Range: Minimum value of 1. Maximum value of 50.

nextToken

When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

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

status

The status of the metadata generation runs.

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

type

The type of the metadata generation runs.

Valid Values: BUSINESS_DESCRIPTIONS

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "id": "string",
         "owningProjectId": "string",
         "status": "string",
         "target": { 
            "identifier": "string",
            "revision": "string",
            "type": "string"
         },
         "type": "string"
      }
   ],
   "nextToken": "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.

items

The results of the ListMetadataGenerationRuns action.

Type: Array of MetadataGenerationRunItem objects

nextToken

Type: String

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

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

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

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 ListMetadataGenerationRuns.

Sample Request



aws datazone list-metadata-generation-runs --domain-identifier "dzd_53ielnpxktdilj"

Sample Response



{
    "items": [{
            "createdAt": 1752642939.631,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "mgr3tlpxo4mg5q",
            "owningProjectId": "prj7nx82mkl",
            "status": "SUCCEEDED",
            "target": {
                "identifier": "ast7k9mpq2xvn4",
                "revision": "1",
                "type": "ASSET"
            },
            "type": "BUSINESS_DESCRIPTIONS"
        },
        {
            "createdAt": 1752643907.566,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "mgr487vbdcqwn8",
            "owningProjectId": "prj7nx82mkl",
            "status": "SUCCEEDED",
            "target": {
                "identifier": "ast7k9mpq2xvn4",
                "revision": "4",
                "type": "ASSET"
            },
            "type": "BUSINESS_DESCRIPTIONS"
        },
        {
            "createdAt": 1752644436.666,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "mgr5g0fy285m1q",
            "owningProjectId": "prj7nx82mkl",
            "status": "CANCELED",
            "target": {
                "identifier": "ast6br2md6v9h",
                "revision": "1",
                "type": "ASSET"
            },
            "type": "BUSINESS_DESCRIPTIONS"
        }
    ]
}

Example

Failuse case - missing parameter:

Sample Request



aws datazone list-metadata-generation-runs

Sample Response



aws: error: the following arguments are required: —domain-identifier

Example

Failure case - invalid input:

Sample Request



aws datazone list-metadata-generation-runs --domain-identifier "invalid_domain"

Sample Response



An error occurred (ValidationException) when calling the ListMetadataGenerationRuns operation: 1 validation error detected: Value at 'domainIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: dzd[-_][a-zA-Z0-9_-]{1,36}