list-robots¶

Description¶

Returns a list of robots. You can optionally provide filters to retrieve specific robots.

Synopsis¶

  list-robots
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--filters (list)

Optional filters to limit results.

The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available .

(structure)

Information about a filter.

name -> (string)

The name of the filter.

values -> (list)

A list of values.

(string)

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "string",
    "values": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 list robots

This example lists robots. A maximum of 20 robots will be returned.

Command:

aws robomaker list-robots --max-results 20

Output:

{
  "robots": [
      {
          "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/Robot100/1544035373264",
          "name": "Robot100",
          "status": "Available",
          "createdAt": 1544035373.0,
          "architecture": "X86_64"
      },
      {
          "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/Robot101/1542146976587",
          "name": "Robot101",
          "status": "Available",
          "createdAt": 1542146976.0,
          "architecture": "X86_64"
      },
      {
          "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/Robot102/1540834232469",
          "name": "Robot102",
          "fleetArn": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/Trek/1539894765711",
          "status": "Available",
          "createdAt": 1540834232.0,
          "architecture": "X86_64",
          "lastDeploymentJob": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-jb007b75gl5f",
          "lastDeploymentTime": 1550689533.0
      },
      {
          "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1540829698778",
          "name": "MyRobot",
          "status": "Registered",
          "createdAt": 1540829698.0,
          "architecture": "X86_64"
      }
  ]
}

Output¶

robots -> (list)

A list of robots that meet the criteria of the request.

(structure)

Information about a robot.

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

greenGrassGroupId -> (string)

The Greengrass group associated with the robot.

createdAt -> (timestamp)

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

architecture -> (string)

The architecture of the robot.

lastDeploymentJob -> (string)

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

lastDeploymentTime -> (timestamp)

The time of the last deployment.

nextToken -> (string)

If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

Table of Contents

Feedback

User Guide