Skip to content

/AWS1/CL_IOTBEHAVIORCRITERIA

The criteria by which the behavior is determined to be normal.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_comparisonoperator TYPE /AWS1/IOTCOMPARISONOPERATOR /AWS1/IOTCOMPARISONOPERATOR

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set

  • number-list: in-set and not-in-set

  • ip-address-list: in-cidr-set and not-in-cidr-set

  • number: less-than, less-than-equals, greater-than, and greater-than-equals

io_value TYPE REF TO /AWS1/CL_IOTMETRICVALUE /AWS1/CL_IOTMETRICVALUE

The value to be compared with the metric.

iv_durationseconds TYPE /AWS1/IOTDURATIONSECONDS /AWS1/IOTDURATIONSECONDS

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

iv_conseqdatapointstoalarm TYPE /AWS1/IOTCONSEQDATAPTSTOALARM /AWS1/IOTCONSEQDATAPTSTOALARM

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

iv_conseqdatapointstoclear TYPE /AWS1/IOTCONSEQDATAPTSTOCLEAR /AWS1/IOTCONSEQDATAPTSTOCLEAR

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

io_statisticalthreshold TYPE REF TO /AWS1/CL_IOTSTATLTHRESHOLD /AWS1/CL_IOTSTATLTHRESHOLD

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

io_mldetectionconfig TYPE REF TO /AWS1/CL_IOTMLDETECTIONCONFIG /AWS1/CL_IOTMLDETECTIONCONFIG

The configuration of an ML Detect

Queryable Attributes

comparisonOperator

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set

  • number-list: in-set and not-in-set

  • ip-address-list: in-cidr-set and not-in-cidr-set

  • number: less-than, less-than-equals, greater-than, and greater-than-equals

Accessible with the following methods

Method Description
GET_COMPARISONOPERATOR() Getter for COMPARISONOPERATOR, with configurable default
ASK_COMPARISONOPERATOR() Getter for COMPARISONOPERATOR w/ exceptions if field has no
HAS_COMPARISONOPERATOR() Determine if COMPARISONOPERATOR has a value

value

The value to be compared with the metric.

Accessible with the following methods

Method Description
GET_VALUE() Getter for VALUE

durationSeconds

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

Accessible with the following methods

Method Description
GET_DURATIONSECONDS() Getter for DURATIONSECONDS, with configurable default
ASK_DURATIONSECONDS() Getter for DURATIONSECONDS w/ exceptions if field has no val
HAS_DURATIONSECONDS() Determine if DURATIONSECONDS has a value

consecutiveDatapointsToAlarm

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

Accessible with the following methods

Method Description
GET_CONSEQDATAPOINTSTOALARM() Getter for CONSECUTIVEDATAPOINTSTOALARM, with configurable d
ASK_CONSEQDATAPOINTSTOALARM() Getter for CONSECUTIVEDATAPOINTSTOALARM w/ exceptions if fie
HAS_CONSEQDATAPOINTSTOALARM() Determine if CONSECUTIVEDATAPOINTSTOALARM has a value

consecutiveDatapointsToClear

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

Accessible with the following methods

Method Description
GET_CONSEQDATAPOINTSTOCLEAR() Getter for CONSECUTIVEDATAPOINTSTOCLEAR, with configurable d
ASK_CONSEQDATAPOINTSTOCLEAR() Getter for CONSECUTIVEDATAPOINTSTOCLEAR w/ exceptions if fie
HAS_CONSEQDATAPOINTSTOCLEAR() Determine if CONSECUTIVEDATAPOINTSTOCLEAR has a value

statisticalThreshold

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Accessible with the following methods

Method Description
GET_STATISTICALTHRESHOLD() Getter for STATISTICALTHRESHOLD

mlDetectionConfig

The configuration of an ML Detect

Accessible with the following methods

Method Description
GET_MLDETECTIONCONFIG() Getter for MLDETECTIONCONFIG