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 | --cli-input-yaml]
[--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 | --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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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 Amazon Web Services 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.
AgentVersion -> (string)
Edge Manager agent version.