aws-sdk-xray 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43e730803966709850ffe2c4b469ae90182a4981
-  data.tar.gz: 2fb535a3ddd482aa782feb725b780b75fe1a8095
+  metadata.gz: 5299564a015481db30f20cc9195b221ffcfd2e99
+  data.tar.gz: 863d583453c84ad57226a3dc1f0c3be37a04344e
 SHA512:
-  metadata.gz: 75b0b73872fd4c156eee099b3cb371b539719a638ff813d22f3867b15fb2ec4938f98eb0b8fc4d2e957da7c565912c449b19ba691f5ed953c47a4b91fe354379
-  data.tar.gz: dc129737c40adafc2f665af5f966572d5ea3a2599e5b61514a9cd7e7702824067b62a6adaeb7bded12ce59313e389a10b3666cba3faf0dbe75830ab455dcf423
+  metadata.gz: 00dc3d6e4bc99de06d0e4a741de6e285a04cd3033541a23b0f54b00be4e51a8676352809cb133634b11fba62e089f47689af8a0649108e51f7cc11a4ddbae18b
+  data.tar.gz: 542294f7c6014b5ada7267ad0dda3afc057750868266580e5e0f89d5528769283b1fea724484a08921a774172bd0527c4423010b206e00ec9a6aa9fbd27341d1

data/lib/aws-sdk-xray.rb

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

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

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

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

@@ -6,6 +6,31 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::XRay
+
+  # When XRay returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::XRay::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all XRay errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::XRay::Errors::ServiceError
+  #       # rescues all XRay 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
+  # * {InvalidRequestException}
+  # * {RuleLimitExceededException}
+  # * {ThrottledException}
+  #
+  # 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 +48,6 @@ module Aws::XRay
       def message
         @message || @data[:message]
       end
-
     end
 
     class RuleLimitExceededException < ServiceError
@@ -39,7 +63,6 @@ module Aws::XRay
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottledException < ServiceError
@@ -55,7 +78,6 @@ module Aws::XRay
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

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

metadata

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