aws-sdk-ioteventsdata 1.5.0 → 1.6.0

This diff has not been reviewed by any users.
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
2
  SHA1:
3
- metadata.gz: 9b97a8464a08bf082dc40515c1752369e02a8f8c
4
- data.tar.gz: d2466511a2e12280036af4cdb7e624a702a74fff
3
+ metadata.gz: 01c8c9693fd5538c9b5f4228366303911ab3f16e
4
+ data.tar.gz: 352f0ca0aacc7f482e9b92444bb78595299cbdef
5
5
  SHA512:
6
- metadata.gz: 89809a61755eb33d92ccd4294844a40b7faba2aa75cf815897e085206e1dc79f6ab150a25cbe3e7c7bbd93d502a81d22e03adb3312dc5e35f007130392d97cee
7
- data.tar.gz: 8d2c0a04623b6aa327718bb8eed0552d5a568f16fcaefca90294e8113dd1311dcd5a5c8ba77cef9a2ca9a58a6d4ee086190c7619ce1cdc8989dee9cd09ae84f7
6
+ metadata.gz: 193cc740c045f17afea68410f461c1be6473efe86e44aefe2b8aec391325cb8eb2ce2f1b80abed9e69bb0acc4a24ae95fed052802d6ff858a0b26a2993bdde61
7
+ data.tar.gz: 074a00aff5183b9d7448fa5d51ab7030e22798a46e9a5759cb29053342623dcaa835788f88af01b9c49cda9bba1e8b49f64ceb9831038c173ca2a670eb78635f
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-ioteventsdata/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # io_t_events_data = Aws::IoTEventsData::Client.new
28
+ # resp = io_t_events_data.batch_put_message(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS IoT Events Data all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS IoT Events Data 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::IoTEventsData::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS IoT Events Data API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-ioteventsdata/customizations'
42
45
  # @service
43
46
  module Aws::IoTEventsData
44
47
 
45
- GEM_VERSION = '1.5.0'
48
+ GEM_VERSION = '1.6.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(:ioteventsdata)
31
31
 
32
32
  module Aws::IoTEventsData
33
+ # An API client for IoTEventsData. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::IoTEventsData::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
@@ -108,6 +120,12 @@ module Aws::IoTEventsData
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::IoTEventsData
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.
@@ -166,15 +188,29 @@ module Aws::IoTEventsData
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,26 @@ module Aws::IoTEventsData
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
+ # * `legacy` - The pre-existing retry behavior. This is default value if
233
+ # no retry mode is provided.
234
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
+ # This includes support for retry quotas, which limit the number of
236
+ # unsuccessful retries a client can make.
237
+ # * `adaptive` - An experimental retry mode that includes all the
238
+ # functionality of `standard` mode along with automatic client side
239
+ # throttling. This is a provisional mode that may change behavior
240
+ # in the future.
190
241
  #
191
242
  # @option options [String] :secret_access_key
192
243
  #
@@ -209,16 +260,16 @@ module Aws::IoTEventsData
209
260
  # requests through. Formatted like 'http://proxy.com:123'.
210
261
  #
211
262
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
263
+ # seconds to wait when opening a HTTP session before raising a
213
264
  # `Timeout::Error`.
214
265
  #
215
266
  # @option options [Integer] :http_read_timeout (60) The default
216
267
  # number of seconds to wait for response data. This value can
217
268
  # safely be set
218
- # per-request on the session yeidled by {#session_for}.
269
+ # per-request on the session yielded by {#session_for}.
219
270
  #
220
271
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
272
+ # seconds a connection is allowed to sit idle before it is
222
273
  # considered stale. Stale connections are closed and removed
223
274
  # from the pool before making a request.
224
275
  #
@@ -227,7 +278,7 @@ module Aws::IoTEventsData
227
278
  # request body. This option has no effect unless the request has
228
279
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
280
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
281
+ # request on the session yielded by {#session_for}.
231
282
  #
232
283
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
284
  # HTTP debug output will be sent to the `:logger`.
@@ -451,7 +502,7 @@ module Aws::IoTEventsData
451
502
  params: params,
452
503
  config: config)
453
504
  context[:gem_name] = 'aws-sdk-ioteventsdata'
454
- context[:gem_version] = '1.5.0'
505
+ context[:gem_version] = '1.6.0'
455
506
  Seahorse::Client::Request.new(handlers, context)
456
507
  end
457
508
 
@@ -6,6 +6,33 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IoTEventsData
9
+
10
+ # When IoTEventsData returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::IoTEventsData::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all IoTEventsData errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::IoTEventsData::Errors::ServiceError
18
+ # # rescues all IoTEventsData 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
+ # * {InternalFailureException}
29
+ # * {InvalidRequestException}
30
+ # * {ResourceNotFoundException}
31
+ # * {ServiceUnavailableException}
32
+ # * {ThrottlingException}
33
+ #
34
+ # Additionally, error classes are dynamically generated for service errors based on the error code
35
+ # if they are not defined above.
9
36
  module Errors
10
37
 
11
38
  extend Aws::Errors::DynamicErrors
@@ -23,7 +50,6 @@ module Aws::IoTEventsData
23
50
  def message
24
51
  @message || @data[:message]
25
52
  end
26
-
27
53
  end
28
54
 
29
55
  class InvalidRequestException < ServiceError
@@ -39,7 +65,6 @@ module Aws::IoTEventsData
39
65
  def message
40
66
  @message || @data[:message]
41
67
  end
42
-
43
68
  end
44
69
 
45
70
  class ResourceNotFoundException < ServiceError
@@ -55,7 +80,6 @@ module Aws::IoTEventsData
55
80
  def message
56
81
  @message || @data[:message]
57
82
  end
58
-
59
83
  end
60
84
 
61
85
  class ServiceUnavailableException < ServiceError
@@ -71,7 +95,6 @@ module Aws::IoTEventsData
71
95
  def message
72
96
  @message || @data[:message]
73
97
  end
74
-
75
98
  end
76
99
 
77
100
  class ThrottlingException < ServiceError
@@ -87,7 +110,6 @@ module Aws::IoTEventsData
87
110
  def message
88
111
  @message || @data[:message]
89
112
  end
90
-
91
113
  end
92
114
 
93
115
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IoTEventsData
9
+ # This class provides a resource oriented interface for IoTEventsData.
10
+ # To create a resource object:
11
+ # resource = Aws::IoTEventsData::Resource.new(region: 'us-west-2')
12
+ # You can supply a client object with custom configuration that will be used for all resource operations.
13
+ # If you do not pass +:client+, a default client will be constructed.
14
+ # client = Aws::IoTEventsData::Client.new(region: 'us-west-2')
15
+ # resource = Aws::IoTEventsData::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-ioteventsdata
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.5.0
4
+ version: 1.6.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-10-23 00:00:00.000000000 Z
11
+ date: 2020-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core