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
UpdateSimulationApplication
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
Updates a simulation application.
Request Syntax
POST /updateSimulationApplication HTTP/1.1
Content-type: application/json
{
"application": "string
",
"currentRevisionId": "string
",
"environment": {
"uri": "string
"
},
"renderingEngine": {
"name": "string
",
"version": "string
"
},
"robotSoftwareSuite": {
"name": "string
",
"version": "string
"
},
"simulationSoftwareSuite": {
"name": "string
",
"version": "string
"
},
"sources": [
{
"architecture": "string
",
"s3Bucket": "string
",
"s3Key": "string
"
}
]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- application
-
The application information for the simulation application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*
Required: Yes
- currentRevisionId
-
The revision id for the robot application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[a-zA-Z0-9_.\-]*
Required: No
- environment
-
The object that contains the Docker image URI for your simulation application.
Type: Environment object
Required: No
- renderingEngine
-
The rendering engine for the simulation application.
Type: RenderingEngine object
Required: No
- robotSoftwareSuite
-
Information about the robot software suite.
Type: RobotSoftwareSuite object
Required: Yes
- simulationSoftwareSuite
-
The simulation software suite used by the simulation application.
Type: SimulationSoftwareSuite object
Required: Yes
- sources
-
The sources of the simulation application.
Type: Array of SourceConfig objects
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"environment": {
"uri": "string"
},
"lastUpdatedAt": number,
"name": "string",
"renderingEngine": {
"name": "string",
"version": "string"
},
"revisionId": "string",
"robotSoftwareSuite": {
"name": "string",
"version": "string"
},
"simulationSoftwareSuite": {
"name": "string",
"version": "string"
},
"sources": [
{
"architecture": "string",
"etag": "string",
"s3Bucket": "string",
"s3Key": "string"
}
],
"version": "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 updated simulation application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*
- environment
-
The object that contains the Docker image URI used for your simulation application.
Type: Environment object
- lastUpdatedAt
-
The time, in milliseconds since the epoch, when the simulation application was last updated.
Type: Timestamp
- name
-
The name of the simulation application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_\-]*
- renderingEngine
-
The rendering engine for the simulation application.
Type: RenderingEngine object
- revisionId
-
The revision id of the simulation application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[a-zA-Z0-9_.\-]*
- robotSoftwareSuite
-
Information about the robot software suite.
Type: RobotSoftwareSuite object
- simulationSoftwareSuite
-
The simulation software suite used by the simulation application.
Type: SimulationSoftwareSuite object
- sources
-
The sources of the simulation application.
Type: Array of Source objects
- version
-
The version of the robot application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
(\$LATEST)|[0-9]*
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
- LimitExceededException
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: