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

StartMetadataGenerationRun

Starts the metadata generation run.

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