[ aws . robomaker ]

describe-fleet

Description

Describes a fleet.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-fleet
--fleet <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--fleet (string)

The Amazon Resource Name (ARN) of the fleet.

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

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a fleet

The following describe-fleet example retrieves the details for the specified fleet.

aws robomaker describe-fleet \
    --fleet arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1550771358907

Output:

{
    "name": "MyFleet",
    "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1539894765711",
    "robots": [
        {
            "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1540834232469",
            "createdAt": 1540834232.0
        },
        {
            "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyOtherRobot/1540829698778",
            "createdAt": 1540829698.0
        }
    ],
    "createdAt": 1539894765.0,
    "lastDeploymentStatus": "Succeeded",
    "lastDeploymentJob": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-xl8qssl6pbcn",
    "lastDeploymentTime": 1551218369.0,
    "tags": {}
}

Output

name -> (string)

The name of the fleet.

arn -> (string)

The Amazon Resource Name (ARN) of the fleet.

robots -> (list)

A list of robots.

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

createdAt -> (timestamp)

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

lastDeploymentStatus -> (string)

The status of the last deployment.

lastDeploymentJob -> (string)

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

lastDeploymentTime -> (timestamp)

The time of the last deployment.

tags -> (map)

The list of all tags added to the specified fleet.

key -> (string)

value -> (string)