aws-sdk-cloudwatch 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5ad96e6f40e11b5d0c3ac8ee265062d86016a4e
-  data.tar.gz: 3e566eb6c5b91db87fd791d10cee75cc1dd4b1d6
+  metadata.gz: 908663d3ebfefebfab82ffd7ad6adf6d0428c3d6
+  data.tar.gz: fd8affb66effb122a2e0c07e8bd14d1c0dd91a5b
 SHA512:
-  metadata.gz: 97a0a0abb744e4a242cfe59696c50c0856f82a48ca3d23413dd9b049809bdc235d6e3d88c28c0be038fef895770a828aca870b8a650196c2c30839240a194cde
-  data.tar.gz: 0dde929b2df8d15b2000bb6dde09fc8d976070ad5996ba69e3b6e7177311206c900124bfec7ca2a8542871d8f4488800f03ec00e3c9c86766bc1ac6ee816c1d2
+  metadata.gz: 8dafde20f958c1af6019f1a1065d4d69aa88002a5adc0f4427498d5efbf857a883b2f25d88974c0f371f3175cba6f8c5a80161bc2f56c476ff81f5089df9c509
+  data.tar.gz: 4e00ad385dde879c99dd658bbb51b21e5eea00fb00455f1833302f2988b3868b79490c73aa546892b53e87b5116cc27426fecf55a3a8bbf727f7e682be042e92

data/lib/aws-sdk-cloudwatch.rb

@@ -45,6 +45,6 @@ require_relative 'aws-sdk-cloudwatch/customizations'
 # @service
 module Aws::CloudWatch
 
-  GEM_VERSION = '1.1.0'
+  GEM_VERSION = '1.2.0'
 
 end

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

@@ -34,26 +34,26 @@ module Aws::CloudWatch
     # The Amazon Resource Name (ARN) of the alarm.
     # @return [String]
     def alarm_arn
-      data.alarm_arn
+      data[:alarm_arn]
     end
 
     # The description of the alarm.
     # @return [String]
     def alarm_description
-      data.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
+      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
+      data[:actions_enabled]
     end
 
     # The actions to execute when this alarm transitions to the `OK` state
@@ -61,7 +61,7 @@ module Aws::CloudWatch
     # Name (ARN).
     # @return [Array<String>]
     def ok_actions
-      data.ok_actions
+      data[:ok_actions]
     end
 
     # The actions to execute when this alarm transitions to the `ALARM`
@@ -69,7 +69,7 @@ module Aws::CloudWatch
     # Resource Name (ARN).
     # @return [Array<String>]
     def alarm_actions
-      data.alarm_actions
+      data[:alarm_actions]
     end
 
     # The actions to execute when this alarm transitions to the
@@ -77,88 +77,88 @@ module Aws::CloudWatch
     # specified as an Amazon Resource Name (ARN).
     # @return [Array<String>]
     def insufficient_data_actions
-      data.insufficient_data_actions
+      data[:insufficient_data_actions]
     end
 
     # The state value for the alarm.
     # @return [String]
     def state_value
-      data.state_value
+      data[:state_value]
     end
 
     # An explanation for the alarm state, in text format.
     # @return [String]
     def state_reason
-      data.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
+      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
+      data[:state_updated_timestamp]
     end
 
     # The name of the metric associated with the alarm.
     # @return [String]
     def metric_name
-      data.metric_name
+      data[:metric_name]
     end
 
     # The namespace of the metric associated with the alarm.
     # @return [String]
     def namespace
-      data.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
+      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
+      data[:extended_statistic]
     end
 
     # The dimensions for the metric associated with the alarm.
     # @return [Array<Types::Dimension>]
     def dimensions
-      data.dimensions
+      data[:dimensions]
     end
 
     # The period, in seconds, over which the statistic is applied.
     # @return [Integer]
     def period
-      data.period
+      data[:period]
     end
 
     # The unit of the metric associated with the alarm.
     # @return [String]
     def unit
-      data.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
+      data[:evaluation_periods]
     end
 
     # The value to compare with the specified statistic.
     # @return [Float]
     def threshold
-      data.threshold
+      data[:threshold]
     end
 
     # The arithmetic operation to use when comparing the specified statistic
@@ -166,14 +166,14 @@ module Aws::CloudWatch
     # operand.
     # @return [String]
     def comparison_operator
-      data.comparison_operator
+      data[:comparison_operator]
     end
 
     # Sets how this alarm is to handle missing data points. If this
     # parameter is omitted, the default behavior of `missing` is used.
     # @return [String]
     def treat_missing_data
-      data.treat_missing_data
+      data[:treat_missing_data]
     end
 
     # Used only for alarms based on percentiles. If `ignore`, the alarm
@@ -183,7 +183,7 @@ module Aws::CloudWatch
     # matter how many data points are available.
     # @return [String]
     def evaluate_low_sample_count_percentile
-      data.evaluate_low_sample_count_percentile
+      data[:evaluate_low_sample_count_percentile]
     end
 
     # @!endgroup
@@ -252,6 +252,101 @@ module Aws::CloudWatch
       })
     end
 
+    # @deprecated Use [Aws::CloudWatch::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Actions
 
     # @example Request syntax with placeholder values
@@ -342,10 +437,10 @@ module Aws::CloudWatch
 
     # @return [Metric, nil]
     def metric
-      if data.namespace && data.metric_name
+      if data[:namespace] && data[:metric_name]
         Metric.new(
-          namespace: data.namespace,
-          name: data.metric_name,
+          namespace: data[:namespace],
+          name: data[:metric_name],
           client: @client
         )
       else

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

@@ -1261,7 +1261,7 @@ module Aws::CloudWatch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatch'
-      context[:gem_version] = '1.1.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -42,7 +42,7 @@ module Aws::CloudWatch
     # The dimensions for the metric.
     # @return [Array<Types::Dimension>]
     def dimensions
-      data.dimensions
+      data[:dimensions]
     end
 
     # @!endgroup
@@ -83,6 +83,101 @@ module Aws::CloudWatch
       !!@data
     end
 
+    # @deprecated Use [Aws::CloudWatch::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Actions
 
     # @example Request syntax with placeholder values

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core