AWS RoboMaker
Developer Guide

SimulationJob

Information about a simulation job.

Contents

arn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: arn:.*

Required: No

clientRequestToken

A unique identifier for this SimulationJob request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_\-=]*

Required: No

failureBehavior

The failure behavior the simulation job.

Continue

Restart the simulation job in the same host instance.

Fail

Stop the simulation job and terminate the instance.

Type: String

Valid Values: Fail | Continue

Required: No

failureCode

The failure code of the simulation job if it failed.

Type: String

Valid Values: InternalServiceError | RobotApplicationCrash | SimulationApplicationCrash | BadPermissionsRobotApplication | BadPermissionsSimulationApplication | BadPermissionsS3Output | BadPermissionsCloudwatchLogs | SubnetIpLimitExceeded | ENILimitExceeded | BadPermissionsUserCredentials | InvalidBundleRobotApplication | InvalidBundleSimulationApplication | RobotApplicationVersionMismatchedEtag | SimulationApplicationVersionMismatchedEtag

Required: No

iamRole

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. See how to specify AWS security credentials for your application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: arn:.*

Required: No

lastUpdatedAt

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

Type: Timestamp

Required: No

maxJobDurationInSeconds

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

Type: Long

Required: No

name

The name of the simulation job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_\-]*

Required: No

outputLocation

Location for output files generated by the simulation job.

Type: OutputLocation object

Required: No

robotApplications

A list of robot applications.

Type: Array of RobotApplicationConfig objects

Array Members: Fixed number of 1 item.

Required: No

simulationApplications

A list of simulation applications.

Type: Array of SimulationApplicationConfig objects

Array Members: Fixed number of 1 item.

Required: No

simulationTimeMillis

The simulation job execution duration in milliseconds.

Type: Long

Required: No

status

Status of the simulation job.

Type: String

Valid Values: Pending | Preparing | Running | Restarting | Completed | Failed | RunningFailed | Terminating | Terminated | Canceled

Required: No

vpcConfig

VPC configuration information.

Type: VPCConfigResponse object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: