Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeSimulationJob

Important

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.

Describes a simulation job.

Request Syntax


POST /describeSimulationJob HTTP/1.1
Content-type: application/json

{
   "job": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

job

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

Type: String

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

Pattern: arn:.*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "clientRequestToken": "string",
   "compute": { 
      "computeType": "string",
      "gpuUnitLimit": number,
      "simulationUnitLimit": number
   },
   "dataSources": [ 
      { 
         "destination": "string",
         "name": "string",
         "s3Bucket": "string",
         "s3Keys": [ 
            { 
               "etag": "string",
               "s3Key": "string"
            }
         ],
         "type": "string"
      }
   ],
   "failureBehavior": "string",
   "failureCode": "string",
   "failureReason": "string",
   "iamRole": "string",
   "lastStartedAt": number,
   "lastUpdatedAt": number,
   "loggingConfig": { 
      "recordAllRosTopics": boolean
   },
   "maxJobDurationInSeconds": number,
   "name": "string",
   "networkInterface": { 
      "networkInterfaceId": "string",
      "privateIpAddress": "string",
      "publicIpAddress": "string"
   },
   "outputLocation": { 
      "s3Bucket": "string",
      "s3Prefix": "string"
   },
   "robotApplications": [ 
      { 
         "application": "string",
         "applicationVersion": "string",
         "launchConfig": { 
            "command": [ "string" ],
            "environmentVariables": { 
               "string" : "string" 
            },
            "launchFile": "string",
            "packageName": "string",
            "portForwardingConfig": { 
               "portMappings": [ 
                  { 
                     "applicationPort": number,
                     "enableOnPublicIp": boolean,
                     "jobPort": number
                  }
               ]
            },
            "streamUI": boolean
         },
         "tools": [ 
            { 
               "command": "string",
               "exitBehavior": "string",
               "name": "string",
               "streamOutputToCloudWatch": boolean,
               "streamUI": boolean
            }
         ],
         "uploadConfigurations": [ 
            { 
               "name": "string",
               "path": "string",
               "uploadBehavior": "string"
            }
         ],
         "useDefaultTools": boolean,
         "useDefaultUploadConfigurations": boolean
      }
   ],
   "simulationApplications": [ 
      { 
         "application": "string",
         "applicationVersion": "string",
         "launchConfig": { 
            "command": [ "string" ],
            "environmentVariables": { 
               "string" : "string" 
            },
            "launchFile": "string",
            "packageName": "string",
            "portForwardingConfig": { 
               "portMappings": [ 
                  { 
                     "applicationPort": number,
                     "enableOnPublicIp": boolean,
                     "jobPort": number
                  }
               ]
            },
            "streamUI": boolean
         },
         "tools": [ 
            { 
               "command": "string",
               "exitBehavior": "string",
               "name": "string",
               "streamOutputToCloudWatch": boolean,
               "streamUI": boolean
            }
         ],
         "uploadConfigurations": [ 
            { 
               "name": "string",
               "path": "string",
               "uploadBehavior": "string"
            }
         ],
         "useDefaultTools": boolean,
         "useDefaultUploadConfigurations": boolean,
         "worldConfigs": [ 
            { 
               "world": "string"
            }
         ]
      }
   ],
   "simulationTimeMillis": number,
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "vpcConfig": { 
      "assignPublicIp": boolean,
      "securityGroups": [ "string" ],
      "subnets": [ "string" ],
      "vpcId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

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

Type: String

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

Pattern: arn:.*

clientRequestToken

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

Type: String

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

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

compute

Compute information for the simulation job.

Type: ComputeResponse object

dataSources

The data sources for the simulation job.

Type: Array of DataSource objects

failureBehavior

The failure behavior for the simulation job.

Type: String

Valid Values: Fail | Continue

failureCode

The failure code of the simulation job if it failed:

InternalServiceError: Internal service error.
RobotApplicationCrash: Robot application exited abnormally.
SimulationApplicationCrash: Simulation application exited abnormally.
BadPermissionsRobotApplication: Robot application bundle could not be downloaded.
BadPermissionsSimulationApplication: Simulation application bundle could not be downloaded.
BadPermissionsS3Output: Unable to publish outputs to customer-provided S3 bucket.
BadPermissionsCloudwatchLogs: Unable to publish logs to customer-provided CloudWatch Logs resource.
SubnetIpLimitExceeded: Subnet IP limit exceeded.
ENILimitExceeded: ENI limit exceeded.
BadPermissionsUserCredentials: Unable to use the Role provided.
InvalidBundleRobotApplication: Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
InvalidBundleSimulationApplication: Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
RobotApplicationVersionMismatchedEtag: Etag for RobotApplication does not match value during version creation.
SimulationApplicationVersionMismatchedEtag: Etag for SimulationApplication does not match value during version creation.

Type: String

failureReason

Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

iamRole

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

Type: String

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

Pattern: arn:aws:iam::\w+:role/.*

lastStartedAt

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

Type: Timestamp

lastUpdatedAt

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

Type: Timestamp

loggingConfig

The logging configuration.

Type: LoggingConfig object

maxJobDurationInSeconds

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

Type: Long

name

The name of the simulation job.

Type: String

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

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

networkInterface

The network interface information for the simulation job.

Type: NetworkInterface object

outputLocation

Location for output files generated by the simulation job.

Type: OutputLocation object

robotApplications

A list of robot applications.

Type: Array of RobotApplicationConfig objects

Array Members: Fixed number of 1 item.

simulationApplications

A list of simulation applications.

Type: Array of SimulationApplicationConfig objects

Array Members: Fixed number of 1 item.

simulationTimeMillis

The simulation job execution duration in milliseconds.

Type: Long

status

The status of the simulation job.

Type: String

tags

The list of all tags added to the specified 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 _.\-\/+=:]*

vpcConfig

The VPC configuration.

Type: VPCConfigResponse object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

AWS RoboMaker experienced a service issue. Try your call again.

HTTP Status Code: 500

InvalidParameterException

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ThrottlingException

AWS RoboMaker is temporarily unable to process the request. Try your call again.

HTTP Status Code: 400