Class ListRobotsCommandProtected

Deprecated

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

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Example

Use a bare-bones client and the command you need to make an API call.

import { RoboMakerClient, ListRobotsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import
// const { RoboMakerClient, ListRobotsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import
const client = new RoboMakerClient(config);
const input = { // ListRobotsRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  filters: [ // Filters
    { // Filter
      name: "STRING_VALUE",
      values: [ // FilterValues
        "STRING_VALUE",
      ],
    },
  ],
};
const command = new ListRobotsCommand(input);
const response = await client.send(command);
// { // ListRobotsResponse
//   robots: [ // Robots
//     { // Robot
//       arn: "STRING_VALUE",
//       name: "STRING_VALUE",
//       fleetArn: "STRING_VALUE",
//       status: "STRING_VALUE",
//       greenGrassGroupId: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//       architecture: "STRING_VALUE",
//       lastDeploymentJob: "STRING_VALUE",
//       lastDeploymentTime: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

ListRobotsCommandInput

Returns

ListRobotsCommandOutput

See

• ListRobotsCommandInput for command's input shape.
• ListRobotsCommandOutput for command's response shape.
• config for RoboMakerClient's config shape.

Throws

InternalServerException (server fault)

AWS RoboMaker experienced a service issue. Try your call again.

Throws

InvalidParameterException (client fault)

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

Throws

ResourceNotFoundException (client fault)

The specified resource does not exist.

Throws

ThrottlingException (client fault)

AWS RoboMaker is temporarily unable to process the request. Try your call again.

Throws

RoboMakerServiceException

Base exception class for all service exceptions from RoboMaker service.