aws-sdk-ecr 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22d1ed8cf01031d960bf658999fea1378f262100
-  data.tar.gz: 0c312cf8cc0510fc830636d58d01b9e160ce7a30
+  metadata.gz: 695a39bbac45848e68529621e4d9914c9035d255
+  data.tar.gz: 871c57b7957fc8678eff180170ffe4e0b8678b10
 SHA512:
-  metadata.gz: f5709aa80ad1be5cfb01e1fb6023942cc1fb51c8bb3d82c165ff7858669b2508d161d6341d63802780fc237b322b21ab0f5bdf86b9ee78a906af7355132dc18e
-  data.tar.gz: 50e44ff1e8f59bb27c63146e66f2aafada56eeb40ba43dc50460ed2d95d0af0b87c7da3d9cbc8b26e3084bfe7262823bfc4b7278427f365c5a40a89eec19d05a
+  metadata.gz: 4417785f27ea27c21593d4d4ce20c75bc2b966848a4176602a9392bdcf031a59c4a6d1aaa34c41eb710ff204b16c48c9da7eac7a2863cc3227eed330837b1491
+  data.tar.gz: 7026b8dcee205e6c4d058eba05fbd7ac2c91b76e071c8ed8f9b3c25fad39c673ea854f783659cccba518ac4802b17861d5fdb0cfa1fcf2148b25c64a4a235f2b

data/lib/aws-sdk-ecr.rb

@@ -12,6 +12,7 @@ require_relative 'aws-sdk-ecr/types'
 require_relative 'aws-sdk-ecr/client_api'
 require_relative 'aws-sdk-ecr/client'
 require_relative 'aws-sdk-ecr/errors'
+require_relative 'aws-sdk-ecr/waiters'
 require_relative 'aws-sdk-ecr/resource'
 require_relative 'aws-sdk-ecr/customizations'
 
@@ -42,6 +43,6 @@ require_relative 'aws-sdk-ecr/customizations'
 # @service
 module Aws::ECR
 
-  GEM_VERSION = '1.23.0'
+  GEM_VERSION = '1.24.0'
 
 end

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

@@ -2065,14 +2065,129 @@ module Aws::ECR
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ecr'
-      context[:gem_version] = '1.23.0'
+      context[:gem_version] = '1.24.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
+    # Polls an API operation until a resource enters a desired state.
+    #
+    # ## Basic Usage
+    #
+    # A waiter will call an API operation until:
+    #
+    # * It is successful
+    # * It enters a terminal state
+    # * It makes the maximum number of attempts
+    #
+    # In between attempts, the waiter will sleep.
+    #
+    #     # polls in a loop, sleeping between attempts
+    #     client.wait_until(waiter_name, params)
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. You can pass
+    # configuration as the final arguments hash.
+    #
+    #     # poll for ~25 seconds
+    #     client.wait_until(waiter_name, params, {
+    #       max_attempts: 5,
+    #       delay: 5,
+    #     })
+    #
+    # ## 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
+    #     client.wait_until(waiter_name, params, {
+    #
+    #       # disable max attempts
+    #       max_attempts: nil,
+    #
+    #       # poll for 1 hour, instead of a number of attempts
+    #       before_wait: -> (attempts, response) do
+    #         throw :failure if Time.now - started_at > 3600
+    #       end
+    #     })
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is unsuccessful, it will raise an error.
+    # All of the failure errors extend from
+    # {Aws::Waiters::Errors::WaiterFailed}.
+    #
+    #     begin
+    #       client.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    # ## Valid Waiters
+    #
+    # The following table lists the valid waiter names, the operations they call,
+    # and the default `:delay` and `:max_attempts` values.
+    #
+    # | waiter_name                       | params                          | :delay   | :max_attempts |
+    # | --------------------------------- | ------------------------------- | -------- | ------------- |
+    # | image_scan_complete               | {#describe_image_scan_findings} | 5        | 60            |
+    # | lifecycle_policy_preview_complete | {#get_lifecycle_policy_preview} | 5        | 20            |
+    #
+    # @raise [Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    # @raise [Errors::TooManyAttemptsError] Raised when the configured
+    #   maximum number of attempts have been made, and the waiter is not
+    #   yet successful.
+    #
+    # @raise [Errors::UnexpectedError] Raised when an error is encounted
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
+    #   for an unknown state.
+    #
+    # @return [Boolean] Returns `true` if the waiter was successful.
+    # @param [Symbol] waiter_name
+    # @param [Hash] params ({})
+    # @param [Hash] options ({})
+    # @option options [Integer] :max_attempts
+    # @option options [Integer] :delay
+    # @option options [Proc] :before_attempt
+    # @option options [Proc] :before_wait
+    def wait_until(waiter_name, params = {}, options = {})
+      w = waiter(waiter_name, options)
+      yield(w.waiter) if block_given? # deprecated
+      w.wait(params)
+    end
+
     # @api private
     # @deprecated
     def waiter_names
-      []
+      waiters.keys
+    end
+
+    private
+
+    # @param [Symbol] waiter_name
+    # @param [Hash] options ({})
+    def waiter(waiter_name, options = {})
+      waiter_class = waiters[waiter_name]
+      if waiter_class
+        waiter_class.new(options.merge(client: self))
+      else
+        raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
+      end
+    end
+
+    def waiters
+      {
+        image_scan_complete: Waiters::ImageScanComplete,
+        lifecycle_policy_preview_complete: Waiters::LifecyclePolicyPreviewComplete
+      }
     end
 
     class << self

data/lib/aws-sdk-ecr/waiters.rb

@@ -0,0 +1,103 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::ECR
+  module Waiters
+
+    # Wait until an image scan is complete and findings can be accessed
+    class ImageScanComplete
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (5)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 5,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_image_scan_findings,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "path",
+                "argument" => "image_scan_status.status",
+                "expected" => "COMPLETE"
+              },
+              {
+                "state" => "failure",
+                "matcher" => "path",
+                "argument" => "image_scan_status.status",
+                "expected" => "FAILED"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_image_scan_findings)
+      # @return (see Client#describe_image_scan_findings)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a lifecycle policy preview request is complete and results can be accessed
+    class LifecyclePolicyPreviewComplete
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (20)
+      # @option options [Integer] :delay (5)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 20,
+          delay: 5,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_lifecycle_policy_preview,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "path",
+                "argument" => "status",
+                "expected" => "COMPLETE"
+              },
+              {
+                "state" => "failure",
+                "matcher" => "path",
+                "argument" => "status",
+                "expected" => "FAILED"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_lifecycle_policy_preview)
+      # @return (see Client#get_lifecycle_policy_preview)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ecr
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -59,6 +59,7 @@ files:
 - lib/aws-sdk-ecr/errors.rb
 - lib/aws-sdk-ecr/resource.rb
 - lib/aws-sdk-ecr/types.rb
+- lib/aws-sdk-ecr/waiters.rb
 homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0