[ aws . iotevents ]

list-detector-model-versions

Description

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--detector-model-name (string)

The name of the detector model whose versions are returned.

--next-token (string)

The token that you can use to return the next set of results.

--max-results (integer)

The maximum number of results to be returned per request.

--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 information about versions of a detector model

The following list-detector-model-versions example Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

aws iotevents list-detector-model-versions \
    --detector-model-name motorDetectorModel

Output:

{
    "detectorModelVersionSummaries": [
        {
            "status": "ACTIVE",
            "lastUpdateTime": 1560796816.077,
            "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole",
            "creationTime": 1560796816.077,
            "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel",
            "detectorModelName": "motorDetectorModel",
            "detectorModelVersion": "1"
        }
    ]
}

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

Output

detectorModelVersionSummaries -> (list)

Summary information about the detector model versions.

(structure)

Information about the detector model version.

detectorModelName -> (string)

The name of the detector model.

detectorModelVersion -> (string)

The ID of the detector model version.

detectorModelArn -> (string)

The ARN of the detector model version.

roleArn -> (string)

The ARN of the role that grants the detector model permission to perform its tasks.

creationTime -> (timestamp)

The time the detector model version was created.

lastUpdateTime -> (timestamp)

The last time the detector model version was updated.

status -> (string)

The status of the detector model version.

evaluationMethod -> (string)

Information about the order in which events are evaluated and how actions are executed.

nextToken -> (string)

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