Skip to content

DescribeAlarmRequest

Source code in docs_src/capo_iot_events_data/types/describe_alarm_request.py 
12
13
14
15
16
class DescribeAlarmRequest(TypedDict, closed=True):
    alarm_model_name: "capo_iot_events_data.types.alarm_model_name.AlarmModelName"
    """<p>The name 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_model_name instance-attribute 

alarm_model_name: AlarmModelName

The name of the alarm model.

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.