File: set_alarm_state.rb

package info (click to toggle)
ruby-fog-aws 3.18.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,140 kB
  • sloc: ruby: 73,328; javascript: 14; makefile: 9; sh: 4
file content (30 lines) | stat: -rw-r--r-- 1,033 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
module Fog
  module AWS
    class CloudWatch
      class Real
        require 'fog/aws/parsers/cloud_watch/set_alarm_state'

        # Temporarily sets the state of an alarm
        # ==== Options
        # * AlarmName<~String>: The names of the alarm
        # * StateReason<~String>: The reason that this alarm is set to this specific state (in human-readable text format)
        # * StateReasonData<~String>: The reason that this alarm is set to this specific state (in machine-readable JSON format)
        # * StateValue<~String>: The value of the state
        #
        # ==== Returns
        # * response<~Excon::Response>:
        #
        # ==== See Also
        # http://docs.amazonwebservices.com/AmazonCloudWatch/latest/APIReference/API_SetAlarmState.html
        #

        def set_alarm_state(options)
          request({
              'Action'    => 'SetAlarmState',
              :parser     => Fog::Parsers::AWS::CloudWatch::SetAlarmState.new
            }.merge(options))
        end
      end
    end
  end
end