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
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
SimulationJobrequest.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_\-=]*Required: No
- compute
-
Compute information for the simulation job
Type: ComputeResponse object
Required: No
- dataSources
-
The data sources for the simulation job.
Type: Array of DataSource objects
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
- failureCode
-
The failure code of the simulation job if it failed.
Type: String
Valid Values:
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 | UploadContentMismatchErrorRequired: No
- failureReason
-
The reason why the simulation job failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
arn:aws:iam::\w+:role/.*Required: No
- lastStartedAt
-
The time, in milliseconds since the epoch, when the simulation job was last started.
Type: Timestamp
Required: No
- lastUpdatedAt
-
The time, in milliseconds since the epoch, when the simulation job was last updated.
Type: Timestamp
Required: No
- loggingConfig
-
The logging configuration.
Type: LoggingConfig object
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
- networkInterface
-
Information about a network interface.
Type: NetworkInterface object
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 | CanceledRequired: No
-
A map that contains tag keys and tag values that are attached to the simulation job.
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
- 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:
