AlexaForBusiness / Paginator / ListDeviceEvents

ListDeviceEvents

class AlexaForBusiness.Paginator.ListDeviceEvents

paginator = client.get_paginator('list_device_events')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DeviceArn='string',
    EventType='CONNECTION_STATUS'|'DEVICE_STATUS',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DeviceArn (string) –

  [REQUIRED]

  The ARN of a device.

• EventType (string) – The event type to filter device events. If EventType isn’t specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

• 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

{
    'DeviceEvents': [
        {
            'Type': 'CONNECTION_STATUS'|'DEVICE_STATUS',
            'Value': 'string',
            'Timestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • DeviceEvents (list) –

    The device events requested for the device ARN.

    • (dict) –

      The list of device events.

      • Type (string) –

        The type of device event.

      • Value (string) –

        The value of the event.

      • Timestamp (datetime) –

        The time (in epoch) when the event occurred.