lib/aws-sdk-iotdataplane/client.rb in aws-sdk-iotdataplane-1.17.0 vs lib/aws-sdk-iotdataplane/client.rb in aws-sdk-iotdataplane-1.18.0
- old
+ new
@@ -30,15 +30,15 @@
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,
- # # ...
- # )
+ # 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.
@@ -103,11 +103,11 @@
# timeouts.
#
# @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']`
# * `ENV['AMAZON_REGION']`
# * `ENV['AWS_DEFAULT_REGION']`
@@ -159,11 +159,11 @@
# to default service endpoint when available.
#
# @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 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
# for endpoint discovery enabled operations. Defaults to 1000.
#
@@ -227,20 +227,24 @@
# 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.
#
+ # * `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
#
# @option options [String] :session_token
#
# @option options [Boolean] :stub_responses (false)
@@ -263,12 +267,11 @@
# 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 yielded 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 idle before it is
# considered stale. Stale connections are closed and removed
# from the pool before making a request.
@@ -276,11 +279,11 @@
# @option options [Float] :http_continue_timeout (1) The number of
# seconds to wait for a 100-continue response before sending the
# 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 yielded 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`.
#
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
@@ -454,10 +457,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-iotdataplane'
- context[:gem_version] = '1.17.0'
+ context[:gem_version] = '1.18.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated