Skip to content

TestAlarmRequest

Source code in docs_src/capo_lightsail/types/test_alarm_request.py 
14
15
16
17
18
class TestAlarmRequest(TypedDict, closed=True):
    alarm_name: "capo_lightsail.types.resource_name.ResourceName"
    """<p>The name of the alarm to test.</p>"""
    state: "capo_lightsail.types.alarm_state.AlarmState"
    """<p>The alarm state to test.</p> <p>An alarm has the following possible states that can be tested:</p> <ul> <li> <p> <code>ALARM</code> - The metric is outside of the defined threshold.</p> </li> <li> <p> <code>INSUFFICIENT_DATA</code> - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.</p> </li> <li> <p> <code>OK</code> - The metric is within the defined threshold.</p> </li> </ul>"""

alarm_name instance-attribute 

alarm_name: ResourceName

The name of the alarm to test.

state instance-attribute 

state: AlarmState

The alarm state to test.

An alarm has the following possible states that can be tested:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.