GetWorkflow
Get a workflow resource object.
Request Syntax
GET /GetWorkflow?workflowBuildVersionArn=workflowBuildVersionArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- workflowBuildVersionArn
-
The Amazon Resource Name (ARN) of the workflow resource that you want to get.
Pattern:
^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"workflow": {
"arn": "string",
"changeDescription": "string",
"data": "string",
"dateCreated": "string",
"description": "string",
"kmsKeyId": "string",
"name": "string",
"owner": "string",
"parameters": [
{
"defaultValue": [ "string" ],
"description": "string",
"name": "string",
"type": "string"
}
],
"state": {
"reason": "string",
"status": "string"
},
"tags": {
"string" : "string"
},
"type": "string",
"version": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- CallRateLimitExceededException
-
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429
- ClientException
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
HTTP Status Code: 400
- ForbiddenException
-
You are not authorized to perform the requested operation.
HTTP Status Code: 403
- InvalidRequestException
-
You have requested an action that that the service doesn't support.
HTTP Status Code: 400
- ServiceException
-
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
