Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . robomaker ]

describe-simulation-application¶

Description¶

Warning

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/ .

Describes a simulation application.

Synopsis¶

  describe-simulation-application
--application <value>
[--application-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--application (string)

The application information for the simulation application.

--application-version (string)

The version of the simulation application to describe.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe a simulation application

This example describes a simulation application.

Command:

aws robomaker describe-simulation-application --application arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605

Output:

{
  "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605",
  "name": "MySimulationApplication",
  "version": "$LATEST",
  "sources": [
      {
          "s3Bucket": "my-bucket",
          "s3Key": "my-simulation-application.tar.gz",
          "architecture": "X86_64"
      }
  ],
  "simulationSoftwareSuite": {
      "name": "Gazebo",
      "version": "7"
  },
  "robotSoftwareSuite": {
      "name": "ROS",
      "version": "Kinetic"
  },
  "renderingEngine": {
      "name": "OGRE",
      "version": "1.x"
  },
  "revisionId": "783674ab-b7b8-42d9-b01f-9373907987e5",
  "lastUpdatedAt": 1551203427.0,
  "tags": {}
}

Output¶

arn -> (string)

The Amazon Resource Name (ARN) of the robot simulation application.

name -> (string)

The name of the simulation application.

version -> (string)

The version of the simulation application.

sources -> (list)

The sources of the simulation application.

(structure)

Information about a source.

s3Bucket -> (string)

The s3 bucket name.

s3Key -> (string)

The s3 object key.

etag -> (string)

A hash of the object specified by s3Bucket and s3Key .

architecture -> (string)

The taget processor architecture for the application.

simulationSoftwareSuite -> (structure)

The simulation software suite used by the simulation application.

name -> (string)

The name of the simulation software suite. SimulationRuntime is the only supported value.

version -> (string)

The version of the simulation software suite. Not applicable for SimulationRuntime .

robotSoftwareSuite -> (structure)

Information about the robot software suite.

name -> (string)

The name of the robot software suite. General is the only supported value.

version -> (string)

The version of the robot software suite. Not applicable for General software suite.

renderingEngine -> (structure)

The rendering engine for the simulation application.

name -> (string)

The name of the rendering engine.

version -> (string)

The version of the rendering engine.

revisionId -> (string)

The revision id of the simulation application.

lastUpdatedAt -> (timestamp)

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

tags -> (map)

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

key -> (string)

value -> (string)

environment -> (structure)

The object that contains the Docker image URI used to create the simulation application.

uri -> (string)

The Docker image URI for either your robot or simulation applications.

imageDigest -> (string)

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

Table Of Contents

Feedback

User Guide