aws-sdk-kinesis 1.54.0 → 1.56.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesis/async_client.rb +67 -23
- data/lib/aws-sdk-kinesis/client.rb +70 -46
- data/lib/aws-sdk-kinesis/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-kinesis.rb +1 -1
- data/sig/client.rbs +475 -0
- data/sig/errors.rbs +37 -0
- data/sig/resource.rbs +83 -0
- data/sig/types.rbs +588 -0
- data/sig/waiters.rbs +39 -0
- metadata +13 -8
data/sig/client.rbs
ADDED
@@ -0,0 +1,475 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Kinesis
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?event_stream_handler: Proc,
|
36
|
+
?ignore_configured_endpoint_urls: bool,
|
37
|
+
?input_event_stream_handler: Proc,
|
38
|
+
?log_formatter: untyped,
|
39
|
+
?log_level: Symbol,
|
40
|
+
?logger: untyped,
|
41
|
+
?max_attempts: Integer,
|
42
|
+
?output_event_stream_handler: Proc,
|
43
|
+
?profile: String,
|
44
|
+
?request_min_compression_size_bytes: Integer,
|
45
|
+
?retry_backoff: Proc,
|
46
|
+
?retry_base_delay: Float,
|
47
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
48
|
+
?retry_limit: Integer,
|
49
|
+
?retry_max_delay: Integer,
|
50
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
51
|
+
?sdk_ua_app_id: String,
|
52
|
+
?secret_access_key: String,
|
53
|
+
?session_token: String,
|
54
|
+
?simple_json: bool,
|
55
|
+
?stub_responses: untyped,
|
56
|
+
?token_provider: untyped,
|
57
|
+
?use_dualstack_endpoint: bool,
|
58
|
+
?use_fips_endpoint: bool,
|
59
|
+
?validate_params: bool,
|
60
|
+
?endpoint_provider: untyped,
|
61
|
+
?http_proxy: String,
|
62
|
+
?http_open_timeout: (Float | Integer),
|
63
|
+
?http_read_timeout: (Float | Integer),
|
64
|
+
?http_idle_timeout: (Float | Integer),
|
65
|
+
?http_continue_timeout: (Float | Integer),
|
66
|
+
?ssl_timeout: (Float | Integer | nil),
|
67
|
+
?http_wire_trace: bool,
|
68
|
+
?ssl_verify_peer: bool,
|
69
|
+
?ssl_ca_bundle: String,
|
70
|
+
?ssl_ca_directory: String,
|
71
|
+
?ssl_ca_store: String,
|
72
|
+
?on_chunk_received: Proc,
|
73
|
+
?on_chunk_sent: Proc,
|
74
|
+
?raise_response_errors: bool
|
75
|
+
) -> instance
|
76
|
+
| (?Hash[Symbol, untyped]) -> instance
|
77
|
+
|
78
|
+
|
79
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#add_tags_to_stream-instance_method
|
80
|
+
def add_tags_to_stream: (
|
81
|
+
?stream_name: ::String,
|
82
|
+
tags: Hash[::String, ::String],
|
83
|
+
?stream_arn: ::String
|
84
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
85
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
86
|
+
|
87
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#create_stream-instance_method
|
88
|
+
def create_stream: (
|
89
|
+
stream_name: ::String,
|
90
|
+
?shard_count: ::Integer,
|
91
|
+
?stream_mode_details: {
|
92
|
+
stream_mode: ("PROVISIONED" | "ON_DEMAND")
|
93
|
+
}
|
94
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
95
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
96
|
+
|
97
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#decrease_stream_retention_period-instance_method
|
98
|
+
def decrease_stream_retention_period: (
|
99
|
+
?stream_name: ::String,
|
100
|
+
retention_period_hours: ::Integer,
|
101
|
+
?stream_arn: ::String
|
102
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
103
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
104
|
+
|
105
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#delete_resource_policy-instance_method
|
106
|
+
def delete_resource_policy: (
|
107
|
+
resource_arn: ::String
|
108
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
109
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
110
|
+
|
111
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#delete_stream-instance_method
|
112
|
+
def delete_stream: (
|
113
|
+
?stream_name: ::String,
|
114
|
+
?enforce_consumer_deletion: bool,
|
115
|
+
?stream_arn: ::String
|
116
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
117
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
118
|
+
|
119
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#deregister_stream_consumer-instance_method
|
120
|
+
def deregister_stream_consumer: (
|
121
|
+
?stream_arn: ::String,
|
122
|
+
?consumer_name: ::String,
|
123
|
+
?consumer_arn: ::String
|
124
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
125
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
126
|
+
|
127
|
+
interface _DescribeLimitsResponseSuccess
|
128
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeLimitsOutput]
|
129
|
+
def shard_limit: () -> ::Integer
|
130
|
+
def open_shard_count: () -> ::Integer
|
131
|
+
def on_demand_stream_count: () -> ::Integer
|
132
|
+
def on_demand_stream_count_limit: () -> ::Integer
|
133
|
+
end
|
134
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#describe_limits-instance_method
|
135
|
+
def describe_limits: (
|
136
|
+
) -> _DescribeLimitsResponseSuccess
|
137
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeLimitsResponseSuccess
|
138
|
+
|
139
|
+
interface _DescribeStreamResponseSuccess
|
140
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeStreamOutput]
|
141
|
+
def stream_description: () -> Types::StreamDescription
|
142
|
+
end
|
143
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#describe_stream-instance_method
|
144
|
+
def describe_stream: (
|
145
|
+
?stream_name: ::String,
|
146
|
+
?limit: ::Integer,
|
147
|
+
?exclusive_start_shard_id: ::String,
|
148
|
+
?stream_arn: ::String
|
149
|
+
) -> _DescribeStreamResponseSuccess
|
150
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeStreamResponseSuccess
|
151
|
+
|
152
|
+
interface _DescribeStreamConsumerResponseSuccess
|
153
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeStreamConsumerOutput]
|
154
|
+
def consumer_description: () -> Types::ConsumerDescription
|
155
|
+
end
|
156
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#describe_stream_consumer-instance_method
|
157
|
+
def describe_stream_consumer: (
|
158
|
+
?stream_arn: ::String,
|
159
|
+
?consumer_name: ::String,
|
160
|
+
?consumer_arn: ::String
|
161
|
+
) -> _DescribeStreamConsumerResponseSuccess
|
162
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeStreamConsumerResponseSuccess
|
163
|
+
|
164
|
+
interface _DescribeStreamSummaryResponseSuccess
|
165
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeStreamSummaryOutput]
|
166
|
+
def stream_description_summary: () -> Types::StreamDescriptionSummary
|
167
|
+
end
|
168
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#describe_stream_summary-instance_method
|
169
|
+
def describe_stream_summary: (
|
170
|
+
?stream_name: ::String,
|
171
|
+
?stream_arn: ::String
|
172
|
+
) -> _DescribeStreamSummaryResponseSuccess
|
173
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeStreamSummaryResponseSuccess
|
174
|
+
|
175
|
+
interface _DisableEnhancedMonitoringResponseSuccess
|
176
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::EnhancedMonitoringOutput]
|
177
|
+
def stream_name: () -> ::String
|
178
|
+
def current_shard_level_metrics: () -> ::Array[("IncomingBytes" | "IncomingRecords" | "OutgoingBytes" | "OutgoingRecords" | "WriteProvisionedThroughputExceeded" | "ReadProvisionedThroughputExceeded" | "IteratorAgeMilliseconds" | "ALL")]
|
179
|
+
def desired_shard_level_metrics: () -> ::Array[("IncomingBytes" | "IncomingRecords" | "OutgoingBytes" | "OutgoingRecords" | "WriteProvisionedThroughputExceeded" | "ReadProvisionedThroughputExceeded" | "IteratorAgeMilliseconds" | "ALL")]
|
180
|
+
def stream_arn: () -> ::String
|
181
|
+
end
|
182
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#disable_enhanced_monitoring-instance_method
|
183
|
+
def disable_enhanced_monitoring: (
|
184
|
+
?stream_name: ::String,
|
185
|
+
shard_level_metrics: Array[("IncomingBytes" | "IncomingRecords" | "OutgoingBytes" | "OutgoingRecords" | "WriteProvisionedThroughputExceeded" | "ReadProvisionedThroughputExceeded" | "IteratorAgeMilliseconds" | "ALL")],
|
186
|
+
?stream_arn: ::String
|
187
|
+
) -> _DisableEnhancedMonitoringResponseSuccess
|
188
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisableEnhancedMonitoringResponseSuccess
|
189
|
+
|
190
|
+
interface _EnableEnhancedMonitoringResponseSuccess
|
191
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::EnhancedMonitoringOutput]
|
192
|
+
def stream_name: () -> ::String
|
193
|
+
def current_shard_level_metrics: () -> ::Array[("IncomingBytes" | "IncomingRecords" | "OutgoingBytes" | "OutgoingRecords" | "WriteProvisionedThroughputExceeded" | "ReadProvisionedThroughputExceeded" | "IteratorAgeMilliseconds" | "ALL")]
|
194
|
+
def desired_shard_level_metrics: () -> ::Array[("IncomingBytes" | "IncomingRecords" | "OutgoingBytes" | "OutgoingRecords" | "WriteProvisionedThroughputExceeded" | "ReadProvisionedThroughputExceeded" | "IteratorAgeMilliseconds" | "ALL")]
|
195
|
+
def stream_arn: () -> ::String
|
196
|
+
end
|
197
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#enable_enhanced_monitoring-instance_method
|
198
|
+
def enable_enhanced_monitoring: (
|
199
|
+
?stream_name: ::String,
|
200
|
+
shard_level_metrics: Array[("IncomingBytes" | "IncomingRecords" | "OutgoingBytes" | "OutgoingRecords" | "WriteProvisionedThroughputExceeded" | "ReadProvisionedThroughputExceeded" | "IteratorAgeMilliseconds" | "ALL")],
|
201
|
+
?stream_arn: ::String
|
202
|
+
) -> _EnableEnhancedMonitoringResponseSuccess
|
203
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _EnableEnhancedMonitoringResponseSuccess
|
204
|
+
|
205
|
+
interface _GetRecordsResponseSuccess
|
206
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetRecordsOutput]
|
207
|
+
def records: () -> ::Array[Types::Record]
|
208
|
+
def next_shard_iterator: () -> ::String
|
209
|
+
def millis_behind_latest: () -> ::Integer
|
210
|
+
def child_shards: () -> ::Array[Types::ChildShard]
|
211
|
+
end
|
212
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#get_records-instance_method
|
213
|
+
def get_records: (
|
214
|
+
shard_iterator: ::String,
|
215
|
+
?limit: ::Integer,
|
216
|
+
?stream_arn: ::String
|
217
|
+
) -> _GetRecordsResponseSuccess
|
218
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRecordsResponseSuccess
|
219
|
+
|
220
|
+
interface _GetResourcePolicyResponseSuccess
|
221
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetResourcePolicyOutput]
|
222
|
+
def policy: () -> ::String
|
223
|
+
end
|
224
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#get_resource_policy-instance_method
|
225
|
+
def get_resource_policy: (
|
226
|
+
resource_arn: ::String
|
227
|
+
) -> _GetResourcePolicyResponseSuccess
|
228
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetResourcePolicyResponseSuccess
|
229
|
+
|
230
|
+
interface _GetShardIteratorResponseSuccess
|
231
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetShardIteratorOutput]
|
232
|
+
def shard_iterator: () -> ::String
|
233
|
+
end
|
234
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#get_shard_iterator-instance_method
|
235
|
+
def get_shard_iterator: (
|
236
|
+
?stream_name: ::String,
|
237
|
+
shard_id: ::String,
|
238
|
+
shard_iterator_type: ("AT_SEQUENCE_NUMBER" | "AFTER_SEQUENCE_NUMBER" | "TRIM_HORIZON" | "LATEST" | "AT_TIMESTAMP"),
|
239
|
+
?starting_sequence_number: ::String,
|
240
|
+
?timestamp: ::Time,
|
241
|
+
?stream_arn: ::String
|
242
|
+
) -> _GetShardIteratorResponseSuccess
|
243
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetShardIteratorResponseSuccess
|
244
|
+
|
245
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#increase_stream_retention_period-instance_method
|
246
|
+
def increase_stream_retention_period: (
|
247
|
+
?stream_name: ::String,
|
248
|
+
retention_period_hours: ::Integer,
|
249
|
+
?stream_arn: ::String
|
250
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
251
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
252
|
+
|
253
|
+
interface _ListShardsResponseSuccess
|
254
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListShardsOutput]
|
255
|
+
def shards: () -> ::Array[Types::Shard]
|
256
|
+
def next_token: () -> ::String
|
257
|
+
end
|
258
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#list_shards-instance_method
|
259
|
+
def list_shards: (
|
260
|
+
?stream_name: ::String,
|
261
|
+
?next_token: ::String,
|
262
|
+
?exclusive_start_shard_id: ::String,
|
263
|
+
?max_results: ::Integer,
|
264
|
+
?stream_creation_timestamp: ::Time,
|
265
|
+
?shard_filter: {
|
266
|
+
type: ("AFTER_SHARD_ID" | "AT_TRIM_HORIZON" | "FROM_TRIM_HORIZON" | "AT_LATEST" | "AT_TIMESTAMP" | "FROM_TIMESTAMP"),
|
267
|
+
shard_id: ::String?,
|
268
|
+
timestamp: ::Time?
|
269
|
+
},
|
270
|
+
?stream_arn: ::String
|
271
|
+
) -> _ListShardsResponseSuccess
|
272
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListShardsResponseSuccess
|
273
|
+
|
274
|
+
interface _ListStreamConsumersResponseSuccess
|
275
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListStreamConsumersOutput]
|
276
|
+
def consumers: () -> ::Array[Types::Consumer]
|
277
|
+
def next_token: () -> ::String
|
278
|
+
end
|
279
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#list_stream_consumers-instance_method
|
280
|
+
def list_stream_consumers: (
|
281
|
+
stream_arn: ::String,
|
282
|
+
?next_token: ::String,
|
283
|
+
?max_results: ::Integer,
|
284
|
+
?stream_creation_timestamp: ::Time
|
285
|
+
) -> _ListStreamConsumersResponseSuccess
|
286
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListStreamConsumersResponseSuccess
|
287
|
+
|
288
|
+
interface _ListStreamsResponseSuccess
|
289
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListStreamsOutput]
|
290
|
+
def stream_names: () -> ::Array[::String]
|
291
|
+
def has_more_streams: () -> bool
|
292
|
+
def next_token: () -> ::String
|
293
|
+
def stream_summaries: () -> ::Array[Types::StreamSummary]
|
294
|
+
end
|
295
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#list_streams-instance_method
|
296
|
+
def list_streams: (
|
297
|
+
?limit: ::Integer,
|
298
|
+
?exclusive_start_stream_name: ::String,
|
299
|
+
?next_token: ::String
|
300
|
+
) -> _ListStreamsResponseSuccess
|
301
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListStreamsResponseSuccess
|
302
|
+
|
303
|
+
interface _ListTagsForStreamResponseSuccess
|
304
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForStreamOutput]
|
305
|
+
def tags: () -> ::Array[Types::Tag]
|
306
|
+
def has_more_tags: () -> bool
|
307
|
+
end
|
308
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#list_tags_for_stream-instance_method
|
309
|
+
def list_tags_for_stream: (
|
310
|
+
?stream_name: ::String,
|
311
|
+
?exclusive_start_tag_key: ::String,
|
312
|
+
?limit: ::Integer,
|
313
|
+
?stream_arn: ::String
|
314
|
+
) -> _ListTagsForStreamResponseSuccess
|
315
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForStreamResponseSuccess
|
316
|
+
|
317
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#merge_shards-instance_method
|
318
|
+
def merge_shards: (
|
319
|
+
?stream_name: ::String,
|
320
|
+
shard_to_merge: ::String,
|
321
|
+
adjacent_shard_to_merge: ::String,
|
322
|
+
?stream_arn: ::String
|
323
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
324
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
325
|
+
|
326
|
+
interface _PutRecordResponseSuccess
|
327
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutRecordOutput]
|
328
|
+
def shard_id: () -> ::String
|
329
|
+
def sequence_number: () -> ::String
|
330
|
+
def encryption_type: () -> ("NONE" | "KMS")
|
331
|
+
end
|
332
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#put_record-instance_method
|
333
|
+
def put_record: (
|
334
|
+
?stream_name: ::String,
|
335
|
+
data: ::String,
|
336
|
+
partition_key: ::String,
|
337
|
+
?explicit_hash_key: ::String,
|
338
|
+
?sequence_number_for_ordering: ::String,
|
339
|
+
?stream_arn: ::String
|
340
|
+
) -> _PutRecordResponseSuccess
|
341
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutRecordResponseSuccess
|
342
|
+
|
343
|
+
interface _PutRecordsResponseSuccess
|
344
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutRecordsOutput]
|
345
|
+
def failed_record_count: () -> ::Integer
|
346
|
+
def records: () -> ::Array[Types::PutRecordsResultEntry]
|
347
|
+
def encryption_type: () -> ("NONE" | "KMS")
|
348
|
+
end
|
349
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#put_records-instance_method
|
350
|
+
def put_records: (
|
351
|
+
records: Array[
|
352
|
+
{
|
353
|
+
data: ::String,
|
354
|
+
explicit_hash_key: ::String?,
|
355
|
+
partition_key: ::String
|
356
|
+
},
|
357
|
+
],
|
358
|
+
?stream_name: ::String,
|
359
|
+
?stream_arn: ::String
|
360
|
+
) -> _PutRecordsResponseSuccess
|
361
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutRecordsResponseSuccess
|
362
|
+
|
363
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#put_resource_policy-instance_method
|
364
|
+
def put_resource_policy: (
|
365
|
+
resource_arn: ::String,
|
366
|
+
policy: ::String
|
367
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
368
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
369
|
+
|
370
|
+
interface _RegisterStreamConsumerResponseSuccess
|
371
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RegisterStreamConsumerOutput]
|
372
|
+
def consumer: () -> Types::Consumer
|
373
|
+
end
|
374
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#register_stream_consumer-instance_method
|
375
|
+
def register_stream_consumer: (
|
376
|
+
stream_arn: ::String,
|
377
|
+
consumer_name: ::String
|
378
|
+
) -> _RegisterStreamConsumerResponseSuccess
|
379
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RegisterStreamConsumerResponseSuccess
|
380
|
+
|
381
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#remove_tags_from_stream-instance_method
|
382
|
+
def remove_tags_from_stream: (
|
383
|
+
?stream_name: ::String,
|
384
|
+
tag_keys: Array[::String],
|
385
|
+
?stream_arn: ::String
|
386
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
387
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
388
|
+
|
389
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#split_shard-instance_method
|
390
|
+
def split_shard: (
|
391
|
+
?stream_name: ::String,
|
392
|
+
shard_to_split: ::String,
|
393
|
+
new_starting_hash_key: ::String,
|
394
|
+
?stream_arn: ::String
|
395
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
396
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
397
|
+
|
398
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#start_stream_encryption-instance_method
|
399
|
+
def start_stream_encryption: (
|
400
|
+
?stream_name: ::String,
|
401
|
+
encryption_type: ("NONE" | "KMS"),
|
402
|
+
key_id: ::String,
|
403
|
+
?stream_arn: ::String
|
404
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
405
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
406
|
+
|
407
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#stop_stream_encryption-instance_method
|
408
|
+
def stop_stream_encryption: (
|
409
|
+
?stream_name: ::String,
|
410
|
+
encryption_type: ("NONE" | "KMS"),
|
411
|
+
key_id: ::String,
|
412
|
+
?stream_arn: ::String
|
413
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
414
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
415
|
+
|
416
|
+
interface _SubscribeToShardResponseSuccess
|
417
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SubscribeToShardOutput]
|
418
|
+
def event_stream: () -> Types::SubscribeToShardEventStream
|
419
|
+
end
|
420
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#subscribe_to_shard-instance_method
|
421
|
+
def subscribe_to_shard: (
|
422
|
+
consumer_arn: ::String,
|
423
|
+
shard_id: ::String,
|
424
|
+
starting_position: {
|
425
|
+
type: ("AT_SEQUENCE_NUMBER" | "AFTER_SEQUENCE_NUMBER" | "TRIM_HORIZON" | "LATEST" | "AT_TIMESTAMP"),
|
426
|
+
sequence_number: ::String?,
|
427
|
+
timestamp: ::Time?
|
428
|
+
}
|
429
|
+
) -> _SubscribeToShardResponseSuccess
|
430
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SubscribeToShardResponseSuccess
|
431
|
+
|
432
|
+
interface _UpdateShardCountResponseSuccess
|
433
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateShardCountOutput]
|
434
|
+
def stream_name: () -> ::String
|
435
|
+
def current_shard_count: () -> ::Integer
|
436
|
+
def target_shard_count: () -> ::Integer
|
437
|
+
def stream_arn: () -> ::String
|
438
|
+
end
|
439
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#update_shard_count-instance_method
|
440
|
+
def update_shard_count: (
|
441
|
+
?stream_name: ::String,
|
442
|
+
target_shard_count: ::Integer,
|
443
|
+
scaling_type: ("UNIFORM_SCALING"),
|
444
|
+
?stream_arn: ::String
|
445
|
+
) -> _UpdateShardCountResponseSuccess
|
446
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateShardCountResponseSuccess
|
447
|
+
|
448
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#update_stream_mode-instance_method
|
449
|
+
def update_stream_mode: (
|
450
|
+
stream_arn: ::String,
|
451
|
+
stream_mode_details: {
|
452
|
+
stream_mode: ("PROVISIONED" | "ON_DEMAND")
|
453
|
+
}
|
454
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
455
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
456
|
+
|
457
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#wait_until-instance_method
|
458
|
+
def wait_until: (:stream_exists waiter_name,
|
459
|
+
?stream_name: ::String,
|
460
|
+
?limit: ::Integer,
|
461
|
+
?exclusive_start_shard_id: ::String,
|
462
|
+
?stream_arn: ::String
|
463
|
+
) -> Client::_DescribeStreamResponseSuccess
|
464
|
+
| (:stream_exists waiter_name, ?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_DescribeStreamResponseSuccess
|
465
|
+
| (:stream_not_exists waiter_name,
|
466
|
+
?stream_name: ::String,
|
467
|
+
?limit: ::Integer,
|
468
|
+
?exclusive_start_shard_id: ::String,
|
469
|
+
?stream_arn: ::String
|
470
|
+
) -> Client::_DescribeStreamResponseSuccess
|
471
|
+
| (:stream_not_exists waiter_name, ?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_DescribeStreamResponseSuccess
|
472
|
+
end
|
473
|
+
end
|
474
|
+
end
|
475
|
+
|
data/sig/errors.rbs
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Kinesis
|
10
|
+
module Errors
|
11
|
+
class ServiceError < ::Aws::Errors::ServiceError
|
12
|
+
end
|
13
|
+
|
14
|
+
class AccessDeniedException < ::Aws::Errors::ServiceError
|
15
|
+
def message: () -> ::String
|
16
|
+
end
|
17
|
+
class ExpiredIteratorException < ::Aws::Errors::ServiceError
|
18
|
+
def message: () -> ::String
|
19
|
+
end
|
20
|
+
class ExpiredNextTokenException < ::Aws::Errors::ServiceError
|
21
|
+
def message: () -> ::String
|
22
|
+
end
|
23
|
+
class InvalidArgumentException < ::Aws::Errors::ServiceError
|
24
|
+
def message: () -> ::String
|
25
|
+
end
|
26
|
+
class LimitExceededException < ::Aws::Errors::ServiceError
|
27
|
+
def message: () -> ::String
|
28
|
+
end
|
29
|
+
class ProvisionedThroughputExceededException < ::Aws::Errors::ServiceError
|
30
|
+
def message: () -> ::String
|
31
|
+
end
|
32
|
+
class ValidationException < ::Aws::Errors::ServiceError
|
33
|
+
def message: () -> ::String
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
data/sig/resource.rbs
ADDED
@@ -0,0 +1,83 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Kinesis
|
10
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Resource.html
|
11
|
+
class Resource
|
12
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Resource.html#initialize-instance_method
|
13
|
+
def initialize: (
|
14
|
+
?client: Client,
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?event_stream_handler: Proc,
|
36
|
+
?ignore_configured_endpoint_urls: bool,
|
37
|
+
?input_event_stream_handler: Proc,
|
38
|
+
?log_formatter: untyped,
|
39
|
+
?log_level: Symbol,
|
40
|
+
?logger: untyped,
|
41
|
+
?max_attempts: Integer,
|
42
|
+
?output_event_stream_handler: Proc,
|
43
|
+
?profile: String,
|
44
|
+
?request_min_compression_size_bytes: Integer,
|
45
|
+
?retry_backoff: Proc,
|
46
|
+
?retry_base_delay: Float,
|
47
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
48
|
+
?retry_limit: Integer,
|
49
|
+
?retry_max_delay: Integer,
|
50
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
51
|
+
?sdk_ua_app_id: String,
|
52
|
+
?secret_access_key: String,
|
53
|
+
?session_token: String,
|
54
|
+
?simple_json: bool,
|
55
|
+
?stub_responses: untyped,
|
56
|
+
?token_provider: untyped,
|
57
|
+
?use_dualstack_endpoint: bool,
|
58
|
+
?use_fips_endpoint: bool,
|
59
|
+
?validate_params: bool,
|
60
|
+
?endpoint_provider: untyped,
|
61
|
+
?http_proxy: String,
|
62
|
+
?http_open_timeout: (Float | Integer),
|
63
|
+
?http_read_timeout: (Float | Integer),
|
64
|
+
?http_idle_timeout: (Float | Integer),
|
65
|
+
?http_continue_timeout: (Float | Integer),
|
66
|
+
?ssl_timeout: (Float | Integer | nil),
|
67
|
+
?http_wire_trace: bool,
|
68
|
+
?ssl_verify_peer: bool,
|
69
|
+
?ssl_ca_bundle: String,
|
70
|
+
?ssl_ca_directory: String,
|
71
|
+
?ssl_ca_store: String,
|
72
|
+
?on_chunk_received: Proc,
|
73
|
+
?on_chunk_sent: Proc,
|
74
|
+
?raise_response_errors: bool
|
75
|
+
) -> void
|
76
|
+
| (?Hash[Symbol, untyped]) -> void
|
77
|
+
|
78
|
+
def client: () -> Client
|
79
|
+
|
80
|
+
|
81
|
+
end
|
82
|
+
end
|
83
|
+
end
|