IoTEventsData / Client / describe_detector

describe_detector#

IoTEventsData.Client.describe_detector(**kwargs)#

Returns information about the specified detector (instance).

See also: AWS API Documentation

Request Syntax

response = client.describe_detector(
    detectorModelName='string',
    keyValue='string'
)
Parameters:

  • detectorModelName (string) –

    [REQUIRED]

    The name of the detector model whose detectors (instances) you want information about.

  • keyValue (string) – A filter used to limit results to detectors (instances) created because of the given key ID.

Return type:

dict

Returns:

Response Syntax

{
    'detector': {
        'detectorModelName': 'string',
        'keyValue': 'string',
        'detectorModelVersion': 'string',
        'state': {
            'stateName': 'string',
            'variables': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'timers': [
                {
                    'name': 'string',
                    'timestamp': datetime(2015, 1, 1)
                },
            ]
        },
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • detector (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.

        • variables (list) –

          The current values of the detector’s variables.

          • (dict) –

            The current state of the variable.

            • name (string) –

              The name of the variable.

            • value (string) –

              The current value of the variable.

        • timers (list) –

          The current state of the detector’s timers.

          • (dict) –

            The current state of a timer.

            • name (string) –

              The name of the timer.

            • timestamp (datetime) –

              The expiration time for the timer.

      • creationTime (datetime) –

        The time the detector (instance) was created.

      • lastUpdateTime (datetime) –

        The time the detector (instance) was last updated.

Exceptions