aws-sdk-states 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54826692697e74b50e190c0e99dd2a805d840f37
-  data.tar.gz: a0ec640131dcfda401c83058bd6d10e7896b5f39
+  metadata.gz: '08ab10c301a4151ccbfb134c60c77756de3e417b'
+  data.tar.gz: 8106f973cfe1f282a3419fc4398c15a1da6dc99a
 SHA512:
-  metadata.gz: 911fafc972a8b3a3e83ac3f513b22b8ebfe37de5ab43a25bdf2ee082f278d4b278dbba3185776b3eff62f6efee0bcccbfbb240d76d8fca5fc212760e8188fcca
-  data.tar.gz: 9d45d1e1d8d8f84e963a549e37513af85de01bee54bd13019957a3f176cc7bddfbc39140eae7d3d3e4a6f8e4af2a409fb6809ba4551106dbbb7a85d662ddb463
+  metadata.gz: e56c54f029d607e222c1e3ce8bf6cb3c6d9a01d875ba42e0c540b816b7c19982548b8d9ce49296015f239dbe06df854935cb950578689ac6388e2b278c17b6e0
+  data.tar.gz: 5f787fd89de31854b65755afe05b7574d81e66c01b7521b5413321947a94e9c827054311e55e99cef14f92ad98b909e6ad4aa78e4e82d736a3cced4b441fb72c

data/lib/aws-sdk-states.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-states/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     states = Aws::States::Client.new
+#     resp = states.create_activity(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from AWS Step Functions all
-# extend {Errors::ServiceError}.
+# Errors returned from AWS Step Functions are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::States::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all AWS Step Functions API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-states/customizations'
 # @service
 module Aws::States
 
-  GEM_VERSION = '1.25.0'
+  GEM_VERSION = '1.26.0'
 
 end

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:states)
 
 module Aws::States
+  # An API client for States.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #   client = Aws::States::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
@@ -108,6 +120,12 @@ module Aws::States
     #     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.
@@ -132,6 +150,10 @@ module Aws::States
     #     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.
@@ -166,15 +188,29 @@ module Aws::States
     #     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
     #
@@ -182,11 +218,26 @@ module Aws::States
     #     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
     #
@@ -219,16 +270,16 @@ module Aws::States
     #     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.
     #
@@ -237,7 +288,7 @@ module Aws::States
     #     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`.
@@ -1557,7 +1608,7 @@ module Aws::States
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-states'
-      context[:gem_version] = '1.25.0'
+      context[:gem_version] = '1.26.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -6,6 +6,51 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::States
+
+  # When States returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::States::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all States errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::States::Errors::ServiceError
+  #       # rescues all States 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
+  # * {ActivityDoesNotExist}
+  # * {ActivityLimitExceeded}
+  # * {ActivityWorkerLimitExceeded}
+  # * {ExecutionAlreadyExists}
+  # * {ExecutionDoesNotExist}
+  # * {ExecutionLimitExceeded}
+  # * {InvalidArn}
+  # * {InvalidDefinition}
+  # * {InvalidExecutionInput}
+  # * {InvalidLoggingConfiguration}
+  # * {InvalidName}
+  # * {InvalidOutput}
+  # * {InvalidToken}
+  # * {MissingRequiredParameter}
+  # * {ResourceNotFound}
+  # * {StateMachineAlreadyExists}
+  # * {StateMachineDeleting}
+  # * {StateMachineDoesNotExist}
+  # * {StateMachineLimitExceeded}
+  # * {StateMachineTypeNotSupported}
+  # * {TaskDoesNotExist}
+  # * {TaskTimedOut}
+  # * {TooManyTags}
+  #
+  # 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 +68,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class ActivityLimitExceeded < ServiceError
@@ -39,7 +83,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class ActivityWorkerLimitExceeded < ServiceError
@@ -55,7 +98,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class ExecutionAlreadyExists < ServiceError
@@ -71,7 +113,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class ExecutionDoesNotExist < ServiceError
@@ -87,7 +128,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class ExecutionLimitExceeded < ServiceError
@@ -103,7 +143,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidArn < ServiceError
@@ -119,7 +158,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidDefinition < ServiceError
@@ -135,7 +173,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidExecutionInput < ServiceError
@@ -151,7 +188,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidLoggingConfiguration < ServiceError
@@ -167,7 +203,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidName < ServiceError
@@ -183,7 +218,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidOutput < ServiceError
@@ -199,7 +233,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidToken < ServiceError
@@ -215,7 +248,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class MissingRequiredParameter < ServiceError
@@ -231,7 +263,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFound < ServiceError
@@ -252,7 +283,6 @@ module Aws::States
       def resource_name
         @data[:resource_name]
       end
-
     end
 
     class StateMachineAlreadyExists < ServiceError
@@ -268,7 +298,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class StateMachineDeleting < ServiceError
@@ -284,7 +313,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class StateMachineDoesNotExist < ServiceError
@@ -300,7 +328,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class StateMachineLimitExceeded < ServiceError
@@ -316,7 +343,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class StateMachineTypeNotSupported < ServiceError
@@ -332,7 +358,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class TaskDoesNotExist < ServiceError
@@ -348,7 +373,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class TaskTimedOut < ServiceError
@@ -364,7 +388,6 @@ module Aws::States
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyTags < ServiceError
@@ -385,7 +408,6 @@ module Aws::States
       def resource_name
         @data[:resource_name]
       end
-
     end
 
   end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-states
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
+date: 2020-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core