• Public
  • Public/Protected
  • All

Interface SimulationJobRequest

Information about a simulation job request.


  • SimulationJobRequest



Optional compute

compute: Compute

Compute information for the simulation job

Optional dataSources

dataSources: DataSourceConfig[]

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

Optional failureBehavior

failureBehavior: FailureBehavior | string

The failure behavior the simulation job.


Leaves the host running for its maximum timeout duration after a 4XX error code.


Stop the simulation job and terminate the instance.

Optional iamRole

iamRole: undefined | string

The IAM role name 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.

Optional loggingConfig

loggingConfig: LoggingConfig

The logging configuration.


maxJobDurationInSeconds: number | undefined

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

Optional outputLocation

outputLocation: OutputLocation

The output location.

Optional robotApplications

robotApplications: RobotApplicationConfig[]

The robot applications to use in the simulation job.

Optional simulationApplications

simulationApplications: SimulationApplicationConfig[]

The simulation applications to use in the simulation job.

Optional tags

tags: Record<string, string>

A map that contains tag keys and tag values that are attached to the simulation job request.

Optional useDefaultApplications

useDefaultApplications: undefined | false | true

A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.

Optional vpcConfig

vpcConfig: VPCConfig

If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.