Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1457289301.4 KB

Describes a simulation job.

post/describeSimulationJob

Request body

jobstring required

The Amazon Resource Name (ARN) of the simulation job to be described.

Response

Success

arnstring

The Amazon Resource Name (ARN) of the simulation job.

namestring

The name of the simulation job.

status'Pending' | 'Preparing' | 'Running' | 'Restarting' | 'Completed' | 'Failed' | 'RunningFailed' | 'Terminating' | 'Terminated' | 'Canceled'

The status of the simulation job.

lastStartedAtstring date-time

The time, in milliseconds since the epoch, when the simulation job was last started.

lastUpdatedAtstring date-time

The time, in milliseconds since the epoch, when the simulation job was last updated.

failureBehavior'Fail' | 'Continue'

The failure behavior for the simulation job.

failureCode'InternalServiceError' | 'RobotApplicationCrash' | 'SimulationApplicationCrash' | 'RobotApplicationHealthCheckFailure' | 'SimulationApplicationHealthCheckFailure' | 'BadPermissionsRobotApplication' | 'BadPermissionsSimulationApplication' | 'BadPermissionsS3Object' | 'BadPermissionsS3Output' | 'BadPermissionsCloudwatchLogs' | 'SubnetIpLimitExceeded' | 'ENILimitExceeded' | 'BadPermissionsUserCredentials' | 'InvalidBundleRobotApplication' | 'InvalidBundleSimulationApplication' | 'InvalidS3Resource' | 'ThrottlingError' | 'LimitExceeded' | 'MismatchedEtag' | 'RobotApplicationVersionMismatchedEtag' | 'SimulationApplicationVersionMismatchedEtag' | 'ResourceNotFound' | 'RequestThrottled' | 'BatchTimedOut' | 'BatchCanceled' | 'InvalidInput' | 'WrongRegionS3Bucket' | 'WrongRegionS3Output' | 'WrongRegionRobotApplication' | 'WrongRegionSimulationApplication' | 'UploadContentMismatchError'
<p>The failure code of the simulation job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>RobotApplicationCrash</dt> <dd> <p>Robot application exited abnormally.</p> </dd> <dt>SimulationApplicationCrash</dt> <dd> <p> Simulation application exited abnormally.</p> </dd> <dt>BadPermissionsRobotApplication</dt> <dd> <p>Robot application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsSimulationApplication</dt> <dd> <p>Simulation application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsS3Output</dt> <dd> <p>Unable to publish outputs to customer-provided S3 bucket.</p> </dd> <dt>BadPermissionsCloudwatchLogs</dt> <dd> <p>Unable to publish logs to customer-provided CloudWatch Logs resource.</p> </dd> <dt>SubnetIpLimitExceeded</dt> <dd> <p>Subnet IP limit exceeded.</p> </dd> <dt>ENILimitExceeded</dt> <dd> <p>ENI limit exceeded.</p> </dd> <dt>BadPermissionsUserCredentials</dt> <dd> <p>Unable to use the Role provided.</p> </dd> <dt>InvalidBundleRobotApplication</dt> <dd> <p>Robot bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>InvalidBundleSimulationApplication</dt> <dd> <p>Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>RobotApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for RobotApplication does not match value during version creation.</p> </dd> <dt>SimulationApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for SimulationApplication does not match value during version creation.</p> </dd> </dl>
failureReasonstring

Details about why the simulation job failed. For more information about troubleshooting, see <a href="https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html">Troubleshooting</a>.

clientRequestTokenstring

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

maxJobDurationInSecondsinteger

The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.

simulationTimeMillisinteger

The simulation job execution duration in milliseconds.

iamRolestring

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

tagsobject

The list of all tags added to the specified simulation job.