Skip to content

SetAlarmStateInput

Source code in docs_src/capo_cloudwatch/types/set_alarm_state_input.py 
16
17
18
19
20
21
22
23
24
25
26
class SetAlarmStateInput(TypedDict, closed=True):
    alarm_name: NotRequired["capo_cloudwatch.types.alarm_name.AlarmName"]
    """<p>The name of the alarm.</p>"""
    state_value: NotRequired["capo_cloudwatch.types.state_value.StateValue"]
    """<p>The value of the state.</p>"""
    state_reason: NotRequired["capo_cloudwatch.types.state_reason.StateReason"]
    """<p>The reason that this alarm is set to this specific state, in text format.</p>"""
    state_reason_data: NotRequired[
        "capo_cloudwatch.types.state_reason_data.StateReasonData"
    ]
    """<p>The reason that this alarm is set to this specific state, in JSON format.</p> <p>For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.</p>"""

alarm_name instance-attribute 

alarm_name: NotRequired[AlarmName]

The name of the alarm.

state_reason instance-attribute 

state_reason: NotRequired[StateReason]

The reason that this alarm is set to this specific state, in text format.

state_reason_data instance-attribute 

state_reason_data: NotRequired[StateReasonData]

The reason that this alarm is set to this specific state, in JSON format.

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

state_value instance-attribute 

state_value: NotRequired[StateValue]

The value of the state.