aws-sdk-swf 1.16.0 → 1.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac26de6156f334992c83d919a546fd0ff5b06b9e
-  data.tar.gz: a45f55331534ecce154dc3c38358dcef136790f2
+SHA256:
+  metadata.gz: 7aa87696b78327774c6af86c50c9d954f82fcc2fa4e09c7df5fe4e1f35bad23e
+  data.tar.gz: 8f351b0fe0f45d90048d84a1135c433e8cefa4940f6f4952b6fea2dab206f501
 SHA512:
-  metadata.gz: 05445a1119563e7a32203d8c8f3beca8d97f7a72fa2a22ec9562659a54d0337b6a2edb869bcd6943cdf7ca6198f2ef0fd3225e6bd218c6f56f14fa3c598fc17c
-  data.tar.gz: 8792f950fa668222ba552c9e1f521eeecd52218d5156ad6ef6bf3a96491da7c5a54d08841f99495d37de27375800d1664997367ec873c8f1d0e17f23f9c9664a
+  metadata.gz: 65d970adbe79f0db1a84c66fb0dfc248a5057638c4198f4e0c16998f40c833853d629e4cc99f55c1e923b1e4b940653a292622608330cf392062af9b1d03d9b9
+  data.tar.gz: 3477035ab2dd1715e51c3acb7a69c9e17eb699572ceaec1254fa6ba890f1a7b1e255f8110646381a88ed123ed957c650ba8a2eb2939772472e0ef75a51ab3915

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.16.0'
+  GEM_VERSION = '1.21.1'
 
 end

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

@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 require 'aws-sdk-swf/plugins/read_timeouts.rb'
@@ -31,6 +32,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
@@ -58,6 +71,7 @@ module Aws::SWF
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
     add_plugin(Aws::SWF::Plugins::ReadTimeouts)
@@ -95,7 +109,7 @@ module Aws::SWF
     #   @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']`
@@ -110,6 +124,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 +154,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.
@@ -141,7 +165,7 @@ module Aws::SWF
     #   @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 or custom 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
@@ -156,7 +180,7 @@ module Aws::SWF
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -168,15 +192,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 +222,30 @@ 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 +278,15 @@ 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}.
+    #     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 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 +295,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.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -1210,6 +1266,8 @@ module Aws::SWF
     #   * {Types::History#events #events} => Array&lt;Types::HistoryEvent&gt;
     #   * {Types::History#next_page_token #next_page_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.get_workflow_execution_history({
@@ -1547,6 +1605,8 @@ module Aws::SWF
     #   * {Types::ActivityTypeInfos#type_infos #type_infos} => Array&lt;Types::ActivityTypeInfo&gt;
     #   * {Types::ActivityTypeInfos#next_page_token #next_page_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.list_activity_types({
@@ -1711,6 +1771,8 @@ module Aws::SWF
     #   * {Types::WorkflowExecutionInfos#execution_infos #execution_infos} => Array&lt;Types::WorkflowExecutionInfo&gt;
     #   * {Types::WorkflowExecutionInfos#next_page_token #next_page_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.list_closed_workflow_executions({
@@ -1830,6 +1892,8 @@ module Aws::SWF
     #   * {Types::DomainInfos#domain_infos #domain_infos} => Array&lt;Types::DomainInfo&gt;
     #   * {Types::DomainInfos#next_page_token #next_page_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.list_domains({
@@ -1959,6 +2023,8 @@ module Aws::SWF
     #   * {Types::WorkflowExecutionInfos#execution_infos #execution_infos} => Array&lt;Types::WorkflowExecutionInfo&gt;
     #   * {Types::WorkflowExecutionInfos#next_page_token #next_page_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.list_open_workflow_executions({
@@ -2099,6 +2165,8 @@ module Aws::SWF
     #   * {Types::WorkflowTypeInfos#type_infos #type_infos} => Array&lt;Types::WorkflowTypeInfo&gt;
     #   * {Types::WorkflowTypeInfos#next_page_token #next_page_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.list_workflow_types({
@@ -2332,6 +2400,8 @@ module Aws::SWF
     #   * {Types::DecisionTask#next_page_token #next_page_token} => String
     #   * {Types::DecisionTask#previous_started_event_id #previous_started_event_id} => Integer
     #
+    # 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.poll_for_decision_task({
@@ -4201,7 +4271,7 @@ module Aws::SWF
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-swf'
-      context[:gem_version] = '1.16.0'
+      context[:gem_version] = '1.21.1'
       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,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SWF
+
   class Resource
 
     # @param options ({})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-swf
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.21.1
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.61.1
+        version: 3.99.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.61.1
+        version: 3.99.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,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 - Amazon SWF