BehaviorCriteria ¶

class BehaviorCriteria(TypedDict, closed=True):
    comparison_operator: NotRequired[
        "capo_iot.types.comparison_operator.ComparisonOperator"
    ]
    """<p>The operator that relates the thing measured (<code>metric</code>) to the criteria (containing a <code>value</code> or <code>statisticalThreshold</code>). Valid operators include:</p> <ul> <li> <p> <code>string-list</code>: <code>in-set</code> and <code>not-in-set</code> </p> </li> <li> <p> <code>number-list</code>: <code>in-set</code> and <code>not-in-set</code> </p> </li> <li> <p> <code>ip-address-list</code>: <code>in-cidr-set</code> and <code>not-in-cidr-set</code> </p> </li> <li> <p> <code>number</code>: <code>less-than</code>, <code>less-than-equals</code>, <code>greater-than</code>, and <code>greater-than-equals</code> </p> </li> </ul>"""
    value: NotRequired["capo_iot.types.metric_value.MetricValue"]
    """<p>The value to be compared with the <code>metric</code>.</p>"""
    duration_seconds: NotRequired["capo_iot.types.duration_seconds.DurationSeconds"]
    """<p>Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, <code>NUM_MESSAGES_SENT</code>). For a <code>statisticalThreshhold</code> 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.</p>"""
    consecutive_datapoints_to_alarm: NotRequired[
        "capo_iot.types.consecutive_datapoints_to_alarm.ConsecutiveDatapointsToAlarm"
    ]
    """<p>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.</p>"""
    consecutive_datapoints_to_clear: NotRequired[
        "capo_iot.types.consecutive_datapoints_to_clear.ConsecutiveDatapointsToClear"
    ]
    """<p>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.</p>"""
    statistical_threshold: NotRequired[
        "capo_iot.types.statistical_threshold.StatisticalThreshold"
    ]
    """<p>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.</p>"""
    ml_detection_config: NotRequired[
        "capo_iot.types.machine_learning_detection_config.MachineLearningDetectionConfig"
    ]
    """<p> The configuration of an ML Detect </p>"""