End of support notice: On September 10, 2025, AWS
will discontinue support for AWS RoboMaker. After September 10, 2025, you will
no longer be able to access the AWS RoboMaker console or AWS RoboMaker resources.
For more information on transitioning to AWS Batch to help run containerized
simulations, visit this blog
post
SimulationJobRequest
Information about a simulation job request.
Contents
- maxJobDurationInSeconds
-
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
Type: Long
Required: Yes
- compute
-
Compute information for the simulation job
Type: Compute object
Required: No
- dataSources
-
Specify data sources to mount read-only files from S3 into your simulation. These files are available under
/opt/robomaker/datasources/data_source_name.Note
There is a limit of 100 files and a combined size of 25GB for all
DataSourceConfigobjects.Type: Array of DataSourceConfig objects
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Required: No
- failureBehavior
-
The failure behavior the simulation job.
- Continue
-
Leaves the host running for its maximum timeout duration after a
4XXerror code. - Fail
-
Stop the simulation job and terminate the instance.
Type: String
Valid Values:
Fail | ContinueRequired: No
- iamRole
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
arn:aws:iam::\w+:role/.*Required: No
- loggingConfig
-
The logging configuration.
Type: LoggingConfig object
Required: No
- outputLocation
-
The output location.
Type: OutputLocation object
Required: No
- robotApplications
-
The robot applications to use in the simulation job.
Type: Array of RobotApplicationConfig objects
Array Members: Fixed number of 1 item.
Required: No
- simulationApplications
-
The simulation applications to use in the simulation job.
Type: Array of SimulationApplicationConfig objects
Array Members: Fixed number of 1 item.
Required: No
-
A map that contains tag keys and tag values that are attached to the simulation job request.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
[a-zA-Z0-9 _.\-\/+=:]*Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[a-zA-Z0-9 _.\-\/+=:]*Required: No
- useDefaultApplications
-
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
Type: Boolean
Required: No
- 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.
Type: VPCConfig object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
