aws-sdk-opsworks 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e8923783bc9cefc8a948fe672aaa854fac96f3ab
-  data.tar.gz: 3838ae0789aa7fae8e490e906d7d6ac7a7c441ad
+SHA256:
+  metadata.gz: cb667fbc01d17d88118a19a053e9370f1021d4164f96c0cfbf54b4444334decd
+  data.tar.gz: 8cd361336e9cb675263c943de8a80e7ff79d23704cc074d116d70adc3afd7564
 SHA512:
-  metadata.gz: af0c80014c34cc1e6e0d373a912d335fc8df58de4419a4c4dc7b2dc9c9337890fa98f6bd75e4263b595da496c56387595e825fe8e2982142598dc4bf248b7b48
-  data.tar.gz: 8d6ce7739a061b8d54d4281753a3f19470dcc074aa2a4c7c5f9ae32fdfe44bb52a21c1f3581109c4501324631b42a45342144c0b38b1f66ed28efb102514a0ef
+  metadata.gz: 4b67514d2b63d3fa302a3d10be525612974f44e1c859e88c0386f6dd297042f30cb6b301b91dbbdc0e66776b73e210a1e8b99de58a9f2db5a0801aa41adf40cb
+  data.tar.gz: 3804023ce4f4a1e257fc7f1e1d83675afca712b11a769922db1b9a2fcbd9006a7eb40960b8f9f3e5d91e776030751d2fe6c4e2a9c55cbbfd429593edcd7e64f9

data/lib/aws-sdk-opsworks.rb

@@ -49,6 +49,6 @@ require_relative 'aws-sdk-opsworks/customizations'
 # @service
 module Aws::OpsWorks
 
-  GEM_VERSION = '1.22.0'
+  GEM_VERSION = '1.23.0'
 
 end

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

@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:opsworks)
 module Aws::OpsWorks
   # An API client for OpsWorks.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
-  #   client = Aws::OpsWorks::Client.new(
-  #     region: region_name,
-  #     credentials: credentials,
-  #     # ...
-  #   )
+  #     client = Aws::OpsWorks::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
   #
   # For details on configuring region and credentials see
   # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -105,7 +105,7 @@ module Aws::OpsWorks
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -161,7 +161,7 @@ module Aws::OpsWorks
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -229,15 +229,19 @@ module Aws::OpsWorks
     #
     #   @option options [String] :retry_mode ("legacy")
     #     Specifies which retry algorithm to use. Values are:
-    #       * `legacy` - The pre-existing retry behavior.  This is default value if
-    #         no retry mode is provided.
-    #       * `standard` - A standardized set of retry rules across the AWS SDKs.
-    #         This includes support for retry quotas, which limit the number of
-    #         unsuccessful retries a client can make.
-    #       * `adaptive` - An experimental retry mode that includes all the
-    #         functionality of `standard` mode along with automatic client side
-    #         throttling.  This is a provisional mode that may change behavior
-    #         in the future.
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -275,8 +279,7 @@ module Aws::OpsWorks
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yielded by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
     #     seconds a connection is allowed to sit idle before it is
@@ -288,7 +291,7 @@ module Aws::OpsWorks
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yielded by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -2407,6 +2410,11 @@ module Aws::OpsWorks
     #   resp.apps[0].environment[0].value #=> String
     #   resp.apps[0].environment[0].secure #=> Boolean
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * app_exists
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeApps AWS API Documentation
     #
     # @overload describe_apps(params = {})
@@ -2543,6 +2551,11 @@ module Aws::OpsWorks
     #   resp.deployments[0].instance_ids #=> Array
     #   resp.deployments[0].instance_ids[0] #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * deployment_successful
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeDeployments AWS API Documentation
     #
     # @overload describe_deployments(params = {})
@@ -2596,6 +2609,8 @@ module Aws::OpsWorks
     #   * {Types::DescribeEcsClustersResult#ecs_clusters #ecs_clusters} => Array<Types::EcsCluster>
     #   * {Types::DescribeEcsClustersResult#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_ecs_clusters({
@@ -2844,6 +2859,14 @@ module Aws::OpsWorks
     #   resp.instances[0].tenancy #=> String
     #   resp.instances[0].virtualization_type #=> String, one of "paravirtual", "hvm"
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * instance_online
+    #   * instance_registered
+    #   * instance_stopped
+    #   * instance_terminated
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeInstances AWS API Documentation
     #
     # @overload describe_instances(params = {})
@@ -5607,7 +5630,7 @@ module Aws::OpsWorks
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-opsworks'
-      context[:gem_version] = '1.22.0'
+      context[:gem_version] = '1.23.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -5673,14 +5696,14 @@ module Aws::OpsWorks
     # 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 |
