IoT1ClickDevicesService / Paginator / ListDeviceEvents

ListDeviceEvents

class IoT1ClickDevicesService.Paginator.ListDeviceEvents

paginator = client.get_paginator('list_device_events')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DeviceId='string',
    FromTimeStamp=datetime(2015, 1, 1),
    ToTimeStamp=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DeviceId (string) –

  [REQUIRED]

  The unique identifier of the device.

• FromTimeStamp (datetime) –

  [REQUIRED]

  The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

• ToTimeStamp (datetime) –

  [REQUIRED]

  The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

• 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

{
    'Events': [
        {
            'Device': {
                'Attributes': {},
                'DeviceId': 'string',
                'Type': 'string'
            },
            'StdEvent': 'string'
        },
    ],

}

Response Structure

• (dict) –

  200 response

  • Events (list) –

    An array of zero or more elements describing the event(s) associated with the device.

    • (dict) –

      • Device (dict) –

        An object representing the device associated with the event.

        • Attributes (dict) –

          The user specified attributes associated with the device for an event.

        • DeviceId (string) –

          The unique identifier of the device.

        • Type (string) –

          The device type, such as “button”.

      • StdEvent (string) –

        A serialized JSON object representing the device-type specific event.