Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]



Describes a fleet.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--device-fleet-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--device-fleet-name (string)

The name of the fleet.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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


DeviceFleetArn -> (string)

The Amazon Resource Name (ARN) of the device.

DeviceFleetName -> (string)

The name of the fleet.

OutputConfig -> (structure)

The output configuration for storing sample data collected by the fleet.

S3OutputLocation -> (string)

The Amazon Simple Storage (S3) bucker URI.

KmsKeyId -> (string)

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

Description -> (string)

Description of the fleet.

ReportGenerated -> (timestamp)

Timestamp of when the report was generated.

DeviceStats -> (structure)

Status of devices.

ConnectedDeviceCount -> (long)

The number of devices connected with a heartbeat.

RegisteredDeviceCount -> (long)

The number of registered devices.

AgentVersions -> (list)

The versions of Edge Manager agent deployed on the fleet.


Edge Manager agent version.

Version -> (string)

Version of the agent.

AgentCount -> (long)

The number of Edge Manager agents.

ModelStats -> (list)

Status of model on device.


Status of edge devices with this model.

ModelName -> (string)

The name of the model.

ModelVersion -> (string)

The model version.

OfflineDeviceCount -> (long)

The number of devices that have this model version and do not have a heart beat.

ConnectedDeviceCount -> (long)

The number of devices that have this model version and have a heart beat.

ActiveDeviceCount -> (long)

The number of devices that have this model version, a heart beat, and are currently running.

SamplingDeviceCount -> (long)

The number of devices with this model version and are producing sample data.