We are excited to announce our new API Documentation.
Protected
Optional
arnThe Amazon Resource Name (arn) of the batch.
Optional
batchThe batch policy.
Optional
clientUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Optional
createdThe time, in milliseconds since the epoch, when the simulation job batch was created.
Optional
createdA list of created simulation job request summaries.
Optional
failedA list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
Optional
failureThe failure code if the simulation job batch failed.
Optional
failureThe reason the simulation job batch failed.
Optional
pendingA list of pending simulation job requests. These requests have not yet been created into simulation jobs.
Optional
statusThe status of the simulation job batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
The simulation job batch failed. One or more simulation job requests could not
be completed due to an internal failure (like InternalServiceError
).
See failureCode
and failureReason
for more
information.
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 InternalServiceError
and (2) when all created
simulation jobs have reached a terminal state (for example, Completed
or Failed
).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to
an internal failure (like InternalServiceError
), the batch status
will be Failed
. If there are no such failing request, the batch
status will be TimedOut
.
The simulation batch job timed out.
Optional
tagsA map that contains tag keys and tag values that are attached to the deployment job batch.
The output of StartSimulationJobBatchCommand.