DescribeFleetCommand

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

Example Syntax

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

import { RoboMakerClient, DescribeFleetCommand } from "@aws-sdk/client-robomaker"; // ES Modules import
// const { RoboMakerClient, DescribeFleetCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import
const client = new RoboMakerClient(config);
const input = { // DescribeFleetRequest
  fleet: "STRING_VALUE", // required
};
const command = new DescribeFleetCommand(input);
const response = await client.send(command);
// { // DescribeFleetResponse
//   name: "STRING_VALUE",
//   arn: "STRING_VALUE",
//   robots: [ // Robots
//     { // Robot
//       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"),
//     },
//   ],
//   createdAt: new Date("TIMESTAMP"),
//   lastDeploymentStatus: "Pending" || "Preparing" || "InProgress" || "Failed" || "Succeeded" || "Canceled",
//   lastDeploymentJob: "STRING_VALUE",
//   lastDeploymentTime: new Date("TIMESTAMP"),
//   tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
// };

DescribeFleetCommand Input

See DescribeFleetCommandInput for more details

Parameter
Type
Description
fleet
Required
string | undefined

The Amazon Resource Name (ARN) of the fleet.

DescribeFleetCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
arn
string | undefined

The Amazon Resource Name (ARN) of the fleet.

createdAt
Date | undefined

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

lastDeploymentJob
string | undefined

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

lastDeploymentStatus
DeploymentStatus | undefined

The status of the last deployment.

lastDeploymentTime
Date | undefined

The time of the last deployment.

name
string | undefined

The name of the fleet.

robots
Robot[] | undefined

A list of robots.

tags
Record<string, string> | undefined

The list of all tags added to the specified fleet.

Throws

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.