ManagedintegrationsforIoTDeviceManagement / Paginator / ListDiscoveredDevices

ListDiscoveredDevices¶

class ManagedintegrationsforIoTDeviceManagement.Paginator.ListDiscoveredDevices¶

paginator = client.get_paginator('list_discovered_devices')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

Identifier (string) –
[REQUIRED]

The identifier of the device discovery job to list discovered devices for.
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': [
        {
            'ConnectorDeviceId': 'string',
            'ConnectorDeviceName': 'string',
            'DeviceTypes': [
                'string',
            ],
            'ManagedThingId': 'string',
            'Modification': 'DISCOVERED'|'UPDATED'|'NO_CHANGE',
            'DiscoveredAt': datetime(2015, 1, 1),
            'Brand': 'string',
            'Model': 'string',
            'AuthenticationMaterial': 'string'
        },
    ],

}

Response Structure

(dict) –
- Items (list) –
  
  The list of discovered devices that match the specified criteria.
  - (dict) –
    
    Structure containing summary information about a device discovered during a device discovery job.
    - ConnectorDeviceId (string) –
      
      The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII).
    - ConnectorDeviceName (string) –
      
      The name of the device as defined by the connector or third-party system.
    - DeviceTypes (list) –
      
      The list of device types or categories that the discovered device belongs to.
      - (string) –
    - ManagedThingId (string) –
      
      The identifier of the managed thing created for this discovered device, if one exists.
    - Modification (string) –
      
      The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.
    - DiscoveredAt (datetime) –
      
      The timestamp indicating when the device was discovered.
    - Brand (string) –
      
      The brand of the discovered device.
    - Model (string) –
      
      The model of the discovered device.
    - AuthenticationMaterial (string) –
      
      The authentication material required for connecting to the discovered device, such as credentials or tokens.