- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeRobotCommand
- Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/ .
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Describes a robot.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { RoboMakerClient, DescribeRobotCommand } from "@aws-sdk/client-robomaker"; // ES Modules import
// const { RoboMakerClient, DescribeRobotCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import
const client = new RoboMakerClient(config);
const input = { // DescribeRobotRequest
robot: "STRING_VALUE", // required
};
const command = new DescribeRobotCommand(input);
const response = await client.send(command);
// { // DescribeRobotResponse
// arn: "STRING_VALUE",
// name: "STRING_VALUE",
// fleetArn: "STRING_VALUE",
// status: "Available" || "Registered" || "PendingNewDeployment" || "Deploying" || "Failed" || "InSync" || "NoResponse",
// greengrassGroupId: "STRING_VALUE",
// createdAt: new Date("TIMESTAMP"),
// architecture: "X86_64" || "ARM64" || "ARMHF",
// lastDeploymentJob: "STRING_VALUE",
// lastDeploymentTime: new Date("TIMESTAMP"),
// tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// };
DescribeRobotCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
robotRequired | string | undefined | The Amazon Resource Name (ARN) of the robot to be described. |
DescribeRobotCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
architecture | Architecture | undefined | The target architecture of the robot application. |
arn | string | undefined | The Amazon Resource Name (ARN) of the robot. |
createdAt | Date | undefined | The time, in milliseconds since the epoch, when the robot was created. |
fleetArn | string | undefined | The Amazon Resource Name (ARN) of the fleet. |
greengrassGroupId | string | undefined | The Greengrass group id. |
lastDeploymentJob | string | undefined | The Amazon Resource Name (ARN) of the last deployment job. |
lastDeploymentTime | Date | undefined | The time of the last deployment job. |
name | string | undefined | The name of the robot. |
status | RobotStatus | undefined | The status of the fleet. |
tags | Record<string, string> | undefined | The list of all tags added to the specified robot. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServerException | server | AWS RoboMaker experienced a service issue. Try your call again. |
| InvalidParameterException | client | 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. |
| ResourceNotFoundException | client | The specified resource does not exist. |
| ThrottlingException | client | AWS RoboMaker is temporarily unable to process the request. Try your call again. |
| RoboMakerServiceException | Base exception class for all service exceptions from RoboMaker service. |