Class: Aws::IoTEventsData::Types::SnoozeAlarmActionRequest

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 SnoozeAlarmActionRequest data as a hash:

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

Information needed to snooze the alarm.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_model_nameString

The name of the alarm model.

Returns:

  • (String)


1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 1328

class SnoozeAlarmActionRequest < Struct.new(
  :request_id,
  :alarm_model_name,
  :key_value,
  :note,
  :snooze_duration)
  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.

Returns:

  • (String)


1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 1328

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

#noteString

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

Returns:

  • (String)


1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 1328

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

#request_idString

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

Returns:

  • (String)


1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 1328

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

#snooze_durationInteger

The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.

Returns:

  • (Integer)


1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 1328

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