aws-sdk-kinesis 1.18.0 → 1.23.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: a3adfc4347dd9b7ee1401349e381647d5c49d306
4
- data.tar.gz: fcedbd879e66ddf6c364b3f63a1fc18906bbd13d
2
+ SHA256:
3
+ metadata.gz: 68402fe2ff49949770c040d8ebbb2f46a3d7757fe31197834ab4363ff8ec8660
4
+ data.tar.gz: d3c65fb83cd1114b27d014a30f4049f04b70946a735fc03a9a3a5b13b3949e58
5
5
  SHA512:
6
- metadata.gz: b7db40b40962a3c4a308b3d533fa2d15ac6d02e7dfb9e0a90bd117d9c359c8b8569952530ac3a92a82d5c99e0bec450fbc94141361f9363f04d804c60285e00c
7
- data.tar.gz: 7ca561e45d08658537561505a4273e488fc4fd7d3352787e8e08f201b6d277d600752cf109e0baa06708764d5dc0ea8d81b1e56e43f83b180111bf51f6197798
6
+ metadata.gz: 400d6f9b32f964b7e8b182890976865b44e2a500218ecf2ec04fe17ba5d94241d84fa54b9c4455da40e38eb5e1c994b0e9589c77b3b606dba2944d0793ade8c5
7
+ data.tar.gz: e0d09ac3beec9ee60db55f73daaacf60bf0cdbdf61f031c812cbf38818abd52b76fb769a9b269116dc98586c7cd8f1d9f9581136eda98b1a9c97ac6bad306e2e
@@ -27,17 +27,20 @@ require_relative 'aws-sdk-kinesis/event_streams'
27
27
  # methods each accept a hash of request parameters and return a response
28
28
  # structure.
29
29
  #
30
+ # kinesis = Aws::Kinesis::Client.new
31
+ # resp = kinesis.add_tags_to_stream(params)
32
+ #
30
33
  # See {Client} for more information.
31
34
  #
32
35
  # # Errors
33
36
  #
34
- # Errors returned from Amazon Kinesis all
35
- # extend {Errors::ServiceError}.
37
+ # Errors returned from Amazon Kinesis are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
36
39
  #
37
40
  # begin
38
41
  # # do stuff
39
42
  # rescue Aws::Kinesis::Errors::ServiceError
40
- # # rescues all service API errors
43
+ # # rescues all Amazon Kinesis API errors
41
44
  # end
42
45
  #
43
46
  # See {Errors} for more information.
@@ -45,6 +48,6 @@ require_relative 'aws-sdk-kinesis/event_streams'
45
48
  # @service
46
49
  module Aws::Kinesis
47
50
 
48
- GEM_VERSION = '1.18.0'
51
+ GEM_VERSION = '1.23.0'
49
52
 
50
53
  end
@@ -88,7 +88,7 @@ module Aws::Kinesis
88
88
  # @option options [required, String] :region
89
89
  # The AWS region to connect to. The configured `:region` is
90
90
  # used to determine the service `:endpoint`. When not passed,
91
- # a default `:region` is search for in the following locations:
91
+ # a default `:region` is searched for in the following locations:
92
92
  #
93
93
  # * `Aws.config[:region]`
94
94
  # * `ENV['AWS_REGION']`
@@ -99,14 +99,24 @@ module Aws::Kinesis
99
99
  #
100
100
  # @option options [String] :access_key_id
101
101
  #
102
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
103
+ # Used only in `adaptive` retry mode. When true, the request will sleep
104
+ # until there is sufficent client side capacity to retry the request.
105
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
106
+ # not retry instead of sleeping.
107
+ #
102
108
  # @option options [Boolean] :convert_params (true)
103
109
  # When `true`, an attempt is made to coerce request parameters into
104
110
  # the required types.
105
111
  #
112
+ # @option options [Boolean] :correct_clock_skew (true)
113
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
114
+ # a clock skew correction and retry requests with skewed client clocks.
115
+ #
106
116
  # @option options [String] :endpoint
107
117
  # The client endpoint is normally constructed from the `:region`
108
118
  # option. You should only configure an `:endpoint` when connecting
109
- # to test endpoints. This should be avalid HTTP(S) URI.
119
+ # to test endpoints. This should be a valid HTTP(S) URI.
110
120
  #
111
121
  # @option options [Proc] :event_stream_handler
112
122
  # When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
@@ -124,6 +134,12 @@ module Aws::Kinesis
124
134
  # The Logger instance to send log messages to. If this option
125
135
  # is not set, logging will be disabled.
126
136
  #
