AlexaForBusiness / Paginator / SearchDevices

SearchDevices

class AlexaForBusiness.Paginator.SearchDevices

paginator = client.get_paginator('search_devices')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

    • Key (string) – [REQUIRED]

      The key of a filter.

    • Values (list) – [REQUIRED]

      The values of a filter.

      • (string) –

• SortCriteria (list) –

  The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

  • (dict) –

    An object representing a sort criteria.

    • Key (string) – [REQUIRED]

      The sort key of a sort object.

    • Value (string) – [REQUIRED]

      The sort value of a sort object.

• 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': [
        {
            'DeviceArn': 'string',
            'DeviceSerialNumber': 'string',
            'DeviceType': 'string',
            'DeviceName': 'string',
            'SoftwareVersion': 'string',
            'MacAddress': 'string',
            'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED'|'FAILED',
            'NetworkProfileArn': 'string',
            'NetworkProfileName': 'string',
            'RoomArn': 'string',
            'RoomName': 'string',
            'DeviceStatusInfo': {
                'DeviceStatusDetails': [
                    {
                        'Feature': 'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'NETWORK_PROFILE'|'SETTINGS'|'ALL',
                        'Code': 'DEVICE_SOFTWARE_UPDATE_NEEDED'|'DEVICE_WAS_OFFLINE'|'CREDENTIALS_ACCESS_FAILURE'|'TLS_VERSION_MISMATCH'|'ASSOCIATION_REJECTION'|'AUTHENTICATION_FAILURE'|'DHCP_FAILURE'|'INTERNET_UNAVAILABLE'|'DNS_FAILURE'|'UNKNOWN_FAILURE'|'CERTIFICATE_ISSUING_LIMIT_EXCEEDED'|'INVALID_CERTIFICATE_AUTHORITY'|'NETWORK_PROFILE_NOT_FOUND'|'INVALID_PASSWORD_STATE'|'PASSWORD_NOT_FOUND'|'PASSWORD_MANAGER_ACCESS_DENIED'|'CERTIFICATE_AUTHORITY_ACCESS_DENIED'
                    },
                ],
                'ConnectionStatus': 'ONLINE'|'OFFLINE',
                'ConnectionStatusUpdatedTime': datetime(2015, 1, 1)
            },
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'TotalCount': 123
}

Response Structure

• (dict) –

  • Devices (list) –

    The devices that meet the specified set of filter criteria, in sort order.

    • (dict) –

      Device attributes.

      • DeviceArn (string) –

        The ARN of a device.

      • DeviceSerialNumber (string) –

        The serial number of a device.

      • DeviceType (string) –

        The type of a device.

      • DeviceName (string) –

        The name of a device.

      • SoftwareVersion (string) –

        The software version of a device.

      • MacAddress (string) –

        The MAC address of a device.

      • DeviceStatus (string) –

        The status of a device.

      • NetworkProfileArn (string) –

        The ARN of the network profile associated with a device.

      • NetworkProfileName (string) –

        The name of the network profile associated with a device.

      • RoomArn (string) –

        The room ARN associated with a device.

      • RoomName (string) –

        The name of the room associated with a device.

      • DeviceStatusInfo (dict) –

        Detailed information about a device’s status.

        • DeviceStatusDetails (list) –

          One or more device status detail descriptions.

          • (dict) –

            Details of a device’s status.

            • Feature (string) –

              The list of available features on the device.

            • Code (string) –

              The device status detail code.

        • ConnectionStatus (string) –

          The latest available information about the connection status of a device.

        • ConnectionStatusUpdatedTime (datetime) –

          The time (in epoch) when the device connection status changed.

      • CreatedTime (datetime) –

        The time (in epoch) when the device data was created.

  • TotalCount (integer) –

    The total number of devices returned.