aws-sdk-cloudwatch 0.0.6 → 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 768c8e2235c9fee3921c8ceca13c009e2c4e9d29
+  data.tar.gz: 7a901c263a474f34d52ea667bdc832ddc66efc69
+SHA512:
+  metadata.gz: 3c5027e27ca59ddb602d745f7bb857196c358e43816d329456a00b15434c37174dd3e3b63d794e98a4eaa2964322a7eb8cd4f49a31e788297a5751c0e2f7d472
+  data.tar.gz: 7c0251b79e957a882637163509cb3fdcf610cb8b6dce1852a319dbaa2fea6bd91f969cfd4c3ba21da05eb715161c78f19260cd7dfa9f22a532b21f4a484710fb

data/lib/aws-sdk-cloudwatch.rb

@@ -0,0 +1,50 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+require_relative 'aws-sdk-cloudwatch/types'
+require_relative 'aws-sdk-cloudwatch/client_api'
+require_relative 'aws-sdk-cloudwatch/client'
+require_relative 'aws-sdk-cloudwatch/errors'
+require_relative 'aws-sdk-cloudwatch/waiters'
+require_relative 'aws-sdk-cloudwatch/resource'
+require_relative 'aws-sdk-cloudwatch/alarm'
+require_relative 'aws-sdk-cloudwatch/metric'
+require_relative 'aws-sdk-cloudwatch/customizations'
+
+# This module provides support for Amazon CloudWatch. This module is available in the
+# `aws-sdk-cloudwatch` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from Amazon CloudWatch all
+# extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::CloudWatch::Errors::ServiceError
+#       # rescues all service API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @service
+module Aws::CloudWatch
+
+  GEM_VERSION = '1.0.0.rc1'
+
+end

data/lib/aws-sdk-cloudwatch/alarm.rb

