[ aws . robomaker ]

describe-robot-application

Description

Describes a robot application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-robot-application
--application <value>
[--application-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application (string)

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

--application-version (string)

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

This example describes a robot application.

Command:

aws robomaker describe-robot-application --application arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821

Output:

{
  "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821",
  "name": "MyRobotApplication",
  "version": "$LATEST",
  "sources": [
      {
          "s3Bucket": "my-bucket",
          "s3Key": "my-robot-application.tar.gz",
          "architecture": "X86_64"
      }
  ],
  "robotSoftwareSuite": {
      "name": "ROS",
      "version": "Kinetic"
  },
  "revisionId": "e72efe0d-f44f-4333-b604-f6fa5c6bb50b",
  "lastUpdatedAt": 1551203485.0,
  "tags": {}
}

Output

arn -> (string)

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

name -> (string)

The name of the robot application.

version -> (string)

The version of the robot application.

sources -> (list)

The sources of the robot 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.

robotSoftwareSuite -> (structure)

The robot software suite (ROS distribution) used by the robot application.

name -> (string)

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

version -> (string)

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

revisionId -> (string)

The revision id of the robot application.

lastUpdatedAt -> (timestamp)

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

tags -> (map)

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

key -> (string)

value -> (string)