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

GetWorkflowExecution

Retrieves runtime information for a specific runtime instance of the workflow.

Request Syntax


GET /GetWorkflowExecution?workflowExecutionId=workflowExecutionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

workflowExecutionId

Use the unique identifier for a runtime instance of the workflow to get runtime details.

Pattern: ^wf-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "endTime": "string",
   "imageBuildVersionArn": "string",
   "message": "string",
   "parallelGroup": "string",
   "requestId": "string",
   "startTime": "string",
   "status": "string",
   "totalStepCount": number,
   "totalStepsFailed": number,
   "totalStepsSkipped": number,
   "totalStepsSucceeded": number,
   "type": "string",
   "workflowBuildVersionArn": "string",
   "workflowExecutionId": "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.

endTime

The timestamp when the specified runtime instance of the workflow finished.

Type: String

imageBuildVersionArn

The Amazon Resource Name (ARN) of the image build version that owns the specified runtime instance of the workflow.

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

message

The output message from the specified runtime instance of the workflow, if applicable.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

parallelGroup

The name of the parallel group that this runtime instance of the workflow ran in, if configured. Parallel groups apply only to test workflows.

Type: String

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

Pattern: ^[A-Za-z0-9][A-Za-z0-9-_+#]{0,99}$

requestId

The request ID that uniquely identifies this request.

Type: String

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

startTime

The timestamp when the specified runtime instance of the workflow started.

Type: String

status

The current runtime status for the specified runtime instance of the workflow. COMPLETED, FAILED, ROLLBACK_COMPLETED, CANCELLED, and SKIPPED are terminal states.

Type: String

totalStepCount

The total number of steps that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.

Type: Integer

totalStepsFailed

A runtime count for the number of steps that failed in the specified runtime instance of the workflow.

Type: Integer

totalStepsSkipped

A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.

Type: Integer

totalStepsSucceeded

A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.

Type: Integer

type

The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

Type: String

Valid Values: BUILD | TEST | DISTRIBUTION

workflowBuildVersionArn

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.

Type: String

Length Constraints: Maximum length of 1024.

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]+\.[0-9]+\.[0-9]+/[0-9]+$

workflowExecutionId

The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

Type: String

Pattern: ^wf-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Errors

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

CallRateLimitExceededException

You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.

HTTP Status Code: 429

ClientException

A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403

InvalidRequestException

The request is malformed or otherwise invalid. Verify the request and try again.

HTTP Status Code: 400

ServiceException

An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.

HTTP Status Code: 500

ServiceUnavailableException

The service is unable to process your request at this time.

HTTP Status Code: 503

Examples

Get the runtime details for a workflow execution

The following example retrieves runtime status and step counts for the build workflow that ran for an image build version, using the workflow execution ID returned by ListWorkflowExecutions.

Sample Request


GET /GetWorkflowExecution?workflowExecutionId=wf-165b1cb6-3a62-4618-a021-94ddcbe32908 HTTP/1.1

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "requestId": "cd69c813-51c3-4261-8e59-382a1af96f73",
    "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1",
    "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908",
    "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1",
    "type": "BUILD",
    "status": "COMPLETED",
    "totalStepCount": 7,
    "totalStepsSucceeded": 5,
    "totalStepsFailed": 0,
    "totalStepsSkipped": 2,
    "startTime": "2026-09-09T19:12:23.175Z",
    "endTime": "2026-09-09T19:19:06.158Z"
}