Skip to content

CustomerAction

Source code in docs_src/capo_iot_events_data/types/customer_action.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class CustomerAction(TypedDict, closed=True):
    action_name: NotRequired[
        "capo_iot_events_data.types.customer_action_name.CustomerActionName"
    ]
    """<p>The name of the action. The action name can be one of the following values:</p> <ul> <li> <p> <code>SNOOZE</code> - When you snooze the alarm, the alarm state changes to <code>SNOOZE_DISABLED</code>.</p> </li> <li> <p> <code>ENABLE</code> - When you enable the alarm, the alarm state changes to <code>NORMAL</code>.</p> </li> <li> <p> <code>DISABLE</code> - When you disable the alarm, the alarm state changes to <code>DISABLED</code>.</p> </li> <li> <p> <code>ACKNOWLEDGE</code> - When you acknowledge the alarm, the alarm state changes to <code>ACKNOWLEDGED</code>.</p> </li> <li> <p> <code>RESET</code> - When you reset the alarm, the alarm state changes to <code>NORMAL</code>.</p> </li> </ul> <p>For more information, see the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html">AlarmState</a> API.</p>"""
    snooze_action_configuration: NotRequired[
        "capo_iot_events_data.types.snooze_action_configuration.SnoozeActionConfiguration"
    ]
    """<p>Contains the configuration information of a snooze action.</p>"""
    enable_action_configuration: NotRequired[
        "capo_iot_events_data.types.enable_action_configuration.EnableActionConfiguration"
    ]
    """<p>Contains the configuration information of an enable action.</p>"""
    disable_action_configuration: NotRequired[
        "capo_iot_events_data.types.disable_action_configuration.DisableActionConfiguration"
    ]
    """<p>Contains the configuration information of a disable action.</p>"""
    acknowledge_action_configuration: NotRequired[
        "capo_iot_events_data.types.acknowledge_action_configuration.AcknowledgeActionConfiguration"
    ]
    """<p>Contains the configuration information of an acknowledge action.</p>"""
    reset_action_configuration: NotRequired[
        "capo_iot_events_data.types.reset_action_configuration.ResetActionConfiguration"
    ]
    """<p>Contains the configuration information of a reset action.</p>"""

acknowledge_action_configuration instance-attribute 

acknowledge_action_configuration: NotRequired[AcknowledgeActionConfiguration]

Contains the configuration information of an acknowledge action.

action_name instance-attribute 

action_name: NotRequired[CustomerActionName]

The name of the action. The action name can be one of the following values:

  • SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.

  • ENABLE - When you enable the alarm, the alarm state changes to NORMAL.

  • DISABLE - When you disable the alarm, the alarm state changes to DISABLED.

  • ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.

  • RESET - When you reset the alarm, the alarm state changes to NORMAL.

For more information, see the AlarmState API.

disable_action_configuration instance-attribute 

disable_action_configuration: NotRequired[DisableActionConfiguration]

Contains the configuration information of a disable action.

enable_action_configuration instance-attribute 

enable_action_configuration: NotRequired[EnableActionConfiguration]

Contains the configuration information of an enable action.

reset_action_configuration instance-attribute 

reset_action_configuration: NotRequired[ResetActionConfiguration]

Contains the configuration information of a reset action.

snooze_action_configuration instance-attribute 

snooze_action_configuration: NotRequired[SnoozeActionConfiguration]

Contains the configuration information of a snooze action.