Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotevents-data ]

list-detectors

Description

Lists detectors (the instances of a detector model).

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-detectors
--detector-model-name <value>
[--state-name <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--detector-model-name (string)

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

--state-name (string)

A filter that limits results to those detectors (instances) in the given state.

--next-token (string)

The token for the next set of results.

--max-results (integer)

The maximum number of results to return at one time.

--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 a list of detectors for a detector model

The following list-detectors example lists detectors (the instances of a detector model).

aws iotevents-data list-detectors \
    --detector-model-name motorDetectorModel

Output:

{
    "detectorSummaries": [
        {
            "lastUpdateTime": 1558129925.2,
            "creationTime": 1552073155.527,
            "state": {
                "stateName": "Normal"
            },
            "keyValue": "Fulton-A32",
            "detectorModelName": "motorDetectorModel",
            "detectorModelVersion": "1"
        }
    ]
}

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

Output

detectorSummaries -> (list)

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

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

creationTime -> (timestamp)

The time the detector (instance) was created.

lastUpdateTime -> (timestamp)

The time the detector (instance) was last updated.

nextToken -> (string)

A token to retrieve the next set of results, or null if there are no additional results.