aws-sdk-connect 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de5e454354938356081edf1e3f2f72d92a94d7ee
-  data.tar.gz: 127ca153c8ca6cbb0c757c3c29627f72c837912a
+  metadata.gz: bd177b600d6b0c07f30b393110a9c5fb6dcd7385
+  data.tar.gz: 682ebd69c6325ca689e4b826df824ed4d65582ad
 SHA512:
-  metadata.gz: 963271e4a66771e7ea0a3fd4315d1f96ec5d6163e62404c5cc57543098b985249439732cd9d4b425b84feda9f2898319ad857f6e365ebf2ba2bfa5ce13bae0b6
-  data.tar.gz: dcd3b8c1c44c037cba79a26bd3101c511f04b06936ca0a101d2e407dd533c0dbcaafdd0116c3b3fb5115025f6880f078865107c89e1db258441bcb80a708e24a
+  metadata.gz: 21daf0e36362140bb19963d8dcfc12818c4246250dc715d072e2edd89547002a10c236f152c559c1cc53cc1950300a806cac37722fea06ec6f0ac3832ae62688
+  data.tar.gz: d74158c10eff94317a43361893e583fd67819bed30bae6054f0d57a36c9e3bd5d875a7ff0b2b909b47e4603a7a6a9474aae69bf2c915ae09cbe944447b9004a7

data/lib/aws-sdk-connect.rb

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

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:connect)
 
 module Aws::Connect
+  # An API client for Connect.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #   client = Aws::Connect::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::Connect
     #     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::Connect
     #     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::Connect
     #     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::Connect
     #     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
     #
@@ -209,16 +260,16 @@ module Aws::Connect
     #     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.
     #
@@ -227,7 +278,7 @@ module Aws::Connect
     #     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`.
@@ -1866,7 +1917,7 @@ module Aws::Connect
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connect'
-      context[:gem_version] = '1.22.0'
+      context[:gem_version] = '1.23.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -6,6 +6,39 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Connect
+
+  # When Connect returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Connect::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Connect errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Connect::Errors::ServiceError
+  #       # rescues all Connect 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
+  # * {ContactNotFoundException}
+  # * {DestinationNotAllowedException}
+  # * {DuplicateResourceException}
+  # * {InternalServiceException}
+  # * {InvalidParameterException}
+  # * {InvalidRequestException}
+  # * {LimitExceededException}
+  # * {OutboundContactNotPermittedException}
+  # * {ResourceNotFoundException}
+  # * {ThrottlingException}
+  # * {UserNotFoundException}
+  #
+  # 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 +56,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class DestinationNotAllowedException < ServiceError
@@ -39,7 +71,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class DuplicateResourceException < ServiceError
@@ -55,7 +86,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServiceException < ServiceError
@@ -71,7 +101,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidParameterException < ServiceError
@@ -87,7 +116,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRequestException < ServiceError
@@ -103,7 +131,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class LimitExceededException < ServiceError
@@ -119,7 +146,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class OutboundContactNotPermittedException < ServiceError
@@ -135,7 +161,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -151,7 +176,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottlingException < ServiceError
@@ -167,7 +191,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
     class UserNotFoundException < ServiceError
@@ -183,7 +206,6 @@ module Aws::Connect
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connect
 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: 2019-11-21 00:00:00.000000000 Z
+date: 2020-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core