aws-sdk-v1 1.52.0

data/lib/aws/cloud_search/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 'CloudSearch', 'cloud_search', 'cloudsearch'
+
+end

data/lib/aws/cloud_search/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 CloudSearch
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/cloud_trail.rb

@@ -0,0 +1,72 @@
+# 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 'aws/core'
+require 'aws/cloud_trail/config'
+
+module AWS
+
+  # This class is the starting point for working with AWS CloudTrail.
+  #
+  # To use AWS CloudTrail you must first
+  # [sign up here](http://aws.amazon.com/cloudtrail/).
+  #
+  # For more information about AWS CloudTrail:
+  #
+  # * [AWS CloudTrail](http://aws.amazon.com/cloudtrail/)
+  # * [AWS CloudTrail Documentation](http://aws.amazon.com/documentation/cloudtrail/)
+  #
+  # # Credentials
+  #
+  # You can setup default credentials for all AWS services via
+  # AWS.config:
+  #
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # Or you can set them directly on the AWS::CloudTrail interface:
+  #
+  #     ct = AWS::CloudTrail.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # # Using the Client
+  #
+  # AWS::CloudTrail does not provide higher level abstractions for CloudTrail at
+  # this time.  You can still access all of the API methods using
+  # {AWS::CloudTrail::Client}.  Here is how you access the client and make
+  # a simple request:
+  #
+  #       ct = AWS::CloudTrail.new
+  #
+  #       resp = ct.client.describe_trails
+  #       resp[:trail_list].each do |trail|
+  #          puts trail
+  #       end
+  #
+  # See {Client} for documentation on all of the supported operations.
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level CloudTrail client object
+  class CloudTrail
+
+    autoload :Client,  'aws/cloud_trail/client'
+    autoload :Errors,  'aws/cloud_trail/errors'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'cloudtrail'
+
+  end
+end

data/lib/aws/cloud_trail/client.rb

@@ -0,0 +1,35 @@
+# 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 CloudTrail
+
+    class Client < Core::QueryClient
+
+      API_VERSION = '2013-11-01'
+
+      signature_version :Version4, 'cloudtrail'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[]
+
+    end
+
+    class Client::V20131101 < Client
+
+      define_client_methods('2013-11-01')
+
+    end
+
+  end
+end

data/lib/aws/cloud_trail/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 'CloudTrail', 'cloud_trail', 'cloudtrail'
+
+end

data/lib/aws/cloud_trail/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 CloudTrail
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/cloud_watch.rb

@@ -0,0 +1,118 @@
+# 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 'aws/core'
+require 'aws/cloud_watch/config'
+
+module AWS
+
+  # This class is the starting point for working with Amazon CloudWatch.
+  #
+  # To use Amazon CloudWatch you must first
+  # [sign up here](http://aws.amazon.com/cloudwatch/).
+  #
+  # For more information about Amazon CloudWatch:
+  #
+  # * [Amazon CloudWatch](http://aws.amazon.com/cloudwatch/)
+  # * [Amazon CloudWatch Documentation](http://aws.amazon.com/documentation/cloudwatch/)
+  #
+  # # Credentials
+  #
+  # You can setup default credentials for all AWS services via
+  # AWS.config:
+  #
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # Or you can set them directly on the AWS::CloudWatch interface:
+  #
+  #     cw = AWS::CloudWatch.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # # Using the Client
+  #
+  # AWS::CloudWatch does not provide higher level abstractions for CloudWatch at
+  # this time.  You can still access all of the API methods using
+  # {AWS::CloudWatch::Client}.  Here is how you access the client and make
+  # a simple request:
+  #
+  #     cw = AWS::CloudWatch.new
+  #
+  #     resp = cw.client.describe_alarms
+  #     resp[:metric_alarms].each do |alarm|
+  #       puts alarm[:alarm_name]
+  #     end
+  #
+  # See {Client} for documentation on all of the supported operations.
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level CloudWatch client object
+  class CloudWatch
+
+    autoload :Alarm, 'aws/cloud_watch/alarm'
+    autoload :AlarmCollection, 'aws/cloud_watch/alarm_collection'
+    autoload :AlarmHistoryItem, 'aws/cloud_watch/alarm_history_item'
+    autoload :AlarmHistoryItemCollection, 'aws/cloud_watch/alarm_history_item_collection'
+    autoload :Client, 'aws/cloud_watch/client'
+    autoload :Errors, 'aws/cloud_watch/errors'
+    autoload :Metric, 'aws/cloud_watch/metric'
+    autoload :MetricCollection, 'aws/cloud_watch/metric_collection'
+    autoload :MetricAlarmCollection, 'aws/cloud_watch/metric_alarm_collection'
+    autoload :MetricStatistics, 'aws/cloud_watch/metric_statistics'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'monitoring'
+
+    # Puts data for a metric.  The metric is created if it does not already
+    # exist.
+    #
+    #     cw.put_metric_data(
+    #       :namespace => 'test/cli',
+    #       :metric_data => [
+    #         { :metric_name => 'sample', :value => 1 },
+    #         { :metric_name => 'sample', :value => 2 },
+    #         { :metric_name => 'sample', :value => 3 },
+    #         { :metric_name => 'sample', :value => 4 },
+    #         { :metric_name => 'sample', :value => 5 },
+    #       ]
+    #     )
+    #
+    # @param [Hash] options
+    # @see Client#put_metric_data
+    # @return [nil]
+    #
+    def put_metric_data options = {}
+      client.put_metric_data(options)
+      nil
+    end
+
+    # @return [AlarmCollection]
+    def alarms
+      AlarmCollection.new(:config => config)
+    end
+
+    # @return [AlarmHistoryItemCollection]
+    def alarm_history_items
+      AlarmHistoryItemCollection.new(:config => config)
+    end
+
+    # @return [MetricCollection]
+    def metrics options = {}
+      MetricCollection.new(options.merge(:config => config))
+    end
+
+  end
+end

