aws-sdk 1.5.6 → 1.5.7

data/lib/aws/cloud_watch/alarm_history_item.rb

@@ -0,0 +1,50 @@
+# Copyright 2011-2012 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
+
+      # @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-2012 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
+
+      # @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,333 @@
+# Copyright 2011-2012 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::Client
+
+      API_VERSION = '2010-08-01'
+
+      extend Core::Client::QueryXML
+
+      # @private
+      CACHEABLE_REQUESTS = Set[
+        :describe_alarm_history,
+        :describe_alarms,
+        :describe_alarms_for_metric,
+        :list_metrics,
+      ]
+
+      ## client methods ##
+
+      # Calls the DeleteAlarms API operation.
+      # @method delete_alarms(options = {})
+      #
+      # === Options:
+      #
+      # * +:alarm_names+ - *required* - (Array<String>)
+      #
+      # === Response Structure:
+      #
+      # This method returns no response data.
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :delete_alarms, 'DeleteAlarms'
+
+      # Calls the DescribeAlarmHistory API operation.
+      # @method describe_alarm_history(options = {})
+      #
+      # === Options:
+      #
+      # * +:alarm_name+ - (String)
+      # * +:history_item_type+ - (String)
+      # * +:start_date+ - (String<ISO8601 datetime>)
+      # * +:end_date+ - (String<ISO8601 datetime>)
+      # * +:max_records+ - (Integer)
+      # * +:next_token+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:alarm_history_items+ - (Array<Hash>)
+      #   * +:alarm_name+ - (String)
+      #   * +:timestamp+ - (Time)
+      #   * +:history_item_type+ - (String)
+      #   * +:history_summary+ - (String)
+      #   * +:history_data+ - (String)
+      # * +:next_token+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :describe_alarm_history, 'DescribeAlarmHistory'
+
+      # Calls the DescribeAlarms API operation.
+      # @method describe_alarms(options = {})
+      #
+      # === Options:
+      #
+      # * +:alarm_names+ - (Array<String>)
+      # * +:alarm_name_prefix+ - (String)
+      # * +:state_value+ - (String)
+      # * +:action_prefix+ - (String)
+      # * +:max_records+ - (Integer)
+      # * +:next_token+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:metric_alarms+ - (Array<Hash>)
+      #   * +:alarm_name+ - (String)
+      #   * +:alarm_arn+ - (String)
+      #   * +:alarm_description+ - (String)
+      #   * +:alarm_configuration_updated_timestamp+ - (Time)
+      #   * +:actions_enabled+ - (Boolean)
+      #   * +:ok_actions+ - (Array<String>)
+      #   * +:alarm_actions+ - (Array<String>)
+      #   * +:insufficient_data_actions+ - (Array<String>)
+      #   * +:state_value+ - (String)
+      #   * +:state_reason+ - (String)
+      #   * +:state_reason_data+ - (String)
+      #   * +:state_updated_timestamp+ - (Time)
+      #   * +:metric_name+ - (String)
+      #   * +:namespace+ - (String)
+      #   * +:statistic+ - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - (String)
+      #     * +:value+ - (String)
+      #   * +:period+ - (Integer)
+      #   * +:unit+ - (String)
+      #   * +:evaluation_periods+ - (Integer)
+      #   * +:threshold+ - (Numeric)
+      #   * +:comparison_operator+ - (String)
+      # * +:next_token+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :describe_alarms, 'DescribeAlarms'
+
+      # Calls the DescribeAlarmsForMetric API operation.
+      # @method describe_alarms_for_metric(options = {})
+      #
+      # === Options:
+      #
+      # * +:metric_name+ - *required* - (String)
+      # * +:namespace+ - *required* - (String)
+      # * +:statistic+ - (String)
+      # * +:dimensions+ - (Array<Hash>)
+      #   * +:name+ - *required* - (String)
+      #   * +:value+ - *required* - (String)
+      # * +:period+ - (Integer)
+      # * +:unit+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:metric_alarms+ - (Array<Hash>)
+      #   * +:alarm_name+ - (String)
+      #   * +:alarm_arn+ - (String)
+      #   * +:alarm_description+ - (String)
+      #   * +:alarm_configuration_updated_timestamp+ - (Time)
+      #   * +:actions_enabled+ - (Boolean)
+      #   * +:ok_actions+ - (Array<String>)
+      #   * +:alarm_actions+ - (Array<String>)
+      #   * +:insufficient_data_actions+ - (Array<String>)
+      #   * +:state_value+ - (String)
+      #   * +:state_reason+ - (String)
+      #   * +:state_reason_data+ - (String)
+      #   * +:state_updated_timestamp+ - (Time)
+      #   * +:metric_name+ - (String)
+      #   * +:namespace+ - (String)
+      #   * +:statistic+ - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - (String)
+      #     * +:value+ - (String)
+      #   * +:period+ - (Integer)
+      #   * +:unit+ - (String)
+      #   * +:evaluation_periods+ - (Integer)
+      #   * +:threshold+ - (Numeric)
+      #   * +:comparison_operator+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :describe_alarms_for_metric, 'DescribeAlarmsForMetric'
+
+      # Calls the DisableAlarmActions API operation.
+      # @method disable_alarm_actions(options = {})
+      #
+      # === Options:
+      #
+      # * +:alarm_names+ - *required* - (Array<String>)
+      #
+      # === Response Structure:
+      #
+      # This method returns no response data.
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :disable_alarm_actions, 'DisableAlarmActions'
+
+      # Calls the EnableAlarmActions API operation.
+      # @method enable_alarm_actions(options = {})
+      #
+      # === Options:
+      #
+      # * +:alarm_names+ - *required* - (Array<String>)
+      #
+      # === Response Structure:
+      #
+      # This method returns no response data.
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :enable_alarm_actions, 'EnableAlarmActions'
+
+      # Calls the GetMetricStatistics API operation.
+      # @method get_metric_statistics(options = {})
+      #
+      # === Options:
+      #
+      # * +:namespace+ - *required* - (String)
+      # * +:metric_name+ - *required* - (String)
+      # * +:dimensions+ - (Array<Hash>)
+      #   * +:name+ - *required* - (String)
+      #   * +:value+ - *required* - (String)
+      # * +:start_time+ - *required* - (String<ISO8601 datetime>)
+      # * +:end_time+ - *required* - (String<ISO8601 datetime>)
+      # * +:period+ - *required* - (Integer)
+      # * +:statistics+ - *required* - (Array<String>)
+      # * +:unit+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:label+ - (String)
+      # * +:datapoints+ - (Array<Hash>)
+      #   * +:timestamp+ - (Time)
+      #   * +:sample_count+ - (Numeric)
+      #   * +:average+ - (Numeric)
+      #   * +:sum+ - (Numeric)
+      #   * +:minimum+ - (Numeric)
+      #   * +:maximum+ - (Numeric)
+      #   * +:unit+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :get_metric_statistics, 'GetMetricStatistics'
+
+      # Calls the ListMetrics API operation.
+      # @method list_metrics(options = {})
+      #
+      # === Options:
+      #
+      # * +:namespace+ - (String)
+      # * +:metric_name+ - (String)
+      # * +:dimensions+ - (Array<Hash>)
+      #   * +:name+ - *required* - (String)
+      #   * +:value+ - (String)
+      # * +:next_token+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:metrics+ - (Array<Hash>)
+      #   * +:namespace+ - (String)
+      #   * +:metric_name+ - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - (String)
+      #     * +:value+ - (String)
+      # * +:next_token+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :list_metrics, 'ListMetrics'
+
+      # Calls the PutMetricAlarm API operation.
+      # @method put_metric_alarm(options = {})
+      #
+      # === Options:
+      #
+      # * +:alarm_name+ - *required* - (String)
+      # * +:alarm_description+ - (String)
+      # * +:actions_enabled+ - (Boolean)
+      # * +:ok_actions+ - (Array<String>)
+      # * +:alarm_actions+ - (Array<String>)
+      # * +:insufficient_data_actions+ - (Array<String>)
+      # * +:metric_name+ - *required* - (String)
+      # * +:namespace+ - *required* - (String)
+      # * +:statistic+ - *required* - (String)
+      # * +:dimensions+ - (Array<Hash>)
+      #   * +:name+ - *required* - (String)
+      #   * +:value+ - *required* - (String)
+      # * +:period+ - *required* - (Integer)
+      # * +:unit+ - (String)
+      # * +:evaluation_periods+ - *required* - (Integer)
+      # * +:threshold+ - *required* - (Float)
+      # * +:comparison_operator+ - *required* - (String)
+      #
+      # === Response Structure:
+      #
+      # This method returns no response data.
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :put_metric_alarm, 'PutMetricAlarm'
+
+      # Calls the PutMetricData API operation.
+      # @method put_metric_data(options = {})
+      #
+      # === Options:
+      #
+      # * +:namespace+ - *required* - (String)
+      # * +:metric_data+ - *required* - (Array<Hash>)
+      #   * +:metric_name+ - *required* - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - *required* - (String)
+      #     * +:value+ - *required* - (String)
+      #   * +:timestamp+ - (String<ISO8601 datetime>)
+      #   * +:value+ - (Float)
+      #   * +:statistic_values+ - (Hash)
+      #     * +:sample_count+ - *required* - (Float)
+      #     * +:sum+ - *required* - (Float)
+      #     * +:minimum+ - *required* - (Float)
+      #     * +:maximum+ - *required* - (Float)
+      #   * +:unit+ - (String)
+      #
+      # === Response Structure:
+      #
+      # This method returns no response data.
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :put_metric_data, 'PutMetricData'
+
+      # Calls the SetAlarmState API operation.
+      # @method set_alarm_state(options = {})
+      #
+      # === Options:
+      #
+      # * +:alarm_name+ - *required* - (String)
+      # * +:state_value+ - *required* - (String)
+      # * +:state_reason+ - *required* - (String)
+      # * +:state_reason_data+ - (String)
+      #
+      # === Response Structure:
+      #
+      # This method returns no response data.
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :set_alarm_state, 'SetAlarmState'
+
+      ## end client methods ##
+
+    end
+  end
+end