aws-sdk-kinesis 1.23.0 → 1.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kinesis.rb +4 -2
- data/lib/aws-sdk-kinesis/async_client.rb +63 -21
- data/lib/aws-sdk-kinesis/client.rb +125 -57
- data/lib/aws-sdk-kinesis/client_api.rb +25 -1
- data/lib/aws-sdk-kinesis/customizations.rb +1 -0
- data/lib/aws-sdk-kinesis/errors.rb +2 -0
- data/lib/aws-sdk-kinesis/event_streams.rb +7 -0
- data/lib/aws-sdk-kinesis/resource.rb +2 -0
- data/lib/aws-sdk-kinesis/types.rb +215 -22
- data/lib/aws-sdk-kinesis/waiters.rb +2 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7d1518388af7d6437f593b5a87c216ba27405d14f4ab26a493cf5ed6a56b276b
|
4
|
+
data.tar.gz: e3f02e6fb8af0510507fa7ce4b807004e2eeb3cda76cf081d6dbd0670b163c69
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ca391c9b4875564751fd78c4d22f03da9ae282085651de79bb79323fb811bca81e5c0afb8e608b55333b7a8be8115429cb596c1b88451bd3afe3e1f6f2ffa6c5
|
7
|
+
data.tar.gz: 68f53a9b06e1bd6d97552b50a12306ac1b338e7dc0cf47dc9b67c289a17b9775e18f46677145a76d3dac3bec0f87f5aef49d2b613471c47c000db7bab4454b45
|
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:
|
@@ -45,9 +47,9 @@ require_relative 'aws-sdk-kinesis/event_streams'
|
|
45
47
|
#
|
46
48
|
# See {Errors} for more information.
|
47
49
|
#
|
48
|
-
#
|
50
|
+
# @!group service
|
49
51
|
module Aws::Kinesis
|
50
52
|
|
51
|
-
GEM_VERSION = '1.
|
53
|
+
GEM_VERSION = '1.28.0'
|
52
54
|
|
53
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)
|
@@ -64,13 +68,28 @@ module Aws::Kinesis
|
|
64
68
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
65
69
|
# credentials.
|
66
70
|
#
|
71
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
72
|
+
# shared file, such as `~/.aws/config`.
|
73
|
+
#
|
74
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
75
|
+
#
|
76
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
77
|
+
# assume a role after providing credentials via the web.
|
78
|
+
#
|
79
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
80
|
+
# access token generated from `aws login`.
|
81
|
+
#
|
82
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
83
|
+
# process that outputs to stdout.
|
84
|
+
#
|
67
85
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
68
86
|
# from an EC2 IMDS on an EC2 instance.
|
69
87
|
#
|
70
|
-
# * `Aws::
|
71
|
-
#
|
88
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
89
|
+
# instances running in ECS.
|
72
90
|
#
|
73
|
-
# * `Aws::
|
91
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
92
|
+
# from the Cognito Identity service.
|
74
93
|
#
|
75
94
|
# When `:credentials` are not configured directly, the following
|
76
95
|
# locations will be searched for credentials:
|
@@ -80,10 +99,10 @@ module Aws::Kinesis
|
|
80
99
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
81
100
|
# * `~/.aws/credentials`
|
82
101
|
# * `~/.aws/config`
|
83
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
84
|
-
# very aggressive. Construct and pass an instance of
|
85
|
-
# `Aws::InstanceProfileCredentails`
|
86
|
-
# timeouts.
|
102
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
103
|
+
# are very aggressive. Construct and pass an instance of
|
104
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
105
|
+
# enable retries and extended timeouts.
|
87
106
|
#
|
88
107
|
# @option options [required, String] :region
|
89
108
|
# The AWS region to connect to. The configured `:region` is
|
@@ -116,7 +135,7 @@ module Aws::Kinesis
|
|
116
135
|
# @option options [String] :endpoint
|
117
136
|
# The client endpoint is normally constructed from the `:region`
|
118
137
|
# option. You should only configure an `:endpoint` when connecting
|
119
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
138
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
120
139
|
#
|
121
140
|
# @option options [Proc] :event_stream_handler
|
122
141
|
# 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.
|
@@ -228,19 +247,36 @@ module Aws::Kinesis
|
|
228
247
|
|
229
248
|
# @!group API Operations
|
230
249
|
|
231
|
-
#
|
250
|
+
# This operation establishes an HTTP/2 connection between the consumer
|
251
|
+
# you specify in the `ConsumerARN` parameter and the shard you specify
|
252
|
+
# in the `ShardId` parameter. After the connection is successfully
|
253
|
+
# established, Kinesis Data Streams pushes records from the shard to the
|
254
|
+
# consumer over this connection. Before you call this operation, call
|
232
255
|
# RegisterStreamConsumer to register the consumer with Kinesis Data
|
233
|
-
# Streams.
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
256
|
+
# Streams.
|
257
|
+
#
|
258
|
+
# When the `SubscribeToShard` call succeeds, your consumer starts
|
259
|
+
# receiving events of type SubscribeToShardEvent over the HTTP/2
|
260
|
+
# connection for up to 5 minutes, after which time you need to call
|
261
|
+
# `SubscribeToShard` again to renew the subscription if you want to
|
262
|
+
# continue to receive records.
|
263
|
+
#
|
264
|
+
# You can make one call to `SubscribeToShard` per second per registered
|
265
|
+
# consumer per shard. For example, if you have a 4000 shard stream and
|
266
|
+
# two registered stream consumers, you can make one `SubscribeToShard`
|
267
|
+
# request per second for each combination of shard and registered
|
268
|
+
# consumer, allowing you to subscribe both consumers to all 4000 shards
|
269
|
+
# in one second.
|
270
|
+
#
|
271
|
+
# If you call `SubscribeToShard` again with the same `ConsumerARN` and
|
272
|
+
# `ShardId` within 5 seconds of a successful call, you'll get a
|
273
|
+
# `ResourceInUseException`. If you call `SubscribeToShard` 5 seconds or
|
274
|
+
# more after a successful call, the first connection will expire and the
|
275
|
+
# second call will take over the subscription.
|
276
|
+
#
|
277
|
+
# For an example of how to use this operations, see [Enhanced Fan-Out
|
278
|
+
# Using the Kinesis Data Streams
|
279
|
+
# API](/streams/latest/dev/building-enhanced-consumers-api.html).
|
244
280
|
#
|
245
281
|
# @option params [required, String] :consumer_arn
|
246
282
|
# For this parameter, use the value you obtained when you called
|
@@ -452,6 +488,12 @@ module Aws::Kinesis
|
|
452
488
|
# event.records[0].encryption_type #=> String, one of "NONE", "KMS"
|
453
489
|
# event.continuation_sequence_number #=> String
|
454
490
|
# event.millis_behind_latest #=> Integer
|
491
|
+
# event.child_shards #=> Array
|
492
|
+
# event.child_shards[0].shard_id #=> String
|
493
|
+
# event.child_shards[0].parent_shards #=> Array
|
494
|
+
# event.child_shards[0].parent_shards[0] #=> String
|
495
|
+
# event.child_shards[0].hash_key_range.starting_hash_key #=> String
|
496
|
+
# event.child_shards[0].hash_key_range.ending_hash_key #=> String
|
455
497
|
#
|
456
498
|
# For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
|
457
499
|
# event.message #=> String
|
@@ -516,7 +558,7 @@ module Aws::Kinesis
|
|
516
558
|
http_response: Seahorse::Client::Http::AsyncResponse.new,
|
517
559
|
config: config)
|
518
560
|
context[:gem_name] = 'aws-sdk-kinesis'
|
519
|
-
context[:gem_version] = '1.
|
561
|
+
context[:gem_version] = '1.28.0'
|
520
562
|
Seahorse::Client::Request.new(handlers, context)
|
521
563
|
end
|
522
564
|
|
@@ -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'
|
@@ -70,6 +73,7 @@ module Aws::Kinesis
|
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
71
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
72
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
76
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
73
77
|
add_plugin(Aws::Plugins::SignatureV4)
|
74
78
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
75
79
|
add_plugin(Aws::Plugins::EventStreamConfiguration)
|
@@ -83,13 +87,28 @@ module Aws::Kinesis
|
|
83
87
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
84
88
|
# credentials.
|
85
89
|
#
|
90
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
91
|
+
# shared file, such as `~/.aws/config`.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
94
|
+
#
|
95
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
96
|
+
# assume a role after providing credentials via the web.
|
97
|
+
#
|
98
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
99
|
+
# access token generated from `aws login`.
|
100
|
+
#
|
101
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
102
|
+
# process that outputs to stdout.
|
103
|
+
#
|
86
104
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
87
105
|
# from an EC2 IMDS on an EC2 instance.
|
88
106
|
#
|
89
|
-
# * `Aws::
|
90
|
-
#
|
107
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
108
|
+
# instances running in ECS.
|
91
109
|
#
|
92
|
-
# * `Aws::
|
110
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
111
|
+
# from the Cognito Identity service.
|
93
112
|
#
|
94
113
|
# When `:credentials` are not configured directly, the following
|
95
114
|
# locations will be searched for credentials:
|
@@ -99,10 +118,10 @@ module Aws::Kinesis
|
|
99
118
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
100
119
|
# * `~/.aws/credentials`
|
101
120
|
# * `~/.aws/config`
|
102
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
103
|
-
# very aggressive. Construct and pass an instance of
|
104
|
-
# `Aws::InstanceProfileCredentails`
|
105
|
-
# timeouts.
|
121
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
122
|
+
# are very aggressive. Construct and pass an instance of
|
123
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
124
|
+
# enable retries and extended timeouts.
|
106
125
|
#
|
107
126
|
# @option options [required, String] :region
|
108
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -163,7 +182,7 @@ module Aws::Kinesis
|
|
163
182
|
# @option options [String] :endpoint
|
164
183
|
# The client endpoint is normally constructed from the `:region`
|
165
184
|
# option. You should only configure an `:endpoint` when connecting
|
166
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
185
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
167
186
|
#
|
168
187
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
169
188
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -375,9 +394,9 @@ module Aws::Kinesis
|
|
375
394
|
#
|
376
395
|
# You specify and control the number of shards that a stream is composed
|
377
396
|
# of. Each shard can support reads up to five transactions per second,
|
378
|
-
# up to a maximum data read total of 2
|
397
|
+
# up to a maximum data read total of 2 MiB per second. Each shard can
|
379
398
|
# support writes up to 1,000 records per second, up to a maximum data
|
380
|
-
# write total of 1
|
399
|
+
# write total of 1 MiB per second. If the amount of data input increases
|
381
400
|
# or decreases, you can add or remove shards.
|
382
401
|
#
|
383
402
|
# The stream name identifies the stream. The name is scoped to the AWS
|
@@ -411,8 +430,8 @@ module Aws::Kinesis
|
|
411
430
|
#
|
412
431
|
#
|
413
432
|
#
|
414
|
-
# [1]:
|
415
|
-
# [2]:
|
433
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
434
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
416
435
|
#
|
417
436
|
# @option params [required, String] :stream_name
|
418
437
|
# A name to identify the stream. The stream name is scoped to the AWS
|
@@ -426,8 +445,6 @@ module Aws::Kinesis
|
|
426
445
|
# stream is a function of the number of shards; more shards are required
|
427
446
|
# for greater provisioned throughput.
|
428
447
|
#
|
429
|
-
# DefaultShardLimit;
|
430
|
-
#
|
431
448
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
432
449
|
#
|
433
450
|
# @example Request syntax with placeholder values
|
@@ -535,8 +552,7 @@ module Aws::Kinesis
|
|
535
552
|
# all the consumers that are currently registered with a given data
|
536
553
|
# stream. The description of a consumer contains its name and ARN.
|
537
554
|
#
|
538
|
-
# This operation has a limit of five transactions per second per
|
539
|
-
# account.
|
555
|
+
# This operation has a limit of five transactions per second per stream.
|
540
556
|
#
|
541
557
|
# @option params [String] :stream_arn
|
542
558
|
# The ARN of the Kinesis data stream that the consumer is registered
|
@@ -626,7 +642,7 @@ module Aws::Kinesis
|
|
626
642
|
#
|
627
643
|
#
|
628
644
|
#
|
629
|
-
# [1]:
|
645
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
|
630
646
|
#
|
631
647
|
# @option params [required, String] :stream_name
|
632
648
|
# The name of the stream to describe.
|
@@ -699,7 +715,7 @@ module Aws::Kinesis
|
|
699
715
|
# operation to get a list of the descriptions of all the consumers that
|
700
716
|
# are currently registered with a given data stream.
|
701
717
|
#
|
702
|
-
# This operation has a limit of 20 transactions per second per
|
718
|
+
# This operation has a limit of 20 transactions per second per stream.
|
703
719
|
#
|
704
720
|
# @option params [String] :stream_arn
|
705
721
|
# The ARN of the Kinesis data stream that the consumer is registered
|
@@ -753,6 +769,9 @@ module Aws::Kinesis
|
|
753
769
|
# Name (ARN), status, record retention period, approximate creation
|
754
770
|
# time, monitoring, encryption details, and open shard count.
|
755
771
|
#
|
772
|
+
# DescribeStreamSummary has a limit of 20 transactions per second per
|
773
|
+
# account.
|
774
|
+
#
|
756
775
|
# @option params [required, String] :stream_name
|
757
776
|
# The name of the stream to describe.
|
758
777
|
#
|
@@ -824,7 +843,7 @@ module Aws::Kinesis
|
|
824
843
|
#
|
825
844
|
#
|
826
845
|
#
|
827
|
-
# [1]:
|
846
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
828
847
|
#
|
829
848
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
830
849
|
#
|
@@ -890,7 +909,7 @@ module Aws::Kinesis
|
|
890
909
|
#
|
891
910
|
#
|
892
911
|
#
|
893
|
-
# [1]:
|
912
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
894
913
|
#
|
895
914
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
896
915
|
#
|
@@ -981,13 +1000,12 @@ module Aws::Kinesis
|
|
981
1000
|
# always increasing. For example, records in a shard or across a stream
|
982
1001
|
# might have time stamps that are out of order.
|
983
1002
|
#
|
984
|
-
# This operation has a limit of five transactions per second per
|
985
|
-
# account.
|
1003
|
+
# This operation has a limit of five transactions per second per shard.
|
986
1004
|
#
|
987
1005
|
#
|
988
1006
|
#
|
989
|
-
# [1]:
|
990
|
-
# [2]:
|
1007
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1008
|
+
# [2]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html
|
991
1009
|
#
|
992
1010
|
# @option params [required, String] :shard_iterator
|
993
1011
|
# The position in the shard from which you want to start sequentially
|
@@ -997,13 +1015,14 @@ module Aws::Kinesis
|
|
997
1015
|
# @option params [Integer] :limit
|
998
1016
|
# The maximum number of records to return. Specify a value of up to
|
999
1017
|
# 10,000. If you specify a value that is greater than 10,000, GetRecords
|
1000
|
-
# throws `InvalidArgumentException`.
|
1018
|
+
# throws `InvalidArgumentException`. The default value is 10,000.
|
1001
1019
|
#
|
1002
1020
|
# @return [Types::GetRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1003
1021
|
#
|
1004
1022
|
# * {Types::GetRecordsOutput#records #records} => Array<Types::Record>
|
1005
1023
|
# * {Types::GetRecordsOutput#next_shard_iterator #next_shard_iterator} => String
|
1006
1024
|
# * {Types::GetRecordsOutput#millis_behind_latest #millis_behind_latest} => Integer
|
1025
|
+
# * {Types::GetRecordsOutput#child_shards #child_shards} => Array<Types::ChildShard>
|
1007
1026
|
#
|
1008
1027
|
# @example Request syntax with placeholder values
|
1009
1028
|
#
|
@@ -1022,6 +1041,12 @@ module Aws::Kinesis
|
|
1022
1041
|
# resp.records[0].encryption_type #=> String, one of "NONE", "KMS"
|
1023
1042
|
# resp.next_shard_iterator #=> String
|
1024
1043
|
# resp.millis_behind_latest #=> Integer
|
1044
|
+
# resp.child_shards #=> Array
|
1045
|
+
# resp.child_shards[0].shard_id #=> String
|
1046
|
+
# resp.child_shards[0].parent_shards #=> Array
|
1047
|
+
# resp.child_shards[0].parent_shards[0] #=> String
|
1048
|
+
# resp.child_shards[0].hash_key_range.starting_hash_key #=> String
|
1049
|
+
# resp.child_shards[0].hash_key_range.ending_hash_key #=> String
|
1025
1050
|
#
|
1026
1051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecords AWS API Documentation
|
1027
1052
|
#
|
@@ -1077,7 +1102,7 @@ module Aws::Kinesis
|
|
1077
1102
|
#
|
1078
1103
|
#
|
1079
1104
|
#
|
1080
|
-
# [1]:
|
1105
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1081
1106
|
#
|
1082
1107
|
# @option params [required, String] :stream_name
|
1083
1108
|
# The name of the Amazon Kinesis data stream.
|
@@ -1248,7 +1273,7 @@ module Aws::Kinesis
|
|
1248
1273
|
# @option params [Integer] :max_results
|
1249
1274
|
# The maximum number of shards to return in a single call to
|
1250
1275
|
# `ListShards`. The minimum value you can specify for this parameter is
|
1251
|
-
# 1, and the maximum is
|
1276
|
+
# 1, and the maximum is 10,000, which is also the default.
|
1252
1277
|
#
|
1253
1278
|
# When the number of shards to be listed is greater than the value of
|
1254
1279
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1265,6 +1290,8 @@ module Aws::Kinesis
|
|
1265
1290
|
# You cannot specify this parameter if you specify the `NextToken`
|
1266
1291
|
# parameter.
|
1267
1292
|
#
|
1293
|
+
# @option params [Types::ShardFilter] :shard_filter
|
1294
|
+
#
|
1268
1295
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1269
1296
|
#
|
1270
1297
|
# * {Types::ListShardsOutput#shards #shards} => Array<Types::Shard>
|
@@ -1278,6 +1305,11 @@ module Aws::Kinesis
|
|
1278
1305
|
# exclusive_start_shard_id: "ShardId",
|
1279
1306
|
# max_results: 1,
|
1280
1307
|
# stream_creation_timestamp: Time.now,
|
1308
|
+
# shard_filter: {
|
1309
|
+
# type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
|
1310
|
+
# shard_id: "ShardId",
|
1311
|
+
# timestamp: Time.now,
|
1312
|
+
# },
|
1281
1313
|
# })
|
1282
1314
|
#
|
1283
1315
|
# @example Response structure
|
@@ -1304,7 +1336,7 @@ module Aws::Kinesis
|
|
1304
1336
|
# Lists the consumers registered to receive data from a stream using
|
1305
1337
|
# enhanced fan-out, and provides information about each consumer.
|
1306
1338
|
#
|
1307
|
-
# This operation has a limit of
|
1339
|
+
# This operation has a limit of 5 transactions per second per stream.
|
1308
1340
|
#
|
1309
1341
|
# @option params [required, String] :stream_arn
|
1310
1342
|
# The ARN of the Kinesis data stream for which you want to list the
|
@@ -1533,7 +1565,7 @@ module Aws::Kinesis
|
|
1533
1565
|
#
|
1534
1566
|
#
|
1535
1567
|
#
|
1536
|
-
# [1]:
|
1568
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
|
1537
1569
|
#
|
1538
1570
|
# @option params [required, String] :stream_name
|
1539
1571
|
# The name of the stream for the merge.
|
@@ -1568,7 +1600,7 @@ module Aws::Kinesis
|
|
1568
1600
|
# `PutRecord` to send data into the stream for real-time ingestion and
|
1569
1601
|
# subsequent processing, one record at a time. Each shard can support
|
1570
1602
|
# writes up to 1,000 records per second, up to a maximum data write
|
1571
|
-
# total of 1
|
1603
|
+
# total of 1 MiB per second.
|
1572
1604
|
#
|
1573
1605
|
# You must specify the name of the stream that captures, stores, and
|
1574
1606
|
# transports the data; a partition key; and the data blob itself.
|
@@ -1602,6 +1634,9 @@ module Aws::Kinesis
|
|
1602
1634
|
# [Adding Data to a Stream][1] in the *Amazon Kinesis Data Streams
|
1603
1635
|
# Developer Guide*.
|
1604
1636
|
#
|
1637
|
+
# After you write a record to a stream, you cannot modify that record or
|
1638
|
+
# its order within the stream.
|
1639
|
+
#
|
1605
1640
|
# If a `PutRecord` request cannot be processed because of insufficient
|
1606
1641
|
# provisioned throughput on the shard involved in the request,
|
1607
1642
|
# `PutRecord` throws `ProvisionedThroughputExceededException`.
|
@@ -1613,16 +1648,16 @@ module Aws::Kinesis
|
|
1613
1648
|
#
|
1614
1649
|
#
|
1615
1650
|
#
|
1616
|
-
# [1]:
|
1651
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
|
1617
1652
|
#
|
1618
1653
|
# @option params [required, String] :stream_name
|
1619
1654
|
# The name of the stream to put the data record into.
|
1620
1655
|
#
|
1621
|
-
# @option params [required, String,
|
1656
|
+
# @option params [required, String, StringIO, File] :data
|
1622
1657
|
# The data blob to put into the record, which is base64-encoded when the
|
1623
1658
|
# blob is serialized. When the data blob (the payload before
|
1624
1659
|
# base64-encoding) is added to the partition key size, the total size
|
1625
|
-
# must not exceed the maximum record size (1
|
1660
|
+
# must not exceed the maximum record size (1 MiB).
|
1626
1661
|
#
|
1627
1662
|
# @option params [required, String] :partition_key
|
1628
1663
|
# Determines which shard in the stream the data record is assigned to.
|
@@ -1683,10 +1718,10 @@ module Aws::Kinesis
|
|
1683
1718
|
# to send data into the stream for data ingestion and processing.
|
1684
1719
|
#
|
1685
1720
|
# Each `PutRecords` request can support up to 500 records. Each record
|
1686
|
-
# in the request can be as large as 1
|
1687
|
-
# entire request, including partition keys. Each shard can support
|
1721
|
+
# in the request can be as large as 1 MiB, up to a limit of 5 MiB for
|
1722
|
+
# the entire request, including partition keys. Each shard can support
|
1688
1723
|
# writes up to 1,000 records per second, up to a maximum data write
|
1689
|
-
# total of 1
|
1724
|
+
# total of 1 MiB per second.
|
1690
1725
|
#
|
1691
1726
|
# You must specify the name of the stream that captures, stores, and
|
1692
1727
|
# transports the data; and an array of request `Records`, with each
|
@@ -1723,7 +1758,10 @@ module Aws::Kinesis
|
|
1723
1758
|
# The response `Records` array includes both successfully and
|
1724
1759
|
# unsuccessfully processed records. Kinesis Data Streams attempts to
|
1725
1760
|
# process all records in each `PutRecords` request. A single record
|
1726
|
-
# failure does not stop the processing of subsequent records.
|
1761
|
+
# failure does not stop the processing of subsequent records. As a
|
1762
|
+
# result, PutRecords doesn't guarantee the ordering of records. If you
|
1763
|
+
# need to read records in the same order they are written to the stream,
|
1764
|
+
# use PutRecord instead of `PutRecords`, and write to the same shard.
|
1727
1765
|
#
|
1728
1766
|
# A successfully processed record includes `ShardId` and
|
1729
1767
|
# `SequenceNumber` values. The `ShardId` parameter identifies the shard
|
@@ -1742,6 +1780,9 @@ module Aws::Kinesis
|
|
1742
1780
|
# see [Adding Multiple Records with PutRecords][3] in the *Amazon
|
1743
1781
|
# Kinesis Data Streams Developer Guide*.
|
1744
1782
|
#
|
1783
|
+
# After you write a record to a stream, you cannot modify that record or
|
1784
|
+
# its order within the stream.
|
1785
|
+
#
|
1745
1786
|
# By default, data records are accessible for 24 hours from the time
|
1746
1787
|
# that they are added to a stream. You can use
|
1747
1788
|
# IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to
|
@@ -1749,9 +1790,9 @@ module Aws::Kinesis
|
|
1749
1790
|
#
|
1750
1791
|
#
|
1751
1792
|
#
|
1752
|
-
# [1]:
|
1753
|
-
# [2]:
|
1754
|
-
# [3]:
|
1793
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
|
1794
|
+
# [2]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords
|
1795
|
+
# [3]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords
|
1755
1796
|
#
|
1756
1797
|
# @option params [required, Array<Types::PutRecordsRequestEntry>] :records
|
1757
1798
|
# The records associated with the request.
|
@@ -1798,15 +1839,24 @@ module Aws::Kinesis
|
|
1798
1839
|
end
|
1799
1840
|
|
1800
1841
|
# Registers a consumer with a Kinesis data stream. When you use this
|
1801
|
-
# operation, the consumer you register can
|
1802
|
-
#
|
1803
|
-
#
|
1842
|
+
# operation, the consumer you register can then call SubscribeToShard to
|
1843
|
+
# receive data from the stream using enhanced fan-out, at a rate of up
|
1844
|
+
# to 2 MiB per second for every shard you subscribe to. This rate is
|
1845
|
+
# unaffected by the total number of consumers that read from the same
|
1846
|
+
# stream.
|
1804
1847
|
#
|
1805
|
-
# You can register up to
|
1806
|
-
# only be registered with one stream.
|
1848
|
+
# You can register up to 20 consumers per stream. A given consumer can
|
1849
|
+
# only be registered with one stream at a time.
|
1807
1850
|
#
|
1808
|
-
#
|
1809
|
-
#
|
1851
|
+
# For an example of how to use this operations, see [Enhanced Fan-Out
|
1852
|
+
# Using the Kinesis Data Streams
|
1853
|
+
# API](/streams/latest/dev/building-enhanced-consumers-api.html).
|
1854
|
+
#
|
1855
|
+
# The use of this operation has a limit of five transactions per second
|
1856
|
+
# per account. Also, only 5 consumers can be created simultaneously. In
|
1857
|
+
# other words, you cannot have more than 5 consumers in a `CREATING`
|
1858
|
+
# status at the same time. Registering a 6th consumer while there are 5
|
1859
|
+
# in a `CREATING` status results in a `LimitExceededException`.
|
1810
1860
|
#
|
1811
1861
|
# @option params [required, String] :stream_arn
|
1812
1862
|
# The ARN of the Kinesis data stream that you want to register the
|
@@ -1935,9 +1985,9 @@ module Aws::Kinesis
|
|
1935
1985
|
#
|
1936
1986
|
#
|
1937
1987
|
#
|
1938
|
-
# [1]:
|
1939
|
-
# [2]:
|
1940
|
-
# [3]:
|
1988
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html
|
1989
|
+
# [2]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1990
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
1941
1991
|
#
|
1942
1992
|
# @option params [required, String] :stream_name
|
1943
1993
|
# The name of the stream for the shard split.
|
@@ -2118,14 +2168,19 @@ module Aws::Kinesis
|
|
2118
2168
|
#
|
2119
2169
|
# To update the shard count, Kinesis Data Streams performs splits or
|
2120
2170
|
# merges on individual shards. This can cause short-lived shards to be
|
2121
|
-
# created, in addition to the final shards.
|
2122
|
-
#
|
2123
|
-
#
|
2171
|
+
# created, in addition to the final shards. These short-lived shards
|
2172
|
+
# count towards your total shard limit for your account in the Region.
|
2173
|
+
#
|
2174
|
+
# When using this operation, we recommend that you specify a target
|
2175
|
+
# shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can
|
2176
|
+
# specify any target value within your shard limit. However, if you
|
2177
|
+
# specify a target that isn't a multiple of 25%, the scaling action
|
2178
|
+
# might take longer to complete.
|
2124
2179
|
#
|
2125
2180
|
# This operation has the following default limits. By default, you
|
2126
2181
|
# cannot do the following:
|
2127
2182
|
#
|
2128
|
-
# * Scale more than
|
2183
|
+
# * Scale more than ten times per rolling 24-hour period per stream
|
2129
2184
|
#
|
2130
2185
|
# * Scale up to more than double your current shard count for a stream
|
2131
2186
|
#
|
@@ -2145,14 +2200,27 @@ module Aws::Kinesis
|
|
2145
2200
|
#
|
2146
2201
|
#
|
2147
2202
|
#
|
2148
|
-
# [1]:
|
2203
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
2149
2204
|
# [2]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis
|
2150
2205
|
#
|
2151
2206
|
# @option params [required, String] :stream_name
|
2152
2207
|
# The name of the stream.
|
2153
2208
|
#
|
2154
2209
|
# @option params [required, Integer] :target_shard_count
|
2155
|
-
# The new number of shards.
|
2210
|
+
# The new number of shards. This value has the following default limits.
|
2211
|
+
# By default, you cannot do the following:
|
2212
|
+
#
|
2213
|
+
# * Set this value to more than double your current shard count for a
|
2214
|
+
# stream.
|
2215
|
+
#
|
2216
|
+
# * Set this value below half your current shard count for a stream.
|
2217
|
+
#
|
2218
|
+
# * Set this value to more than 500 shards in a stream (the default
|
2219
|
+
# limit for shard count per stream is 500 per account per region),
|
2220
|
+
# unless you request a limit increase.
|
2221
|
+
#
|
2222
|
+
# * Scale a stream with more than 500 shards down unless you set this
|
2223
|
+
# value to less than 500 shards.
|
2156
2224
|
#
|
2157
2225
|
# @option params [required, String] :scaling_type
|
2158
2226
|
# The scaling type. Uniform scaling creates shards of equal size.
|
@@ -2199,7 +2267,7 @@ module Aws::Kinesis
|
|
2199
2267
|
params: params,
|
2200
2268
|
config: config)
|
2201
2269
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2202
|
-
context[:gem_version] = '1.
|
2270
|
+
context[:gem_version] = '1.28.0'
|
2203
2271
|
Seahorse::Client::Request.new(handlers, context)
|
2204
2272
|
end
|
2205
2273
|
|