@@ -0,0 +1,451 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module CloudWatch
+    class Alarm
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(name, options = {})
+      #   @param [String] name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @name = extract_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def name
+        @name
+      end
+      alias :alarm_name :name
+
+      # The Amazon Resource Name (ARN) of the alarm.
+      # @return [String]
+      def alarm_arn
+        data.alarm_arn
+      end
+
+      # The description of the alarm.
+      # @return [String]
+      def alarm_description
+        data.alarm_description
+      end
+
+      # The time stamp of the last update to the alarm configuration.
+      # @return [Time]
+      def alarm_configuration_updated_timestamp
+        data.alarm_configuration_updated_timestamp
+      end
+
+      # Indicates whether actions should be executed during any changes to the
+      # alarm state.
+      # @return [Boolean]
+      def actions_enabled
+        data.actions_enabled
+      end
+
+      # The actions to execute when this alarm transitions to the `OK` state
+      # from any other state. Each action is specified as an Amazon Resource
+      # Name (ARN).
+      # @return [Array<String>]
+      def ok_actions
+        data.ok_actions
+      end
+
+      # The actions to execute when this alarm transitions to the `ALARM`
+      # state from any other state. Each action is specified as an Amazon
+      # Resource Name (ARN).
+      # @return [Array<String>]
+      def alarm_actions
+        data.alarm_actions
+      end
+
+      # The actions to execute when this alarm transitions to the
+      # `INSUFFICIENT_DATA` state from any other state. Each action is
+      # specified as an Amazon Resource Name (ARN).
+      # @return [Array<String>]
+      def insufficient_data_actions
+        data.insufficient_data_actions
+      end
+
+      # The state value for the alarm.
+      # @return [String]
+      def state_value
+        data.state_value
+      end
+
+      # An explanation for the alarm state, in text format.
+      # @return [String]
+      def state_reason
+        data.state_reason
+      end
+
+      # An explanation for the alarm state, in JSON format.
+      # @return [String]
+      def state_reason_data
+        data.state_reason_data
+      end
+
+      # The time stamp of the last update to the alarm state.
+      # @return [Time]
+      def state_updated_timestamp
+        data.state_updated_timestamp
+      end
+
+      # The name of the metric associated with the alarm.
+      # @return [String]
+      def metric_name
+        data.metric_name
+      end
+
+      # The namespace of the metric associated with the alarm.
+      # @return [String]
+      def namespace
+        data.namespace
+      end
+
+      # The statistic for the metric associated with the alarm, other than
+      # percentile. For percentile statistics, use `ExtendedStatistic`.
+      # @return [String]
+      def statistic
+        data.statistic
+      end
+
+      # The percentile statistic for the metric associated with the alarm.
+      # Specify a value between p0.0 and p100.
+      # @return [String]
+      def extended_statistic
+        data.extended_statistic
+      end
+
+      # The dimensions for the metric associated with the alarm.
+      # @return [Array<Types::Dimension>]
+      def dimensions
+        data.dimensions
+      end
+
+      # The period, in seconds, over which the statistic is applied.
+      # @return [Integer]
+      def period
+        data.period
+      end
+
+      # The unit of the metric associated with the alarm.
+      # @return [String]
+      def unit
+        data.unit
+      end
+
+      # The number of periods over which data is compared to the specified
+      # threshold.
+      # @return [Integer]
+      def evaluation_periods
+        data.evaluation_periods
+      end
+
+      # The value to compare with the specified statistic.
+      # @return [Float]
+      def threshold
+        data.threshold
+      end
+
+      # The arithmetic operation to use when comparing the specified statistic
+      # and threshold. The specified statistic value is used as the first
+      # operand.
+      # @return [String]
+      def comparison_operator
+        data.comparison_operator
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {Alarm}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     alarm.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.describe_alarms(alarm_names: [@name])
+        @data = resp.metricalarms[0]
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::MetricAlarm]
+      #   Returns the data for this {Alarm}. Calls
+      #   {Client#describe_alarms} if {#data_loaded?} is `false`.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @param [Hash] options ({})
+      # @return [Boolean]
+      #   Returns `true` if the Alarm exists.
+      def exists?(options = {})
+        begin
+          wait_until_exists(options.merge(max_attempts: 1))
+          true
+        rescue Aws::Waiters::Errors::UnexpectedError => e
+          raise e.error
+        rescue Aws::Waiters::Errors::WaiterFailed
+          false
+        end
+      end
+
+      # @param [Hash] options ({})
+      # @option options [Integer] :max_attempts (40)
+      # @option options [Float] :delay (5)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      # @return [Alarm]
+      def wait_until_exists(options = {})
+        options, params = separate_params_and_options(options)
+        waiter = Waiters::AlarmExists.new(options)
+        yield_waiter_and_warn(waiter, &Proc.new) if block_given?
+        waiter.wait(params.merge(alarm_names: [@name]))
+        Alarm.new({
+          name: @name,
+          client: @client
+        })
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   alarm.delete()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = Aws::Util.deep_merge(options, alarm_names: [@name])
+        resp = @client.delete_alarms(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   alarm.describe_history({
+      #     history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action
+      #     start_date: Time.now,
+      #     end_date: Time.now,
+      #     max_records: 1,
+      #     next_token: "NextToken",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :history_item_type
+      #   The type of alarm histories to retrieve.
+      # @option options [Time,DateTime,Date,Integer,String] :start_date
+      #   The starting date to retrieve alarm history.
+      # @option options [Time,DateTime,Date,Integer,String] :end_date
+      #   The ending date to retrieve alarm history.
+      # @option options [Integer] :max_records
+      #   The maximum number of alarm history records to retrieve.
+      # @option options [String] :next_token
+      #   The token returned by a previous call to indicate that there is more
+      #   data available.
+      # @return [Types::DescribeAlarmHistoryOutput]
+      def describe_history(options = {})
+        options = options.merge(alarm_name: @name)
+        resp = @client.describe_alarm_history(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   alarm.disable_actions()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def disable_actions(options = {})
+        options = Aws::Util.deep_merge(options, alarm_names: [@name])
+        resp = @client.disable_alarm_actions(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   alarm.enable_actions()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def enable_actions(options = {})
+        options = Aws::Util.deep_merge(options, alarm_names: [@name])
+        resp = @client.enable_alarm_actions(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   alarm.set_state({
+      #     state_value: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
+      #     state_reason: "StateReason", # required
+      #     state_reason_data: "StateReasonData",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :state_value
+      #   The value of the state.
+      # @option options [required, String] :state_reason
+      #   The reason that this alarm is set to this specific state, in text
+      #   format.
+      # @option options [String] :state_reason_data
+      #   The reason that this alarm is set to this specific state, in JSON
+      #   format.
+      # @return [EmptyStructure]
+      def set_state(options = {})
+        options = options.merge(alarm_name: @name)
+        resp = @client.set_alarm_state(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [Metric, nil]
+      def metric
+        if data.namespace && data.metric_name
+          Metric.new(
+            namespace: data.namespace,
+            name: data.metric_name,
+            client: @client
+          )
+        else
+          nil
+        end
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        { name: @name }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_name(args, options)
+        value = args[0] || options.delete(:name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :name"
+        else
+          msg = "expected :name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def yield_waiter_and_warn(waiter, &block)
+        if !@waiter_block_warned
+          msg = "pass options to configure the waiter; "
+          msg << "yielding the waiter is deprecated"
+          warn(msg)
+          @waiter_block_warned = true
+        end
+        yield(waiter.waiter)
+      end
+
+      def separate_params_and_options(options)
+        opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
+        waiter_opts = {}
+        waiter_params = {}
+        options.each_pair do |key, value|
+          if opts.include?(key)
+            waiter_opts[key] = value
+          else
+            waiter_params[key] = value
+          end
+        end
+        waiter_opts[:client] ||= @client
+        [waiter_opts, waiter_params]
+      end
+
+      class Collection < Aws::Resources::Collection
+
+        # @!group Batch Actions
+
+        # @example Request syntax with placeholder values
+        #
+        #   alarm.batch_delete!()
+        # @param options ({})
+        # @return [void]
+        def batch_delete!(options = {})
+          batch_enum.each do |batch|
+            params = Aws::Util.copy_hash(options)
+            params[:alarm_names] ||= []
+            batch.each do |item|
+              params[:alarm_names] << {
+                name: item.name
+              }
+            end
+            batch[0].client.delete_alarms(params)
+          end
+          nil
+        end
+
+        # @example Request syntax with placeholder values
+        #
+        #   alarm.batch_disable_actions()
+        # @param options ({})
+        # @return [void]
+        def batch_disable_actions(options = {})
+          batch_enum.each do |batch|
+            params = Aws::Util.copy_hash(options)
+            params[:alarm_names] ||= []
+            batch.each do |item|
+              params[:alarm_names] << {
+                name: item.name
+              }
+            end
+            batch[0].client.disable_alarm_actions(params)
+          end
+          nil
+        end
+
+        # @example Request syntax with placeholder values
+        #
+        #   alarm.batch_enable_actions()
+        # @param options ({})
+        # @return [void]
+        def batch_enable_actions(options = {})
+          batch_enum.each do |batch|
+            params = Aws::Util.copy_hash(options)
+            params[:alarm_names] ||= []
+            batch.each do |item|
+              params[:alarm_names] << {
+                name: item.name
+              }
+            end
+            batch[0].client.enable_alarm_actions(params)
+          end
+          nil
+        end
+
+        # @!endgroup
+
+      end
+    end
+  end
+end