Class: Aws::IoTEventsData::Types::AcknowledgeAlarmActionRequest

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

Overview

Note:

When making an API call, you may pass AcknowledgeAlarmActionRequest data as a hash:

{
  request_id: "RequestId", # required
  alarm_model_name: "AlarmModelName", # required
  key_value: "KeyValue",
  note: "Note",
}

Information needed to acknowledge the alarm.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_model_name ⇒ String

The name of the alarm model.

Returns:

  • (String) 


58
59
60
61
62
63
64
65
 
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 58

class AcknowledgeAlarmActionRequest < Struct.new(
  :request_id,
  :alarm_model_name,
  :key_value,
  :note)
  SENSITIVE = []
  include Aws::Structure
end

#key_value ⇒ String

The value of the key used as a filter to select only the alarms associated with the key.

Returns:

  • (String) 


58
59
60
61
62
63
64
65
 
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 58

class AcknowledgeAlarmActionRequest < Struct.new(
  :request_id,
  :alarm_model_name,
  :key_value,
  :note)
  SENSITIVE = []
  include Aws::Structure
end

#note ⇒ String

The note that you can leave when you acknowledge the alarm.

Returns:

  • (String) 


58
59
60
61
62
63
64
65
 
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 58

class AcknowledgeAlarmActionRequest < Struct.new(
  :request_id,
  :alarm_model_name,
  :key_value,
  :note)
  SENSITIVE = []
  include Aws::Structure
end

#request_id ⇒ String

The request ID. Each ID must be unique within each batch.

Returns:

  • (String) 


58
59
60
61
62
63
64
65
 
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 58

class AcknowledgeAlarmActionRequest < Struct.new(
  :request_id,
  :alarm_model_name,
  :key_value,
  :note)
  SENSITIVE = []
  include Aws::Structure
end