137
+ # @option options [Integer] :max_attempts (3)
138
+ # An integer representing the maximum number attempts that will be made for
139
+ # a single request, including the initial attempt. For example,
140
+ # setting this value to 5 will result in a request being retried up to
141
+ # 4 times. Used in `standard` and `adaptive` retry modes.
142
+ #
127
143
  # @option options [Proc] :output_event_stream_handler
128
144
  # When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
129
145
  #
@@ -131,11 +147,19 @@ module Aws::Kinesis
131
147
  # Used when loading credentials from the shared credentials file
132
148
  # at HOME/.aws/credentials. When not specified, 'default' is used.
133
149
  #
150
+ # @option options [Proc] :retry_backoff
151
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
152
+ # This option is only used in the `legacy` retry mode.
153
+ #
134
154
  # @option options [Float] :retry_base_delay (0.3)
135
- # The base delay in seconds used by the default backoff function.
155
+ # The base delay in seconds used by the default backoff function. This option
156
+ # is only used in the `legacy` retry mode.
136
157
  #
137
158
  # @option options [Symbol] :retry_jitter (:none)
138
- # 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.
159
+ # A delay randomiser function used by the default backoff function.
160
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
161
+ # otherwise a Proc that takes and returns a number. This option is only used
162
+ # in the `legacy` retry mode.
139
163
  #
140
164
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
141
165
  #
@@ -143,11 +167,30 @@ module Aws::Kinesis
143
167
  # The maximum number of times to retry failed requests. Only
144
168
  # ~ 500 level server errors and certain ~ 400 level client errors
145
169
  # are retried. Generally, these are throttling errors, data
146
- # checksum errors, networking errors, timeout errors and auth
147
- # errors from expired credentials.
170
+ # checksum errors, networking errors, timeout errors, auth errors,
171
+ # endpoint discovery, and errors from expired credentials.
172
+ # This option is only used in the `legacy` retry mode.
148
173
  #
149
174
  # @option options [Integer] :retry_max_delay (0)
150
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
175
+ # The maximum number of seconds to delay between retries (0 for no limit)
176
+ # used by the default backoff function. This option is only used in the
177
+ # `legacy` retry mode.
178
+ #
179
+ # @option options [String] :retry_mode ("legacy")
180
+ # Specifies which retry algorithm to use. Values are:
181
+ #
182
+ # * `legacy` - The pre-existing retry behavior. This is default value if
183
+ # no retry mode is provided.
184
+ #
185
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
186
+ # This includes support for retry quotas, which limit the number of
187
+ # unsuccessful retries a client can make.
188
+ #
189
+ # * `adaptive` - An experimental retry mode that includes all the
190
+ # functionality of `standard` mode along with automatic client side
191
+ # throttling. This is a provisional mode that may change behavior
192
+ # in the future.
193
+ #
151
194
  #
152
195
  # @option options [String] :secret_access_key
153
196
  #
@@ -473,7 +516,7 @@ module Aws::Kinesis
473
516
  http_response: Seahorse::Client::Http::AsyncResponse.new,
474
517
  config: config)
475
518
  context[:gem_name] = 'aws-sdk-kinesis'
476
- context[:gem_version] = '1.18.0'
519
+ context[:gem_version] = '1.23.0'
477
520
  Seahorse::Client::Request.new(handlers, context)
478
521
  end
479
522
 
@@ -486,8 +529,8 @@ module Aws::Kinesis
486
529
  when nil then event_stream_class.new
487
530
  else
488
531
  msg = "expected #{type}_event_stream_handler to be a block or "\
489
- "instance of Aws::Kinesis::#{event_stream_class}"\
490
- ", got `#{handler.inspect}` instead"
532
+ "instance of Aws::Kinesis::#{event_stream_class}"\
533
+ ", got `#{handler.inspect}` instead"
491
534
  raise ArgumentError, msg
492
535
  end
493
536
  end
@@ -31,6 +31,18 @@ require 'aws-sdk-core/plugins/event_stream_configuration.rb'
31
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:kinesis)
32
32
 
33
33
  module Aws::Kinesis
34
+ # An API client for Kinesis. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::Kinesis::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
34
46
  class Client < Seahorse::Client::Base
35
47
 
36
48
  include Aws::ClientStubs
@@ -95,7 +107,7 @@ module Aws::Kinesis
95
107
  # @option options [required, String] :region
96
108
  # The AWS region to connect to. The configured `:region` is
97
109
  # used to determine the service `:endpoint`. When not passed,
98
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
99
111
  #
100
112
  # * `Aws.config[:region]`
101
113
  # * `ENV['AWS_REGION']`
