aws-sdk-databasemigrationservice 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b72060ac7d2d00a2ee8000742859c896e324348
-  data.tar.gz: f046fadfdf30a6903de547f1057e1c224f6ea164
+  metadata.gz: b64aa23746136cc7473c09f762548e1b28569ecc
+  data.tar.gz: d5e237d8ac9a6d11d01ea6e803240abd3343626f
 SHA512:
-  metadata.gz: c1f1e7e3c5de6ddda912f5c9fdf7dfd2e7f082749f06419c6b0c021708a97715258adc7aacfdd6f5800c91af4dfa53cd9a77eb0a4127cbcc3b1036ac7cfe7936
-  data.tar.gz: d7c2d58918d6429dcf1346973e4d6068c176a7099b7bdb309750b904718c8d52c9bdbc965a7e6c3401706fe947c14b0f947375fdde3035d2025d0eb16b6370f2
+  metadata.gz: f8e928d8e167bd98363786ad7a4b5030cdc1551b8cc08df47ee996b28b01ce17a427d4786e90805f746afde29a52020de8dc594c47579264b391c441a3e65eb1
+  data.tar.gz: ca165c37caa6d8516d0875a07865dbbef7e444296070b8603950b89a507a2117bfb1b3a2649660038063fd49fe8d551b085c443142b5f140f9b0b42c19cc2b72

data/lib/aws-sdk-databasemigrationservice.rb

@@ -12,6 +12,7 @@ require_relative 'aws-sdk-databasemigrationservice/types'
 require_relative 'aws-sdk-databasemigrationservice/client_api'
 require_relative 'aws-sdk-databasemigrationservice/client'
 require_relative 'aws-sdk-databasemigrationservice/errors'
+require_relative 'aws-sdk-databasemigrationservice/waiters'
 require_relative 'aws-sdk-databasemigrationservice/resource'
 require_relative 'aws-sdk-databasemigrationservice/customizations'
 
@@ -42,6 +43,6 @@ require_relative 'aws-sdk-databasemigrationservice/customizations'
 # @service
 module Aws::DatabaseMigrationService
 
-  GEM_VERSION = '1.11.0'
+  GEM_VERSION = '1.12.0'
 
 end

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

@@ -4284,14 +4284,141 @@ module Aws::DatabaseMigrationService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-databasemigrationservice'
-      context[:gem_version] = '1.11.0'
+      context[:gem_version] = '1.12.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.waiter_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 |
+    # | ------------------------------ | --------------------------------- | -------- | ------------- |
+    # | endpoint_deleted               | {#describe_endpoints}             | 5        | 60            |
+    # | replication_instance_available | {#describe_replication_instances} | 60       | 60            |
+    # | replication_instance_deleted   | {#describe_replication_instances} | 15       | 60            |
+    # | replication_task_deleted       | {#describe_replication_tasks}     | 15       | 60            |
+    # | replication_task_ready         | {#describe_replication_tasks}     | 15       | 60            |
+    # | replication_task_running       | {#describe_replication_tasks}     | 15       | 60            |
+    # | replication_task_stopped       | {#describe_replication_tasks}     | 15       | 60            |
+    # | test_connection_succeeds       | {#test_connection}                | 5        | 60            |
+    #
+    # @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
+      {
+        endpoint_deleted: Waiters::EndpointDeleted,
+        replication_instance_available: Waiters::ReplicationInstanceAvailable,
+        replication_instance_deleted: Waiters::ReplicationInstanceDeleted,
+        replication_task_deleted: Waiters::ReplicationTaskDeleted,
+        replication_task_ready: Waiters::ReplicationTaskReady,
+        replication_task_running: Waiters::ReplicationTaskRunning,
+        replication_task_stopped: Waiters::ReplicationTaskStopped,
+        test_connection_succeeds: Waiters::TestConnectionSucceeds
+      }
     end
 
     class << self

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

