aws-sdk-swf 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dea98d06d2f2e3e0fc13bb9ea4d8f13c29788c9
-  data.tar.gz: 38f89aec6fefe53a3d56a74141c4acfbec22a255
+  metadata.gz: 924ac335b1168eb0515ac11776a630ae6a96f3b6
+  data.tar.gz: b83802a1994b1cf0d275c1c3e9e4948f5ac50611
 SHA512:
-  metadata.gz: 648c62e2cd02c36a82f3725dc7eac60c02256d6900acfbba571971a5976ddff67f8445490510a70a688a5d5dad508bfd0e6de9f3a561c36d400310132d135ab5
-  data.tar.gz: a9951369eb5917815e309584abacf3549047e0184764588e4735947c0275aa4752ed66c629fbf9d893d5d6f246ed6c916fc8b62598f73122a5f5d2ae11a24b97
+  metadata.gz: 95c9e2f4d8d900a3f86a2d1d9824111a75b8e076cd583e1c105cb561075e970c615d2dd1a5f48467600d2e287125993cc06b1d3e0622b934e4c322ee6344c75c
+  data.tar.gz: b0727e8ced4046cc203fb98dad1350f019b09ec44afa9e65fb3f9416029c878236804a3f2348e0988e95dc3a0f50bcc64ac2abbcc1e5acaf037f92f178677689

data/lib/aws-sdk-swf.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-swf/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     swf = Aws::SWF::Client.new
+#     resp = swf.count_closed_workflow_executions(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Simple Workflow Service all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Simple Workflow Service are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::SWF::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Simple Workflow Service API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-swf/customizations'
 # @service
 module Aws::SWF
 
-  GEM_VERSION = '1.17.0'
+  GEM_VERSION = '1.18.0'
 
 end

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

@@ -31,6 +31,18 @@ require 'aws-sdk-swf/plugins/read_timeouts.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:swf)
 
 module Aws::SWF
+  # An API client for SWF.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #   client = Aws::SWF::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).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -110,6 +122,12 @@ module Aws::SWF
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -134,6 +152,10 @@ module Aws::SWF
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -168,15 +190,29 @@ module Aws::SWF
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #     A delay randomiser function used by the default backoff function.
+    #     Some predefined functions can be referenced by name - :none, :equal, :full,
+    #     otherwise a Proc that takes and returns a number. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -184,11 +220,26 @@ module Aws::SWF
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     used by the default backoff function. This option is only used in the
+    #     `legacy` retry mode.
+    #
+    #   @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.
     #
     #   @option options [String] :secret_access_key
     #
@@ -221,16 +272,16 @@ module Aws::SWF
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @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 yeidled by {#session_for}.
+    #     per-request on the session yielded by {#session_for}.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     seconds a connection is allowed to sit idle before it is
     #     considered stale.  Stale connections are closed and removed
     #     from the pool before making a request.
     #
@@ -239,7 +290,7 @@ module Aws::SWF
     #     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 yeidled by {#session_for}.
+    #     request on the session yielded by {#session_for}.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -4201,7 +4252,7 @@ module Aws::SWF
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-swf'
-      context[:gem_version] = '1.17.0'
+      context[:gem_version] = '1.18.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-swf/errors.rb

@@ -6,6 +6,38 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SWF
+
+  # When SWF returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::SWF::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all SWF errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::SWF::Errors::ServiceError
+  #       # rescues all SWF API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {DefaultUndefinedFault}
+  # * {DomainAlreadyExistsFault}
+  # * {DomainDeprecatedFault}
+  # * {LimitExceededFault}
+  # * {OperationNotPermittedFault}
+  # * {TooManyTagsFault}
+  # * {TypeAlreadyExistsFault}
+  # * {TypeDeprecatedFault}
+  # * {UnknownResourceFault}
+  # * {WorkflowExecutionAlreadyStartedFault}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -23,7 +55,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class DomainAlreadyExistsFault < ServiceError
@@ -39,7 +70,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class DomainDeprecatedFault < ServiceError
@@ -55,7 +85,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class LimitExceededFault < ServiceError
@@ -71,7 +100,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class OperationNotPermittedFault < ServiceError
@@ -87,7 +115,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyTagsFault < ServiceError
@@ -103,7 +130,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class TypeAlreadyExistsFault < ServiceError
@@ -119,7 +145,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class TypeDeprecatedFault < ServiceError
@@ -135,7 +160,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnknownResourceFault < ServiceError
@@ -151,7 +175,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
     class WorkflowExecutionAlreadyStartedFault < ServiceError
@@ -167,7 +190,6 @@ module Aws::SWF
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

@@ -6,6 +6,13 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SWF
+  # This class provides a resource oriented interface for SWF.
+  # To create a resource object:
+  #     resource = Aws::SWF::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.
+  #     client = Aws::SWF::Client.new(region: 'us-west-2')
+  #     resource = Aws::SWF::Resource.new(client: client)
   class Resource
 
     # @param options ({})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-swf
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2020-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core