ManagedintegrationsforIoTDeviceManagement / Client / list_discovered_devices

list_discovered_devices

ManagedintegrationsforIoTDeviceManagement.Client.list_discovered_devices(**kwargs)

Lists all devices discovered during a specific device discovery task.

See also: AWS API Documentation

Request Syntax

response = client.list_discovered_devices(
    Identifier='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Identifier (string) –

    [REQUIRED]

    The identifier of the device discovery job to list discovered devices for.

  • NextToken (string) – A token used for pagination of results.

  • MaxResults (integer) – The maximum number of discovered devices to return in a single 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'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      A token used for pagination of results when there are more discovered devices than can be returned in a single response.

Exceptions