Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

Starts a batch of workflow runs. You can group up to 100,000 runs into a single batch that share a common configuration defined in defaultRunSetting. Per-run overrides can be provided either inline via inlineSettings (up to 100 runs) or via a JSON file stored in Amazon S3 via s3UriSettings (up to 100,000 runs).

StartRunBatch validates common fields synchronously and returns immediately with a batch ID and status CREATING. The batch transitions to PENDING once initial setup completes. Runs are then submitted gradually and asynchronously at a rate governed by your StartRun throughput quota.

post/runBatch

Request body

batchNamestring

An optional user-friendly name for the run batch.

requestIdstring required

A client token used to deduplicate retry requests and prevent duplicate batches from being created.

tagsobject

AWS tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use <code>defaultRunSetting.runTags</code>.

Response

Success

idstring

The identifier portion of the run batch ARN.

arnstring

The unique ARN of the run batch.

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

The initial status of the run batch. Returns <code>CREATING</code> while the batch is being initialized.

uuidstring

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

tagsobject

AWS tags associated with the run batch.