Class: Aws::IoTEventsData::Types::DisableAlarmActionRequest

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

Overview

Note:

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

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

Information used to disable 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) 


1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 1031

class DisableAlarmActionRequest < 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].

[1]: docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key

Returns:

  • (String) 


1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 1031

class DisableAlarmActionRequest < 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 disable the alarm.

Returns:

  • (String) 


1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 1031

class DisableAlarmActionRequest < 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) 


1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 1031

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