Table Of Contents

Feedback

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 ]

describe-device

Description

Describes the device.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--next-token (string)

Next token of device description.

--device-name (string)

The unique ID of the device.

--device-fleet-name (string)

The name of the fleet the devices belong to.

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

Output

DeviceArn -> (string)

The Amazon Resource Name (ARN) of the device.

DeviceName -> (string)

The unique identifier of the device.

Description -> (string)

A description of the device.

DeviceFleetName -> (string)

The name of the fleet the device belongs to.

IotThingName -> (string)

The AWS Internet of Things (IoT) object thing name associated with the device.

RegistrationTime -> (timestamp)

The timestamp of the last registration or de-reregistration.

LatestHeartbeat -> (timestamp)

The last heartbeat received from the device.

Models -> (list)

Models on the device.

(structure)

The model on the edge device.

ModelName -> (string)

The name of the model.

ModelVersion -> (string)

The model version.

LatestSampleTime -> (timestamp)

The timestamp of the last data sample taken.

LatestInference -> (timestamp)

The timestamp of the last inference that was made.

MaxModels -> (integer)

The maximum number of models.

NextToken -> (string)

The response from the last list when returning a list large enough to need tokening.