Behavior ¶

class Behavior(TypedDict, closed=True):
    name: "capo_iot.types.behavior_name.BehaviorName"
    """<p>The name you've given to the behavior.</p>"""
    metric: NotRequired["capo_iot.types.behavior_metric.BehaviorMetric"]
    """<p>What is measured by the behavior.</p>"""
    metric_dimension: NotRequired["capo_iot.types.metric_dimension.MetricDimension"]
    """<p>The dimension for a metric in your behavior. For example, using a <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.</p>"""
    criteria: NotRequired["capo_iot.types.behavior_criteria.BehaviorCriteria"]
    """<p>The criteria that determine if a device is behaving normally in regard to the <code>metric</code>.</p> <note> <p>In the IoT console, you can choose to be sent an alert through Amazon SNS when IoT Device Defender detects that a device is behaving anomalously.</p> </note>"""
    suppress_alerts: NotRequired["capo_iot.types.suppress_alerts.SuppressAlerts"]
    """<p> Suppresses alerts. </p>"""
    export_metric: NotRequired["capo_iot.types.export_metric.ExportMetric"]
    """<p>Value indicates exporting metrics related to the behavior when it is true.</p>"""