@@ -110,6 +122,12 @@ module Aws::Kinesis
110
122
  # When set to `true`, a thread polling for endpoints will be running in
111
123
  # the background every 60 secs (default). Defaults to `false`.
112
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
113
131
  # @option options [Boolean] :client_side_monitoring (false)
114
132
  # When `true`, client-side metrics will be collected for all API requests from
115
133
  # this client.
@@ -134,6 +152,10 @@ module Aws::Kinesis
134
152
  # When `true`, an attempt is made to coerce request parameters into
135
153
  # the required types.
136
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
137
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
138
160
  # Set to true to disable SDK automatically adding host prefix
139
161
  # to default service endpoint when available.
@@ -141,7 +163,7 @@ module Aws::Kinesis
141
163
  # @option options [String] :endpoint
142
164
  # The client endpoint is normally constructed from the `:region`
143
165
  # option. You should only configure an `:endpoint` when connecting
144
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test endpoints. This should be a valid HTTP(S) URI.
145
167
  #
146
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
147
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -156,7 +178,7 @@ module Aws::Kinesis
156
178
  # requests fetching endpoints information. Defaults to 60 sec.
157
179
  #
158
180
  # @option options [Boolean] :endpoint_discovery (false)
159
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
160
182
  #
161
183
  # @option options [Proc] :event_stream_handler
162
184
  # When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
@@ -174,6 +196,12 @@ module Aws::Kinesis
174
196
  # The Logger instance to send log messages to. If this option
175
197
  # is not set, logging will be disabled.
176
198
  #
199
+ # @option options [Integer] :max_attempts (3)
200
+ # An integer representing the maximum number attempts that will be made for
201
+ # a single request, including the initial attempt. For example,
202
+ # setting this value to 5 will result in a request being retried up to
203
+ # 4 times. Used in `standard` and `adaptive` retry modes.
204
+ #
177
205
  # @option options [Proc] :output_event_stream_handler
178
206
  # When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
179
207
  #
@@ -181,11 +209,19 @@ module Aws::Kinesis
181
209
  # Used when loading credentials from the shared credentials file
182
210
  # at HOME/.aws/credentials. When not specified, 'default' is used.
183
211
  #
212
+ # @option options [Proc] :retry_backoff
213
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
214
+ # This option is only used in the `legacy` retry mode.
215
+ #
184
216
  # @option options [Float] :retry_base_delay (0.3)
185
- # The base delay in seconds used by the default backoff function.
217
+ # The base delay in seconds used by the default backoff function. This option
218
+ # is only used in the `legacy` retry mode.
186
219
  #
187
220
  # @option options [Symbol] :retry_jitter (:none)
188
- # 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.
221
+ # A delay randomiser function used by the default backoff function.
222
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
223
+ # otherwise a Proc that takes and returns a number. This option is only used
224
+ # in the `legacy` retry mode.
189
225
  #
190
226
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
191
227
  #
@@ -193,11 +229,30 @@ module Aws::Kinesis
193
229
  # The maximum number of times to retry failed requests. Only
194
230
  # ~ 500 level server errors and certain ~ 400 level client errors
195
231
  # are retried. Generally, these are throttling errors, data
196
- # checksum errors, networking errors, timeout errors and auth
197
- # errors from expired credentials.
232
+ # checksum errors, networking errors, timeout errors, auth errors,
233
+ # endpoint discovery, and errors from expired credentials.
234
+ # This option is only used in the `legacy` retry mode.
198
235
  #
199
236
  # @option options [Integer] :retry_max_delay (0)
200
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
237
+ # The maximum number of seconds to delay between retries (0 for no limit)
238
+ # used by the default backoff function. This option is only used in the
239
+ # `legacy` retry mode.
240
+ #
241
+ # @option options [String] :retry_mode ("legacy")
242
+ # Specifies which retry algorithm to use. Values are:
243
+ #
244
+ # * `legacy` - The pre-existing retry behavior. This is default value if
245
+ # no retry mode is provided.
246
+ #
247
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
248
+ # This includes support for retry quotas, which limit the number of
249
+ # unsuccessful retries a client can make.
250
+ #
251
+ # * `adaptive` - An experimental retry mode that includes all the
252
+ # functionality of `standard` mode along with automatic client side
253
+ # throttling. This is a provisional mode that may change behavior
254
+ # in the future.
255
+ #
201
256
  #
202
257
  # @option options [String] :secret_access_key
203
258
  #
@@ -230,16 +285,15 @@ module Aws::Kinesis
230
285
  # requests through. Formatted like 'http://proxy.com:123'.
231
286
  #
