Skip to content

ViolationEvent

Source code in docs_src/capo_iot/types/violation_event.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
class ViolationEvent(TypedDict, closed=True):
    violation_id: NotRequired["capo_iot.types.violation_id.ViolationId"]
    """<p>The ID of the violation event.</p>"""
    thing_name: NotRequired[
        "capo_iot.types.device_defender_thing_name.DeviceDefenderThingName"
    ]
    """<p>The name of the thing responsible for the violation event.</p>"""
    security_profile_name: NotRequired[
        "capo_iot.types.security_profile_name.SecurityProfileName"
    ]
    """<p>The name of the security profile whose behavior was violated.</p>"""
    behavior: NotRequired["capo_iot.types.behavior.Behavior"]
    """<p>The behavior that was violated.</p>"""
    metric_value: NotRequired["capo_iot.types.metric_value.MetricValue"]
    """<p>The value of the metric (the measurement).</p>"""
    violation_event_additional_info: NotRequired[
        "capo_iot.types.violation_event_additional_info.ViolationEventAdditionalInfo"
    ]
    """<p> The details of a violation event. </p>"""
    violation_event_type: NotRequired[
        "capo_iot.types.violation_event_type.ViolationEventType"
    ]
    """<p>The type of 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>"""
    violation_event_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The time the violation event occurred.</p>"""

behavior instance-attribute 

behavior: NotRequired[Behavior]

The behavior that was violated.

metric_value instance-attribute 

metric_value: NotRequired[MetricValue]

The value of the metric (the measurement).

security_profile_name instance-attribute 

security_profile_name: NotRequired[SecurityProfileName]

The name of the security profile whose behavior was violated.

thing_name instance-attribute 

thing_name: NotRequired[DeviceDefenderThingName]

The name of the thing responsible for the violation event.

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_event_time instance-attribute 

violation_event_time: NotRequired[Timestamp]

The time the violation event occurred.

violation_event_type instance-attribute 

violation_event_type: NotRequired[ViolationEventType]

The type of violation event.

violation_id instance-attribute 

violation_id: NotRequired[ViolationId]

The ID of the violation event.