aws-sdk-v1 1.52.0

data/lib/aws/cloud_watch/alarm_collection.rb

@@ -0,0 +1,153 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+
+    # # AlarmCollection
+    #
+    # Represents alarms for an AWS account.
+    #
+    # ## Getting an alarm by name
+    #
+    # If you know the name of the alarm, you can get a reference using
+    # the {#[]} method.
+    #
+    #     cw = AWS::CloudWatch.new
+    #     alarm = cw.alarms['alarm-name']
+    #
+    # ## Enumerating Alarms
+    #
+    # You can enumerate all alarms using each (or any of the
+    # methods defined in {Core::Collection}).
+    #
+    #     cw.alarms.each do |alarm|
+    #       puts alarm.name
+    #     end
+    #
+    # ## Filtering Alarms
+    #
+    # Use one of the filtering methods to reduce the number of alarms
+    # returned.
+    #
+    #     cw.alarms.with_name_prefix('some-prefix-').each {|alarm| ... }
+    #
+    class AlarmCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      def initialize options = {}
+        @filters = options[:filters] || {}
+        super
+      end
+
+      # @param [String] alarm_name
+      # @return [Alarm]
+      def [] alarm_name
+        Alarm.new(alarm_name, :config => config)
+      end
+
+      # Creates an alarm and associates it with the specified metric.
+      #
+      # @param [String] alarm_name The descriptive name for the alarm.
+      #   This name must be unique within the user's AWS account.
+      # @param [Hash] options
+      # @option options [String,required] :namespace The namespace for the
+      #   alarm's associated metric.
+      # @option options [String,required] :metric_name The name for the
+      #   alarm's associated metric.
+      # @option options [Array<Hash>] :dimensions The dimensions for the
+      #   alarm's associated metric.  Each dimension must specify a
+      #   `:name` and a `:value`.
+      # @option (see Alarm#update)
+      # @return [Alarm]
+      def create alarm_name, options = {}
+        options[:alarm_name] = alarm_name
+        client.put_metric_alarm(options)
+        self[alarm_name]
+      end
+
+      # Delete one or more alarms by name.
+      #
+      #     cloud_watch.alarms.delete('alarm1', 'alarm2')
+      #
+      # @param [String,Array<String>] alarm_names
+      # @return [nil]
+      def delete *alarm_names
+        client.delete_alarms(:alarm_names => alarm_names.flatten)
+        nil
+      end
+
+      # Returns a new collection with the given filter.
+      # @param [String,Symbol] name
+      # @param [String,Integer] value
+      # @return [Alarm]
+      def filter name, value
+        filters = @filters.merge(name.to_s.to_sym => value)
+        AlarmCollection.new(:filters => filters, :config => config)
+      end
+
+      # @param [String] prefix
+      # @return [MetricAlarmCollection]
+      def with_action_prefix prefix
+        filter(:action_prefix, prefix)
+      end
+
+      # @param [String] prefix The alarm name prefix.
+      # @return [MetricAlarmCollection]
+      def with_name_prefix prefix
+        filter(:alarm_name_prefix, prefix)
+      end
+
+      # @param [String,Array<String>] names A list of alarm names to
+      #   retrieve information for.
+      # @return [MetricAlarmCollection]
+      def with_name *names
+        filter(:alarm_names, names.flatten)
+      end
+
+      # @param [String] state The state value to be used in matching alarms.
+      # @return [MetricAlarmCollection]
+      def with_state_value state
+        filter(:state_value, state)
+      end
+
+      protected
+
+      def _each_item next_token, limit, options = {}, &block
+
+        options = @filters.merge(options)
+
+        options[:next_token] = next_token if next_token
+        options[:max_records] = limit if limit
+
+        resp = client.describe_alarms(options)
+        resp.data[:metric_alarms].each do |details|
+
+          alarm = Alarm.new_from(
+            :describe_alarms,
+            details,
+            details[:alarm_name],
+            :config => config)
+
+          yield(alarm)
+
+        end
+
+        resp.data[:next_token]
+
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_watch/alarm_history_item.rb

@@ -0,0 +1,50 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+    class AlarmHistoryItem
+
+      # @api private
+      def initialize options
+        @alarm_name = options[:alarm_name]
+        @history_data = options[:history_data]
+        @history_item_type = options[:history_item_type]
+        @history_summary = options[:history_summary]
+        @timestamp = options[:timestamp]
+      end
+
+      # @return [String] The descriptive name for the alarm.
+      attr_reader :alarm_name
+
+      # @return [String] Machine-readable data about the alarm in JSON format.
+      attr_reader :history_data
+
+      alias_method :data, :history_data
+
+      # @return [String] The type of alarm history item.
+      attr_reader :history_item_type
+
+      alias_method :type, :history_item_type
+
+      # @return [String] A human-readable summary of the alarm history.
+      attr_reader :history_summary
+
+      alias_method :summary, :history_summary
+
+      # @return [Time] The time stamp for the alarm history item.
+      attr_reader :timestamp
+
+    end
+  end
+end

data/lib/aws/cloud_watch/alarm_history_item_collection.rb