data/lib/aws/cloud_watch/alarm.rb

@@ -0,0 +1,293 @@
+# 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
+
+    # @attr_reader [String] metric_name
+    #
+    # @attr_reader [String] namespace
+    #
+    # @attr_reader [Array<Hash>] dimensions
+    #
+    # @attr_reader [Boolean] enabled Indicates whether actions
+    #   should be executed during any changes to the alarm's state.
+    #
+    # @attr_reader [Array<String>] alarm_actions The list of actions to execute
+    #   when this alarm transitions into an ALARM state from any other
+    #   state.
+    #
+    # @attr_reader [String] arn The Amazon Resource Name (ARN) of the alarm.
+    #
+    # @attr_reader [Time] configuration_updated_timestamp
+    #   The time stamp of the last update to the alarm configuration.
+    #
+    # @attr_reader [String] description The description for the alarm.
+    #
+    # @attr_reader [String] comparison_operator The arithmetic operation to
+    #   use when comparing the specified Statistic and Threshold. The
+    #   specified Statistic value is used as the first operand.
+    #
+    # @attr_reader [Integer] evaluation_periods The number of periods over
+    #   which data is compared to the specified threshold.
+    #
+    # @attr_reader [Array<Hash>] insufficient_data_actions The list of
+    #   actions to execute when this alarm transitions into an
+    #   INSUFFICIENT_DATA state
+    #
+    # @attr_reader [Array<Hash>] ok_actions The list of actions to execute
+    #   when this alarm transitions into an OK state.
+    #
+    # @attr_reader [Integer] period The period in seconds over which the
+    #   statistic is applied.
+    #
+    # @attr_reader [String] state_reason A human-readable explanation for
+    #   the alarm's state.
+    #
+    # @attr_reader [String] state_reason_data An explanation for the alarm's
+    #   state in machine-readable JSON format.
+    #
+    # @attr_reader [Time] state_updated_timestamp When the alarm's state
+    #   last updated.
+    #
+    # @attr_reader [String] state_value The state value for the alarm.
+    #
+    # @attr_reader [Float] threshold The value against which the specified
+    #   statistic is compared.
+    #
+    # @attr_reader [String] unit The unit of the alarm's associated metric.
+    #
+    class Alarm < Core::Resource
+
+      # @api private
+      def initialize alarm_name, options = {}
+        @alarm_name = alarm_name
+        super
+      end
+
+      # @return [String]
+      attr_reader :alarm_name
+
+      alias_method :name, :alarm_name
+
+      attribute :namespace, :static => true
+
+      attribute :metric_name, :static => true
+
+      attribute :dimensions, :static => true
+
+      attribute :actions_enabled
+
+      alias_method :enabled, :actions_enabled
+
+      alias_method :enabled?, :enabled
+
+      attribute :alarm_actions
+
+      alias_method :actions, :alarm_actions
+
+      attribute :alarm_arn, :static => true
+
+      alias_method :arn, :alarm_arn
+
+      attribute :alarm_configuration_updated_timestamp
+
+      alias_method :configuration_updated_timestamp,
+        :alarm_configuration_updated_timestamp
+
+      attribute :alarm_description
+
+      alias_method :description, :alarm_description
+
+      attribute :comparison_operator
+
+      attribute :evaluation_periods
+
+      attribute :insufficient_data_actions
+
+      attribute :ok_actions
+
+      attribute :period
+
+      attribute :state_reason
+
+      attribute :state_reason_data
+
+      attribute :state_updated_timestamp
+
+      attribute :state_value
+
+      attribute :statistic
+
+      attribute :threshold
+
+      attribute :unit
+
+      populates_from :describe_alarms do |resp|
+        resp.data[:metric_alarms].find{|a| a[:alarm_name] == alarm_name }
+      end
+
+      populates_from :describe_alarms_for_metric do |resp|
+        resp.data[:metric_alarms].find{|a| a[:alarm_name] == alarm_name }
+      end
+
+      # @return [Metric]
+      def metric
+        options = {}
+        options[:dimensions] = dimensions unless dimensions.empty?
+        options[:config] = config
+        Metric.new(namespace, metric_name, options)
+      end
+
+      # Updates the metric alarm.
+      #
+      # @option options [String,required] :comparison_operator The arithmetic
+      #   operation to use when comparing the specified Statistic and
+      #   Threshold. The specified Statistic value is used as the first
+      #   operand.  Valid values include:
+      #
+      #     * 'GreaterThanOrEqualToThreshold'
+      #     * 'GreaterThanThreshold'
+      #     * 'LessThanThreshold'
+      #     * 'LessThanOrEqualToThreshold'
+      #
+      # @option options [String,required] :namespace The namespace for the
+      #   alarm's associated metric.
+      #
+      # @option options [Integer,required] :evaluation_periods The number
+      #   of periods over which data is compared to the specified threshold.
+      #
+      # @option options [Integer,required] :period The period in seconds
+      #   over which the specified statistic is applied.
+      #
+      # @option options [String,required] :statistic The statistic to apply
+      #   to the alarm's associated metric. Valid values include:
+      #
+      #     * 'SampleCount'
+      #     * 'Average'
+      #     * 'Sum'
+      #     * 'Minimum'
+      #     * 'Maximum'
+      #
+      # @option options [Number,required] :threshold The value against which
+      #   the specified statistic is compared.
+      #
+      # @option options [Array<String>] :insufficient_data_actions
+      #   The list of actions to execute when this alarm transitions into an
+      #   INSUFFICIENT_DATA state from any other state. Each action is
+      #   specified as an Amazon Resource Number (ARN). Currently the only
+      #   action supported is publishing to an Amazon SNS topic or an
+      #   Amazon Auto Scaling policy.
+      #
+      # @option options [Array<String>] :ok_actions The list of actions to
+      #   execute when this alarm transitions into an OK state from any
+      #   other state. Each action is specified as an Amazon Resource
+      #   Number (ARN). Currently the only action supported is publishing to
+      #   an Amazon SNS topic or an Amazon Auto Scaling policy.
+      #
+      # @option options [Boolean] :actions_enabled Indicates whether or not
+      #   actions should be executed during any changes to the alarm's
+      #   state.
+      #
+      # @option options [Array<String>] :alarm_actions The list of actions
+      #   to execute when this alarm transitions into an ALARM state from
+      #   any other state. Each action is specified as an Amazon Resource
+      #   Number (ARN). Currently the only action supported is publishing
+      #   to an Amazon SNS topic or an Amazon Auto Scaling policy.
+      #   Maximum of 5 alarm actions.
+      #
+      # @option options [String] :alarm_description The description for
+      #   the alarm.
+      #
+      # @option options [String] :unit The unit for the alarm's associated
+      #   metric.
+      #
+      # @return [nil]
+      def update options = {}
+        options[:alarm_name] = alarm_name
+        client.put_metric_alarm(options)
+        nil
+      end
+
+      # Deletes the current alarm.
+      # @return [nil]
+      def delete
+        client.delete_alarms(:alarm_names => [ alarm_name ])
+        nil
+      end
+
+      # Disable the current alarm actions.
+      # @return [nil]
+      def disable
+        client.disable_alarm_actions(:alarm_names => [ alarm_name ])
+        nil
+      end
+
+      # Enable the current alarm actions.
+      # @return [nil]
+      def enable
+        client.enable_alarm_actions(:alarm_names => [ alarm_name ])
+        nil
+      end
+
+      # @return [Boolean] Returns true if this alarm exists.
+      def exists?
+        !get_resource.data[:metric_alarms].empty?
+      end
+
+      # Returns a collection of the history items for current alarm.
+      # @return [AlarmHistoryItemCollection]
+      def history_items options = {}
+        AlarmHistoryItemCollection.new(:config => config).with_alarm_name(name)
+      end
+      alias_method :history, :history_items
+      alias_method :histories, :history_items
+
+      # Temporarily sets the state of current alarm.
+      # @param [String] reason The reason that this alarm is set to this
+      #   specific state (in human-readable text format).
+      #
+      # @param [String] value Valid values include:
+      #
+      #   * 'OK'
+      #   * 'ALARM'
+      #   * 'INSUFFICIENT_DATA'
+      #
+      # @param [Hash] options
+      # @option options [String] :state_reason_data The reason that this
+      #
+      #   alarm is set to this specific state (in machine-readable JSON
+      #   format)
+      #
+      # @return [nil]
+      def set_state reason, value, options = {}
+        options[:alarm_name] = alarm_name
+        options[:state_reason] = reason
+        options[:state_value] = value
+        client.set_alarm_state(options)
+        nil
+      end
+
+      protected
+
+      def resource_identifiers
+        [[:alarm_name, alarm_name]]
+      end
+
+      def get_resource attr_name = nil
+        client.describe_alarms(:alarm_names => [ alarm_name ])
+      end
+
+    end
+  end
+end