Class: Aws::IoTEventsData::Types::CustomerAction

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ioteventsdata/types.rb

Overview

Contains information about the action that you can take to respond to the alarm.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#acknowledge_action_configuration ⇒ Types::AcknowledgeActionConfiguration

Contains the configuration information of an acknowledge action.

Returns:



569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 569

class CustomerAction < Struct.new(
  :action_name,
  :snooze_action_configuration,
  :enable_action_configuration,
  :disable_action_configuration,
  :acknowledge_action_configuration,
  :reset_action_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#action_name ⇒ String

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.

[1]: docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 569

class CustomerAction < Struct.new(
  :action_name,
  :snooze_action_configuration,
  :enable_action_configuration,
  :disable_action_configuration,
  :acknowledge_action_configuration,
  :reset_action_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#disable_action_configuration ⇒ Types::DisableActionConfiguration

Contains the configuration information of a disable action.

Returns:



569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 569

class CustomerAction < Struct.new(
  :action_name,
  :snooze_action_configuration,
  :enable_action_configuration,
  :disable_action_configuration,
  :acknowledge_action_configuration,
  :reset_action_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enable_action_configuration ⇒ Types::EnableActionConfiguration

Contains the configuration information of an enable action.

Returns:



569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 569

class CustomerAction < Struct.new(
  :action_name,
  :snooze_action_configuration,
  :enable_action_configuration,
  :disable_action_configuration,
  :acknowledge_action_configuration,
  :reset_action_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#reset_action_configuration ⇒ Types::ResetActionConfiguration

Contains the configuration information of a reset action.

Returns:



569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 569

class CustomerAction < Struct.new(
  :action_name,
  :snooze_action_configuration,
  :enable_action_configuration,
  :disable_action_configuration,
  :acknowledge_action_configuration,
  :reset_action_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snooze_action_configuration ⇒ Types::SnoozeActionConfiguration

Contains the configuration information of a snooze action.

Returns:



569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 569

class CustomerAction < Struct.new(
  :action_name,
  :snooze_action_configuration,
  :enable_action_configuration,
  :disable_action_configuration,
  :acknowledge_action_configuration,
  :reset_action_configuration)
  SENSITIVE = []
  include Aws::Structure
end