ManagedintegrationsforIoTDeviceManagement / Client / list_device_discoveries

list_device_discoveries

ManagedintegrationsforIoTDeviceManagement.Client.list_device_discoveries(**kwargs)

Lists all device discovery tasks, with optional filtering by type and status.

See also: AWS API Documentation

Request Syntax

response = client.list_device_discoveries(
    NextToken='string',
    MaxResults=123,
    TypeFilter='ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM',
    StatusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'
)
Parameters:

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

  • MaxResults (integer) – The maximum number of device discovery jobs to return in a single response.

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

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

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

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

Exceptions