-    # | --------------------- | ----------------------- | -------- | ------------- |
-    # | app_exists            | {#describe_apps}        | 1        | 40            |
-    # | deployment_successful | {#describe_deployments} | 15       | 40            |
-    # | instance_online       | {#describe_instances}   | 15       | 40            |
-    # | instance_registered   | {#describe_instances}   | 15       | 40            |
-    # | instance_stopped      | {#describe_instances}   | 15       | 40            |
-    # | instance_terminated   | {#describe_instances}   | 15       | 40            |
+    # | waiter_name           | params                        | :delay   | :max_attempts |
+    # | --------------------- | ----------------------------- | -------- | ------------- |
+    # | app_exists            | {Client#describe_apps}        | 1        | 40            |
+    # | deployment_successful | {Client#describe_deployments} | 15       | 40            |
+    # | instance_online       | {Client#describe_instances}   | 15       | 40            |
+    # | instance_registered   | {Client#describe_instances}   | 15       | 40            |
+    # | instance_stopped      | {Client#describe_instances}   | 15       | 40            |
+    # | instance_terminated   | {Client#describe_instances}   | 15       | 40            |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition

data/lib/aws-sdk-opsworks/layer.rb

@@ -263,7 +263,8 @@ module Aws::OpsWorks
     # 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
+    # @note The waiting operation is performed on a copy. The original resource
+    #   remains unchanged.
     #
     # ## Basic Usage
     #
@@ -276,13 +277,15 @@ module Aws::OpsWorks
     #
     # ## Example
     #
-    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #     instance.wait_until(max_attempts:10, delay:5) do |instance|
+    #       instance.state.name == 'running'
+    #     end
     #
     # ## 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}:
+    # 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|...}
@@ -313,17 +316,16 @@ module Aws::OpsWorks
     #       # resource did not enter the desired state in time
     #     end
     #
+    # @yieldparam [Resource] resource to be used in the waiting condition.
     #
-    # @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.
+    # @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 [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
     #

data/lib/aws-sdk-opsworks/resource.rb

@@ -6,13 +6,18 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::OpsWorks
+
   # This class provides a resource oriented interface for OpsWorks.
   # To create a resource object:
+  #
   #     resource = Aws::OpsWorks::Resource.new(region: 'us-west-2')
+  #
   # You can supply a client object with custom configuration that will be used for all resource operations.
-  # If you do not pass +:client+, a default client will be constructed.
+  # If you do not pass `:client`, a default client will be constructed.
+  #
   #     client = Aws::OpsWorks::Client.new(region: 'us-west-2')
   #     resource = Aws::OpsWorks::Resource.new(client: client)
+  #
   class Resource
 
     # @param options ({})

data/lib/aws-sdk-opsworks/stack.rb

@@ -256,7 +256,8 @@ module Aws::OpsWorks
     # 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
+    # @note The waiting operation is performed on a copy. The original resource
+    #   remains unchanged.
     #
     # ## Basic Usage
     #
@@ -269,13 +270,15 @@ module Aws::OpsWorks
     #
     # ## Example
     #
-    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #     instance.wait_until(max_attempts:10, delay:5) do |instance|
+    #       instance.state.name == 'running'
+    #     end
     #
     # ## 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}:
+    # 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|...}
@@ -306,17 +309,16 @@ module Aws::OpsWorks
     #       # resource did not enter the desired state in time
     #     end
     #
+    # @yieldparam [Resource] resource to be used in the waiting condition.
     #
-    # @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.
+    # @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 [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
     #

data/lib/aws-sdk-opsworks/stack_summary.rb

@@ -103,7 +103,8 @@ module Aws::OpsWorks
     # 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
+    # @note The waiting operation is performed on a copy. The original resource
+    #   remains unchanged.
     #
     # ## Basic Usage
     #
@@ -116,13 +117,15 @@ module Aws::OpsWorks
     #
     # ## Example
     #
-    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #     instance.wait_until(max_attempts:10, delay:5) do |instance|
+    #       instance.state.name == 'running'
+    #     end
     #
     # ## 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}:
+    # 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|...}
@@ -153,17 +156,16 @@ module Aws::OpsWorks
     #       # resource did not enter the desired state in time
     #     end
     #
+    # @yieldparam [Resource] resource to be used in the waiting condition.
     #
-    # @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.
+    # @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 [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
     #

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

@@ -8,6 +8,72 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::OpsWorks
+  # 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 |
+  # | --------------------- | ----------------------------- | -------- | ------------- |
+  # | app_exists            | {Client#describe_apps}        | 1        | 40            |
+  # | deployment_successful | {Client#describe_deployments} | 15       | 40            |
+  # | instance_online       | {Client#describe_instances}   | 15       | 40            |
+  # | instance_registered   | {Client#describe_instances}   | 15       | 40            |
+  # | instance_stopped      | {Client#describe_instances}   | 15       | 40            |
+  # | instance_terminated   | {Client#describe_instances}   | 15       | 40            |
+  #
   module Waiters
 
     class AppExists

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-opsworks
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - AWS OpsWorks