Starts a new simulation job batch. The batch is defined using one or more <code>SimulationJobRequest</code> objects.
post/startSimulationJobBatch
Request body
clientRequestTokenstring
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
tagsobject
A map that contains tag keys and tag values that are attached to the deployment job batch.
Response
Success
arnstring
The Amazon Resource Name (arn) of the batch.
status'Pending' | 'InProgress' | 'Failed' | 'Completed' | 'Canceled' | 'Canceling' | 'Completing' | 'TimingOut' | 'TimedOut'
<p>The status of the simulation job batch.</p> <dl> <dt>Pending</dt> <dd> <p>The simulation job batch request is pending.</p> </dd> <dt>InProgress</dt> <dd> <p>The simulation job batch is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like <code>InternalServiceError</code>). See <code>failureCode</code> and <code>failureReason</code> for more information.</p> </dd> <dt>Completed</dt> <dd> <p>The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to <code>InternalServiceError</code> and (2) when all created simulation jobs have reached a terminal state (for example, <code>Completed</code> or <code>Failed</code>). </p> </dd> <dt>Canceled</dt> <dd> <p>The simulation batch job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The simulation batch job is being cancelled.</p> </dd> <dt>Completing</dt> <dd> <p>The simulation batch job is completing.</p> </dd> <dt>TimingOut</dt> <dd> <p>The simulation job batch is timing out.</p> <p>If a batch timing out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), the batch status will be <code>Failed</code>. If there are no such failing request, the batch status will be <code>TimedOut</code>. </p> </dd> <dt>TimedOut</dt> <dd> <p>The simulation batch job timed out.</p> </dd> </dl>
createdAtstring date-time
The time, in milliseconds since the epoch, when the simulation job batch was created.
clientRequestTokenstring
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
failureCode'InternalServiceError'
The failure code if the simulation job batch failed.
failureReasonstring
The reason the simulation job batch failed.
tagsobject
A map that contains tag keys and tag values that are attached to the deployment job batch.