Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iotevents-data ]

describe-detector

Description

Returns information about the specified detector (instance).

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-detector
--detector-model-name <value>
[--key-value <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--detector-model-name (string)

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

--key-value (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To get information about a detector (instance)

The following describe-detector example returns information about the specified detector (instance).

aws iotevents-data describe-detector \
    --detector-model-name motorDetectorModel \
    --key-value "Fulton-A32"

Output:

{
    "detector": {
        "lastUpdateTime": 1560797852.776,
        "creationTime": 1560797852.775,
        "state": {
            "variables": [
                {
                    "name": "pressureThresholdBreached",
                    "value": "3"
                }
            ],
            "stateName": "Dangerous",
            "timers": []
        },
        "keyValue": "Fulton-A32",
        "detectorModelName": "motorDetectorModel",
        "detectorModelVersion": "1"
    }
}

For more information, see DescribeDetector in the AWS IoT Events Developer Guide*.

Output

detector -> (structure)

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 -> (structure)

The current state of the detector (instance).

stateName -> (string)

The name of the state.

variables -> (list)

The current values of the detector's variables.

(structure)

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.

(structure)

The current state of a timer.

name -> (string)

The name of the timer.

timestamp -> (timestamp)

The number of seconds which have elapsed on the timer.

creationTime -> (timestamp)

The time the detector (instance) was created.

lastUpdateTime -> (timestamp)

The time the detector (instance) was last updated.