232
287
  # @option options [Float] :http_open_timeout (15) The number of
233
- # seconds to wait when opening a HTTP session before rasing a
288
+ # seconds to wait when opening a HTTP session before raising a
234
289
  # `Timeout::Error`.
235
290
  #
236
291
  # @option options [Integer] :http_read_timeout (60) The default
237
292
  # number of seconds to wait for response data. This value can
238
- # safely be set
239
- # per-request on the session yeidled by {#session_for}.
293
+ # safely be set per-request on the session.
240
294
  #
241
295
  # @option options [Float] :http_idle_timeout (5) The number of
242
- # seconds a connection is allowed to sit idble before it is
296
+ # seconds a connection is allowed to sit idle before it is
243
297
  # considered stale. Stale connections are closed and removed
244
298
  # from the pool before making a request.
245
299
  #
@@ -248,7 +302,7 @@ module Aws::Kinesis
248
302
  # request body. This option has no effect unless the request has
249
303
  # "Expect" header set to "100-continue". Defaults to `nil` which
250
304
  # disables this behaviour. This value can safely be set per
251
- # request on the session yeidled by {#session_for}.
305
+ # request on the session.
252
306
  #
253
307
  # @option options [Boolean] :http_wire_trace (false) When `true`,
254
308
  # HTTP debug output will be sent to the `:logger`.
@@ -589,6 +643,8 @@ module Aws::Kinesis
589
643
  #
590
644
  # * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
591
645
  #
646
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
647
+ #
592
648
  # @example Request syntax with placeholder values
593
649
  #
594
650
  # resp = client.describe_stream({
@@ -619,6 +675,12 @@ module Aws::Kinesis
619
675
  # resp.stream_description.encryption_type #=> String, one of "NONE", "KMS"
620
676
  # resp.stream_description.key_id #=> String
621
677
  #
678
+ #
679
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
680
+ #
681
+ # * stream_exists
682
+ # * stream_not_exists
683
+ #
622
684
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStream AWS API Documentation
623
685
  #
624
686
  # @overload describe_stream(params = {})
@@ -1298,6 +1360,8 @@ module Aws::Kinesis
1298
1360
  # * {Types::ListStreamConsumersOutput#consumers #consumers} => Array&lt;Types::Consumer&gt;
1299
1361
  # * {Types::ListStreamConsumersOutput#next_token #next_token} => String
1300
1362
  #
1363
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1364
+ #
1301
1365
  # @example Request syntax with placeholder values
1302
1366
  #
1303
1367
  # resp = client.list_stream_consumers({
@@ -1355,6 +1419,8 @@ module Aws::Kinesis
1355
1419
  # * {Types::ListStreamsOutput#stream_names #stream_names} => Array&lt;String&gt;
1356
1420
  # * {Types::ListStreamsOutput#has_more_streams #has_more_streams} => Boolean
1357
1421
  #
1422
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1423
+ #
1358
1424
  # @example Request syntax with placeholder values
1359
1425
  #
1360
1426
  # resp = client.list_streams({
@@ -2133,7 +2199,7 @@ module Aws::Kinesis
2133
2199
  params: params,
2134
2200
  config: config)
2135
2201
  context[:gem_name] = 'aws-sdk-kinesis'
2136
- context[:gem_version] = '1.18.0'
2202
+ context[:gem_version] = '1.23.0'
2137
2203
  Seahorse::Client::Request.new(handlers, context)
2138
2204
  end
2139
2205
 
@@ -2199,10 +2265,10 @@ module Aws::Kinesis
2199
2265
  # The following table lists the valid waiter names, the operations they call,
2200
2266
  # and the default `:delay` and `:max_attempts` values.
2201
2267
  #
2202
- # | waiter_name | params | :delay | :max_attempts |
2203
- # | ----------------- | ------------------ | -------- | ------------- |
2204
- # | stream_exists | {#describe_stream} | 10 | 18 |
2205
- # | stream_not_exists | {#describe_stream} | 10 | 18 |
2268
+ # | waiter_name | params | :delay | :max_attempts |
2269
+ # | ----------------- | ------------------------ | -------- | ------------- |
2270
+ # | stream_exists | {Client#describe_stream} | 10 | 18 |
2271
+ # | stream_not_exists | {Client#describe_stream} | 10 | 18 |
2206
2272
  #
2207
2273
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
2208
2274
  # because the waiter has entered a state that it will not transition
