ManagedintegrationsforIoTDeviceManagement / Paginator / ListDeviceDiscoveries

ListDeviceDiscoveries

class ManagedintegrationsforIoTDeviceManagement.Paginator.ListDeviceDiscoveries

paginator = client.get_paginator('list_device_discoveries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ManagedintegrationsforIoTDeviceManagement.Client.list_device_discoveries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TypeFilter='ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM',
    StatusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• TypeFilter (string) – The discovery type to filter device discovery jobs by.

• StatusFilter (string) – The status to filter device discovery jobs by.

• 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

{
    'Items': [
        {
            'Id': 'string',
            'DiscoveryType': 'ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM',
            'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'
        },
    ],

}

Response Structure

• (dict) –

  • Items (list) –

    The list of device discovery jobs that match the specified criteria.

    • (dict) –

      Structure containing summary information about a device discovery job, including its identifier, type, and status.

      • Id (string) –

        The unique identifier of the device discovery job.

      • DiscoveryType (string) –

        The type of discovery process used to find devices.

      • Status (string) –

        The current status of the device discovery job.