Skip to content

AlarmState

Source code in docs_src/capo_iot_events_data/types/alarm_state.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class AlarmState(TypedDict, closed=True):
    state_name: NotRequired[
        "capo_iot_events_data.types.alarm_state_name.AlarmStateName"
    ]
    """<p>The name of the alarm state. The state name can be one of the following values:</p> <ul> <li> <p> <code>DISABLED</code> - When the alarm is in the <code>DISABLED</code> state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the <code>NORMAL</code> state.</p> </li> <li> <p> <code>NORMAL</code> - When the alarm is in the <code>NORMAL</code> state, it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVE</code> - If the alarm is in the <code>ACTIVE</code> state, the alarm is invoked.</p> </li> <li> <p> <code>ACKNOWLEDGED</code> - When the alarm is in the <code>ACKNOWLEDGED</code> state, the alarm was invoked and you acknowledged the alarm.</p> </li> <li> <p> <code>SNOOZE_DISABLED</code> - When the alarm is in the <code>SNOOZE_DISABLED</code> state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the <code>NORMAL</code> state. </p> </li> <li> <p> <code>LATCHED</code> - When the alarm is in the <code>LATCHED</code> state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the <code>NORMAL</code> state, you must acknowledge the alarm.</p> </li> </ul>"""
    rule_evaluation: NotRequired[
        "capo_iot_events_data.types.rule_evaluation.RuleEvaluation"
    ]
    """<p>Information needed to evaluate data.</p>"""
    customer_action: NotRequired[
        "capo_iot_events_data.types.customer_action.CustomerAction"
    ]
    """<p>Contains information about the action that you can take to respond to the alarm.</p>"""
    system_event: NotRequired["capo_iot_events_data.types.system_event.SystemEvent"]
    """<p>Contains information about alarm state changes.</p>"""

customer_action instance-attribute 

customer_action: NotRequired[CustomerAction]

Contains information about the action that you can take to respond to the alarm.

rule_evaluation instance-attribute 

rule_evaluation: NotRequired[RuleEvaluation]

Information needed to evaluate data.

state_name instance-attribute 

state_name: NotRequired[AlarmStateName]

The name of the alarm state. The state name can be one of the following values:

  • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

  • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

  • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

  • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

  • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

  • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

system_event instance-attribute 

system_event: NotRequired[SystemEvent]

Contains information about alarm state changes.