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 . iot1click-devices ]



Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


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


--device-id (string)

The unique identifier of the device.

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


To describe a device

The following describe-device example describes the specified device.

aws iot1click-devices describe-device \
    --device-id G030PM0123456789


    "DeviceDescription": {
        "Arn": "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789",
        "Attributes": {
            "projectRegion": "us-west-2",
            "projectName": "AnytownDumpsters",
            "placementName": "customer217",
            "deviceTemplateName": "empty-dumpster-request"
        "DeviceId": "G030PM0123456789",
        "Enabled": false,
        "RemainingLife": 99.9,
        "Type": "button",
        "Tags": {}

For more information, see Using AWS IoT 1-Click with the AWS CLI in the AWS IoT 1-Click Developer Guide.


DeviceDescription -> (structure)

Device details.

Arn -> (string)

The ARN of the device.

Attributes -> (map)

An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.

key -> (string)

value -> (string)

DeviceId -> (string)

The unique identifier of the device.

Enabled -> (boolean)

A Boolean value indicating whether or not the device is enabled.

RemainingLife -> (double)

A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

Type -> (string)

The type of the device, such as "button".

Tags -> (map)

The tags currently associated with the AWS IoT 1-Click device.

key -> (string)

value -> (string)