Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

get/runBatch/{batchId}

Path parameters

batchIdstring required

The identifier portion of the run batch ARN.

Response

Success

idstring

The identifier portion of the run batch ARN.

arnstring

The unique ARN of the run batch.

uuidstring

The universally unique identifier (UUID) for the run batch.

namestring

The optional user-friendly name of the batch.

status'CREATING' | 'PENDING' | 'SUBMITTING' | 'INPROGRESS' | 'STOPPING' | 'CANCELLED' | 'FAILED' | 'PROCESSED' | 'RUNS_DELETING' | 'RUNS_DELETED'

The current status of the run batch. Possible values: <code>CREATING</code> (initial setup), <code>PENDING</code> (ready to submit runs), <code>SUBMITTING</code> (submitting runs), <code>INPROGRESS</code> (runs executing), <code>STOPPING</code> (cancellation in progress), <code>PROCESSED</code> (all runs completed), <code>CANCELLED</code> (batch cancelled), <code>FAILED</code> (batch failed), <code>RUNS_DELETING</code> (deleting runs), <code>RUNS_DELETED</code> (runs deleted).

tagsobject

AWS tags associated with the run batch.

totalRunsinteger

The total number of runs in the batch.

creationTimestring date-time

The timestamp when the batch was created.

submittedTimestring date-time

The timestamp when all run submissions completed.

processedTimestring date-time

The timestamp when all run executions completed.

failedTimestring date-time

The timestamp when the batch transitioned to a <code>FAILED</code> status.

failureReasonstring

A description of the batch failure. Present only when status is <code>FAILED</code>.