@@ -6,6 +6,33 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Kinesis
9
+
10
+ # When Kinesis returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::Kinesis::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all Kinesis errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::Kinesis::Errors::ServiceError
18
+ # # rescues all Kinesis 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
+ # * {ExpiredIteratorException}
29
+ # * {ExpiredNextTokenException}
30
+ # * {InvalidArgumentException}
31
+ # * {LimitExceededException}
32
+ # * {ProvisionedThroughputExceededException}
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::Kinesis
23
50
  def message
24
51
  @message || @data[:message]
25
52
  end
26
-
27
53
  end
28
54
 
29
55
  class ExpiredNextTokenException < ServiceError
@@ -39,7 +65,6 @@ module Aws::Kinesis
39
65
  def message
40
66
  @message || @data[:message]
41
67
  end
42
-
43
68
  end
44
69
 
45
70
  class InvalidArgumentException < ServiceError
@@ -55,7 +80,6 @@ module Aws::Kinesis
55
80
  def message
56
81
  @message || @data[:message]
57
82
  end
58
-
59
83
  end
60
84
 
61
85
  class LimitExceededException < ServiceError
@@ -71,7 +95,6 @@ module Aws::Kinesis
71
95
  def message
72
96
  @message || @data[:message]
73
97
  end
74
-
75
98
  end
76
99
 
77
100
  class ProvisionedThroughputExceededException < ServiceError
@@ -87,7 +110,6 @@ module Aws::Kinesis
87
110
  def message
88
111
  @message || @data[:message]
89
112
  end
90
-
91
113
  end
92
114
 
93
115
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Kinesis
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -8,6 +8,68 @@
8
8
  require 'aws-sdk-core/waiters'
9
9
 
10
10
  module Aws::Kinesis
11
+ # Waiters are utility methods that poll for a particular state to occur
12
+ # on a client. Waiters can fail after a number of attempts at a polling
13
+ # interval defined for the service client.
14
+ #
15
+ # For a list of operations that can be waited for and the
16
+ # client methods called for each operation, see the table below or the
17
+ # {Client#wait_until} field documentation for the {Client}.
18
+ #
19
+ # # Invoking a Waiter
20
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
21
+ # is the waiter name, which is specific to the service client and indicates
22
+ # which operation is being waited for. The second parameter is a hash of
23
+ # parameters that are passed to the client method called by the waiter,
24
+ # which varies according to the waiter name.
25
+ #
26
+ # # Wait Failures
27
+ # To catch errors in a waiter, use WaiterFailed,
28
+ # as shown in the following example.
29
+ #
30
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
31
+ # puts "failed waiting for instance running: #{error.message}
32
+ # end
33
+ #
34
+ # # Configuring a Waiter
35
+ # Each waiter has a default polling interval and a maximum number of
36
+ # attempts it will make before returning control to your program.
37
+ # To set these values, use the `max_attempts` and `delay` parameters
38
+ # in your `#wait_until` call.
39
+ # The following example waits for up to 25 seconds, polling every five seconds.
40
+ #
41
+ # client.wait_until(...) do |w|
42
+ # w.max_attempts = 5
43
+ # w.delay = 5
44
+ # end
45
+ #
46
+ # To disable wait failures, set the value of either of these parameters
47
+ # to `nil`.
48
+ #
49
+ # # Extending a Waiter
50
+ # To modify the behavior of waiters, you can register callbacks that are
51
+ # triggered before each polling attempt and before waiting.
52
+ #
53
+ # The following example implements an exponential backoff in a waiter
54
+ # by doubling the amount of time to wait on every attempt.
55
+ #
56
+ # client.wait_until(...) do |w|
57
+ # w.interval = 0 # disable normal sleep
58
+ # w.before_wait do |n, resp|
59
+ # sleep(n ** 2)
60
+ # end
61
+ # end
62
+ #
63
+ # # Available Waiters
64
+ #
65
+ # The following table lists the valid waiter names, the operations they call,
66
+ # and the default `:delay` and `:max_attempts` values.
67
+ #
68
+ # | waiter_name | params | :delay | :max_attempts |
69
+ # | ----------------- | ------------------------ | -------- | ------------- |
70
+ # | stream_exists | {Client#describe_stream} | 10 | 18 |
71
+ # | stream_not_exists | {Client#describe_stream} | 10 | 18 |
72
+ #
11
73
  module Waiters
12
74
 
13
75
  class StreamExists
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-kinesis
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.18.0
4
+ version: 1.23.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
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
84
84
  version: '0'
85
85
  requirements: []
86
86
  rubyforge_project:
87
- rubygems_version: 2.5.2.3
87
+ rubygems_version: 2.7.6.2
88
88
  signing_key:
89
89
  specification_version: 4
90
90
  summary: AWS SDK for Ruby - Kinesis