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

DescribeSimulationApplication

Describes a simulation application.

Request Syntax


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

{
   "application": "string",
   "applicationVersion": "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

applicationVersion

The version of the simulation application to describe.

Type: String

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

Pattern: (\$LATEST)|[0-9]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "environment": { 
      "uri": "string"
   },
   "imageDigest": "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"
      }
   ],
   "tags": { 
      "string" : "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 robot 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 to create the simulation application.

Type: Environment object

imageDigest

A SHA256 identifier for the Docker image that you use for your simulation application.

Type: String

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

Pattern: [Ss][Hh][Aa]256:[0-9a-fA-F]{64}

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

tags

The list of all tags added to the specified simulation application.

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 _.\-\/+=:]*

version

The version of the simulation 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

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