aws-sdk-iot1clickdevicesservice 1.16.0 → 1.21.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 333fc477f9f38a974e42607b7975efa7ddaf9410
4
- data.tar.gz: 98b2147e84288acc777480474c429f8d7ebe3295
2
+ SHA256:
3
+ metadata.gz: 765caf16ba5c82ecdd04cebfbe6b83a3e3392441a2af898c55e29a5469a3d7a7
4
+ data.tar.gz: a31eb3f493ca7662369871662d284ae84bc13263d6de8fa71b151239e719d37b
5
5
  SHA512:
6
- metadata.gz: 85703b91ec228723b936540c29103934ec41886f581403246d9ad09531df3b1dc87da5abc06479fea8e64bb0d23d451267d1e1cdf827b0147071f4ef84bb65cb
7
- data.tar.gz: 584d3ee3d0b4461be54ebd4e251d566ce952efe5cfa597835a80f3e58eec27af530f778af527ab15765eb73e7335b03f598eb071ae40a215071898219d0d4db4
6
+ metadata.gz: 4e074ff7a2bb9f70e6dcca5ecb5a10796317517ef9ad1177e9d001c22f5d31ab21e9319e485812540f7c31883460ef9ebdd1ef5d83c56010e47bb1d6adf95922
7
+ data.tar.gz: 4839e0b60ec50a53e098e882695fdf262b3a3e8ee671fd42d9a88c9d5bd84f56e27d9bca8d7d3e582563164e2147ed00f8d63af0d14a3aa126ad5242debbb900
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-iot1clickdevicesservice/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # io_t1_click_devices_service = Aws::IoT1ClickDevicesService::Client.new
28
+ # resp = io_t1_click_devices_service.claim_devices_by_claim_code(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS IoT 1-Click Devices Service all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS IoT 1-Click Devices Service are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::IoT1ClickDevicesService::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS IoT 1-Click Devices Service API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-iot1clickdevicesservice/customizations'
42
45
  # @service
43
46
  module Aws::IoT1ClickDevicesService
44
47
 
45
- GEM_VERSION = '1.16.0'
48
+ GEM_VERSION = '1.21.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:iot1clickdevicesservice)
31
31
 
32
32
  module Aws::IoT1ClickDevicesService
33
+ # An API client for IoT1ClickDevicesService. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::IoT1ClickDevicesService::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::IoT1ClickDevicesService
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::IoT1ClickDevicesService
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::IoT1ClickDevicesService
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::IoT1ClickDevicesService
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::IoT1ClickDevicesService
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::IoT1ClickDevicesService
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # 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.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::IoT1ClickDevicesService
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::IoT1ClickDevicesService
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::IoT1ClickDevicesService
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -703,7 +757,7 @@ module Aws::IoT1ClickDevicesService
703
757
  params: params,
704
758
  config: config)
705
759
  context[:gem_name] = 'aws-sdk-iot1clickdevicesservice'
706
- context[:gem_version] = '1.16.0'
760
+ context[:gem_version] = '1.21.0'
707
761
  Seahorse::Client::Request.new(handlers, context)
708
762
  end
709
763
 
@@ -6,6 +6,35 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IoT1ClickDevicesService
9
+
10
+ # When IoT1ClickDevicesService returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::IoT1ClickDevicesService::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all IoT1ClickDevicesService errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::IoT1ClickDevicesService::Errors::ServiceError
18
+ # # rescues all IoT1ClickDevicesService API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {ForbiddenException}
29
+ # * {InternalFailureException}
30
+ # * {InvalidRequestException}
31
+ # * {PreconditionFailedException}
32
+ # * {RangeNotSatisfiableException}
33
+ # * {ResourceConflictException}
34
+ # * {ResourceNotFoundException}
35
+ #
36
+ # Additionally, error classes are dynamically generated for service errors based on the error code
37
+ # if they are not defined above.
9
38
  module Errors
10
39
 
11
40
  extend Aws::Errors::DynamicErrors
@@ -28,7 +57,6 @@ module Aws::IoT1ClickDevicesService
28
57
  def message
29
58
  @message || @data[:message]
30
59
  end
31
-
32
60
  end
33
61
 
34
62
  class InternalFailureException < ServiceError
@@ -49,7 +77,6 @@ module Aws::IoT1ClickDevicesService
49
77
  def message
50
78
  @message || @data[:message]
51
79
  end
52
-
53
80
  end
54
81
 
55
82
  class InvalidRequestException < ServiceError
@@ -70,7 +97,6 @@ module Aws::IoT1ClickDevicesService
70
97
  def message
71
98
  @message || @data[:message]
72
99
  end
73
-
74
100
  end
75
101
 
76
102
  class PreconditionFailedException < ServiceError
@@ -91,7 +117,6 @@ module Aws::IoT1ClickDevicesService
91
117
  def message
92
118
  @message || @data[:message]
93
119
  end
94
-
95
120
  end
96
121
 
97
122
  class RangeNotSatisfiableException < ServiceError
@@ -112,7 +137,6 @@ module Aws::IoT1ClickDevicesService
112
137
  def message
113
138
  @message || @data[:message]
114
139
  end
115
-
116
140
  end
117
141
 
118
142
  class ResourceConflictException < ServiceError
@@ -133,7 +157,6 @@ module Aws::IoT1ClickDevicesService
133
157
  def message
134
158
  @message || @data[:message]
135
159
  end
136
-
137
160
  end
138
161
 
139
162
  class ResourceNotFoundException < ServiceError
@@ -154,7 +177,6 @@ module Aws::IoT1ClickDevicesService
154
177
  def message
155
178
  @message || @data[:message]
156
179
  end
157
-
158
180
  end
159
181
 
160
182
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IoT1ClickDevicesService
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-iot1clickdevicesservice
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.16.0
4
+ version: 1.21.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-07-01 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.58.0
22
+ version: 3.71.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.58.0
32
+ version: 3.71.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - AWS IoT 1-Click Devices Service