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

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

Overview

Information needed to acknowledge the alarm.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_model_nameString

The name of the alarm model.

Returns:

  • (String)


48
49
50
51
52
53
54
55
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 48

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

#key_valueString

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)


48
49
50
51
52
53
54
55
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 48

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

#noteString

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

Returns:

  • (String)


48
49
50
51
52
53
54
55
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 48

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

#request_idString

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

Returns:

  • (String)


48
49
50
51
52
53
54
55
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 48

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