GetMetadataGenerationRun
Gets a metadata generation run in Amazon DataZone.
Request Syntax
GET /v2/domains/domainIdentifier/metadata-generation-runs/identifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the Amazon DataZone domain the metadata generation run of which you want to get.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The identifier of the metadata generation run.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"createdBy": "string",
"domainId": "string",
"id": "string",
"owningProjectId": "string",
"status": "string",
"target": {
"identifier": "string",
"revision": "string",
"type": "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 of when the metadata generation run was start.
Type: Timestamp
- createdBy
-
The Amazon DataZone user who started the metadata generation run.
Type: String
- domainId
-
The ID of the Amazon DataZone domain the metadata generation run of which you want to get.
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 assets for which you're running metadata generation.
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 - target
-
The asset for which you're generating metadata.
Type: MetadataGenerationRunTarget object
- type
-
The type of 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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