@@ -0,0 +1,84 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'date'
+require 'time'
+
+module AWS
+  class CloudWatch
+    class AlarmHistoryItemCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      # @api private
+      def initialize options = {}
+        @filters = options[:filters] || {}
+        super
+      end
+
+      # @param [String,Symbol] name
+      # @param [String] value
+      # @return [AlarmHistoryItemCollection]
+      def filter name, value
+        filters = @filters.merge(name.to_s.to_sym => value)
+        AlarmHistoryItemCollection.new(:filters => filters, :config => config)
+      end
+
+      # @param [String] name
+      # @return [AlarmHistoryItemCollection]
+      def with_alarm_name name
+        filter(:alarm_name, name)
+      end
+
+      # @param [Time,DateTime,String<ISO8601>] date
+      # @return [AlarmHistoryItemCollection]
+      def with_start_date date
+        date = date.iso8601 if date.respond_to?(:iso8601)
+        filter(:start_date, date)
+      end
+
+      # @param [Time,DateTime,String<ISO8601>] date
+      # @return [AlarmHistoryItemCollection]
+      def with_end_date date
+        date = date.iso8601 if date.respond_to?(:iso8601)
+        filter(:end_date, date)
+      end
+
+      # @param [String] type
+      # @return [AlarmHistoryItemCollection]
+      def with_type type
+        filter(:history_item_type, type)
+      end
+
+      protected
+
+      def _each_item next_token, limit, options = {}, &block
+
+        options = @filters.merge(options)
+        options[:max_records] = limit if limit
+        options[:next_token] = next_token if next_token
+
+        resp = client.describe_alarm_history(options)
+        resp.data[:alarm_history_items].each do |details|
+
+          yield(AlarmHistoryItem.new(details))
+
+        end
+
+       resp.data[:next_token]
+
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_watch/client.rb

@@ -0,0 +1,40 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+
+    # Client class for Cloud Watch
+    class Client < Core::QueryClient
+
+      API_VERSION = '2010-08-01'
+
+      signature_version :Version4, 'monitoring'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[
+        :describe_alarm_history,
+        :describe_alarms,
+        :describe_alarms_for_metric,
+        :list_metrics,
+      ]
+
+    end
+
+    class Client::V20100801 < Client
+
+      define_client_methods('2010-08-01')
+
+    end
+  end
+end

data/lib/aws/cloud_watch/config.rb

@@ -0,0 +1,18 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'CloudWatch', 'cloud_watch', 'monitoring'
+
+end

data/lib/aws/cloud_watch/errors.rb

@@ -0,0 +1,22 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/cloud_watch/metric.rb

@@ -0,0 +1,135 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'date'
+require 'time'
+
+module AWS
+  class CloudWatch
+
+    # # Metric
+    #
+    # Represents a single metric.
+    #
+    class Metric < Core::Resource
+
+      # @param [String] namespace The metric namespace.
+      # @param [String] metric_name The metric name.
+      # @param [Hash] options
+      # @option options [Array<Hash>] :dimensions An array of dimensions.
+      #   Each hash must have a `:name` and a `value` key (with string values).
+      def initialize namespace, metric_name, options = {}
+        @namespace = namespace
+        @metric_name = metric_name
+        @dimensions = options[:dimensions] || []
+        super
+      end
+
+      # @return [String]
+      attr_reader :namespace
+
+      # @return [String]
+      attr_reader :metric_name
+
+      alias_method :name, :metric_name
+
+      # @return [Array<Hash>]
+      attr_reader :dimensions
+
+      # @return [MetricAlarmCollection]
+      def alarms
+        MetricAlarmCollection.new(self, :config => config)
+      end
+
+      # Publishes metric data points to Amazon CloudWatch.
+      # @param [Array<Hash>] metric_data An array of hashes.  Each hash
+      #   must pass `:value` (number) or `:statistic_values` (hash).
+      # @return [nil]
+      def put_data *metric_data
+
+        metric_opts = {}
+        metric_opts[:metric_name] = metric_name
+        metric_opts[:dimensions] = dimensions unless dimensions.empty?
+
+        options = {}
+        options[:namespace] = namespace
+        options[:metric_data] = metric_data.flatten.map do |data|
+          data.merge(metric_opts)
+        end
+
+        client.put_metric_data(options)
+        nil
+
+      end
+
+      # Gets statistics for this metric.
+      #
+      #     metric = CloudWatch::Metric.new('my/namepace', 'metric-name')
+      #
+      #     stats = metric.statistics(
+      #       :start_time => Time.now - 3600,
+      #       :end_time => Time.now,
+      #       :statistics => ['Average'])
+      #
+      #     stats.label #=> 'some-label'
+      #     stats.each do |datapoint|
+      #       # datapoint is a hash
+      #     end
+      #
+      # @param [Hash] options
+      # @option options [Time,required] :start_time
+      # @option options [Time,required] :end_time
+      # @option options [Array<String>,required] :statistics
+      # @option options [String] :unit
+      # @option options [Integer] :period (60)
+      # @return [MetricStatistics]
+      def statistics options = {}
+
+        start = options.delete(:start_time)
+        stop = options.delete(:end_time)
+
+        options[:namespace] = namespace
+        options[:metric_name] = metric_name
+        options[:dimensions] = dimensions unless dimensions.empty?
+        options[:start_time] = start.respond_to?(:iso8601) ? start.iso8601 : start
+        options[:end_time] = stop.respond_to?(:iso8601) ? stop.iso8601 : stop
+        options[:period] ||= 60
+
+        resp = client.get_metric_statistics(options)
+
+        MetricStatistics.new(self, resp[:label], resp[:datapoints])
+
+      end
+
+      # @return [Boolean] Returns `true` if this metric exists.
+      def exists?
+        !get_resource.data[:metrics].empty?
+      end
+
+      protected
+
+      def resource_identifiers
+        [
+          [:namespace, namespace],
+          [:metric_name, metric_name],
+          [:dimensions, dimensions],
+        ]
+      end
+
+      def get_resource attr_name = nil
+        client.list_metrics(resource_options)
+      end
+
+    end
+  end
+end