[ aws . iot1click-devices ]

list-devices

Description

Lists the 1-Click compatible devices associated with your AWS account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-devices is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Devices

Synopsis

  list-devices
[--device-type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--device-type (string)

The type of the device, such as “button”.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To list the devices of a specified type

The following list-devices example lists the devices of a specified type.

aws iot1click-devices list-devices \
    --device-type button

This command produces no output.

Output:

{
    "Devices": [
        {
            "remainingLife": 99.9,
            "attributes": {
                "arn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
                "type": "button",
                "deviceId": "G030PM0123456789",
                "enabled": false
            }
        }
    ]
}

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

Output

Devices -> (list)

A list of devices.

(structure)

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)

NextToken -> (string)

The token to retrieve the next set of results.