aws-sdk-ecr 1.3.0 → 1.69.0

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::ECR
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available 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               | {Client#describe_image_scan_findings} | 5        | 60            |
+  # | lifecycle_policy_preview_complete | {Client#get_lifecycle_policy_preview} | 5        | 20            |
+  #
+  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

data/lib/aws-sdk-ecr.rb

@@ -1,18 +1,26 @@
+# frozen_string_literal: true
+
 # 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
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
 require_relative 'aws-sdk-ecr/types'
 require_relative 'aws-sdk-ecr/client_api'
+require_relative 'aws-sdk-ecr/plugins/endpoints.rb'
 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/endpoint_parameters'
+require_relative 'aws-sdk-ecr/endpoint_provider'
+require_relative 'aws-sdk-ecr/endpoints'
 require_relative 'aws-sdk-ecr/customizations'
 
 # This module provides support for Amazon EC2 Container Registry. This module is available in the
@@ -24,24 +32,27 @@ require_relative 'aws-sdk-ecr/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     ecr = Aws::ECR::Client.new
+#     resp = ecr.batch_check_layer_availability(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon EC2 Container Registry all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon EC2 Container Registry are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::ECR::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon EC2 Container Registry API errors
 #     end
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::ECR
 
-  GEM_VERSION = '1.3.0'
+  GEM_VERSION = '1.69.0'
 
 end