Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . robomaker ]

describe-robot

Description

Describes a robot.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-robot
--robot <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--robot (string)

The Amazon Resource Name (ARN) of the robot to be described.

--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.

See 'aws help' for descriptions of global parameters.

Examples

To describe a robot

This example describes a robot.

Command:

aws robomaker describe-robot --robot arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398

Output:

{
  "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398",
  "name": "MyRobot",
  "status": "Available",
  "greengrassGroupId": "0f728a3c-7dbf-4a3e-976d-d16a8360caba",
  "createdAt": 1550772325.0,
  "architecture": "ARMHF",
  "tags": {
      "Region": "East"
  }
}

Output

arn -> (string)

The Amazon Resource Name (ARN) of the robot.

name -> (string)

The name of the robot.

fleetArn -> (string)

The Amazon Resource Name (ARN) of the fleet.

status -> (string)

The status of the fleet.

greengrassGroupId -> (string)

The Greengrass group id.

createdAt -> (timestamp)

The time, in milliseconds since the epoch, when the robot was created.

architecture -> (string)

The target architecture of the robot application.

lastDeploymentJob -> (string)

The Amazon Resource Name (ARN) of the last deployment job.

lastDeploymentTime -> (timestamp)

The time of the last deployment job.

tags -> (map)

The list of all tags added to the specified robot.

key -> (string)

value -> (string)