aws-sdk-iotdataplane 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 322b7cca5b7df99bb136c9fea9a16c444e3f3e67
-  data.tar.gz: 8d3ca43bd8173f89da5ed62ac73064f5b3198315
+  metadata.gz: 788d08e12515b21b750b0cdc4f381cb078caa381
+  data.tar.gz: bd6c26682463609d11d4a36e31a93699bb4785be
 SHA512:
-  metadata.gz: 02ffa8662d6efd1c5a137d865ac90163afc26fefa990929335b6c4d9d57846ca15333feca2e96c9496ab1813f67bf6135b872908af55ef144dcf0ca8ff431ea0
-  data.tar.gz: 9487376c766f5d730a67b731e10c6e9c8465c44c743e03ff953f5145e1285233733bceb22acba6ac87332c17c78e3d3e943a013f0bf36129a79f95d419dcf56c
+  metadata.gz: ea7b8677fa0072336aece400b0974360e9229a8ddcbc5f51886085ab628a05d710b868b4791526c0652bbd46b6005a35ba9a138d99ad1bd459c9f97af49bf6f8
+  data.tar.gz: 76e8a3e9af95bf747f959c10dd50da095c2a748b144c0960c18a6a9f9670304575fb585c9b51436009a9acab0b2272487b030d4eaa8b3aecb5a5de763501f274

data/lib/aws-sdk-iotdataplane.rb

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

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

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

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

@@ -6,6 +6,38 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::IoTDataPlane
+
+  # When IoTDataPlane returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::IoTDataPlane::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all IoTDataPlane errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::IoTDataPlane::Errors::ServiceError
+  #       # rescues all IoTDataPlane 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
+  # * {ConflictException}
+  # * {InternalFailureException}
+  # * {InvalidRequestException}
+  # * {MethodNotAllowedException}
+  # * {RequestEntityTooLargeException}
+  # * {ResourceNotFoundException}
+  # * {ServiceUnavailableException}
+  # * {ThrottlingException}
+  # * {UnauthorizedException}
+  # * {UnsupportedDocumentEncodingException}
+  #
+  # 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::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalFailureException < ServiceError
@@ -39,7 +70,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRequestException < ServiceError
@@ -55,7 +85,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class MethodNotAllowedException < ServiceError
@@ -71,7 +100,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class RequestEntityTooLargeException < ServiceError
@@ -87,7 +115,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -103,7 +130,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class ServiceUnavailableException < ServiceError
@@ -119,7 +145,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottlingException < ServiceError
@@ -135,7 +160,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnauthorizedException < ServiceError
@@ -151,7 +175,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnsupportedDocumentEncodingException < ServiceError
@@ -167,7 +190,6 @@ module Aws::IoTDataPlane
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotdataplane
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.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