aws-sdk-kinesis 1.24.1 → 1.29.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/lib/aws-sdk-kinesis.rb +5 -2
- data/lib/aws-sdk-kinesis/async_client.rb +60 -20
- data/lib/aws-sdk-kinesis/client.rb +122 -56
- 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 +2 -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 +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4d3e41e8ad4f80e3a6ad6e48be27974af9f4d40b742fc46dc33ece3e9cf2e46a
|
4
|
+
data.tar.gz: 81e9c3d4961f695133a02cb823a505f3835fce4a61c71ff460be696eec6e5c33
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 35304dc1b103d8e2958fcbe7b4a277e04b71922a6671984fb4ed76745b21777e1427682a63b8c7fc871cab73257a74e6a1943fd47ffc10513d35240800a20538
|
7
|
+
data.tar.gz: 04a30da97531424782644cb177a11eac471b510990d0a3e9bf8635e0f596809687217a2cfc3ef565763c02ae02db86776f11f426d4441d14df60b4d2a33916e0
|
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:
|
@@ -5,6 +7,7 @@
|
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
10
|
+
|
8
11
|
require 'aws-sdk-core'
|
9
12
|
require 'aws-sigv4'
|
10
13
|
|
@@ -45,9 +48,9 @@ require_relative 'aws-sdk-kinesis/event_streams'
|
|
45
48
|
#
|
46
49
|
# See {Errors} for more information.
|
47
50
|
#
|
48
|
-
#
|
51
|
+
# @!group service
|
49
52
|
module Aws::Kinesis
|
50
53
|
|
51
|
-
GEM_VERSION = '1.
|
54
|
+
GEM_VERSION = '1.29.0'
|
52
55
|
|
53
56
|
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:
|
@@ -66,13 +68,28 @@ module Aws::Kinesis
|
|
66
68
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
67
69
|
# credentials.
|
68
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
|
+
#
|
69
85
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
70
86
|
# from an EC2 IMDS on an EC2 instance.
|
71
87
|
#
|
72
|
-
# * `Aws::
|
73
|
-
#
|
88
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
89
|
+
# instances running in ECS.
|
74
90
|
#
|
75
|
-
# * `Aws::
|
91
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
92
|
+
# from the Cognito Identity service.
|
76
93
|
#
|
77
94
|
# When `:credentials` are not configured directly, the following
|
78
95
|
# locations will be searched for credentials:
|
@@ -82,10 +99,10 @@ module Aws::Kinesis
|
|
82
99
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
83
100
|
# * `~/.aws/credentials`
|
84
101
|
# * `~/.aws/config`
|
85
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
86
|
-
# very aggressive. Construct and pass an instance of
|
87
|
-
# `Aws::InstanceProfileCredentails`
|
88
|
-
# 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.
|
89
106
|
#
|
90
107
|
# @option options [required, String] :region
|
91
108
|
# The AWS region to connect to. The configured `:region` is
|
@@ -230,19 +247,36 @@ module Aws::Kinesis
|
|
230
247
|
|
231
248
|
# @!group API Operations
|
232
249
|
|
233
|
-
#
|
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
|
234
255
|
# RegisterStreamConsumer to register the consumer with Kinesis Data
|
235
|
-
# Streams.
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
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).
|
246
280
|
#
|
247
281
|
# @option params [required, String] :consumer_arn
|
248
282
|
# For this parameter, use the value you obtained when you called
|
@@ -454,6 +488,12 @@ module Aws::Kinesis
|
|
454
488
|
# event.records[0].encryption_type #=> String, one of "NONE", "KMS"
|
455
489
|
# event.continuation_sequence_number #=> String
|
456
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
|
457
497
|
#
|
458
498
|
# For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
|
459
499
|
# event.message #=> String
|
@@ -518,7 +558,7 @@ module Aws::Kinesis
|
|
518
558
|
http_response: Seahorse::Client::Http::AsyncResponse.new,
|
519
559
|
config: config)
|
520
560
|
context[:gem_name] = 'aws-sdk-kinesis'
|
521
|
-
context[:gem_version] = '1.
|
561
|
+
context[:gem_version] = '1.29.0'
|
522
562
|
Seahorse::Client::Request.new(handlers, context)
|
523
563
|
end
|
524
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:
|
@@ -85,13 +87,28 @@ module Aws::Kinesis
|
|
85
87
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
88
|
# credentials.
|
87
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
|
+
#
|
88
104
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
105
|
# from an EC2 IMDS on an EC2 instance.
|
90
106
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
107
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
108
|
+
# instances running in ECS.
|
93
109
|
#
|
94
|
-
# * `Aws::
|
110
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
111
|
+
# from the Cognito Identity service.
|
95
112
|
#
|
96
113
|
# When `:credentials` are not configured directly, the following
|
97
114
|
# locations will be searched for credentials:
|
@@ -101,10 +118,10 @@ module Aws::Kinesis
|
|
101
118
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
119
|
# * `~/.aws/credentials`
|
103
120
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# 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.
|
108
125
|
#
|
109
126
|
# @option options [required, String] :region
|
110
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -377,9 +394,9 @@ module Aws::Kinesis
|
|
377
394
|
#
|
378
395
|
# You specify and control the number of shards that a stream is composed
|
379
396
|
# of. Each shard can support reads up to five transactions per second,
|
380
|
-
# 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
|
381
398
|
# support writes up to 1,000 records per second, up to a maximum data
|
382
|
-
# write total of 1
|
399
|
+
# write total of 1 MiB per second. If the amount of data input increases
|
383
400
|
# or decreases, you can add or remove shards.
|
384
401
|
#
|
385
402
|
# The stream name identifies the stream. The name is scoped to the AWS
|
@@ -413,8 +430,8 @@ module Aws::Kinesis
|
|
413
430
|
#
|
414
431
|
#
|
415
432
|
#
|
416
|
-
# [1]:
|
417
|
-
# [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
|
418
435
|
#
|
419
436
|
# @option params [required, String] :stream_name
|
420
437
|
# A name to identify the stream. The stream name is scoped to the AWS
|
@@ -428,8 +445,6 @@ module Aws::Kinesis
|
|
428
445
|
# stream is a function of the number of shards; more shards are required
|
429
446
|
# for greater provisioned throughput.
|
430
447
|
#
|
431
|
-
# DefaultShardLimit;
|
432
|
-
#
|
433
448
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
434
449
|
#
|
435
450
|
# @example Request syntax with placeholder values
|
@@ -537,8 +552,7 @@ module Aws::Kinesis
|
|
537
552
|
# all the consumers that are currently registered with a given data
|
538
553
|
# stream. The description of a consumer contains its name and ARN.
|
539
554
|
#
|
540
|
-
# This operation has a limit of five transactions per second per
|
541
|
-
# account.
|
555
|
+
# This operation has a limit of five transactions per second per stream.
|
542
556
|
#
|
543
557
|
# @option params [String] :stream_arn
|
544
558
|
# The ARN of the Kinesis data stream that the consumer is registered
|
@@ -628,7 +642,7 @@ module Aws::Kinesis
|
|
628
642
|
#
|
629
643
|
#
|
630
644
|
#
|
631
|
-
# [1]:
|
645
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
|
632
646
|
#
|
633
647
|
# @option params [required, String] :stream_name
|
634
648
|
# The name of the stream to describe.
|
@@ -701,7 +715,7 @@ module Aws::Kinesis
|
|
701
715
|
# operation to get a list of the descriptions of all the consumers that
|
702
716
|
# are currently registered with a given data stream.
|
703
717
|
#
|
704
|
-
# This operation has a limit of 20 transactions per second per
|
718
|
+
# This operation has a limit of 20 transactions per second per stream.
|
705
719
|
#
|
706
720
|
# @option params [String] :stream_arn
|
707
721
|
# The ARN of the Kinesis data stream that the consumer is registered
|
@@ -755,6 +769,9 @@ module Aws::Kinesis
|
|
755
769
|
# Name (ARN), status, record retention period, approximate creation
|
756
770
|
# time, monitoring, encryption details, and open shard count.
|
757
771
|
#
|
772
|
+
# DescribeStreamSummary has a limit of 20 transactions per second per
|
773
|
+
# account.
|
774
|
+
#
|
758
775
|
# @option params [required, String] :stream_name
|
759
776
|
# The name of the stream to describe.
|
760
777
|
#
|
@@ -826,7 +843,7 @@ module Aws::Kinesis
|
|
826
843
|
#
|
827
844
|
#
|
828
845
|
#
|
829
|
-
# [1]:
|
846
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
830
847
|
#
|
831
848
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
832
849
|
#
|
@@ -892,7 +909,7 @@ module Aws::Kinesis
|
|
892
909
|
#
|
893
910
|
#
|
894
911
|
#
|
895
|
-
# [1]:
|
912
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
896
913
|
#
|
897
914
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
898
915
|
#
|
@@ -983,13 +1000,12 @@ module Aws::Kinesis
|
|
983
1000
|
# always increasing. For example, records in a shard or across a stream
|
984
1001
|
# might have time stamps that are out of order.
|
985
1002
|
#
|
986
|
-
# This operation has a limit of five transactions per second per
|
987
|
-
# account.
|
1003
|
+
# This operation has a limit of five transactions per second per shard.
|
988
1004
|
#
|
989
1005
|
#
|
990
1006
|
#
|
991
|
-
# [1]:
|
992
|
-
# [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
|
993
1009
|
#
|
994
1010
|
# @option params [required, String] :shard_iterator
|
995
1011
|
# The position in the shard from which you want to start sequentially
|
@@ -999,13 +1015,14 @@ module Aws::Kinesis
|
|
999
1015
|
# @option params [Integer] :limit
|
1000
1016
|
# The maximum number of records to return. Specify a value of up to
|
1001
1017
|
# 10,000. If you specify a value that is greater than 10,000, GetRecords
|
1002
|
-
# throws `InvalidArgumentException`.
|
1018
|
+
# throws `InvalidArgumentException`. The default value is 10,000.
|
1003
1019
|
#
|
1004
1020
|
# @return [Types::GetRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1005
1021
|
#
|
1006
1022
|
# * {Types::GetRecordsOutput#records #records} => Array<Types::Record>
|
1007
1023
|
# * {Types::GetRecordsOutput#next_shard_iterator #next_shard_iterator} => String
|
1008
1024
|
# * {Types::GetRecordsOutput#millis_behind_latest #millis_behind_latest} => Integer
|
1025
|
+
# * {Types::GetRecordsOutput#child_shards #child_shards} => Array<Types::ChildShard>
|
1009
1026
|
#
|
1010
1027
|
# @example Request syntax with placeholder values
|
1011
1028
|
#
|
@@ -1024,6 +1041,12 @@ module Aws::Kinesis
|
|
1024
1041
|
# resp.records[0].encryption_type #=> String, one of "NONE", "KMS"
|
1025
1042
|
# resp.next_shard_iterator #=> String
|
1026
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
|
1027
1050
|
#
|
1028
1051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecords AWS API Documentation
|
1029
1052
|
#
|
@@ -1079,7 +1102,7 @@ module Aws::Kinesis
|
|
1079
1102
|
#
|
1080
1103
|
#
|
1081
1104
|
#
|
1082
|
-
# [1]:
|
1105
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1083
1106
|
#
|
1084
1107
|
# @option params [required, String] :stream_name
|
1085
1108
|
# The name of the Amazon Kinesis data stream.
|
@@ -1250,7 +1273,7 @@ module Aws::Kinesis
|
|
1250
1273
|
# @option params [Integer] :max_results
|
1251
1274
|
# The maximum number of shards to return in a single call to
|
1252
1275
|
# `ListShards`. The minimum value you can specify for this parameter is
|
1253
|
-
# 1, and the maximum is
|
1276
|
+
# 1, and the maximum is 10,000, which is also the default.
|
1254
1277
|
#
|
1255
1278
|
# When the number of shards to be listed is greater than the value of
|
1256
1279
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1267,6 +1290,8 @@ module Aws::Kinesis
|
|
1267
1290
|
# You cannot specify this parameter if you specify the `NextToken`
|
1268
1291
|
# parameter.
|
1269
1292
|
#
|
1293
|
+
# @option params [Types::ShardFilter] :shard_filter
|
1294
|
+
#
|
1270
1295
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1271
1296
|
#
|
1272
1297
|
# * {Types::ListShardsOutput#shards #shards} => Array<Types::Shard>
|
@@ -1280,6 +1305,11 @@ module Aws::Kinesis
|
|
1280
1305
|
# exclusive_start_shard_id: "ShardId",
|
1281
1306
|
# max_results: 1,
|
1282
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
|
+
# },
|
1283
1313
|
# })
|
1284
1314
|
#
|
1285
1315
|
# @example Response structure
|
@@ -1306,7 +1336,7 @@ module Aws::Kinesis
|
|
1306
1336
|
# Lists the consumers registered to receive data from a stream using
|
1307
1337
|
# enhanced fan-out, and provides information about each consumer.
|
1308
1338
|
#
|
1309
|
-
# This operation has a limit of
|
1339
|
+
# This operation has a limit of 5 transactions per second per stream.
|
1310
1340
|
#
|
1311
1341
|
# @option params [required, String] :stream_arn
|
1312
1342
|
# The ARN of the Kinesis data stream for which you want to list the
|
@@ -1535,7 +1565,7 @@ module Aws::Kinesis
|
|
1535
1565
|
#
|
1536
1566
|
#
|
1537
1567
|
#
|
1538
|
-
# [1]:
|
1568
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
|
1539
1569
|
#
|
1540
1570
|
# @option params [required, String] :stream_name
|
1541
1571
|
# The name of the stream for the merge.
|
@@ -1570,7 +1600,7 @@ module Aws::Kinesis
|
|
1570
1600
|
# `PutRecord` to send data into the stream for real-time ingestion and
|
1571
1601
|
# subsequent processing, one record at a time. Each shard can support
|
1572
1602
|
# writes up to 1,000 records per second, up to a maximum data write
|
1573
|
-
# total of 1
|
1603
|
+
# total of 1 MiB per second.
|
1574
1604
|
#
|
1575
1605
|
# You must specify the name of the stream that captures, stores, and
|
1576
1606
|
# transports the data; a partition key; and the data blob itself.
|
@@ -1604,6 +1634,9 @@ module Aws::Kinesis
|
|
1604
1634
|
# [Adding Data to a Stream][1] in the *Amazon Kinesis Data Streams
|
1605
1635
|
# Developer Guide*.
|
1606
1636
|
#
|
1637
|
+
# After you write a record to a stream, you cannot modify that record or
|
1638
|
+
# its order within the stream.
|
1639
|
+
#
|
1607
1640
|
# If a `PutRecord` request cannot be processed because of insufficient
|
1608
1641
|
# provisioned throughput on the shard involved in the request,
|
1609
1642
|
# `PutRecord` throws `ProvisionedThroughputExceededException`.
|
@@ -1615,16 +1648,16 @@ module Aws::Kinesis
|
|
1615
1648
|
#
|
1616
1649
|
#
|
1617
1650
|
#
|
1618
|
-
# [1]:
|
1651
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
|
1619
1652
|
#
|
1620
1653
|
# @option params [required, String] :stream_name
|
1621
1654
|
# The name of the stream to put the data record into.
|
1622
1655
|
#
|
1623
|
-
# @option params [required, String,
|
1656
|
+
# @option params [required, String, StringIO, File] :data
|
1624
1657
|
# The data blob to put into the record, which is base64-encoded when the
|
1625
1658
|
# blob is serialized. When the data blob (the payload before
|
1626
1659
|
# base64-encoding) is added to the partition key size, the total size
|
1627
|
-
# must not exceed the maximum record size (1
|
1660
|
+
# must not exceed the maximum record size (1 MiB).
|
1628
1661
|
#
|
1629
1662
|
# @option params [required, String] :partition_key
|
1630
1663
|
# Determines which shard in the stream the data record is assigned to.
|
@@ -1685,10 +1718,10 @@ module Aws::Kinesis
|
|
1685
1718
|
# to send data into the stream for data ingestion and processing.
|
1686
1719
|
#
|
1687
1720
|
# Each `PutRecords` request can support up to 500 records. Each record
|
1688
|
-
# in the request can be as large as 1
|
1689
|
-
# 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
|
1690
1723
|
# writes up to 1,000 records per second, up to a maximum data write
|
1691
|
-
# total of 1
|
1724
|
+
# total of 1 MiB per second.
|
1692
1725
|
#
|
1693
1726
|
# You must specify the name of the stream that captures, stores, and
|
1694
1727
|
# transports the data; and an array of request `Records`, with each
|
@@ -1725,7 +1758,10 @@ module Aws::Kinesis
|
|
1725
1758
|
# The response `Records` array includes both successfully and
|
1726
1759
|
# unsuccessfully processed records. Kinesis Data Streams attempts to
|
1727
1760
|
# process all records in each `PutRecords` request. A single record
|
1728
|
-
# 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.
|
1729
1765
|
#
|
1730
1766
|
# A successfully processed record includes `ShardId` and
|
1731
1767
|
# `SequenceNumber` values. The `ShardId` parameter identifies the shard
|
@@ -1744,6 +1780,9 @@ module Aws::Kinesis
|
|
1744
1780
|
# see [Adding Multiple Records with PutRecords][3] in the *Amazon
|
1745
1781
|
# Kinesis Data Streams Developer Guide*.
|
1746
1782
|
#
|
1783
|
+
# After you write a record to a stream, you cannot modify that record or
|
1784
|
+
# its order within the stream.
|
1785
|
+
#
|
1747
1786
|
# By default, data records are accessible for 24 hours from the time
|
1748
1787
|
# that they are added to a stream. You can use
|
1749
1788
|
# IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to
|
@@ -1751,9 +1790,9 @@ module Aws::Kinesis
|
|
1751
1790
|
#
|
1752
1791
|
#
|
1753
1792
|
#
|
1754
|
-
# [1]:
|
1755
|
-
# [2]:
|
1756
|
-
# [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
|
1757
1796
|
#
|
1758
1797
|
# @option params [required, Array<Types::PutRecordsRequestEntry>] :records
|
1759
1798
|
# The records associated with the request.
|
@@ -1800,15 +1839,24 @@ module Aws::Kinesis
|
|
1800
1839
|
end
|
1801
1840
|
|
1802
1841
|
# Registers a consumer with a Kinesis data stream. When you use this
|
1803
|
-
# operation, the consumer you register can
|
1804
|
-
#
|
1805
|
-
#
|
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.
|
1806
1847
|
#
|
1807
|
-
# You can register up to
|
1808
|
-
# 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.
|
1809
1850
|
#
|
1810
|
-
#
|
1811
|
-
#
|
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`.
|
1812
1860
|
#
|
1813
1861
|
# @option params [required, String] :stream_arn
|
1814
1862
|
# The ARN of the Kinesis data stream that you want to register the
|
@@ -1937,9 +1985,9 @@ module Aws::Kinesis
|
|
1937
1985
|
#
|
1938
1986
|
#
|
1939
1987
|
#
|
1940
|
-
# [1]:
|
1941
|
-
# [2]:
|
1942
|
-
# [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
|
1943
1991
|
#
|
1944
1992
|
# @option params [required, String] :stream_name
|
1945
1993
|
# The name of the stream for the shard split.
|
@@ -2120,14 +2168,19 @@ module Aws::Kinesis
|
|
2120
2168
|
#
|
2121
2169
|
# To update the shard count, Kinesis Data Streams performs splits or
|
2122
2170
|
# merges on individual shards. This can cause short-lived shards to be
|
2123
|
-
# created, in addition to the final shards.
|
2124
|
-
#
|
2125
|
-
#
|
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.
|
2126
2179
|
#
|
2127
2180
|
# This operation has the following default limits. By default, you
|
2128
2181
|
# cannot do the following:
|
2129
2182
|
#
|
2130
|
-
# * Scale more than
|
2183
|
+
# * Scale more than ten times per rolling 24-hour period per stream
|
2131
2184
|
#
|
2132
2185
|
# * Scale up to more than double your current shard count for a stream
|
2133
2186
|
#
|
@@ -2147,14 +2200,27 @@ module Aws::Kinesis
|
|
2147
2200
|
#
|
2148
2201
|
#
|
2149
2202
|
#
|
2150
|
-
# [1]:
|
2203
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
2151
2204
|
# [2]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis
|
2152
2205
|
#
|
2153
2206
|
# @option params [required, String] :stream_name
|
2154
2207
|
# The name of the stream.
|
2155
2208
|
#
|
2156
2209
|
# @option params [required, Integer] :target_shard_count
|
2157
|
-
# 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.
|
2158
2224
|
#
|
2159
2225
|
# @option params [required, String] :scaling_type
|
2160
2226
|
# The scaling type. Uniform scaling creates shards of equal size.
|
@@ -2201,7 +2267,7 @@ module Aws::Kinesis
|
|
2201
2267
|
params: params,
|
2202
2268
|
config: config)
|
2203
2269
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2204
|
-
context[:gem_version] = '1.
|
2270
|
+
context[:gem_version] = '1.29.0'
|
2205
2271
|
Seahorse::Client::Request.new(handlers, context)
|
2206
2272
|
end
|
2207
2273
|
|