IoT1ClickDevicesService / Paginator / ListDevices

ListDevices

class IoT1ClickDevicesService.Paginator.ListDevices

paginator = client.get_paginator('list_devices')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT1ClickDevicesService.Client.list_devices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DeviceType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

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'
            }
        },
    ],

}

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