POST

/createSimulationJob

http://robomaker.{region}.amazonaws.com/createSimulationJob

Creates a simulation job. <note> After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible. </note>

Access Token Required: API Key

Body Params

tagsobject

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

computeobject

Compute information for the simulation job.

iamRolestringrequired

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.

vpcConfigobject

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.

dataSourcesarray

Specify data sources to mount read-only files from S3 into your simulation. These files are available under <code>/opt/robomaker/datasources/data_source_name</code>. <note> There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </note>

loggingConfigobject

The logging configuration.

outputLocationobject

The output location.

failureBehaviorstring

The failure behavior the simulation job. <dl> <dt>Continue</dt> <dd> Leaves the instance running for its maximum timeout duration after a <code>4XX</code> error code. </dd> <dt>Fail</dt> <dd> Stop the simulation job and terminate the instance. </dd> </dl>

robotApplicationsarray

The robot application to use in the simulation job.

clientRequestTokenstring

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

simulationApplicationsarray

The simulation application to use in the simulation job.

maxJobDurationInSecondsintegerrequired

The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When <code>maxJobDurationInSeconds</code> is reached, the simulation job will status will transition to <code>Completed</code>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://robomaker.{region}.amazonaws.com/createSimulationJob' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}