[ aws . alexaforbusiness ]

get-device

Description

Gets the details of a device by device ARN.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-device
[--device-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--device-arn (string)

The ARN of the device for which to request details. Required.

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

Device -> (structure)

The details of the device requested. Required.

DeviceArn -> (string)

The ARN of a device.

DeviceSerialNumber -> (string)

The serial number of a device.

DeviceType -> (string)

The type of a device.

DeviceName -> (string)

The name of a device.

SoftwareVersion -> (string)

The software version of a device.

MacAddress -> (string)

The MAC address of a device.

RoomArn -> (string)

The room ARN of a device.

DeviceStatus -> (string)

The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.

DeviceStatusInfo -> (structure)

Detailed information about a device’s status.

DeviceStatusDetails -> (list)

One or more device status detail descriptions.

(structure)

Details of a device’s status.

Feature -> (string)

The list of available features on the device.

Code -> (string)

The device status detail code.

ConnectionStatus -> (string)

The latest available information about the connection status of a device.

ConnectionStatusUpdatedTime -> (timestamp)

The time (in epoch) when the device connection status changed.

NetworkProfileInfo -> (structure)

Detailed information about a device’s network profile.

NetworkProfileArn -> (string)

The ARN of the network profile associated with a device.

CertificateArn -> (string)

The ARN of the certificate associated with a device.

CertificateExpirationTime -> (timestamp)

The time (in epoch) when the certificate expires.