aws-sdk-kinesis 1.22.0 → 1.27.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 +3 -1
- data/lib/aws-sdk-kinesis/async_client.rb +41 -14
- data/lib/aws-sdk-kinesis/client.rb +104 -51
- 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: 402a2a96aba832c9e8b4df7f5619665770e471603260951ddcca0be5c4ecddad
|
4
|
+
data.tar.gz: dfa0a56f52c7e5ff3b8992c608b70bf2f0bbfe8e51bfd34ba5c6bcdfc4513734
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fc909f9743f05544980d2ec71883265543b26e28c9cbf0ed0e6d2930f1734ee3f44f3063f808c550f4f99add4c7872f06c2b363d7357d629c48de220fcb28506
|
7
|
+
data.tar.gz: c7da65816c05722c6d6d25234cdc67df1f4f03075cfc17622c35378a493baf4c065103da2b62244fa9a99c6825bab0fa8a9fc51a908be32616b52507c97d72c6
|
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:
|
@@ -48,6 +50,6 @@ require_relative 'aws-sdk-kinesis/event_streams'
|
|
48
50
|
# @service
|
49
51
|
module Aws::Kinesis
|
50
52
|
|
51
|
-
GEM_VERSION = '1.
|
53
|
+
GEM_VERSION = '1.27.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)
|
@@ -116,7 +120,7 @@ module Aws::Kinesis
|
|
116
120
|
# @option options [String] :endpoint
|
117
121
|
# The client endpoint is normally constructed from the `:region`
|
118
122
|
# option. You should only configure an `:endpoint` when connecting
|
119
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
123
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
120
124
|
#
|
121
125
|
# @option options [Proc] :event_stream_handler
|
122
126
|
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
|
@@ -228,19 +232,36 @@ module Aws::Kinesis
|
|
228
232
|
|
229
233
|
# @!group API Operations
|
230
234
|
|
231
|
-
#
|
235
|
+
# This operation establishes an HTTP/2 connection between the consumer
|
236
|
+
# you specify in the `ConsumerARN` parameter and the shard you specify
|
237
|
+
# in the `ShardId` parameter. After the connection is successfully
|
238
|
+
# established, Kinesis Data Streams pushes records from the shard to the
|
239
|
+
# consumer over this connection. Before you call this operation, call
|
232
240
|
# RegisterStreamConsumer to register the consumer with Kinesis Data
|
233
|
-
# Streams.
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
241
|
+
# Streams.
|
242
|
+
#
|
243
|
+
# When the `SubscribeToShard` call succeeds, your consumer starts
|
244
|
+
# receiving events of type SubscribeToShardEvent over the HTTP/2
|
245
|
+
# connection for up to 5 minutes, after which time you need to call
|
246
|
+
# `SubscribeToShard` again to renew the subscription if you want to
|
247
|
+
# continue to receive records.
|
248
|
+
#
|
249
|
+
# You can make one call to `SubscribeToShard` per second per registered
|
250
|
+
# consumer per shard. For example, if you have a 4000 shard stream and
|
251
|
+
# two registered stream consumers, you can make one `SubscribeToShard`
|
252
|
+
# request per second for each combination of shard and registered
|
253
|
+
# consumer, allowing you to subscribe both consumers to all 4000 shards
|
254
|
+
# in one second.
|
255
|
+
#
|
256
|
+
# If you call `SubscribeToShard` again with the same `ConsumerARN` and
|
257
|
+
# `ShardId` within 5 seconds of a successful call, you'll get a
|
258
|
+
# `ResourceInUseException`. If you call `SubscribeToShard` 5 seconds or
|
259
|
+
# more after a successful call, the first connection will expire and the
|
260
|
+
# second call will take over the subscription.
|
261
|
+
#
|
262
|
+
# For an example of how to use this operations, see [Enhanced Fan-Out
|
263
|
+
# Using the Kinesis Data Streams
|
264
|
+
# API](/streams/latest/dev/building-enhanced-consumers-api.html).
|
244
265
|
#
|
245
266
|
# @option params [required, String] :consumer_arn
|
246
267
|
# For this parameter, use the value you obtained when you called
|
@@ -452,6 +473,12 @@ module Aws::Kinesis
|
|
452
473
|
# event.records[0].encryption_type #=> String, one of "NONE", "KMS"
|
453
474
|
# event.continuation_sequence_number #=> String
|
454
475
|
# event.millis_behind_latest #=> Integer
|
476
|
+
# event.child_shards #=> Array
|
477
|
+
# event.child_shards[0].shard_id #=> String
|
478
|
+
# event.child_shards[0].parent_shards #=> Array
|
479
|
+
# event.child_shards[0].parent_shards[0] #=> String
|
480
|
+
# event.child_shards[0].hash_key_range.starting_hash_key #=> String
|
481
|
+
# event.child_shards[0].hash_key_range.ending_hash_key #=> String
|
455
482
|
#
|
456
483
|
# For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
|
457
484
|
# event.message #=> String
|
@@ -516,7 +543,7 @@ module Aws::Kinesis
|
|
516
543
|
http_response: Seahorse::Client::Http::AsyncResponse.new,
|
517
544
|
config: config)
|
518
545
|
context[:gem_name] = 'aws-sdk-kinesis'
|
519
|
-
context[:gem_version] = '1.
|
546
|
+
context[:gem_version] = '1.27.0'
|
520
547
|
Seahorse::Client::Request.new(handlers, context)
|
521
548
|
end
|
522
549
|
|
@@ -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)
|
@@ -163,7 +167,7 @@ module Aws::Kinesis
|
|
163
167
|
# @option options [String] :endpoint
|
164
168
|
# The client endpoint is normally constructed from the `:region`
|
165
169
|
# option. You should only configure an `:endpoint` when connecting
|
166
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
170
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
167
171
|
#
|
168
172
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
169
173
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -178,7 +182,7 @@ module Aws::Kinesis
|
|
178
182
|
# requests fetching endpoints information. Defaults to 60 sec.
|
179
183
|
#
|
180
184
|
# @option options [Boolean] :endpoint_discovery (false)
|
181
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
185
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
182
186
|
#
|
183
187
|
# @option options [Proc] :event_stream_handler
|
184
188
|
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
|
@@ -375,9 +379,9 @@ module Aws::Kinesis
|
|
375
379
|
#
|
376
380
|
# You specify and control the number of shards that a stream is composed
|
377
381
|
# of. Each shard can support reads up to five transactions per second,
|
378
|
-
# up to a maximum data read total of 2
|
382
|
+
# up to a maximum data read total of 2 MiB per second. Each shard can
|
379
383
|
# support writes up to 1,000 records per second, up to a maximum data
|
380
|
-
# write total of 1
|
384
|
+
# write total of 1 MiB per second. If the amount of data input increases
|
381
385
|
# or decreases, you can add or remove shards.
|
382
386
|
#
|
383
387
|
# The stream name identifies the stream. The name is scoped to the AWS
|
@@ -411,8 +415,8 @@ module Aws::Kinesis
|
|
411
415
|
#
|
412
416
|
#
|
413
417
|
#
|
414
|
-
# [1]:
|
415
|
-
# [2]:
|
418
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
419
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
416
420
|
#
|
417
421
|
# @option params [required, String] :stream_name
|
418
422
|
# A name to identify the stream. The stream name is scoped to the AWS
|
@@ -426,8 +430,6 @@ module Aws::Kinesis
|
|
426
430
|
# stream is a function of the number of shards; more shards are required
|
427
431
|
# for greater provisioned throughput.
|
428
432
|
#
|
429
|
-
# DefaultShardLimit;
|
430
|
-
#
|
431
433
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
432
434
|
#
|
433
435
|
# @example Request syntax with placeholder values
|
@@ -535,8 +537,7 @@ module Aws::Kinesis
|
|
535
537
|
# all the consumers that are currently registered with a given data
|
536
538
|
# stream. The description of a consumer contains its name and ARN.
|
537
539
|
#
|
538
|
-
# This operation has a limit of five transactions per second per
|
539
|
-
# account.
|
540
|
+
# This operation has a limit of five transactions per second per stream.
|
540
541
|
#
|
541
542
|
# @option params [String] :stream_arn
|
542
543
|
# The ARN of the Kinesis data stream that the consumer is registered
|
@@ -626,7 +627,7 @@ module Aws::Kinesis
|
|
626
627
|
#
|
627
628
|
#
|
628
629
|
#
|
629
|
-
# [1]:
|
630
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
|
630
631
|
#
|
631
632
|
# @option params [required, String] :stream_name
|
632
633
|
# The name of the stream to describe.
|
@@ -699,7 +700,7 @@ module Aws::Kinesis
|
|
699
700
|
# operation to get a list of the descriptions of all the consumers that
|
700
701
|
# are currently registered with a given data stream.
|
701
702
|
#
|
702
|
-
# This operation has a limit of 20 transactions per second per
|
703
|
+
# This operation has a limit of 20 transactions per second per stream.
|
703
704
|
#
|
704
705
|
# @option params [String] :stream_arn
|
705
706
|
# The ARN of the Kinesis data stream that the consumer is registered
|
@@ -753,6 +754,9 @@ module Aws::Kinesis
|
|
753
754
|
# Name (ARN), status, record retention period, approximate creation
|
754
755
|
# time, monitoring, encryption details, and open shard count.
|
755
756
|
#
|
757
|
+
# DescribeStreamSummary has a limit of 20 transactions per second per
|
758
|
+
# account.
|
759
|
+
#
|
756
760
|
# @option params [required, String] :stream_name
|
757
761
|
# The name of the stream to describe.
|
758
762
|
#
|
@@ -824,7 +828,7 @@ module Aws::Kinesis
|
|
824
828
|
#
|
825
829
|
#
|
826
830
|
#
|
827
|
-
# [1]:
|
831
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
828
832
|
#
|
829
833
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
830
834
|
#
|
@@ -890,7 +894,7 @@ module Aws::Kinesis
|
|
890
894
|
#
|
891
895
|
#
|
892
896
|
#
|
893
|
-
# [1]:
|
897
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
894
898
|
#
|
895
899
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
896
900
|
#
|
@@ -981,13 +985,12 @@ module Aws::Kinesis
|
|
981
985
|
# always increasing. For example, records in a shard or across a stream
|
982
986
|
# might have time stamps that are out of order.
|
983
987
|
#
|
984
|
-
# This operation has a limit of five transactions per second per
|
985
|
-
# account.
|
988
|
+
# This operation has a limit of five transactions per second per shard.
|
986
989
|
#
|
987
990
|
#
|
988
991
|
#
|
989
|
-
# [1]:
|
990
|
-
# [2]:
|
992
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
993
|
+
# [2]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html
|
991
994
|
#
|
992
995
|
# @option params [required, String] :shard_iterator
|
993
996
|
# The position in the shard from which you want to start sequentially
|
@@ -997,13 +1000,14 @@ module Aws::Kinesis
|
|
997
1000
|
# @option params [Integer] :limit
|
998
1001
|
# The maximum number of records to return. Specify a value of up to
|
999
1002
|
# 10,000. If you specify a value that is greater than 10,000, GetRecords
|
1000
|
-
# throws `InvalidArgumentException`.
|
1003
|
+
# throws `InvalidArgumentException`. The default value is 10,000.
|
1001
1004
|
#
|
1002
1005
|
# @return [Types::GetRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1003
1006
|
#
|
1004
1007
|
# * {Types::GetRecordsOutput#records #records} => Array<Types::Record>
|
1005
1008
|
# * {Types::GetRecordsOutput#next_shard_iterator #next_shard_iterator} => String
|
1006
1009
|
# * {Types::GetRecordsOutput#millis_behind_latest #millis_behind_latest} => Integer
|
1010
|
+
# * {Types::GetRecordsOutput#child_shards #child_shards} => Array<Types::ChildShard>
|
1007
1011
|
#
|
1008
1012
|
# @example Request syntax with placeholder values
|
1009
1013
|
#
|
@@ -1022,6 +1026,12 @@ module Aws::Kinesis
|
|
1022
1026
|
# resp.records[0].encryption_type #=> String, one of "NONE", "KMS"
|
1023
1027
|
# resp.next_shard_iterator #=> String
|
1024
1028
|
# resp.millis_behind_latest #=> Integer
|
1029
|
+
# resp.child_shards #=> Array
|
1030
|
+
# resp.child_shards[0].shard_id #=> String
|
1031
|
+
# resp.child_shards[0].parent_shards #=> Array
|
1032
|
+
# resp.child_shards[0].parent_shards[0] #=> String
|
1033
|
+
# resp.child_shards[0].hash_key_range.starting_hash_key #=> String
|
1034
|
+
# resp.child_shards[0].hash_key_range.ending_hash_key #=> String
|
1025
1035
|
#
|
1026
1036
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecords AWS API Documentation
|
1027
1037
|
#
|
@@ -1077,7 +1087,7 @@ module Aws::Kinesis
|
|
1077
1087
|
#
|
1078
1088
|
#
|
1079
1089
|
#
|
1080
|
-
# [1]:
|
1090
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1081
1091
|
#
|
1082
1092
|
# @option params [required, String] :stream_name
|
1083
1093
|
# The name of the Amazon Kinesis data stream.
|
@@ -1248,7 +1258,7 @@ module Aws::Kinesis
|
|
1248
1258
|
# @option params [Integer] :max_results
|
1249
1259
|
# The maximum number of shards to return in a single call to
|
1250
1260
|
# `ListShards`. The minimum value you can specify for this parameter is
|
1251
|
-
# 1, and the maximum is
|
1261
|
+
# 1, and the maximum is 10,000, which is also the default.
|
1252
1262
|
#
|
1253
1263
|
# When the number of shards to be listed is greater than the value of
|
1254
1264
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1265,6 +1275,8 @@ module Aws::Kinesis
|
|
1265
1275
|
# You cannot specify this parameter if you specify the `NextToken`
|
1266
1276
|
# parameter.
|
1267
1277
|
#
|
1278
|
+
# @option params [Types::ShardFilter] :shard_filter
|
1279
|
+
#
|
1268
1280
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1269
1281
|
#
|
1270
1282
|
# * {Types::ListShardsOutput#shards #shards} => Array<Types::Shard>
|
@@ -1278,6 +1290,11 @@ module Aws::Kinesis
|
|
1278
1290
|
# exclusive_start_shard_id: "ShardId",
|
1279
1291
|
# max_results: 1,
|
1280
1292
|
# stream_creation_timestamp: Time.now,
|
1293
|
+
# shard_filter: {
|
1294
|
+
# type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
|
1295
|
+
# shard_id: "ShardId",
|
1296
|
+
# timestamp: Time.now,
|
1297
|
+
# },
|
1281
1298
|
# })
|
1282
1299
|
#
|
1283
1300
|
# @example Response structure
|
@@ -1304,7 +1321,7 @@ module Aws::Kinesis
|
|
1304
1321
|
# Lists the consumers registered to receive data from a stream using
|
1305
1322
|
# enhanced fan-out, and provides information about each consumer.
|
1306
1323
|
#
|
1307
|
-
# This operation has a limit of
|
1324
|
+
# This operation has a limit of 5 transactions per second per stream.
|
1308
1325
|
#
|
1309
1326
|
# @option params [required, String] :stream_arn
|
1310
1327
|
# The ARN of the Kinesis data stream for which you want to list the
|
@@ -1533,7 +1550,7 @@ module Aws::Kinesis
|
|
1533
1550
|
#
|
1534
1551
|
#
|
1535
1552
|
#
|
1536
|
-
# [1]:
|
1553
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
|
1537
1554
|
#
|
1538
1555
|
# @option params [required, String] :stream_name
|
1539
1556
|
# The name of the stream for the merge.
|
@@ -1568,7 +1585,7 @@ module Aws::Kinesis
|
|
1568
1585
|
# `PutRecord` to send data into the stream for real-time ingestion and
|
1569
1586
|
# subsequent processing, one record at a time. Each shard can support
|
1570
1587
|
# writes up to 1,000 records per second, up to a maximum data write
|
1571
|
-
# total of 1
|
1588
|
+
# total of 1 MiB per second.
|
1572
1589
|
#
|
1573
1590
|
# You must specify the name of the stream that captures, stores, and
|
1574
1591
|
# transports the data; a partition key; and the data blob itself.
|
@@ -1602,6 +1619,9 @@ module Aws::Kinesis
|
|
1602
1619
|
# [Adding Data to a Stream][1] in the *Amazon Kinesis Data Streams
|
1603
1620
|
# Developer Guide*.
|
1604
1621
|
#
|
1622
|
+
# After you write a record to a stream, you cannot modify that record or
|
1623
|
+
# its order within the stream.
|
1624
|
+
#
|
1605
1625
|
# If a `PutRecord` request cannot be processed because of insufficient
|
1606
1626
|
# provisioned throughput on the shard involved in the request,
|
1607
1627
|
# `PutRecord` throws `ProvisionedThroughputExceededException`.
|
@@ -1613,16 +1633,16 @@ module Aws::Kinesis
|
|
1613
1633
|
#
|
1614
1634
|
#
|
1615
1635
|
#
|
1616
|
-
# [1]:
|
1636
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
|
1617
1637
|
#
|
1618
1638
|
# @option params [required, String] :stream_name
|
1619
1639
|
# The name of the stream to put the data record into.
|
1620
1640
|
#
|
1621
|
-
# @option params [required, String,
|
1641
|
+
# @option params [required, String, StringIO, File] :data
|
1622
1642
|
# The data blob to put into the record, which is base64-encoded when the
|
1623
1643
|
# blob is serialized. When the data blob (the payload before
|
1624
1644
|
# base64-encoding) is added to the partition key size, the total size
|
1625
|
-
# must not exceed the maximum record size (1
|
1645
|
+
# must not exceed the maximum record size (1 MiB).
|
1626
1646
|
#
|
1627
1647
|
# @option params [required, String] :partition_key
|
1628
1648
|
# Determines which shard in the stream the data record is assigned to.
|
@@ -1683,10 +1703,10 @@ module Aws::Kinesis
|
|
1683
1703
|
# to send data into the stream for data ingestion and processing.
|
1684
1704
|
#
|
1685
1705
|
# 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
|
1706
|
+
# in the request can be as large as 1 MiB, up to a limit of 5 MiB for
|
1707
|
+
# the entire request, including partition keys. Each shard can support
|
1688
1708
|
# writes up to 1,000 records per second, up to a maximum data write
|
1689
|
-
# total of 1
|
1709
|
+
# total of 1 MiB per second.
|
1690
1710
|
#
|
1691
1711
|
# You must specify the name of the stream that captures, stores, and
|
1692
1712
|
# transports the data; and an array of request `Records`, with each
|
@@ -1723,7 +1743,10 @@ module Aws::Kinesis
|
|
1723
1743
|
# The response `Records` array includes both successfully and
|
1724
1744
|
# unsuccessfully processed records. Kinesis Data Streams attempts to
|
1725
1745
|
# process all records in each `PutRecords` request. A single record
|
1726
|
-
# failure does not stop the processing of subsequent records.
|
1746
|
+
# failure does not stop the processing of subsequent records. As a
|
1747
|
+
# result, PutRecords doesn't guarantee the ordering of records. If you
|
1748
|
+
# need to read records in the same order they are written to the stream,
|
1749
|
+
# use PutRecord instead of `PutRecords`, and write to the same shard.
|
1727
1750
|
#
|
1728
1751
|
# A successfully processed record includes `ShardId` and
|
1729
1752
|
# `SequenceNumber` values. The `ShardId` parameter identifies the shard
|
@@ -1742,6 +1765,9 @@ module Aws::Kinesis
|
|
1742
1765
|
# see [Adding Multiple Records with PutRecords][3] in the *Amazon
|
1743
1766
|
# Kinesis Data Streams Developer Guide*.
|
1744
1767
|
#
|
1768
|
+
# After you write a record to a stream, you cannot modify that record or
|
1769
|
+
# its order within the stream.
|
1770
|
+
#
|
1745
1771
|
# By default, data records are accessible for 24 hours from the time
|
1746
1772
|
# that they are added to a stream. You can use
|
1747
1773
|
# IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to
|
@@ -1749,9 +1775,9 @@ module Aws::Kinesis
|
|
1749
1775
|
#
|
1750
1776
|
#
|
1751
1777
|
#
|
1752
|
-
# [1]:
|
1753
|
-
# [2]:
|
1754
|
-
# [3]:
|
1778
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
|
1779
|
+
# [2]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords
|
1780
|
+
# [3]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords
|
1755
1781
|
#
|
1756
1782
|
# @option params [required, Array<Types::PutRecordsRequestEntry>] :records
|
1757
1783
|
# The records associated with the request.
|
@@ -1798,15 +1824,24 @@ module Aws::Kinesis
|
|
1798
1824
|
end
|
1799
1825
|
|
1800
1826
|
# Registers a consumer with a Kinesis data stream. When you use this
|
1801
|
-
# operation, the consumer you register can
|
1802
|
-
#
|
1803
|
-
#
|
1827
|
+
# operation, the consumer you register can then call SubscribeToShard to
|
1828
|
+
# receive data from the stream using enhanced fan-out, at a rate of up
|
1829
|
+
# to 2 MiB per second for every shard you subscribe to. This rate is
|
1830
|
+
# unaffected by the total number of consumers that read from the same
|
1831
|
+
# stream.
|
1804
1832
|
#
|
1805
|
-
# You can register up to
|
1806
|
-
# only be registered with one stream.
|
1833
|
+
# You can register up to 20 consumers per stream. A given consumer can
|
1834
|
+
# only be registered with one stream at a time.
|
1807
1835
|
#
|
1808
|
-
#
|
1809
|
-
#
|
1836
|
+
# For an example of how to use this operations, see [Enhanced Fan-Out
|
1837
|
+
# Using the Kinesis Data Streams
|
1838
|
+
# API](/streams/latest/dev/building-enhanced-consumers-api.html).
|
1839
|
+
#
|
1840
|
+
# The use of this operation has a limit of five transactions per second
|
1841
|
+
# per account. Also, only 5 consumers can be created simultaneously. In
|
1842
|
+
# other words, you cannot have more than 5 consumers in a `CREATING`
|
1843
|
+
# status at the same time. Registering a 6th consumer while there are 5
|
1844
|
+
# in a `CREATING` status results in a `LimitExceededException`.
|
1810
1845
|
#
|
1811
1846
|
# @option params [required, String] :stream_arn
|
1812
1847
|
# The ARN of the Kinesis data stream that you want to register the
|
@@ -1935,9 +1970,9 @@ module Aws::Kinesis
|
|
1935
1970
|
#
|
1936
1971
|
#
|
1937
1972
|
#
|
1938
|
-
# [1]:
|
1939
|
-
# [2]:
|
1940
|
-
# [3]:
|
1973
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html
|
1974
|
+
# [2]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1975
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
1941
1976
|
#
|
1942
1977
|
# @option params [required, String] :stream_name
|
1943
1978
|
# The name of the stream for the shard split.
|
@@ -2118,14 +2153,19 @@ module Aws::Kinesis
|
|
2118
2153
|
#
|
2119
2154
|
# To update the shard count, Kinesis Data Streams performs splits or
|
2120
2155
|
# merges on individual shards. This can cause short-lived shards to be
|
2121
|
-
# created, in addition to the final shards.
|
2122
|
-
#
|
2123
|
-
#
|
2156
|
+
# created, in addition to the final shards. These short-lived shards
|
2157
|
+
# count towards your total shard limit for your account in the Region.
|
2158
|
+
#
|
2159
|
+
# When using this operation, we recommend that you specify a target
|
2160
|
+
# shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can
|
2161
|
+
# specify any target value within your shard limit. However, if you
|
2162
|
+
# specify a target that isn't a multiple of 25%, the scaling action
|
2163
|
+
# might take longer to complete.
|
2124
2164
|
#
|
2125
2165
|
# This operation has the following default limits. By default, you
|
2126
2166
|
# cannot do the following:
|
2127
2167
|
#
|
2128
|
-
# * Scale more than
|
2168
|
+
# * Scale more than ten times per rolling 24-hour period per stream
|
2129
2169
|
#
|
2130
2170
|
# * Scale up to more than double your current shard count for a stream
|
2131
2171
|
#
|
@@ -2145,14 +2185,27 @@ module Aws::Kinesis
|
|
2145
2185
|
#
|
2146
2186
|
#
|
2147
2187
|
#
|
2148
|
-
# [1]:
|
2188
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
2149
2189
|
# [2]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis
|
2150
2190
|
#
|
2151
2191
|
# @option params [required, String] :stream_name
|
2152
2192
|
# The name of the stream.
|
2153
2193
|
#
|
2154
2194
|
# @option params [required, Integer] :target_shard_count
|
2155
|
-
# The new number of shards.
|
2195
|
+
# The new number of shards. This value has the following default limits.
|
2196
|
+
# By default, you cannot do the following:
|
2197
|
+
#
|
2198
|
+
# * Set this value to more than double your current shard count for a
|
2199
|
+
# stream.
|
2200
|
+
#
|
2201
|
+
# * Set this value below half your current shard count for a stream.
|
2202
|
+
#
|
2203
|
+
# * Set this value to more than 500 shards in a stream (the default
|
2204
|
+
# limit for shard count per stream is 500 per account per region),
|
2205
|
+
# unless you request a limit increase.
|
2206
|
+
#
|
2207
|
+
# * Scale a stream with more than 500 shards down unless you set this
|
2208
|
+
# value to less than 500 shards.
|
2156
2209
|
#
|
2157
2210
|
# @option params [required, String] :scaling_type
|
2158
2211
|
# The scaling type. Uniform scaling creates shards of equal size.
|
@@ -2199,7 +2252,7 @@ module Aws::Kinesis
|
|
2199
2252
|
params: params,
|
2200
2253
|
config: config)
|
2201
2254
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2202
|
-
context[:gem_version] = '1.
|
2255
|
+
context[:gem_version] = '1.27.0'
|
2203
2256
|
Seahorse::Client::Request.new(handlers, context)
|
2204
2257
|
end
|
2205
2258
|
|