[ aws . iotevents ]

list-detector-models

Description

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-detector-models
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 your detector models

The following list-detector-models example Lists the detector models you have created. Only the metadata associated with each detector model is returned.

aws iotevents list-detector-models

Output:

{
    "detectorModelSummaries": [
        {
            "detectorModelName": "motorDetectorModel",
            "creationTime": 1552072424.212
            "detectorModelDescription": "Detect overpressure in a motor."
        }
    ]
}

For more information, see ListDetectorModels in the AWS IoT Events API Reference.

Output

detectorModelSummaries -> (list)

Summary information about the detector models.

(structure)

Information about the detector model.

detectorModelName -> (string)

The name of the detector model.

detectorModelDescription -> (string)

A brief description of the detector model.

creationTime -> (timestamp)

The time the detector model was created.

nextToken -> (string)

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