@@ -0,0 +1,544 @@
+# 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::DatabaseMigrationService
+  module Waiters
+
+    # Wait until testing endpoint is deleted.
+    class EndpointDeleted
+
+      # @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_endpoints,
+            acceptors: [
+              {
+                "expected" => "ResourceNotFoundFault",
+                "matcher" => "error",
+                "state" => "success"
+              },
+              {
+                "argument" => "endpoints[].status",
+                "expected" => "active",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "endpoints[].status",
+                "expected" => "creating",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_endpoints)
+      # @return (see Client#describe_endpoints)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until DMS replication instance is available.
+    class ReplicationInstanceAvailable
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (60)
+      # @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: 60,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_replication_instances,
+            acceptors: [
+              {
+                "argument" => "replication_instances[].replication_instance_status",
+                "expected" => "available",
+                "matcher" => "pathAll",
+                "state" => "success"
+              },
+              {
+                "argument" => "replication_instances[].replication_instance_status",
+                "expected" => "deleting",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_instances[].replication_instance_status",
+                "expected" => "incompatible-credentials",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_instances[].replication_instance_status",
+                "expected" => "incompatible-network",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_instances[].replication_instance_status",
+                "expected" => "inaccessible-encryption-credentials",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_replication_instances)
+      # @return (see Client#describe_replication_instances)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until DMS replication instance is deleted.
+    class ReplicationInstanceDeleted
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (15)
+      # @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: 15,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_replication_instances,
+            acceptors: [
+              {
+                "argument" => "replication_instances[].replication_instance_status",
+                "expected" => "available",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "expected" => "ResourceNotFoundFault",
+                "matcher" => "error",
+                "state" => "success"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_replication_instances)
+      # @return (see Client#describe_replication_instances)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until DMS replication task is deleted.
+    class ReplicationTaskDeleted
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (15)
+      # @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: 15,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_replication_tasks,
+            acceptors: [
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "ready",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "creating",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "stopped",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "running",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "failed",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "expected" => "ResourceNotFoundFault",
+                "matcher" => "error",
+                "state" => "success"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_replication_tasks)
+      # @return (see Client#describe_replication_tasks)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until DMS replication task is ready.
+    class ReplicationTaskReady
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (15)
+      # @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: 15,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_replication_tasks,
+            acceptors: [
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "ready",
+                "matcher" => "pathAll",
+                "state" => "success"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "starting",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "running",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "stopping",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "stopped",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "failed",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "modifying",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "testing",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "deleting",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_replication_tasks)
+      # @return (see Client#describe_replication_tasks)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until DMS replication task is running.
+    class ReplicationTaskRunning
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (15)
+      # @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: 15,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_replication_tasks,
+            acceptors: [
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "running",
+                "matcher" => "pathAll",
+                "state" => "success"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "ready",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "creating",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "stopping",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "stopped",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "failed",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "modifying",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "testing",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "deleting",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_replication_tasks)
+      # @return (see Client#describe_replication_tasks)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until DMS replication task is stopped.
+    class ReplicationTaskStopped
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (15)
+      # @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: 15,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_replication_tasks,
+            acceptors: [
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "stopped",
+                "matcher" => "pathAll",
+                "state" => "success"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "ready",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "creating",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "starting",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "running",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "failed",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "modifying",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "testing",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              },
+              {
+                "argument" => "replication_tasks[].status",
+                "expected" => "deleting",
+                "matcher" => "pathAny",
+                "state" => "failure"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_replication_tasks)
+      # @return (see Client#describe_replication_tasks)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until testing connection succeeds.
+    class TestConnectionSucceeds
+
+      # @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: :test_connection,
+            acceptors: [
+              {
+                "argument" => "connection.status",
+                "expected" => "successful",
+                "matcher" => "path",
+                "state" => "success"
+              },
+              {
+                "argument" => "connection.status",
+                "expected" => "failed",
+                "matcher" => "path",
+                "state" => "failure"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#test_connection)
+      # @return (see Client#test_connection)
+      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-databasemigrationservice
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -59,6 +59,7 @@ files:
 - lib/aws-sdk-databasemigrationservice/errors.rb
 - lib/aws-sdk-databasemigrationservice/resource.rb
 - lib/aws-sdk-databasemigrationservice/types.rb
+- lib/aws-sdk-databasemigrationservice/waiters.rb
 homepage: http://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0