IoT1ClickDevicesService / Client / list_devices

list_devices#

IoT1ClickDevicesService.Client.list_devices(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_devices(
    DeviceType='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DeviceType (string) – The type of the device, such as “button”.

  • MaxResults (integer) – The maximum number of results to return per request. If not set, a default value of 100 is used.

  • NextToken (string) – The token to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'Devices': [
        {
            'Arn': 'string',
            'Attributes': {
                'string': 'string'
            },
            'DeviceId': 'string',
            'Enabled': True|False,
            'RemainingLife': 123.0,
            'Type': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    200 response

    • Devices (list) –

      A list of devices.

      • (dict) –

        • Arn (string) –

          The ARN of the device.

        • Attributes (dict) –

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

          • (string) –

            • (string) –

        • DeviceId (string) –

          The unique identifier of the device.

        • Enabled (boolean) –

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

        • RemainingLife (float) –

          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 (dict) –

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

          • (string) –

            • (string) –

    • NextToken (string) –

      The token to retrieve the next set of results.

Exceptions

  • IoT1ClickDevicesService.Client.exceptions.RangeNotSatisfiableException

  • IoT1ClickDevicesService.Client.exceptions.InvalidRequestException

  • IoT1ClickDevicesService.Client.exceptions.InternalFailureException