Skip to content

Alarm

Source code in docs_src/capo_iot_events_data/types/alarm.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class Alarm(TypedDict, closed=True):
    alarm_model_name: NotRequired[
        "capo_iot_events_data.types.alarm_model_name.AlarmModelName"
    ]
    """<p>The name of the alarm model.</p>"""
    alarm_model_version: NotRequired[
        "capo_iot_events_data.types.alarm_model_version.AlarmModelVersion"
    ]
    """<p>The version of the alarm model.</p>"""
    key_value: NotRequired["capo_iot_events_data.types.key_value.KeyValue"]
    """<p>The value of the key used as a filter to select only the alarms associated with the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>"""
    alarm_state: NotRequired["capo_iot_events_data.types.alarm_state.AlarmState"]
    """<p>Contains information about the current state of the alarm.</p>"""
    severity: NotRequired["capo_iot_events_data.types.severity.Severity"]
    """<p>A non-negative integer that reflects the severity level of the alarm.</p>"""
    creation_time: NotRequired["capo_iot_events_data.types.timestamp.Timestamp"]
    """<p>The time the alarm was created, in the Unix epoch format.</p>"""
    last_update_time: NotRequired["capo_iot_events_data.types.timestamp.Timestamp"]
    """<p>The time the alarm was last updated, in the Unix epoch format.</p>"""

alarm_model_name instance-attribute 

alarm_model_name: NotRequired[AlarmModelName]

The name of the alarm model.

alarm_model_version instance-attribute 

alarm_model_version: NotRequired[AlarmModelVersion]

The version of the alarm model.

alarm_state instance-attribute 

alarm_state: NotRequired[AlarmState]

Contains information about the current state of the alarm.

creation_time instance-attribute 

creation_time: NotRequired[Timestamp]

The time the alarm was created, in the Unix epoch format.

key_value instance-attribute 

key_value: NotRequired[KeyValue]

The value of the key used as a filter to select only the alarms associated with the key.

last_update_time instance-attribute 

last_update_time: NotRequired[Timestamp]

The time the alarm was last updated, in the Unix epoch format.

severity instance-attribute 

severity: NotRequired[Severity]

A non-negative integer that reflects the severity level of the alarm.