list_detectors

IoTEventsData.Client.list_detectors(**kwargs)

Lists detectors (the instances of a detector model).

See also: AWS API Documentation

Request Syntax

response = client.list_detectors(
    detectorModelName='string',
    stateName='string',
    nextToken='string',
    maxResults=123
)

Parameters

• detectorModelName (string) --

  [REQUIRED]

  The name of the detector model whose detectors (instances) are listed.

• stateName (string) -- A filter that limits results to those detectors (instances) in the given state.
• nextToken (string) -- The token that you can use to return the next set of results.
• maxResults (integer) -- The maximum number of results to be returned per request.

Return type

dict

Returns

Response Syntax

{
    'detectorSummaries': [
        {
            'detectorModelName': 'string',
            'keyValue': 'string',
            'detectorModelVersion': 'string',
            'state': {
                'stateName': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • detectorSummaries (list) --

    A list of summary information about the detectors (instances).

    • (dict) --

      Information about the detector (instance).

      • detectorModelName (string) --

        The name of the detector model that created this detector (instance).

      • keyValue (string) --

        The value of the key (identifying the device or system) that caused the creation of this detector (instance).

      • detectorModelVersion (string) --

        The version of the detector model that created this detector (instance).

      • state (dict) --

        The current state of the detector (instance).

        • stateName (string) --

          The name of the state.

      • creationTime (datetime) --

        The time the detector (instance) was created.

      • lastUpdateTime (datetime) --

        The time the detector (instance) was last updated.

  • nextToken (string) --

    The token that you can use to return the next set of results, or null if there are no more results.

Exceptions

• IoTEventsData.Client.exceptions.InvalidRequestException
• IoTEventsData.Client.exceptions.ResourceNotFoundException
• IoTEventsData.Client.exceptions.ThrottlingException
• IoTEventsData.Client.exceptions.InternalFailureException
• IoTEventsData.Client.exceptions.ServiceUnavailableException