[ aws . robomaker ]

describe-simulation-application

Description

Describes a simulation application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-simulation-application
--application <value>
[--application-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

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.

version -> (string)

The version of the simulation software suite.

robotSoftwareSuite -> (structure)

Information about the robot software suite (ROS distribution).

name -> (string)

The name of the robot software suite (ROS distribution).

version -> (string)

The version of the robot software suite (ROS distribution).

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)