aws-sdk-kinesis 1.20.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-kinesis.rb +9 -4
- data/lib/aws-sdk-kinesis/async_client.rb +57 -10
- data/lib/aws-sdk-kinesis/client.rb +88 -18
- data/lib/aws-sdk-kinesis/client_api.rb +2 -0
- data/lib/aws-sdk-kinesis/customizations.rb +1 -0
- data/lib/aws-sdk-kinesis/errors.rb +29 -5
- data/lib/aws-sdk-kinesis/event_streams.rb +7 -0
- data/lib/aws-sdk-kinesis/resource.rb +3 -0
- data/lib/aws-sdk-kinesis/types.rb +73 -0
- data/lib/aws-sdk-kinesis/waiters.rb +64 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4e3041a8a4a1a2435292f9326cfbb7fea38ab756ef5785cc67897c1b336d1dc6
|
4
|
+
data.tar.gz: fb815e7ab1cf5c040719c316cf5c5cf0706d6c4ced4f2de6cd7c63335569e831
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '09deae891e03dda344895306c37768c4f88ecfa626a095bc27e7d536873b5c8c47da33771518bf3283b1a4659e95619fc959e3c166c39244799cec6f58ac071e'
|
7
|
+
data.tar.gz: 4f92cca04ac1587970992748d4f1b923c85297e332ceb3d06cd61852daea81e48108dc300ebdd2ce244b86b13afd22bee4e5dc043d1e5e9d094d7cb74c02210b
|
data/lib/aws-sdk-kinesis.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -27,17 +29,20 @@ require_relative 'aws-sdk-kinesis/event_streams'
|
|
27
29
|
# methods each accept a hash of request parameters and return a response
|
28
30
|
# structure.
|
29
31
|
#
|
32
|
+
# kinesis = Aws::Kinesis::Client.new
|
33
|
+
# resp = kinesis.add_tags_to_stream(params)
|
34
|
+
#
|
30
35
|
# See {Client} for more information.
|
31
36
|
#
|
32
37
|
# # Errors
|
33
38
|
#
|
34
|
-
# Errors returned from Amazon Kinesis
|
35
|
-
# extend {Errors::ServiceError}.
|
39
|
+
# Errors returned from Amazon Kinesis are defined in the
|
40
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
36
41
|
#
|
37
42
|
# begin
|
38
43
|
# # do stuff
|
39
44
|
# rescue Aws::Kinesis::Errors::ServiceError
|
40
|
-
# # rescues all
|
45
|
+
# # rescues all Amazon Kinesis API errors
|
41
46
|
# end
|
42
47
|
#
|
43
48
|
# See {Errors} for more information.
|
@@ -45,6 +50,6 @@ require_relative 'aws-sdk-kinesis/event_streams'
|
|
45
50
|
# @service
|
46
51
|
module Aws::Kinesis
|
47
52
|
|
48
|
-
GEM_VERSION = '1.
|
53
|
+
GEM_VERSION = '1.25.0'
|
49
54
|
|
50
55
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -23,6 +25,7 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
23
25
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
26
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
27
|
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
28
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
26
29
|
require 'aws-sdk-core/plugins/invocation_id.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
@@ -52,6 +55,7 @@ module Aws::Kinesis
|
|
52
55
|
add_plugin(Aws::Plugins::StubResponses)
|
53
56
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
54
57
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
58
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
55
59
|
add_plugin(Aws::Plugins::InvocationId)
|
56
60
|
add_plugin(Aws::Plugins::SignatureV4)
|
57
61
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
@@ -88,7 +92,7 @@ module Aws::Kinesis
|
|
88
92
|
# @option options [required, String] :region
|
89
93
|
# The AWS region to connect to. The configured `:region` is
|
90
94
|
# used to determine the service `:endpoint`. When not passed,
|
91
|
-
# a default `:region` is
|
95
|
+
# a default `:region` is searched for in the following locations:
|
92
96
|
#
|
93
97
|
# * `Aws.config[:region]`
|
94
98
|
# * `ENV['AWS_REGION']`
|
@@ -99,14 +103,24 @@ module Aws::Kinesis
|
|
99
103
|
#
|
100
104
|
# @option options [String] :access_key_id
|
101
105
|
#
|
106
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
107
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
108
|
+
# until there is sufficent client side capacity to retry the request.
|
109
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
110
|
+
# not retry instead of sleeping.
|
111
|
+
#
|
102
112
|
# @option options [Boolean] :convert_params (true)
|
103
113
|
# When `true`, an attempt is made to coerce request parameters into
|
104
114
|
# the required types.
|
105
115
|
#
|
116
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
117
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
118
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
119
|
+
#
|
106
120
|
# @option options [String] :endpoint
|
107
121
|
# The client endpoint is normally constructed from the `:region`
|
108
122
|
# option. You should only configure an `:endpoint` when connecting
|
109
|
-
# to test endpoints. This should be
|
123
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
110
124
|
#
|
111
125
|
# @option options [Proc] :event_stream_handler
|
112
126
|
# 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 +138,12 @@ module Aws::Kinesis
|
|
124
138
|
# The Logger instance to send log messages to. If this option
|
125
139
|
# is not set, logging will be disabled.
|
126
140
|
#
|
141
|
+
# @option options [Integer] :max_attempts (3)
|
142
|
+
# An integer representing the maximum number attempts that will be made for
|
143
|
+
# a single request, including the initial attempt. For example,
|
144
|
+
# setting this value to 5 will result in a request being retried up to
|
145
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
146
|
+
#
|
127
147
|
# @option options [Proc] :output_event_stream_handler
|
128
148
|
# 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
149
|
#
|
@@ -131,11 +151,19 @@ module Aws::Kinesis
|
|
131
151
|
# Used when loading credentials from the shared credentials file
|
132
152
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
133
153
|
#
|
154
|
+
# @option options [Proc] :retry_backoff
|
155
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
156
|
+
# This option is only used in the `legacy` retry mode.
|
157
|
+
#
|
134
158
|
# @option options [Float] :retry_base_delay (0.3)
|
135
|
-
# The base delay in seconds used by the default backoff function.
|
159
|
+
# The base delay in seconds used by the default backoff function. This option
|
160
|
+
# is only used in the `legacy` retry mode.
|
136
161
|
#
|
137
162
|
# @option options [Symbol] :retry_jitter (:none)
|
138
|
-
# A delay randomiser function used by the default backoff function.
|
163
|
+
# A delay randomiser function used by the default backoff function.
|
164
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
165
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
166
|
+
# in the `legacy` retry mode.
|
139
167
|
#
|
140
168
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
141
169
|
#
|
@@ -143,11 +171,30 @@ module Aws::Kinesis
|
|
143
171
|
# The maximum number of times to retry failed requests. Only
|
144
172
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
145
173
|
# are retried. Generally, these are throttling errors, data
|
146
|
-
# checksum errors, networking errors, timeout errors
|
147
|
-
# errors from expired credentials.
|
174
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
175
|
+
# endpoint discovery, and errors from expired credentials.
|
176
|
+
# This option is only used in the `legacy` retry mode.
|
148
177
|
#
|
149
178
|
# @option options [Integer] :retry_max_delay (0)
|
150
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
179
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
180
|
+
# used by the default backoff function. This option is only used in the
|
181
|
+
# `legacy` retry mode.
|
182
|
+
#
|
183
|
+
# @option options [String] :retry_mode ("legacy")
|
184
|
+
# Specifies which retry algorithm to use. Values are:
|
185
|
+
#
|
186
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
187
|
+
# no retry mode is provided.
|
188
|
+
#
|
189
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
190
|
+
# This includes support for retry quotas, which limit the number of
|
191
|
+
# unsuccessful retries a client can make.
|
192
|
+
#
|
193
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
194
|
+
# functionality of `standard` mode along with automatic client side
|
195
|
+
# throttling. This is a provisional mode that may change behavior
|
196
|
+
# in the future.
|
197
|
+
#
|
151
198
|
#
|
152
199
|
# @option options [String] :secret_access_key
|
153
200
|
#
|
@@ -473,7 +520,7 @@ module Aws::Kinesis
|
|
473
520
|
http_response: Seahorse::Client::Http::AsyncResponse.new,
|
474
521
|
config: config)
|
475
522
|
context[:gem_name] = 'aws-sdk-kinesis'
|
476
|
-
context[:gem_version] = '1.
|
523
|
+
context[:gem_version] = '1.25.0'
|
477
524
|
Seahorse::Client::Request.new(handlers, context)
|
478
525
|
end
|
479
526
|
|
@@ -486,8 +533,8 @@ module Aws::Kinesis
|
|
486
533
|
when nil then event_stream_class.new
|
487
534
|
else
|
488
535
|
msg = "expected #{type}_event_stream_handler to be a block or "\
|
489
|
-
|
490
|
-
|
536
|
+
"instance of Aws::Kinesis::#{event_stream_class}"\
|
537
|
+
", got `#{handler.inspect}` instead"
|
491
538
|
raise ArgumentError, msg
|
492
539
|
end
|
493
540
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
32
|
require 'aws-sdk-core/plugins/event_stream_configuration.rb'
|
@@ -31,6 +34,18 @@ require 'aws-sdk-core/plugins/event_stream_configuration.rb'
|
|
31
34
|
Aws::Plugins::GlobalConfiguration.add_identifier(:kinesis)
|
32
35
|
|
33
36
|
module Aws::Kinesis
|
37
|
+
# An API client for Kinesis. To construct a client, you need to configure a `:region` and `:credentials`.
|
38
|
+
#
|
39
|
+
# client = Aws::Kinesis::Client.new(
|
40
|
+
# region: region_name,
|
41
|
+
# credentials: credentials,
|
42
|
+
# # ...
|
43
|
+
# )
|
44
|
+
#
|
45
|
+
# For details on configuring region and credentials see
|
46
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
47
|
+
#
|
48
|
+
# See {#initialize} for a full list of supported configuration options.
|
34
49
|
class Client < Seahorse::Client::Base
|
35
50
|
|
36
51
|
include Aws::ClientStubs
|
@@ -58,6 +73,7 @@ module Aws::Kinesis
|
|
58
73
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
59
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
60
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
76
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
61
77
|
add_plugin(Aws::Plugins::SignatureV4)
|
62
78
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
63
79
|
add_plugin(Aws::Plugins::EventStreamConfiguration)
|
@@ -95,7 +111,7 @@ module Aws::Kinesis
|
|
95
111
|
# @option options [required, String] :region
|
96
112
|
# The AWS region to connect to. The configured `:region` is
|
97
113
|
# used to determine the service `:endpoint`. When not passed,
|
98
|
-
# a default `:region` is
|
114
|
+
# a default `:region` is searched for in the following locations:
|
99
115
|
#
|
100
116
|
# * `Aws.config[:region]`
|
101
117
|
# * `ENV['AWS_REGION']`
|
@@ -110,6 +126,12 @@ module Aws::Kinesis
|
|
110
126
|
# When set to `true`, a thread polling for endpoints will be running in
|
111
127
|
# the background every 60 secs (default). Defaults to `false`.
|
112
128
|
#
|
129
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
130
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
131
|
+
# until there is sufficent client side capacity to retry the request.
|
132
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
133
|
+
# not retry instead of sleeping.
|
134
|
+
#
|
113
135
|
# @option options [Boolean] :client_side_monitoring (false)
|
114
136
|
# When `true`, client-side metrics will be collected for all API requests from
|
115
137
|
# this client.
|
@@ -134,6 +156,10 @@ module Aws::Kinesis
|
|
134
156
|
# When `true`, an attempt is made to coerce request parameters into
|
135
157
|
# the required types.
|
136
158
|
#
|
159
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
160
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
161
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
162
|
+
#
|
137
163
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
138
164
|
# Set to true to disable SDK automatically adding host prefix
|
139
165
|
# to default service endpoint when available.
|
@@ -141,7 +167,7 @@ module Aws::Kinesis
|
|
141
167
|
# @option options [String] :endpoint
|
142
168
|
# The client endpoint is normally constructed from the `:region`
|
143
169
|
# option. You should only configure an `:endpoint` when connecting
|
144
|
-
# to test endpoints. This should be
|
170
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
145
171
|
#
|
146
172
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
147
173
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -156,7 +182,7 @@ module Aws::Kinesis
|
|
156
182
|
# requests fetching endpoints information. Defaults to 60 sec.
|
157
183
|
#
|
158
184
|
# @option options [Boolean] :endpoint_discovery (false)
|
159
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
185
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
160
186
|
#
|
161
187
|
# @option options [Proc] :event_stream_handler
|
162
188
|
# 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 +200,12 @@ module Aws::Kinesis
|
|
174
200
|
# The Logger instance to send log messages to. If this option
|
175
201
|
# is not set, logging will be disabled.
|
176
202
|
#
|
203
|
+
# @option options [Integer] :max_attempts (3)
|
204
|
+
# An integer representing the maximum number attempts that will be made for
|
205
|
+
# a single request, including the initial attempt. For example,
|
206
|
+
# setting this value to 5 will result in a request being retried up to
|
207
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
208
|
+
#
|
177
209
|
# @option options [Proc] :output_event_stream_handler
|
178
210
|
# 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
211
|
#
|
@@ -181,11 +213,19 @@ module Aws::Kinesis
|
|
181
213
|
# Used when loading credentials from the shared credentials file
|
182
214
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
183
215
|
#
|
216
|
+
# @option options [Proc] :retry_backoff
|
217
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
218
|
+
# This option is only used in the `legacy` retry mode.
|
219
|
+
#
|
184
220
|
# @option options [Float] :retry_base_delay (0.3)
|
185
|
-
# The base delay in seconds used by the default backoff function.
|
221
|
+
# The base delay in seconds used by the default backoff function. This option
|
222
|
+
# is only used in the `legacy` retry mode.
|
186
223
|
#
|
187
224
|
# @option options [Symbol] :retry_jitter (:none)
|
188
|
-
# A delay randomiser function used by the default backoff function.
|
225
|
+
# A delay randomiser function used by the default backoff function.
|
226
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
227
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
228
|
+
# in the `legacy` retry mode.
|
189
229
|
#
|
190
230
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
191
231
|
#
|
@@ -193,11 +233,30 @@ module Aws::Kinesis
|
|
193
233
|
# The maximum number of times to retry failed requests. Only
|
194
234
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
195
235
|
# are retried. Generally, these are throttling errors, data
|
196
|
-
# checksum errors, networking errors, timeout errors
|
197
|
-
# errors from expired credentials.
|
236
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
237
|
+
# endpoint discovery, and errors from expired credentials.
|
238
|
+
# This option is only used in the `legacy` retry mode.
|
198
239
|
#
|
199
240
|
# @option options [Integer] :retry_max_delay (0)
|
200
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
241
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
242
|
+
# used by the default backoff function. This option is only used in the
|
243
|
+
# `legacy` retry mode.
|
244
|
+
#
|
245
|
+
# @option options [String] :retry_mode ("legacy")
|
246
|
+
# Specifies which retry algorithm to use. Values are:
|
247
|
+
#
|
248
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
249
|
+
# no retry mode is provided.
|
250
|
+
#
|
251
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
252
|
+
# This includes support for retry quotas, which limit the number of
|
253
|
+
# unsuccessful retries a client can make.
|
254
|
+
#
|
255
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
256
|
+
# functionality of `standard` mode along with automatic client side
|
257
|
+
# throttling. This is a provisional mode that may change behavior
|
258
|
+
# in the future.
|
259
|
+
#
|
201
260
|
#
|
202
261
|
# @option options [String] :secret_access_key
|
203
262
|
#
|
@@ -230,16 +289,15 @@ module Aws::Kinesis
|
|
230
289
|
# requests through. Formatted like 'http://proxy.com:123'.
|
231
290
|
#
|
232
291
|
# @option options [Float] :http_open_timeout (15) The number of
|
233
|
-
# seconds to wait when opening a HTTP session before
|
292
|
+
# seconds to wait when opening a HTTP session before raising a
|
234
293
|
# `Timeout::Error`.
|
235
294
|
#
|
236
295
|
# @option options [Integer] :http_read_timeout (60) The default
|
237
296
|
# 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}.
|
297
|
+
# safely be set per-request on the session.
|
240
298
|
#
|
241
299
|
# @option options [Float] :http_idle_timeout (5) The number of
|
242
|
-
# seconds a connection is allowed to sit
|
300
|
+
# seconds a connection is allowed to sit idle before it is
|
243
301
|
# considered stale. Stale connections are closed and removed
|
244
302
|
# from the pool before making a request.
|
245
303
|
#
|
@@ -248,7 +306,7 @@ module Aws::Kinesis
|
|
248
306
|
# request body. This option has no effect unless the request has
|
249
307
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
250
308
|
# disables this behaviour. This value can safely be set per
|
251
|
-
# request on the session
|
309
|
+
# request on the session.
|
252
310
|
#
|
253
311
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
254
312
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -589,6 +647,8 @@ module Aws::Kinesis
|
|
589
647
|
#
|
590
648
|
# * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
|
591
649
|
#
|
650
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
651
|
+
#
|
592
652
|
# @example Request syntax with placeholder values
|
593
653
|
#
|
594
654
|
# resp = client.describe_stream({
|
@@ -619,6 +679,12 @@ module Aws::Kinesis
|
|
619
679
|
# resp.stream_description.encryption_type #=> String, one of "NONE", "KMS"
|
620
680
|
# resp.stream_description.key_id #=> String
|
621
681
|
#
|
682
|
+
#
|
683
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
684
|
+
#
|
685
|
+
# * stream_exists
|
686
|
+
# * stream_not_exists
|
687
|
+
#
|
622
688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStream AWS API Documentation
|
623
689
|
#
|
624
690
|
# @overload describe_stream(params = {})
|
@@ -1298,6 +1364,8 @@ module Aws::Kinesis
|
|
1298
1364
|
# * {Types::ListStreamConsumersOutput#consumers #consumers} => Array<Types::Consumer>
|
1299
1365
|
# * {Types::ListStreamConsumersOutput#next_token #next_token} => String
|
1300
1366
|
#
|
1367
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1368
|
+
#
|
1301
1369
|
# @example Request syntax with placeholder values
|
1302
1370
|
#
|
1303
1371
|
# resp = client.list_stream_consumers({
|
@@ -1355,6 +1423,8 @@ module Aws::Kinesis
|
|
1355
1423
|
# * {Types::ListStreamsOutput#stream_names #stream_names} => Array<String>
|
1356
1424
|
# * {Types::ListStreamsOutput#has_more_streams #has_more_streams} => Boolean
|
1357
1425
|
#
|
1426
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1427
|
+
#
|
1358
1428
|
# @example Request syntax with placeholder values
|
1359
1429
|
#
|
1360
1430
|
# resp = client.list_streams({
|
@@ -2133,7 +2203,7 @@ module Aws::Kinesis
|
|
2133
2203
|
params: params,
|
2134
2204
|
config: config)
|
2135
2205
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2136
|
-
context[:gem_version] = '1.
|
2206
|
+
context[:gem_version] = '1.25.0'
|
2137
2207
|
Seahorse::Client::Request.new(handlers, context)
|
2138
2208
|
end
|
2139
2209
|
|
@@ -2199,10 +2269,10 @@ module Aws::Kinesis
|
|
2199
2269
|
# The following table lists the valid waiter names, the operations they call,
|
2200
2270
|
# and the default `:delay` and `:max_attempts` values.
|
2201
2271
|
#
|
2202
|
-
# | waiter_name | params
|
2203
|
-
# | ----------------- |
|
2204
|
-
# | stream_exists | {#describe_stream} | 10 | 18 |
|
2205
|
-
# | stream_not_exists | {#describe_stream} | 10 | 18 |
|
2272
|
+
# | waiter_name | params | :delay | :max_attempts |
|
2273
|
+
# | ----------------- | ------------------------ | -------- | ------------- |
|
2274
|
+
# | stream_exists | {Client#describe_stream} | 10 | 18 |
|
2275
|
+
# | stream_not_exists | {Client#describe_stream} | 10 | 18 |
|
2206
2276
|
#
|
2207
2277
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
2208
2278
|
# because the waiter has entered a state that it will not transition
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -6,6 +8,33 @@
|
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
8
10
|
module Aws::Kinesis
|
11
|
+
|
12
|
+
# When Kinesis returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::Kinesis::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all Kinesis errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::Kinesis::Errors::ServiceError
|
20
|
+
# # rescues all Kinesis API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {ExpiredIteratorException}
|
31
|
+
# * {ExpiredNextTokenException}
|
32
|
+
# * {InvalidArgumentException}
|
33
|
+
# * {LimitExceededException}
|
34
|
+
# * {ProvisionedThroughputExceededException}
|
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
|
@@ -23,7 +52,6 @@ module Aws::Kinesis
|
|
23
52
|
def message
|
24
53
|
@message || @data[:message]
|
25
54
|
end
|
26
|
-
|
27
55
|
end
|
28
56
|
|
29
57
|
class ExpiredNextTokenException < ServiceError
|
@@ -39,7 +67,6 @@ module Aws::Kinesis
|
|
39
67
|
def message
|
40
68
|
@message || @data[:message]
|
41
69
|
end
|
42
|
-
|
43
70
|
end
|
44
71
|
|
45
72
|
class InvalidArgumentException < ServiceError
|
@@ -55,7 +82,6 @@ module Aws::Kinesis
|
|
55
82
|
def message
|
56
83
|
@message || @data[:message]
|
57
84
|
end
|
58
|
-
|
59
85
|
end
|
60
86
|
|
61
87
|
class LimitExceededException < ServiceError
|
@@ -71,7 +97,6 @@ module Aws::Kinesis
|
|
71
97
|
def message
|
72
98
|
@message || @data[:message]
|
73
99
|
end
|
74
|
-
|
75
100
|
end
|
76
101
|
|
77
102
|
class ProvisionedThroughputExceededException < ServiceError
|
@@ -87,7 +112,6 @@ module Aws::Kinesis
|
|
87
112
|
def message
|
88
113
|
@message || @data[:message]
|
89
114
|
end
|
90
|
-
|
91
115
|
end
|
92
116
|
|
93
117
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -61,6 +63,10 @@ module Aws::Kinesis
|
|
61
63
|
@event_emitter.on(:initial_response, block) if block_given?
|
62
64
|
end
|
63
65
|
|
66
|
+
def on_unknown_event(&block)
|
67
|
+
@event_emitter.on(:unknown_event, block) if block_given?
|
68
|
+
end
|
69
|
+
|
64
70
|
def on_event(&block)
|
65
71
|
on_subscribe_to_shard_event_event(&block)
|
66
72
|
on_resource_not_found_exception_event(&block)
|
@@ -74,6 +80,7 @@ module Aws::Kinesis
|
|
74
80
|
on_internal_failure_exception_event(&block)
|
75
81
|
on_error_event(&block)
|
76
82
|
on_initial_response_event(&block)
|
83
|
+
on_unknown_event(&block)
|
77
84
|
end
|
78
85
|
|
79
86
|
# @api private
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -6,6 +8,7 @@
|
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
8
10
|
module Aws::Kinesis
|
11
|
+
|
9
12
|
class Resource
|
10
13
|
|
11
14
|
# @param options ({})
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -33,6 +35,7 @@ module Aws::Kinesis
|
|
33
35
|
class AddTagsToStreamInput < Struct.new(
|
34
36
|
:stream_name,
|
35
37
|
:tags)
|
38
|
+
SENSITIVE = []
|
36
39
|
include Aws::Structure
|
37
40
|
end
|
38
41
|
|
@@ -68,6 +71,7 @@ module Aws::Kinesis
|
|
68
71
|
:consumer_arn,
|
69
72
|
:consumer_status,
|
70
73
|
:consumer_creation_timestamp)
|
74
|
+
SENSITIVE = []
|
71
75
|
include Aws::Structure
|
72
76
|
end
|
73
77
|
|
@@ -108,6 +112,7 @@ module Aws::Kinesis
|
|
108
112
|
:consumer_status,
|
109
113
|
:consumer_creation_timestamp,
|
110
114
|
:stream_arn)
|
115
|
+
SENSITIVE = []
|
111
116
|
include Aws::Structure
|
112
117
|
end
|
113
118
|
|
@@ -142,6 +147,7 @@ module Aws::Kinesis
|
|
142
147
|
class CreateStreamInput < Struct.new(
|
143
148
|
:stream_name,
|
144
149
|
:shard_count)
|
150
|
+
SENSITIVE = []
|
145
151
|
include Aws::Structure
|
146
152
|
end
|
147
153
|
|
@@ -169,6 +175,7 @@ module Aws::Kinesis
|
|
169
175
|
class DecreaseStreamRetentionPeriodInput < Struct.new(
|
170
176
|
:stream_name,
|
171
177
|
:retention_period_hours)
|
178
|
+
SENSITIVE = []
|
172
179
|
include Aws::Structure
|
173
180
|
end
|
174
181
|
|
@@ -197,6 +204,7 @@ module Aws::Kinesis
|
|
197
204
|
class DeleteStreamInput < Struct.new(
|
198
205
|
:stream_name,
|
199
206
|
:enforce_consumer_deletion)
|
207
|
+
SENSITIVE = []
|
200
208
|
include Aws::Structure
|
201
209
|
end
|
202
210
|
|
@@ -238,6 +246,7 @@ module Aws::Kinesis
|
|
238
246
|
:stream_arn,
|
239
247
|
:consumer_name,
|
240
248
|
:consumer_arn)
|
249
|
+
SENSITIVE = []
|
241
250
|
include Aws::Structure
|
242
251
|
end
|
243
252
|
|
@@ -260,6 +269,7 @@ module Aws::Kinesis
|
|
260
269
|
class DescribeLimitsOutput < Struct.new(
|
261
270
|
:shard_limit,
|
262
271
|
:open_shard_count)
|
272
|
+
SENSITIVE = []
|
263
273
|
include Aws::Structure
|
264
274
|
end
|
265
275
|
|
@@ -297,6 +307,7 @@ module Aws::Kinesis
|
|
297
307
|
:stream_arn,
|
298
308
|
:consumer_name,
|
299
309
|
:consumer_arn)
|
310
|
+
SENSITIVE = []
|
300
311
|
include Aws::Structure
|
301
312
|
end
|
302
313
|
|
@@ -308,6 +319,7 @@ module Aws::Kinesis
|
|
308
319
|
#
|
309
320
|
class DescribeStreamConsumerOutput < Struct.new(
|
310
321
|
:consumer_description)
|
322
|
+
SENSITIVE = []
|
311
323
|
include Aws::Structure
|
312
324
|
end
|
313
325
|
|
@@ -342,6 +354,7 @@ module Aws::Kinesis
|
|
342
354
|
:stream_name,
|
343
355
|
:limit,
|
344
356
|
:exclusive_start_shard_id)
|
357
|
+
SENSITIVE = []
|
345
358
|
include Aws::Structure
|
346
359
|
end
|
347
360
|
|
@@ -357,6 +370,7 @@ module Aws::Kinesis
|
|
357
370
|
#
|
358
371
|
class DescribeStreamOutput < Struct.new(
|
359
372
|
:stream_description)
|
373
|
+
SENSITIVE = []
|
360
374
|
include Aws::Structure
|
361
375
|
end
|
362
376
|
|
@@ -375,6 +389,7 @@ module Aws::Kinesis
|
|
375
389
|
#
|
376
390
|
class DescribeStreamSummaryInput < Struct.new(
|
377
391
|
:stream_name)
|
392
|
+
SENSITIVE = []
|
378
393
|
include Aws::Structure
|
379
394
|
end
|
380
395
|
|
@@ -386,6 +401,7 @@ module Aws::Kinesis
|
|
386
401
|
#
|
387
402
|
class DescribeStreamSummaryOutput < Struct.new(
|
388
403
|
:stream_description_summary)
|
404
|
+
SENSITIVE = []
|
389
405
|
include Aws::Structure
|
390
406
|
end
|
391
407
|
|
@@ -440,6 +456,7 @@ module Aws::Kinesis
|
|
440
456
|
class DisableEnhancedMonitoringInput < Struct.new(
|
441
457
|
:stream_name,
|
442
458
|
:shard_level_metrics)
|
459
|
+
SENSITIVE = []
|
443
460
|
include Aws::Structure
|
444
461
|
end
|
445
462
|
|
@@ -493,6 +510,7 @@ module Aws::Kinesis
|
|
493
510
|
class EnableEnhancedMonitoringInput < Struct.new(
|
494
511
|
:stream_name,
|
495
512
|
:shard_level_metrics)
|
513
|
+
SENSITIVE = []
|
496
514
|
include Aws::Structure
|
497
515
|
end
|
498
516
|
|
@@ -533,6 +551,7 @@ module Aws::Kinesis
|
|
533
551
|
#
|
534
552
|
class EnhancedMetrics < Struct.new(
|
535
553
|
:shard_level_metrics)
|
554
|
+
SENSITIVE = []
|
536
555
|
include Aws::Structure
|
537
556
|
end
|
538
557
|
|
@@ -559,6 +578,7 @@ module Aws::Kinesis
|
|
559
578
|
:stream_name,
|
560
579
|
:current_shard_level_metrics,
|
561
580
|
:desired_shard_level_metrics)
|
581
|
+
SENSITIVE = []
|
562
582
|
include Aws::Structure
|
563
583
|
end
|
564
584
|
|
@@ -572,6 +592,7 @@ module Aws::Kinesis
|
|
572
592
|
#
|
573
593
|
class ExpiredIteratorException < Struct.new(
|
574
594
|
:message)
|
595
|
+
SENSITIVE = []
|
575
596
|
include Aws::Structure
|
576
597
|
end
|
577
598
|
|
@@ -584,6 +605,7 @@ module Aws::Kinesis
|
|
584
605
|
#
|
585
606
|
class ExpiredNextTokenException < Struct.new(
|
586
607
|
:message)
|
608
|
+
SENSITIVE = []
|
587
609
|
include Aws::Structure
|
588
610
|
end
|
589
611
|
|
@@ -614,6 +636,7 @@ module Aws::Kinesis
|
|
614
636
|
class GetRecordsInput < Struct.new(
|
615
637
|
:shard_iterator,
|
616
638
|
:limit)
|
639
|
+
SENSITIVE = []
|
617
640
|
include Aws::Structure
|
618
641
|
end
|
619
642
|
|
@@ -642,6 +665,7 @@ module Aws::Kinesis
|
|
642
665
|
:records,
|
643
666
|
:next_shard_iterator,
|
644
667
|
:millis_behind_latest)
|
668
|
+
SENSITIVE = []
|
645
669
|
include Aws::Structure
|
646
670
|
end
|
647
671
|
|
@@ -716,6 +740,7 @@ module Aws::Kinesis
|
|
716
740
|
:shard_iterator_type,
|
717
741
|
:starting_sequence_number,
|
718
742
|
:timestamp)
|
743
|
+
SENSITIVE = []
|
719
744
|
include Aws::Structure
|
720
745
|
end
|
721
746
|
|
@@ -731,6 +756,7 @@ module Aws::Kinesis
|
|
731
756
|
#
|
732
757
|
class GetShardIteratorOutput < Struct.new(
|
733
758
|
:shard_iterator)
|
759
|
+
SENSITIVE = []
|
734
760
|
include Aws::Structure
|
735
761
|
end
|
736
762
|
|
@@ -750,6 +776,7 @@ module Aws::Kinesis
|
|
750
776
|
class HashKeyRange < Struct.new(
|
751
777
|
:starting_hash_key,
|
752
778
|
:ending_hash_key)
|
779
|
+
SENSITIVE = []
|
753
780
|
include Aws::Structure
|
754
781
|
end
|
755
782
|
|
@@ -777,6 +804,7 @@ module Aws::Kinesis
|
|
777
804
|
class IncreaseStreamRetentionPeriodInput < Struct.new(
|
778
805
|
:stream_name,
|
779
806
|
:retention_period_hours)
|
807
|
+
SENSITIVE = []
|
780
808
|
include Aws::Structure
|
781
809
|
end
|
782
810
|
|
@@ -788,6 +816,7 @@ module Aws::Kinesis
|
|
788
816
|
class InternalFailureException < Struct.new(
|
789
817
|
:message,
|
790
818
|
:event_type)
|
819
|
+
SENSITIVE = []
|
791
820
|
include Aws::Structure
|
792
821
|
end
|
793
822
|
|
@@ -802,6 +831,7 @@ module Aws::Kinesis
|
|
802
831
|
#
|
803
832
|
class InvalidArgumentException < Struct.new(
|
804
833
|
:message)
|
834
|
+
SENSITIVE = []
|
805
835
|
include Aws::Structure
|
806
836
|
end
|
807
837
|
|
@@ -817,6 +847,7 @@ module Aws::Kinesis
|
|
817
847
|
class KMSAccessDeniedException < Struct.new(
|
818
848
|
:message,
|
819
849
|
:event_type)
|
850
|
+
SENSITIVE = []
|
820
851
|
include Aws::Structure
|
821
852
|
end
|
822
853
|
|
@@ -832,6 +863,7 @@ module Aws::Kinesis
|
|
832
863
|
class KMSDisabledException < Struct.new(
|
833
864
|
:message,
|
834
865
|
:event_type)
|
866
|
+
SENSITIVE = []
|
835
867
|
include Aws::Structure
|
836
868
|
end
|
837
869
|
|
@@ -853,6 +885,7 @@ module Aws::Kinesis
|
|
853
885
|
class KMSInvalidStateException < Struct.new(
|
854
886
|
:message,
|
855
887
|
:event_type)
|
888
|
+
SENSITIVE = []
|
856
889
|
include Aws::Structure
|
857
890
|
end
|
858
891
|
|
@@ -868,6 +901,7 @@ module Aws::Kinesis
|
|
868
901
|
class KMSNotFoundException < Struct.new(
|
869
902
|
:message,
|
870
903
|
:event_type)
|
904
|
+
SENSITIVE = []
|
871
905
|
include Aws::Structure
|
872
906
|
end
|
873
907
|
|
@@ -882,6 +916,7 @@ module Aws::Kinesis
|
|
882
916
|
class KMSOptInRequired < Struct.new(
|
883
917
|
:message,
|
884
918
|
:event_type)
|
919
|
+
SENSITIVE = []
|
885
920
|
include Aws::Structure
|
886
921
|
end
|
887
922
|
|
@@ -902,6 +937,7 @@ module Aws::Kinesis
|
|
902
937
|
class KMSThrottlingException < Struct.new(
|
903
938
|
:message,
|
904
939
|
:event_type)
|
940
|
+
SENSITIVE = []
|
905
941
|
include Aws::Structure
|
906
942
|
end
|
907
943
|
|
@@ -917,6 +953,7 @@ module Aws::Kinesis
|
|
917
953
|
#
|
918
954
|
class LimitExceededException < Struct.new(
|
919
955
|
:message)
|
956
|
+
SENSITIVE = []
|
920
957
|
include Aws::Structure
|
921
958
|
end
|
922
959
|
|
@@ -1005,6 +1042,7 @@ module Aws::Kinesis
|
|
1005
1042
|
:exclusive_start_shard_id,
|
1006
1043
|
:max_results,
|
1007
1044
|
:stream_creation_timestamp)
|
1045
|
+
SENSITIVE = []
|
1008
1046
|
include Aws::Structure
|
1009
1047
|
end
|
1010
1048
|
|
@@ -1037,6 +1075,7 @@ module Aws::Kinesis
|
|
1037
1075
|
class ListShardsOutput < Struct.new(
|
1038
1076
|
:shards,
|
1039
1077
|
:next_token)
|
1078
|
+
SENSITIVE = []
|
1040
1079
|
include Aws::Structure
|
1041
1080
|
end
|
1042
1081
|
|
@@ -1112,6 +1151,7 @@ module Aws::Kinesis
|
|
1112
1151
|
:next_token,
|
1113
1152
|
:max_results,
|
1114
1153
|
:stream_creation_timestamp)
|
1154
|
+
SENSITIVE = []
|
1115
1155
|
include Aws::Structure
|
1116
1156
|
end
|
1117
1157
|
|
@@ -1144,6 +1184,7 @@ module Aws::Kinesis
|
|
1144
1184
|
class ListStreamConsumersOutput < Struct.new(
|
1145
1185
|
:consumers,
|
1146
1186
|
:next_token)
|
1187
|
+
SENSITIVE = []
|
1147
1188
|
include Aws::Structure
|
1148
1189
|
end
|
1149
1190
|
|
@@ -1170,6 +1211,7 @@ module Aws::Kinesis
|
|
1170
1211
|
class ListStreamsInput < Struct.new(
|
1171
1212
|
:limit,
|
1172
1213
|
:exclusive_start_stream_name)
|
1214
|
+
SENSITIVE = []
|
1173
1215
|
include Aws::Structure
|
1174
1216
|
end
|
1175
1217
|
|
@@ -1189,6 +1231,7 @@ module Aws::Kinesis
|
|
1189
1231
|
class ListStreamsOutput < Struct.new(
|
1190
1232
|
:stream_names,
|
1191
1233
|
:has_more_streams)
|
1234
|
+
SENSITIVE = []
|
1192
1235
|
include Aws::Structure
|
1193
1236
|
end
|
1194
1237
|
|
@@ -1226,6 +1269,7 @@ module Aws::Kinesis
|
|
1226
1269
|
:stream_name,
|
1227
1270
|
:exclusive_start_tag_key,
|
1228
1271
|
:limit)
|
1272
|
+
SENSITIVE = []
|
1229
1273
|
include Aws::Structure
|
1230
1274
|
end
|
1231
1275
|
|
@@ -1247,6 +1291,7 @@ module Aws::Kinesis
|
|
1247
1291
|
class ListTagsForStreamOutput < Struct.new(
|
1248
1292
|
:tags,
|
1249
1293
|
:has_more_tags)
|
1294
|
+
SENSITIVE = []
|
1250
1295
|
include Aws::Structure
|
1251
1296
|
end
|
1252
1297
|
|
@@ -1280,6 +1325,7 @@ module Aws::Kinesis
|
|
1280
1325
|
:stream_name,
|
1281
1326
|
:shard_to_merge,
|
1282
1327
|
:adjacent_shard_to_merge)
|
1328
|
+
SENSITIVE = []
|
1283
1329
|
include Aws::Structure
|
1284
1330
|
end
|
1285
1331
|
|
@@ -1302,6 +1348,7 @@ module Aws::Kinesis
|
|
1302
1348
|
#
|
1303
1349
|
class ProvisionedThroughputExceededException < Struct.new(
|
1304
1350
|
:message)
|
1351
|
+
SENSITIVE = []
|
1305
1352
|
include Aws::Structure
|
1306
1353
|
end
|
1307
1354
|
|
@@ -1363,6 +1410,7 @@ module Aws::Kinesis
|
|
1363
1410
|
:partition_key,
|
1364
1411
|
:explicit_hash_key,
|
1365
1412
|
:sequence_number_for_ordering)
|
1413
|
+
SENSITIVE = []
|
1366
1414
|
include Aws::Structure
|
1367
1415
|
end
|
1368
1416
|
|
@@ -1395,6 +1443,7 @@ module Aws::Kinesis
|
|
1395
1443
|
:shard_id,
|
1396
1444
|
:sequence_number,
|
1397
1445
|
:encryption_type)
|
1446
|
+
SENSITIVE = []
|
1398
1447
|
include Aws::Structure
|
1399
1448
|
end
|
1400
1449
|
|
@@ -1427,6 +1476,7 @@ module Aws::Kinesis
|
|
1427
1476
|
class PutRecordsInput < Struct.new(
|
1428
1477
|
:records,
|
1429
1478
|
:stream_name)
|
1479
|
+
SENSITIVE = []
|
1430
1480
|
include Aws::Structure
|
1431
1481
|
end
|
1432
1482
|
|
@@ -1461,6 +1511,7 @@ module Aws::Kinesis
|
|
1461
1511
|
:failed_record_count,
|
1462
1512
|
:records,
|
1463
1513
|
:encryption_type)
|
1514
|
+
SENSITIVE = []
|
1464
1515
|
include Aws::Structure
|
1465
1516
|
end
|
1466
1517
|
|
@@ -1505,6 +1556,7 @@ module Aws::Kinesis
|
|
1505
1556
|
:data,
|
1506
1557
|
:explicit_hash_key,
|
1507
1558
|
:partition_key)
|
1559
|
+
SENSITIVE = []
|
1508
1560
|
include Aws::Structure
|
1509
1561
|
end
|
1510
1562
|
|
@@ -1543,6 +1595,7 @@ module Aws::Kinesis
|
|
1543
1595
|
:shard_id,
|
1544
1596
|
:error_code,
|
1545
1597
|
:error_message)
|
1598
|
+
SENSITIVE = []
|
1546
1599
|
include Aws::Structure
|
1547
1600
|
end
|
1548
1601
|
|
@@ -1587,6 +1640,7 @@ module Aws::Kinesis
|
|
1587
1640
|
:data,
|
1588
1641
|
:partition_key,
|
1589
1642
|
:encryption_type)
|
1643
|
+
SENSITIVE = []
|
1590
1644
|
include Aws::Structure
|
1591
1645
|
end
|
1592
1646
|
|
@@ -1619,6 +1673,7 @@ module Aws::Kinesis
|
|
1619
1673
|
class RegisterStreamConsumerInput < Struct.new(
|
1620
1674
|
:stream_arn,
|
1621
1675
|
:consumer_name)
|
1676
|
+
SENSITIVE = []
|
1622
1677
|
include Aws::Structure
|
1623
1678
|
end
|
1624
1679
|
|
@@ -1632,6 +1687,7 @@ module Aws::Kinesis
|
|
1632
1687
|
#
|
1633
1688
|
class RegisterStreamConsumerOutput < Struct.new(
|
1634
1689
|
:consumer)
|
1690
|
+
SENSITIVE = []
|
1635
1691
|
include Aws::Structure
|
1636
1692
|
end
|
1637
1693
|
|
@@ -1659,6 +1715,7 @@ module Aws::Kinesis
|
|
1659
1715
|
class RemoveTagsFromStreamInput < Struct.new(
|
1660
1716
|
:stream_name,
|
1661
1717
|
:tag_keys)
|
1718
|
+
SENSITIVE = []
|
1662
1719
|
include Aws::Structure
|
1663
1720
|
end
|
1664
1721
|
|
@@ -1674,6 +1731,7 @@ module Aws::Kinesis
|
|
1674
1731
|
class ResourceInUseException < Struct.new(
|
1675
1732
|
:message,
|
1676
1733
|
:event_type)
|
1734
|
+
SENSITIVE = []
|
1677
1735
|
include Aws::Structure
|
1678
1736
|
end
|
1679
1737
|
|
@@ -1689,6 +1747,7 @@ module Aws::Kinesis
|
|
1689
1747
|
class ResourceNotFoundException < Struct.new(
|
1690
1748
|
:message,
|
1691
1749
|
:event_type)
|
1750
|
+
SENSITIVE = []
|
1692
1751
|
include Aws::Structure
|
1693
1752
|
end
|
1694
1753
|
|
@@ -1708,6 +1767,7 @@ module Aws::Kinesis
|
|
1708
1767
|
class SequenceNumberRange < Struct.new(
|
1709
1768
|
:starting_sequence_number,
|
1710
1769
|
:ending_sequence_number)
|
1770
|
+
SENSITIVE = []
|
1711
1771
|
include Aws::Structure
|
1712
1772
|
end
|
1713
1773
|
|
@@ -1742,6 +1802,7 @@ module Aws::Kinesis
|
|
1742
1802
|
:adjacent_parent_shard_id,
|
1743
1803
|
:hash_key_range,
|
1744
1804
|
:sequence_number_range)
|
1805
|
+
SENSITIVE = []
|
1745
1806
|
include Aws::Structure
|
1746
1807
|
end
|
1747
1808
|
|
@@ -1781,6 +1842,7 @@ module Aws::Kinesis
|
|
1781
1842
|
:stream_name,
|
1782
1843
|
:shard_to_split,
|
1783
1844
|
:new_starting_hash_key)
|
1845
|
+
SENSITIVE = []
|
1784
1846
|
include Aws::Structure
|
1785
1847
|
end
|
1786
1848
|
|
@@ -1828,6 +1890,7 @@ module Aws::Kinesis
|
|
1828
1890
|
:stream_name,
|
1829
1891
|
:encryption_type,
|
1830
1892
|
:key_id)
|
1893
|
+
SENSITIVE = []
|
1831
1894
|
include Aws::Structure
|
1832
1895
|
end
|
1833
1896
|
|
@@ -1855,6 +1918,7 @@ module Aws::Kinesis
|
|
1855
1918
|
:type,
|
1856
1919
|
:sequence_number,
|
1857
1920
|
:timestamp)
|
1921
|
+
SENSITIVE = []
|
1858
1922
|
include Aws::Structure
|
1859
1923
|
end
|
1860
1924
|
|
@@ -1902,6 +1966,7 @@ module Aws::Kinesis
|
|
1902
1966
|
:stream_name,
|
1903
1967
|
:encryption_type,
|
1904
1968
|
:key_id)
|
1969
|
+
SENSITIVE = []
|
1905
1970
|
include Aws::Structure
|
1906
1971
|
end
|
1907
1972
|
|
@@ -2000,6 +2065,7 @@ module Aws::Kinesis
|
|
2000
2065
|
:enhanced_monitoring,
|
2001
2066
|
:encryption_type,
|
2002
2067
|
:key_id)
|
2068
|
+
SENSITIVE = []
|
2003
2069
|
include Aws::Structure
|
2004
2070
|
end
|
2005
2071
|
|
@@ -2095,6 +2161,7 @@ module Aws::Kinesis
|
|
2095
2161
|
:key_id,
|
2096
2162
|
:open_shard_count,
|
2097
2163
|
:consumer_count)
|
2164
|
+
SENSITIVE = []
|
2098
2165
|
include Aws::Structure
|
2099
2166
|
end
|
2100
2167
|
|
@@ -2123,6 +2190,7 @@ module Aws::Kinesis
|
|
2123
2190
|
:continuation_sequence_number,
|
2124
2191
|
:millis_behind_latest,
|
2125
2192
|
:event_type)
|
2193
|
+
SENSITIVE = []
|
2126
2194
|
include Aws::Structure
|
2127
2195
|
end
|
2128
2196
|
|
@@ -2158,6 +2226,7 @@ module Aws::Kinesis
|
|
2158
2226
|
:consumer_arn,
|
2159
2227
|
:shard_id,
|
2160
2228
|
:starting_position)
|
2229
|
+
SENSITIVE = []
|
2161
2230
|
include Aws::Structure
|
2162
2231
|
end
|
2163
2232
|
|
@@ -2170,6 +2239,7 @@ module Aws::Kinesis
|
|
2170
2239
|
#
|
2171
2240
|
class SubscribeToShardOutput < Struct.new(
|
2172
2241
|
:event_stream)
|
2242
|
+
SENSITIVE = []
|
2173
2243
|
include Aws::Structure
|
2174
2244
|
end
|
2175
2245
|
|
@@ -2192,6 +2262,7 @@ module Aws::Kinesis
|
|
2192
2262
|
class Tag < Struct.new(
|
2193
2263
|
:key,
|
2194
2264
|
:value)
|
2265
|
+
SENSITIVE = []
|
2195
2266
|
include Aws::Structure
|
2196
2267
|
end
|
2197
2268
|
|
@@ -2222,6 +2293,7 @@ module Aws::Kinesis
|
|
2222
2293
|
:stream_name,
|
2223
2294
|
:target_shard_count,
|
2224
2295
|
:scaling_type)
|
2296
|
+
SENSITIVE = []
|
2225
2297
|
include Aws::Structure
|
2226
2298
|
end
|
2227
2299
|
|
@@ -2243,6 +2315,7 @@ module Aws::Kinesis
|
|
2243
2315
|
:stream_name,
|
2244
2316
|
:current_shard_count,
|
2245
2317
|
:target_shard_count)
|
2318
|
+
SENSITIVE = []
|
2246
2319
|
include Aws::Structure
|
2247
2320
|
end
|
2248
2321
|
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -8,6 +10,68 @@
|
|
8
10
|
require 'aws-sdk-core/waiters'
|
9
11
|
|
10
12
|
module Aws::Kinesis
|
13
|
+
# Waiters are utility methods that poll for a particular state to occur
|
14
|
+
# on a client. Waiters can fail after a number of attempts at a polling
|
15
|
+
# interval defined for the service client.
|
16
|
+
#
|
17
|
+
# For a list of operations that can be waited for and the
|
18
|
+
# client methods called for each operation, see the table below or the
|
19
|
+
# {Client#wait_until} field documentation for the {Client}.
|
20
|
+
#
|
21
|
+
# # Invoking a Waiter
|
22
|
+
# To invoke a waiter, call #wait_until on a {Client}. The first parameter
|
23
|
+
# is the waiter name, which is specific to the service client and indicates
|
24
|
+
# which operation is being waited for. The second parameter is a hash of
|
25
|
+
# parameters that are passed to the client method called by the waiter,
|
26
|
+
# which varies according to the waiter name.
|
27
|
+
#
|
28
|
+
# # Wait Failures
|
29
|
+
# To catch errors in a waiter, use WaiterFailed,
|
30
|
+
# as shown in the following example.
|
31
|
+
#
|
32
|
+
# rescue rescue Aws::Waiters::Errors::WaiterFailed => error
|
33
|
+
# puts "failed waiting for instance running: #{error.message}
|
34
|
+
# end
|
35
|
+
#
|
36
|
+
# # Configuring a Waiter
|
37
|
+
# Each waiter has a default polling interval and a maximum number of
|
38
|
+
# attempts it will make before returning control to your program.
|
39
|
+
# To set these values, use the `max_attempts` and `delay` parameters
|
40
|
+
# in your `#wait_until` call.
|
41
|
+
# The following example waits for up to 25 seconds, polling every five seconds.
|
42
|
+
#
|
43
|
+
# client.wait_until(...) do |w|
|
44
|
+
# w.max_attempts = 5
|
45
|
+
# w.delay = 5
|
46
|
+
# end
|
47
|
+
#
|
48
|
+
# To disable wait failures, set the value of either of these parameters
|
49
|
+
# to `nil`.
|
50
|
+
#
|
51
|
+
# # Extending a Waiter
|
52
|
+
# To modify the behavior of waiters, you can register callbacks that are
|
53
|
+
# triggered before each polling attempt and before waiting.
|
54
|
+
#
|
55
|
+
# The following example implements an exponential backoff in a waiter
|
56
|
+
# by doubling the amount of time to wait on every attempt.
|
57
|
+
#
|
58
|
+
# client.wait_until(...) do |w|
|
59
|
+
# w.interval = 0 # disable normal sleep
|
60
|
+
# w.before_wait do |n, resp|
|
61
|
+
# sleep(n ** 2)
|
62
|
+
# end
|
63
|
+
# end
|
64
|
+
#
|
65
|
+
# # Available Waiters
|
66
|
+
#
|
67
|
+
# The following table lists the valid waiter names, the operations they call,
|
68
|
+
# and the default `:delay` and `:max_attempts` values.
|
69
|
+
#
|
70
|
+
# | waiter_name | params | :delay | :max_attempts |
|
71
|
+
# | ----------------- | ------------------------ | -------- | ------------- |
|
72
|
+
# | stream_exists | {Client#describe_stream} | 10 | 18 |
|
73
|
+
# | stream_not_exists | {Client#describe_stream} | 10 | 18 |
|
74
|
+
#
|
11
75
|
module Waiters
|
12
76
|
|
13
77
|
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.
|
4
|
+
version: 1.25.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:
|
11
|
+
date: 2020-06-23 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.
|
22
|
+
version: 3.99.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.
|
32
|
+
version: 3.99.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.
|
87
|
+
rubygems_version: 2.7.6.2
|
88
88
|
signing_key:
|
89
89
|
specification_version: 4
|
90
90
|
summary: AWS SDK for Ruby - Kinesis
|