Skip to content

ActiveViolation

Source code in docs_src/capo_iot/types/active_violation.py
class ActiveViolation(TypedDict, closed=True):
    violation_id: NotRequired["capo_iot.types.violation_id.ViolationId"]
    """<p>The ID of the active violation.</p>"""
    thing_name: NotRequired[
        "capo_iot.types.device_defender_thing_name.DeviceDefenderThingName"
    ]
    """<p>The name of the thing responsible for the active violation.</p>"""
    security_profile_name: NotRequired[
        "capo_iot.types.security_profile_name.SecurityProfileName"
    ]
    """<p>The security profile with the behavior is in violation.</p>"""
    behavior: NotRequired["capo_iot.types.behavior.Behavior"]
    """<p>The behavior that is being violated.</p>"""
    last_violation_value: NotRequired["capo_iot.types.metric_value.MetricValue"]
    """<p>The value of the metric (the measurement) that caused the most recent violation.</p>"""
    violation_event_additional_info: NotRequired[
        "capo_iot.types.violation_event_additional_info.ViolationEventAdditionalInfo"
    ]
    """<p> The details of a violation event. </p>"""
    verification_state: NotRequired[
        "capo_iot.types.verification_state.VerificationState"
    ]
    """<p>The verification state of the violation (detect alarm).</p>"""
    verification_state_description: NotRequired[
        "capo_iot.types.verification_state_description.VerificationStateDescription"
    ]
    """<p>The description of the verification state of the violation.</p>"""
    last_violation_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The time the most recent violation occurred.</p>"""
    violation_start_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The time the violation started.</p>"""

behavior instance-attribute

behavior: NotRequired[Behavior]

The behavior that is being violated.

last_violation_time instance-attribute

last_violation_time: NotRequired[Timestamp]

The time the most recent violation occurred.

last_violation_value instance-attribute

last_violation_value: NotRequired[MetricValue]

The value of the metric (the measurement) that caused the most recent violation.

security_profile_name instance-attribute

security_profile_name: NotRequired[SecurityProfileName]

The security profile with the behavior is in violation.

thing_name instance-attribute

thing_name: NotRequired[DeviceDefenderThingName]

The name of the thing responsible for the active violation.

verification_state instance-attribute

verification_state: NotRequired[VerificationState]

The verification state of the violation (detect alarm).

verification_state_description instance-attribute

verification_state_description: NotRequired[VerificationStateDescription]

The description of the verification state of the violation.

violation_event_additional_info instance-attribute

violation_event_additional_info: NotRequired[ViolationEventAdditionalInfo]

The details of a violation event.

violation_id instance-attribute

violation_id: NotRequired[ViolationId]

The ID of the active violation.

violation_start_time instance-attribute

violation_start_time: NotRequired[Timestamp]

The time the violation started.