aws-sdk-kinesis 1.26.0 → 1.31.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 +3 -2
- data/lib/aws-sdk-kinesis/async_client.rb +58 -20
- data/lib/aws-sdk-kinesis/client.rb +120 -56
- data/lib/aws-sdk-kinesis/client_api.rb +23 -1
- data/lib/aws-sdk-kinesis/types.rb +142 -22
- 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: fe9ef1399ca7b04aeda1a91b5ea65f93a065254d665b54df1abe459dbfc3a677
|
4
|
+
data.tar.gz: a1d067a32d404498b93fef6b225f27882acdd56215bbfc1bd3ea95dcba2522fb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 914beaf924d3fbfda64117fdbfa3f1c51b10b0a048ae40cd5b09b3fc0912f37b277520fb4cffbe93eb898ef0885e81275fb5346233172f7650cf77f407032d24
|
7
|
+
data.tar.gz: 5fc6aefa04bcfb88f5f0a5a2fa4d3222df014bf83f950aa416cc71ac1e47850d563cca5850dc3282047dc74252907452078d09542f3926799ab2e4603dd6ae11
|
data/lib/aws-sdk-kinesis.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -47,9 +48,9 @@ require_relative 'aws-sdk-kinesis/event_streams'
|
|
47
48
|
#
|
48
49
|
# See {Errors} for more information.
|
49
50
|
#
|
50
|
-
#
|
51
|
+
# @!group service
|
51
52
|
module Aws::Kinesis
|
52
53
|
|
53
|
-
GEM_VERSION = '1.
|
54
|
+
GEM_VERSION = '1.31.0'
|
54
55
|
|
55
56
|
end
|
@@ -68,13 +68,28 @@ module Aws::Kinesis
|
|
68
68
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
69
69
|
# credentials.
|
70
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
|
+
#
|
71
85
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
72
86
|
# from an EC2 IMDS on an EC2 instance.
|
73
87
|
#
|
74
|
-
# * `Aws::
|
75
|
-
#
|
88
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
89
|
+
# instances running in ECS.
|
76
90
|
#
|
77
|
-
# * `Aws::
|
91
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
92
|
+
# from the Cognito Identity service.
|
78
93
|
#
|
79
94
|
# When `:credentials` are not configured directly, the following
|
80
95
|
# locations will be searched for credentials:
|
@@ -84,10 +99,10 @@ module Aws::Kinesis
|
|
84
99
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
85
100
|
# * `~/.aws/credentials`
|
86
101
|
# * `~/.aws/config`
|
87
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
88
|
-
# very aggressive. Construct and pass an instance of
|
89
|
-
# `Aws::InstanceProfileCredentails`
|
90
|
-
# 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.
|
91
106
|
#
|
92
107
|
# @option options [required, String] :region
|
93
108
|
# The AWS region to connect to. The configured `:region` is
|
@@ -232,19 +247,36 @@ module Aws::Kinesis
|
|
232
247
|
|
233
248
|
# @!group API Operations
|
234
249
|
|
235
|
-
#
|
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
|
236
255
|
# RegisterStreamConsumer to register the consumer with Kinesis Data
|
237
|
-
# Streams.
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
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).
|
248
280
|
#
|
249
281
|
# @option params [required, String] :consumer_arn
|
250
282
|
# For this parameter, use the value you obtained when you called
|
@@ -456,6 +488,12 @@ module Aws::Kinesis
|
|
456
488
|
# event.records[0].encryption_type #=> String, one of "NONE", "KMS"
|
457
489
|
# event.continuation_sequence_number #=> String
|
458
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
|
459
497
|
#
|
460
498
|
# For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
|
461
499
|
# event.message #=> String
|
@@ -520,7 +558,7 @@ module Aws::Kinesis
|
|
520
558
|
http_response: Seahorse::Client::Http::AsyncResponse.new,
|
521
559
|
config: config)
|
522
560
|
context[:gem_name] = 'aws-sdk-kinesis'
|
523
|
-
context[:gem_version] = '1.
|
561
|
+
context[:gem_version] = '1.31.0'
|
524
562
|
Seahorse::Client::Request.new(handlers, context)
|
525
563
|
end
|
526
564
|
|
@@ -87,13 +87,28 @@ module Aws::Kinesis
|
|
87
87
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
88
88
|
# credentials.
|
89
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
|
+
#
|
90
104
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
91
105
|
# from an EC2 IMDS on an EC2 instance.
|
92
106
|
#
|
93
|
-
# * `Aws::
|
94
|
-
#
|
107
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
108
|
+
# instances running in ECS.
|
95
109
|
#
|
96
|
-
# * `Aws::
|
110
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
111
|
+
# from the Cognito Identity service.
|
97
112
|
#
|
98
113
|
# When `:credentials` are not configured directly, the following
|
99
114
|
# locations will be searched for credentials:
|
@@ -103,10 +118,10 @@ module Aws::Kinesis
|
|
103
118
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
104
119
|
# * `~/.aws/credentials`
|
105
120
|
# * `~/.aws/config`
|
106
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
107
|
-
# very aggressive. Construct and pass an instance of
|
108
|
-
# `Aws::InstanceProfileCredentails`
|
109
|
-
# 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.
|
110
125
|
#
|
111
126
|
# @option options [required, String] :region
|
112
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -379,9 +394,9 @@ module Aws::Kinesis
|
|
379
394
|
#
|
380
395
|
# You specify and control the number of shards that a stream is composed
|
381
396
|
# of. Each shard can support reads up to five transactions per second,
|
382
|
-
# 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
|
383
398
|
# support writes up to 1,000 records per second, up to a maximum data
|
384
|
-
# write total of 1
|
399
|
+
# write total of 1 MiB per second. If the amount of data input increases
|
385
400
|
# or decreases, you can add or remove shards.
|
386
401
|
#
|
387
402
|
# The stream name identifies the stream. The name is scoped to the AWS
|
@@ -415,8 +430,8 @@ module Aws::Kinesis
|
|
415
430
|
#
|
416
431
|
#
|
417
432
|
#
|
418
|
-
# [1]:
|
419
|
-
# [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
|
420
435
|
#
|
421
436
|
# @option params [required, String] :stream_name
|
422
437
|
# A name to identify the stream. The stream name is scoped to the AWS
|
@@ -430,8 +445,6 @@ module Aws::Kinesis
|
|
430
445
|
# stream is a function of the number of shards; more shards are required
|
431
446
|
# for greater provisioned throughput.
|
432
447
|
#
|
433
|
-
# DefaultShardLimit;
|
434
|
-
#
|
435
448
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
436
449
|
#
|
437
450
|
# @example Request syntax with placeholder values
|
@@ -539,8 +552,7 @@ module Aws::Kinesis
|
|
539
552
|
# all the consumers that are currently registered with a given data
|
540
553
|
# stream. The description of a consumer contains its name and ARN.
|
541
554
|
#
|
542
|
-
# This operation has a limit of five transactions per second per
|
543
|
-
# account.
|
555
|
+
# This operation has a limit of five transactions per second per stream.
|
544
556
|
#
|
545
557
|
# @option params [String] :stream_arn
|
546
558
|
# The ARN of the Kinesis data stream that the consumer is registered
|
@@ -630,7 +642,7 @@ module Aws::Kinesis
|
|
630
642
|
#
|
631
643
|
#
|
632
644
|
#
|
633
|
-
# [1]:
|
645
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
|
634
646
|
#
|
635
647
|
# @option params [required, String] :stream_name
|
636
648
|
# The name of the stream to describe.
|
@@ -703,7 +715,7 @@ module Aws::Kinesis
|
|
703
715
|
# operation to get a list of the descriptions of all the consumers that
|
704
716
|
# are currently registered with a given data stream.
|
705
717
|
#
|
706
|
-
# This operation has a limit of 20 transactions per second per
|
718
|
+
# This operation has a limit of 20 transactions per second per stream.
|
707
719
|
#
|
708
720
|
# @option params [String] :stream_arn
|
709
721
|
# The ARN of the Kinesis data stream that the consumer is registered
|
@@ -757,6 +769,9 @@ module Aws::Kinesis
|
|
757
769
|
# Name (ARN), status, record retention period, approximate creation
|
758
770
|
# time, monitoring, encryption details, and open shard count.
|
759
771
|
#
|
772
|
+
# DescribeStreamSummary has a limit of 20 transactions per second per
|
773
|
+
# account.
|
774
|
+
#
|
760
775
|
# @option params [required, String] :stream_name
|
761
776
|
# The name of the stream to describe.
|
762
777
|
#
|
@@ -828,7 +843,7 @@ module Aws::Kinesis
|
|
828
843
|
#
|
829
844
|
#
|
830
845
|
#
|
831
|
-
# [1]:
|
846
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
832
847
|
#
|
833
848
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
834
849
|
#
|
@@ -894,7 +909,7 @@ module Aws::Kinesis
|
|
894
909
|
#
|
895
910
|
#
|
896
911
|
#
|
897
|
-
# [1]:
|
912
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
898
913
|
#
|
899
914
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
900
915
|
#
|
@@ -985,13 +1000,12 @@ module Aws::Kinesis
|
|
985
1000
|
# always increasing. For example, records in a shard or across a stream
|
986
1001
|
# might have time stamps that are out of order.
|
987
1002
|
#
|
988
|
-
# This operation has a limit of five transactions per second per
|
989
|
-
# account.
|
1003
|
+
# This operation has a limit of five transactions per second per shard.
|
990
1004
|
#
|
991
1005
|
#
|
992
1006
|
#
|
993
|
-
# [1]:
|
994
|
-
# [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
|
995
1009
|
#
|
996
1010
|
# @option params [required, String] :shard_iterator
|
997
1011
|
# The position in the shard from which you want to start sequentially
|
@@ -1001,13 +1015,14 @@ module Aws::Kinesis
|
|
1001
1015
|
# @option params [Integer] :limit
|
1002
1016
|
# The maximum number of records to return. Specify a value of up to
|
1003
1017
|
# 10,000. If you specify a value that is greater than 10,000, GetRecords
|
1004
|
-
# throws `InvalidArgumentException`.
|
1018
|
+
# throws `InvalidArgumentException`. The default value is 10,000.
|
1005
1019
|
#
|
1006
1020
|
# @return [Types::GetRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1007
1021
|
#
|
1008
1022
|
# * {Types::GetRecordsOutput#records #records} => Array<Types::Record>
|
1009
1023
|
# * {Types::GetRecordsOutput#next_shard_iterator #next_shard_iterator} => String
|
1010
1024
|
# * {Types::GetRecordsOutput#millis_behind_latest #millis_behind_latest} => Integer
|
1025
|
+
# * {Types::GetRecordsOutput#child_shards #child_shards} => Array<Types::ChildShard>
|
1011
1026
|
#
|
1012
1027
|
# @example Request syntax with placeholder values
|
1013
1028
|
#
|
@@ -1026,6 +1041,12 @@ module Aws::Kinesis
|
|
1026
1041
|
# resp.records[0].encryption_type #=> String, one of "NONE", "KMS"
|
1027
1042
|
# resp.next_shard_iterator #=> String
|
1028
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
|
1029
1050
|
#
|
1030
1051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecords AWS API Documentation
|
1031
1052
|
#
|
@@ -1081,7 +1102,7 @@ module Aws::Kinesis
|
|
1081
1102
|
#
|
1082
1103
|
#
|
1083
1104
|
#
|
1084
|
-
# [1]:
|
1105
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1085
1106
|
#
|
1086
1107
|
# @option params [required, String] :stream_name
|
1087
1108
|
# The name of the Amazon Kinesis data stream.
|
@@ -1252,7 +1273,7 @@ module Aws::Kinesis
|
|
1252
1273
|
# @option params [Integer] :max_results
|
1253
1274
|
# The maximum number of shards to return in a single call to
|
1254
1275
|
# `ListShards`. The minimum value you can specify for this parameter is
|
1255
|
-
# 1, and the maximum is
|
1276
|
+
# 1, and the maximum is 10,000, which is also the default.
|
1256
1277
|
#
|
1257
1278
|
# When the number of shards to be listed is greater than the value of
|
1258
1279
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1269,6 +1290,8 @@ module Aws::Kinesis
|
|
1269
1290
|
# You cannot specify this parameter if you specify the `NextToken`
|
1270
1291
|
# parameter.
|
1271
1292
|
#
|
1293
|
+
# @option params [Types::ShardFilter] :shard_filter
|
1294
|
+
#
|
1272
1295
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1273
1296
|
#
|
1274
1297
|
# * {Types::ListShardsOutput#shards #shards} => Array<Types::Shard>
|
@@ -1282,6 +1305,11 @@ module Aws::Kinesis
|
|
1282
1305
|
# exclusive_start_shard_id: "ShardId",
|
1283
1306
|
# max_results: 1,
|
1284
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
|
+
# },
|
1285
1313
|
# })
|
1286
1314
|
#
|
1287
1315
|
# @example Response structure
|
@@ -1308,7 +1336,7 @@ module Aws::Kinesis
|
|
1308
1336
|
# Lists the consumers registered to receive data from a stream using
|
1309
1337
|
# enhanced fan-out, and provides information about each consumer.
|
1310
1338
|
#
|
1311
|
-
# This operation has a limit of
|
1339
|
+
# This operation has a limit of 5 transactions per second per stream.
|
1312
1340
|
#
|
1313
1341
|
# @option params [required, String] :stream_arn
|
1314
1342
|
# The ARN of the Kinesis data stream for which you want to list the
|
@@ -1537,7 +1565,7 @@ module Aws::Kinesis
|
|
1537
1565
|
#
|
1538
1566
|
#
|
1539
1567
|
#
|
1540
|
-
# [1]:
|
1568
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
|
1541
1569
|
#
|
1542
1570
|
# @option params [required, String] :stream_name
|
1543
1571
|
# The name of the stream for the merge.
|
@@ -1572,7 +1600,7 @@ module Aws::Kinesis
|
|
1572
1600
|
# `PutRecord` to send data into the stream for real-time ingestion and
|
1573
1601
|
# subsequent processing, one record at a time. Each shard can support
|
1574
1602
|
# writes up to 1,000 records per second, up to a maximum data write
|
1575
|
-
# total of 1
|
1603
|
+
# total of 1 MiB per second.
|
1576
1604
|
#
|
1577
1605
|
# You must specify the name of the stream that captures, stores, and
|
1578
1606
|
# transports the data; a partition key; and the data blob itself.
|
@@ -1606,6 +1634,9 @@ module Aws::Kinesis
|
|
1606
1634
|
# [Adding Data to a Stream][1] in the *Amazon Kinesis Data Streams
|
1607
1635
|
# Developer Guide*.
|
1608
1636
|
#
|
1637
|
+
# After you write a record to a stream, you cannot modify that record or
|
1638
|
+
# its order within the stream.
|
1639
|
+
#
|
1609
1640
|
# If a `PutRecord` request cannot be processed because of insufficient
|
1610
1641
|
# provisioned throughput on the shard involved in the request,
|
1611
1642
|
# `PutRecord` throws `ProvisionedThroughputExceededException`.
|
@@ -1617,16 +1648,16 @@ module Aws::Kinesis
|
|
1617
1648
|
#
|
1618
1649
|
#
|
1619
1650
|
#
|
1620
|
-
# [1]:
|
1651
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
|
1621
1652
|
#
|
1622
1653
|
# @option params [required, String] :stream_name
|
1623
1654
|
# The name of the stream to put the data record into.
|
1624
1655
|
#
|
1625
|
-
# @option params [required, String,
|
1656
|
+
# @option params [required, String, StringIO, File] :data
|
1626
1657
|
# The data blob to put into the record, which is base64-encoded when the
|
1627
1658
|
# blob is serialized. When the data blob (the payload before
|
1628
1659
|
# base64-encoding) is added to the partition key size, the total size
|
1629
|
-
# must not exceed the maximum record size (1
|
1660
|
+
# must not exceed the maximum record size (1 MiB).
|
1630
1661
|
#
|
1631
1662
|
# @option params [required, String] :partition_key
|
1632
1663
|
# Determines which shard in the stream the data record is assigned to.
|
@@ -1687,10 +1718,10 @@ module Aws::Kinesis
|
|
1687
1718
|
# to send data into the stream for data ingestion and processing.
|
1688
1719
|
#
|
1689
1720
|
# Each `PutRecords` request can support up to 500 records. Each record
|
1690
|
-
# in the request can be as large as 1
|
1691
|
-
# 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
|
1692
1723
|
# writes up to 1,000 records per second, up to a maximum data write
|
1693
|
-
# total of 1
|
1724
|
+
# total of 1 MiB per second.
|
1694
1725
|
#
|
1695
1726
|
# You must specify the name of the stream that captures, stores, and
|
1696
1727
|
# transports the data; and an array of request `Records`, with each
|
@@ -1727,7 +1758,10 @@ module Aws::Kinesis
|
|
1727
1758
|
# The response `Records` array includes both successfully and
|
1728
1759
|
# unsuccessfully processed records. Kinesis Data Streams attempts to
|
1729
1760
|
# process all records in each `PutRecords` request. A single record
|
1730
|
-
# 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.
|
1731
1765
|
#
|
1732
1766
|
# A successfully processed record includes `ShardId` and
|
1733
1767
|
# `SequenceNumber` values. The `ShardId` parameter identifies the shard
|
@@ -1746,6 +1780,9 @@ module Aws::Kinesis
|
|
1746
1780
|
# see [Adding Multiple Records with PutRecords][3] in the *Amazon
|
1747
1781
|
# Kinesis Data Streams Developer Guide*.
|
1748
1782
|
#
|
1783
|
+
# After you write a record to a stream, you cannot modify that record or
|
1784
|
+
# its order within the stream.
|
1785
|
+
#
|
1749
1786
|
# By default, data records are accessible for 24 hours from the time
|
1750
1787
|
# that they are added to a stream. You can use
|
1751
1788
|
# IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to
|
@@ -1753,9 +1790,9 @@ module Aws::Kinesis
|
|
1753
1790
|
#
|
1754
1791
|
#
|
1755
1792
|
#
|
1756
|
-
# [1]:
|
1757
|
-
# [2]:
|
1758
|
-
# [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
|
1759
1796
|
#
|
1760
1797
|
# @option params [required, Array<Types::PutRecordsRequestEntry>] :records
|
1761
1798
|
# The records associated with the request.
|
@@ -1802,15 +1839,24 @@ module Aws::Kinesis
|
|
1802
1839
|
end
|
1803
1840
|
|
1804
1841
|
# Registers a consumer with a Kinesis data stream. When you use this
|
1805
|
-
# operation, the consumer you register can
|
1806
|
-
#
|
1807
|
-
#
|
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.
|
1808
1847
|
#
|
1809
|
-
# You can register up to
|
1810
|
-
# 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.
|
1811
1850
|
#
|
1812
|
-
#
|
1813
|
-
#
|
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`.
|
1814
1860
|
#
|
1815
1861
|
# @option params [required, String] :stream_arn
|
1816
1862
|
# The ARN of the Kinesis data stream that you want to register the
|
@@ -1939,9 +1985,9 @@ module Aws::Kinesis
|
|
1939
1985
|
#
|
1940
1986
|
#
|
1941
1987
|
#
|
1942
|
-
# [1]:
|
1943
|
-
# [2]:
|
1944
|
-
# [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
|
1945
1991
|
#
|
1946
1992
|
# @option params [required, String] :stream_name
|
1947
1993
|
# The name of the stream for the shard split.
|
@@ -2122,14 +2168,19 @@ module Aws::Kinesis
|
|
2122
2168
|
#
|
2123
2169
|
# To update the shard count, Kinesis Data Streams performs splits or
|
2124
2170
|
# merges on individual shards. This can cause short-lived shards to be
|
2125
|
-
# created, in addition to the final shards.
|
2126
|
-
#
|
2127
|
-
#
|
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.
|
2128
2179
|
#
|
2129
2180
|
# This operation has the following default limits. By default, you
|
2130
2181
|
# cannot do the following:
|
2131
2182
|
#
|
2132
|
-
# * Scale more than
|
2183
|
+
# * Scale more than ten times per rolling 24-hour period per stream
|
2133
2184
|
#
|
2134
2185
|
# * Scale up to more than double your current shard count for a stream
|
2135
2186
|
#
|
@@ -2149,14 +2200,27 @@ module Aws::Kinesis
|
|
2149
2200
|
#
|
2150
2201
|
#
|
2151
2202
|
#
|
2152
|
-
# [1]:
|
2203
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
2153
2204
|
# [2]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis
|
2154
2205
|
#
|
2155
2206
|
# @option params [required, String] :stream_name
|
2156
2207
|
# The name of the stream.
|
2157
2208
|
#
|
2158
2209
|
# @option params [required, Integer] :target_shard_count
|
2159
|
-
# 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.
|
2160
2224
|
#
|
2161
2225
|
# @option params [required, String] :scaling_type
|
2162
2226
|
# The scaling type. Uniform scaling creates shards of equal size.
|
@@ -2203,7 +2267,7 @@ module Aws::Kinesis
|
|
2203
2267
|
params: params,
|
2204
2268
|
config: config)
|
2205
2269
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2206
|
-
context[:gem_version] = '1.
|
2270
|
+
context[:gem_version] = '1.31.0'
|
2207
2271
|
Seahorse::Client::Request.new(handlers, context)
|
2208
2272
|
end
|
2209
2273
|
|
@@ -15,6 +15,8 @@ module Aws::Kinesis
|
|
15
15
|
|
16
16
|
AddTagsToStreamInput = Shapes::StructureShape.new(name: 'AddTagsToStreamInput')
|
17
17
|
BooleanObject = Shapes::BooleanShape.new(name: 'BooleanObject')
|
18
|
+
ChildShard = Shapes::StructureShape.new(name: 'ChildShard')
|
19
|
+
ChildShardList = Shapes::ListShape.new(name: 'ChildShardList')
|
18
20
|
Consumer = Shapes::StructureShape.new(name: 'Consumer')
|
19
21
|
ConsumerARN = Shapes::StringShape.new(name: 'ConsumerARN')
|
20
22
|
ConsumerCountObject = Shapes::IntegerShape.new(name: 'ConsumerCountObject')
|
@@ -105,7 +107,10 @@ module Aws::Kinesis
|
|
105
107
|
SequenceNumberRange = Shapes::StructureShape.new(name: 'SequenceNumberRange')
|
106
108
|
Shard = Shapes::StructureShape.new(name: 'Shard')
|
107
109
|
ShardCountObject = Shapes::IntegerShape.new(name: 'ShardCountObject')
|
110
|
+
ShardFilter = Shapes::StructureShape.new(name: 'ShardFilter')
|
111
|
+
ShardFilterType = Shapes::StringShape.new(name: 'ShardFilterType')
|
108
112
|
ShardId = Shapes::StringShape.new(name: 'ShardId')
|
113
|
+
ShardIdList = Shapes::ListShape.new(name: 'ShardIdList')
|
109
114
|
ShardIterator = Shapes::StringShape.new(name: 'ShardIterator')
|
110
115
|
ShardIteratorType = Shapes::StringShape.new(name: 'ShardIteratorType')
|
111
116
|
ShardList = Shapes::ListShape.new(name: 'ShardList')
|
@@ -137,6 +142,13 @@ module Aws::Kinesis
|
|
137
142
|
AddTagsToStreamInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, required: true, location_name: "Tags"))
|
138
143
|
AddTagsToStreamInput.struct_class = Types::AddTagsToStreamInput
|
139
144
|
|
145
|
+
ChildShard.add_member(:shard_id, Shapes::ShapeRef.new(shape: ShardId, required: true, location_name: "ShardId"))
|
146
|
+
ChildShard.add_member(:parent_shards, Shapes::ShapeRef.new(shape: ShardIdList, required: true, location_name: "ParentShards"))
|
147
|
+
ChildShard.add_member(:hash_key_range, Shapes::ShapeRef.new(shape: HashKeyRange, required: true, location_name: "HashKeyRange"))
|
148
|
+
ChildShard.struct_class = Types::ChildShard
|
149
|
+
|
150
|
+
ChildShardList.member = Shapes::ShapeRef.new(shape: ChildShard)
|
151
|
+
|
140
152
|
Consumer.add_member(:consumer_name, Shapes::ShapeRef.new(shape: ConsumerName, required: true, location_name: "ConsumerName"))
|
141
153
|
Consumer.add_member(:consumer_arn, Shapes::ShapeRef.new(shape: ConsumerARN, required: true, location_name: "ConsumerARN"))
|
142
154
|
Consumer.add_member(:consumer_status, Shapes::ShapeRef.new(shape: ConsumerStatus, required: true, location_name: "ConsumerStatus"))
|
@@ -228,6 +240,7 @@ module Aws::Kinesis
|
|
228
240
|
GetRecordsOutput.add_member(:records, Shapes::ShapeRef.new(shape: RecordList, required: true, location_name: "Records"))
|
229
241
|
GetRecordsOutput.add_member(:next_shard_iterator, Shapes::ShapeRef.new(shape: ShardIterator, location_name: "NextShardIterator"))
|
230
242
|
GetRecordsOutput.add_member(:millis_behind_latest, Shapes::ShapeRef.new(shape: MillisBehindLatest, location_name: "MillisBehindLatest"))
|
243
|
+
GetRecordsOutput.add_member(:child_shards, Shapes::ShapeRef.new(shape: ChildShardList, location_name: "ChildShards"))
|
231
244
|
GetRecordsOutput.struct_class = Types::GetRecordsOutput
|
232
245
|
|
233
246
|
GetShardIteratorInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
|
@@ -280,6 +293,7 @@ module Aws::Kinesis
|
|
280
293
|
ListShardsInput.add_member(:exclusive_start_shard_id, Shapes::ShapeRef.new(shape: ShardId, location_name: "ExclusiveStartShardId"))
|
281
294
|
ListShardsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: ListShardsInputLimit, location_name: "MaxResults"))
|
282
295
|
ListShardsInput.add_member(:stream_creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StreamCreationTimestamp"))
|
296
|
+
ListShardsInput.add_member(:shard_filter, Shapes::ShapeRef.new(shape: ShardFilter, location_name: "ShardFilter"))
|
283
297
|
ListShardsInput.struct_class = Types::ListShardsInput
|
284
298
|
|
285
299
|
ListShardsOutput.add_member(:shards, Shapes::ShapeRef.new(shape: ShardList, location_name: "Shards"))
|
@@ -396,6 +410,13 @@ module Aws::Kinesis
|
|
396
410
|
Shard.add_member(:sequence_number_range, Shapes::ShapeRef.new(shape: SequenceNumberRange, required: true, location_name: "SequenceNumberRange"))
|
397
411
|
Shard.struct_class = Types::Shard
|
398
412
|
|
413
|
+
ShardFilter.add_member(:type, Shapes::ShapeRef.new(shape: ShardFilterType, required: true, location_name: "Type"))
|
414
|
+
ShardFilter.add_member(:shard_id, Shapes::ShapeRef.new(shape: ShardId, location_name: "ShardId"))
|
415
|
+
ShardFilter.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
|
416
|
+
ShardFilter.struct_class = Types::ShardFilter
|
417
|
+
|
418
|
+
ShardIdList.member = Shapes::ShapeRef.new(shape: ShardId)
|
419
|
+
|
399
420
|
ShardList.member = Shapes::ShapeRef.new(shape: Shard)
|
400
421
|
|
401
422
|
SplitShardInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
|
@@ -433,7 +454,7 @@ module Aws::Kinesis
|
|
433
454
|
StreamDescriptionSummary.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
|
434
455
|
StreamDescriptionSummary.add_member(:stream_arn, Shapes::ShapeRef.new(shape: StreamARN, required: true, location_name: "StreamARN"))
|
435
456
|
StreamDescriptionSummary.add_member(:stream_status, Shapes::ShapeRef.new(shape: StreamStatus, required: true, location_name: "StreamStatus"))
|
436
|
-
StreamDescriptionSummary.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape:
|
457
|
+
StreamDescriptionSummary.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape: RetentionPeriodHours, required: true, location_name: "RetentionPeriodHours"))
|
437
458
|
StreamDescriptionSummary.add_member(:stream_creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StreamCreationTimestamp"))
|
438
459
|
StreamDescriptionSummary.add_member(:enhanced_monitoring, Shapes::ShapeRef.new(shape: EnhancedMonitoringList, required: true, location_name: "EnhancedMonitoring"))
|
439
460
|
StreamDescriptionSummary.add_member(:encryption_type, Shapes::ShapeRef.new(shape: EncryptionType, location_name: "EncryptionType"))
|
@@ -447,6 +468,7 @@ module Aws::Kinesis
|
|
447
468
|
SubscribeToShardEvent.add_member(:records, Shapes::ShapeRef.new(shape: RecordList, required: true, location_name: "Records"))
|
448
469
|
SubscribeToShardEvent.add_member(:continuation_sequence_number, Shapes::ShapeRef.new(shape: SequenceNumber, required: true, location_name: "ContinuationSequenceNumber"))
|
449
470
|
SubscribeToShardEvent.add_member(:millis_behind_latest, Shapes::ShapeRef.new(shape: MillisBehindLatest, required: true, location_name: "MillisBehindLatest"))
|
471
|
+
SubscribeToShardEvent.add_member(:child_shards, Shapes::ShapeRef.new(shape: ChildShardList, location_name: "ChildShards"))
|
450
472
|
SubscribeToShardEvent.struct_class = Types::SubscribeToShardEvent
|
451
473
|
|
452
474
|
SubscribeToShardEventStream.add_member(:subscribe_to_shard_event, Shapes::ShapeRef.new(shape: SubscribeToShardEvent, required: true, event: true, location_name: "SubscribeToShardEvent"))
|
@@ -39,7 +39,29 @@ module Aws::Kinesis
|
|
39
39
|
include Aws::Structure
|
40
40
|
end
|
41
41
|
|
42
|
+
# @!attribute [rw] shard_id
|
43
|
+
# @return [String]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] parent_shards
|
46
|
+
# @return [Array<String>]
|
47
|
+
#
|
48
|
+
# @!attribute [rw] hash_key_range
|
49
|
+
# The range of possible hash key values for the shard, which is a set
|
50
|
+
# of ordered contiguous positive integers.
|
51
|
+
# @return [Types::HashKeyRange]
|
52
|
+
#
|
53
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ChildShard AWS API Documentation
|
54
|
+
#
|
55
|
+
class ChildShard < Struct.new(
|
56
|
+
:shard_id,
|
57
|
+
:parent_shards,
|
58
|
+
:hash_key_range)
|
59
|
+
SENSITIVE = []
|
60
|
+
include Aws::Structure
|
61
|
+
end
|
62
|
+
|
42
63
|
# An object that represents the details of the consumer you registered.
|
64
|
+
# This type of object is returned by RegisterStreamConsumer.
|
43
65
|
#
|
44
66
|
# @!attribute [rw] consumer_name
|
45
67
|
# The name of the consumer is something you choose when you register
|
@@ -75,7 +97,8 @@ module Aws::Kinesis
|
|
75
97
|
include Aws::Structure
|
76
98
|
end
|
77
99
|
|
78
|
-
# An object that represents the details of a registered consumer.
|
100
|
+
# An object that represents the details of a registered consumer. This
|
101
|
+
# type of object is returned by DescribeStreamConsumer.
|
79
102
|
#
|
80
103
|
# @!attribute [rw] consumer_name
|
81
104
|
# The name of the consumer is something you choose when you register
|
@@ -138,8 +161,6 @@ module Aws::Kinesis
|
|
138
161
|
# The number of shards that the stream will use. The throughput of the
|
139
162
|
# stream is a function of the number of shards; more shards are
|
140
163
|
# required for greater provisioned throughput.
|
141
|
-
#
|
142
|
-
# DefaultShardLimit;
|
143
164
|
# @return [Integer]
|
144
165
|
#
|
145
166
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/CreateStreamInput AWS API Documentation
|
@@ -448,7 +469,7 @@ module Aws::Kinesis
|
|
448
469
|
#
|
449
470
|
#
|
450
471
|
#
|
451
|
-
# [1]:
|
472
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
452
473
|
# @return [Array<String>]
|
453
474
|
#
|
454
475
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DisableEnhancedMonitoringInput AWS API Documentation
|
@@ -502,7 +523,7 @@ module Aws::Kinesis
|
|
502
523
|
#
|
503
524
|
#
|
504
525
|
#
|
505
|
-
# [1]:
|
526
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
506
527
|
# @return [Array<String>]
|
507
528
|
#
|
508
529
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnableEnhancedMonitoringInput AWS API Documentation
|
@@ -544,7 +565,7 @@ module Aws::Kinesis
|
|
544
565
|
#
|
545
566
|
#
|
546
567
|
#
|
547
|
-
# [1]:
|
568
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
548
569
|
# @return [Array<String>]
|
549
570
|
#
|
550
571
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnhancedMetrics AWS API Documentation
|
@@ -628,7 +649,8 @@ module Aws::Kinesis
|
|
628
649
|
# @!attribute [rw] limit
|
629
650
|
# The maximum number of records to return. Specify a value of up to
|
630
651
|
# 10,000. If you specify a value that is greater than 10,000,
|
631
|
-
# GetRecords throws `InvalidArgumentException`.
|
652
|
+
# GetRecords throws `InvalidArgumentException`. The default value is
|
653
|
+
# 10,000.
|
632
654
|
# @return [Integer]
|
633
655
|
#
|
634
656
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecordsInput AWS API Documentation
|
@@ -659,12 +681,16 @@ module Aws::Kinesis
|
|
659
681
|
# and there are no new records to process at this moment.
|
660
682
|
# @return [Integer]
|
661
683
|
#
|
684
|
+
# @!attribute [rw] child_shards
|
685
|
+
# @return [Array<Types::ChildShard>]
|
686
|
+
#
|
662
687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecordsOutput AWS API Documentation
|
663
688
|
#
|
664
689
|
class GetRecordsOutput < Struct.new(
|
665
690
|
:records,
|
666
691
|
:next_shard_iterator,
|
667
|
-
:millis_behind_latest
|
692
|
+
:millis_behind_latest,
|
693
|
+
:child_shards)
|
668
694
|
SENSITIVE = []
|
669
695
|
include Aws::Structure
|
670
696
|
end
|
@@ -808,6 +834,9 @@ module Aws::Kinesis
|
|
808
834
|
include Aws::Structure
|
809
835
|
end
|
810
836
|
|
837
|
+
# The processing of the request failed because of an unknown error,
|
838
|
+
# exception, or failure.
|
839
|
+
#
|
811
840
|
# @!attribute [rw] message
|
812
841
|
# @return [String]
|
813
842
|
#
|
@@ -874,7 +903,7 @@ module Aws::Kinesis
|
|
874
903
|
#
|
875
904
|
#
|
876
905
|
#
|
877
|
-
# [1]:
|
906
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
878
907
|
#
|
879
908
|
# @!attribute [rw] message
|
880
909
|
# A message that provides information about the error.
|
@@ -926,7 +955,7 @@ module Aws::Kinesis
|
|
926
955
|
#
|
927
956
|
#
|
928
957
|
#
|
929
|
-
# [1]:
|
958
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second
|
930
959
|
#
|
931
960
|
# @!attribute [rw] message
|
932
961
|
# A message that provides information about the error.
|
@@ -966,6 +995,11 @@ module Aws::Kinesis
|
|
966
995
|
# exclusive_start_shard_id: "ShardId",
|
967
996
|
# max_results: 1,
|
968
997
|
# stream_creation_timestamp: Time.now,
|
998
|
+
# shard_filter: {
|
999
|
+
# type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
|
1000
|
+
# shard_id: "ShardId",
|
1001
|
+
# timestamp: Time.now,
|
1002
|
+
# },
|
969
1003
|
# }
|
970
1004
|
#
|
971
1005
|
# @!attribute [rw] stream_name
|
@@ -1015,7 +1049,7 @@ module Aws::Kinesis
|
|
1015
1049
|
# @!attribute [rw] max_results
|
1016
1050
|
# The maximum number of shards to return in a single call to
|
1017
1051
|
# `ListShards`. The minimum value you can specify for this parameter
|
1018
|
-
# is 1, and the maximum is
|
1052
|
+
# is 1, and the maximum is 10,000, which is also the default.
|
1019
1053
|
#
|
1020
1054
|
# When the number of shards to be listed is greater than the value of
|
1021
1055
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1034,6 +1068,9 @@ module Aws::Kinesis
|
|
1034
1068
|
# parameter.
|
1035
1069
|
# @return [Time]
|
1036
1070
|
#
|
1071
|
+
# @!attribute [rw] shard_filter
|
1072
|
+
# @return [Types::ShardFilter]
|
1073
|
+
#
|
1037
1074
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListShardsInput AWS API Documentation
|
1038
1075
|
#
|
1039
1076
|
class ListShardsInput < Struct.new(
|
@@ -1041,7 +1078,8 @@ module Aws::Kinesis
|
|
1041
1078
|
:next_token,
|
1042
1079
|
:exclusive_start_shard_id,
|
1043
1080
|
:max_results,
|
1044
|
-
:stream_creation_timestamp
|
1081
|
+
:stream_creation_timestamp,
|
1082
|
+
:shard_filter)
|
1045
1083
|
SENSITIVE = []
|
1046
1084
|
include Aws::Structure
|
1047
1085
|
end
|
@@ -1337,8 +1375,8 @@ module Aws::Kinesis
|
|
1337
1375
|
#
|
1338
1376
|
#
|
1339
1377
|
#
|
1340
|
-
# [1]:
|
1341
|
-
# [2]:
|
1378
|
+
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1379
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/api-retries.html
|
1342
1380
|
#
|
1343
1381
|
# @!attribute [rw] message
|
1344
1382
|
# A message that provides information about the error.
|
@@ -1373,7 +1411,7 @@ module Aws::Kinesis
|
|
1373
1411
|
# The data blob to put into the record, which is base64-encoded when
|
1374
1412
|
# the blob is serialized. When the data blob (the payload before
|
1375
1413
|
# base64-encoding) is added to the partition key size, the total size
|
1376
|
-
# must not exceed the maximum record size (1
|
1414
|
+
# must not exceed the maximum record size (1 MiB).
|
1377
1415
|
# @return [String]
|
1378
1416
|
#
|
1379
1417
|
# @!attribute [rw] partition_key
|
@@ -1530,7 +1568,7 @@ module Aws::Kinesis
|
|
1530
1568
|
# The data blob to put into the record, which is base64-encoded when
|
1531
1569
|
# the blob is serialized. When the data blob (the payload before
|
1532
1570
|
# base64-encoding) is added to the partition key size, the total size
|
1533
|
-
# must not exceed the maximum record size (1
|
1571
|
+
# must not exceed the maximum record size (1 MiB).
|
1534
1572
|
# @return [String]
|
1535
1573
|
#
|
1536
1574
|
# @!attribute [rw] explicit_hash_key
|
@@ -1615,7 +1653,7 @@ module Aws::Kinesis
|
|
1615
1653
|
# Kinesis Data Streams, which does not inspect, interpret, or change
|
1616
1654
|
# the data in the blob in any way. When the data blob (the payload
|
1617
1655
|
# before base64-encoding) is added to the partition key size, the
|
1618
|
-
# total size must not exceed the maximum record size (1
|
1656
|
+
# total size must not exceed the maximum record size (1 MiB).
|
1619
1657
|
# @return [String]
|
1620
1658
|
#
|
1621
1659
|
# @!attribute [rw] partition_key
|
@@ -1806,6 +1844,34 @@ module Aws::Kinesis
|
|
1806
1844
|
include Aws::Structure
|
1807
1845
|
end
|
1808
1846
|
|
1847
|
+
# @note When making an API call, you may pass ShardFilter
|
1848
|
+
# data as a hash:
|
1849
|
+
#
|
1850
|
+
# {
|
1851
|
+
# type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
|
1852
|
+
# shard_id: "ShardId",
|
1853
|
+
# timestamp: Time.now,
|
1854
|
+
# }
|
1855
|
+
#
|
1856
|
+
# @!attribute [rw] type
|
1857
|
+
# @return [String]
|
1858
|
+
#
|
1859
|
+
# @!attribute [rw] shard_id
|
1860
|
+
# @return [String]
|
1861
|
+
#
|
1862
|
+
# @!attribute [rw] timestamp
|
1863
|
+
# @return [Time]
|
1864
|
+
#
|
1865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ShardFilter AWS API Documentation
|
1866
|
+
#
|
1867
|
+
class ShardFilter < Struct.new(
|
1868
|
+
:type,
|
1869
|
+
:shard_id,
|
1870
|
+
:timestamp)
|
1871
|
+
SENSITIVE = []
|
1872
|
+
include Aws::Structure
|
1873
|
+
end
|
1874
|
+
|
1809
1875
|
# Represents the input for `SplitShard`.
|
1810
1876
|
#
|
1811
1877
|
# @note When making an API call, you may pass SplitShardInput
|
@@ -1904,12 +1970,41 @@ module Aws::Kinesis
|
|
1904
1970
|
# }
|
1905
1971
|
#
|
1906
1972
|
# @!attribute [rw] type
|
1973
|
+
# You can set the starting position to one of the following values:
|
1974
|
+
#
|
1975
|
+
# `AT_SEQUENCE_NUMBER`\: Start streaming from the position denoted by
|
1976
|
+
# the sequence number specified in the `SequenceNumber` field.
|
1977
|
+
#
|
1978
|
+
# `AFTER_SEQUENCE_NUMBER`\: Start streaming right after the position
|
1979
|
+
# denoted by the sequence number specified in the `SequenceNumber`
|
1980
|
+
# field.
|
1981
|
+
#
|
1982
|
+
# `AT_TIMESTAMP`\: Start streaming from the position denoted by the
|
1983
|
+
# time stamp specified in the `Timestamp` field.
|
1984
|
+
#
|
1985
|
+
# `TRIM_HORIZON`\: Start streaming at the last untrimmed record in the
|
1986
|
+
# shard, which is the oldest data record in the shard.
|
1987
|
+
#
|
1988
|
+
# `LATEST`\: Start streaming just after the most recent record in the
|
1989
|
+
# shard, so that you always read the most recent data in the shard.
|
1907
1990
|
# @return [String]
|
1908
1991
|
#
|
1909
1992
|
# @!attribute [rw] sequence_number
|
1993
|
+
# The sequence number of the data record in the shard from which to
|
1994
|
+
# start streaming. To specify a sequence number, set
|
1995
|
+
# `StartingPosition` to `AT_SEQUENCE_NUMBER` or
|
1996
|
+
# `AFTER_SEQUENCE_NUMBER`.
|
1910
1997
|
# @return [String]
|
1911
1998
|
#
|
1912
1999
|
# @!attribute [rw] timestamp
|
2000
|
+
# The time stamp of the data record from which to start reading. To
|
2001
|
+
# specify a time stamp, set `StartingPosition` to `Type AT_TIMESTAMP`.
|
2002
|
+
# A time stamp is the Unix epoch date with precision in milliseconds.
|
2003
|
+
# For example, `2016-04-04T19:58:46.480-00:00` or `1459799926.480`. If
|
2004
|
+
# a record with this exact time stamp does not exist, records will be
|
2005
|
+
# streamed from the next (later) record. If the time stamp is older
|
2006
|
+
# than the current trim horizon, records will be streamed from the
|
2007
|
+
# oldest untrimmed data record (`TRIM_HORIZON`).
|
1913
2008
|
# @return [Time]
|
1914
2009
|
#
|
1915
2010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartingPosition AWS API Documentation
|
@@ -2010,7 +2105,8 @@ module Aws::Kinesis
|
|
2010
2105
|
# @return [Boolean]
|
2011
2106
|
#
|
2012
2107
|
# @!attribute [rw] retention_period_hours
|
2013
|
-
# The current retention period, in hours.
|
2108
|
+
# The current retention period, in hours. Minimum value of 24. Maximum
|
2109
|
+
# value of 168.
|
2014
2110
|
# @return [Integer]
|
2015
2111
|
#
|
2016
2112
|
# @!attribute [rw] stream_creation_timestamp
|
@@ -2166,14 +2262,17 @@ module Aws::Kinesis
|
|
2166
2262
|
end
|
2167
2263
|
|
2168
2264
|
# After you call SubscribeToShard, Kinesis Data Streams sends events of
|
2169
|
-
# this type to your consumer.
|
2265
|
+
# this type over an HTTP/2 connection to your consumer.
|
2170
2266
|
#
|
2171
2267
|
# @!attribute [rw] records
|
2172
2268
|
# @return [Array<Types::Record>]
|
2173
2269
|
#
|
2174
2270
|
# @!attribute [rw] continuation_sequence_number
|
2175
|
-
# Use this as `
|
2176
|
-
#
|
2271
|
+
# Use this as `SequenceNumber` in the next call to SubscribeToShard,
|
2272
|
+
# with `StartingPosition` set to `AT_SEQUENCE_NUMBER` or
|
2273
|
+
# `AFTER_SEQUENCE_NUMBER`. Use `ContinuationSequenceNumber` for
|
2274
|
+
# checkpointing because it captures your shard progress even when no
|
2275
|
+
# data is written to the shard.
|
2177
2276
|
# @return [String]
|
2178
2277
|
#
|
2179
2278
|
# @!attribute [rw] millis_behind_latest
|
@@ -2183,12 +2282,16 @@ module Aws::Kinesis
|
|
2183
2282
|
# there are no new records to process at this moment.
|
2184
2283
|
# @return [Integer]
|
2185
2284
|
#
|
2285
|
+
# @!attribute [rw] child_shards
|
2286
|
+
# @return [Array<Types::ChildShard>]
|
2287
|
+
#
|
2186
2288
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SubscribeToShardEvent AWS API Documentation
|
2187
2289
|
#
|
2188
2290
|
class SubscribeToShardEvent < Struct.new(
|
2189
2291
|
:records,
|
2190
2292
|
:continuation_sequence_number,
|
2191
2293
|
:millis_behind_latest,
|
2294
|
+
:child_shards,
|
2192
2295
|
:event_type)
|
2193
2296
|
SENSITIVE = []
|
2194
2297
|
include Aws::Structure
|
@@ -2280,7 +2383,20 @@ module Aws::Kinesis
|
|
2280
2383
|
# @return [String]
|
2281
2384
|
#
|
2282
2385
|
# @!attribute [rw] target_shard_count
|
2283
|
-
# The new number of shards.
|
2386
|
+
# The new number of shards. This value has the following default
|
2387
|
+
# limits. By default, you cannot do the following:
|
2388
|
+
#
|
2389
|
+
# * Set this value to more than double your current shard count for a
|
2390
|
+
# stream.
|
2391
|
+
#
|
2392
|
+
# * Set this value below half your current shard count for a stream.
|
2393
|
+
#
|
2394
|
+
# * Set this value to more than 500 shards in a stream (the default
|
2395
|
+
# limit for shard count per stream is 500 per account per region),
|
2396
|
+
# unless you request a limit increase.
|
2397
|
+
#
|
2398
|
+
# * Scale a stream with more than 500 shards down unless you set this
|
2399
|
+
# value to less than 500 shards.
|
2284
2400
|
# @return [Integer]
|
2285
2401
|
#
|
2286
2402
|
# @!attribute [rw] scaling_type
|
@@ -2319,6 +2435,10 @@ module Aws::Kinesis
|
|
2319
2435
|
include Aws::Structure
|
2320
2436
|
end
|
2321
2437
|
|
2438
|
+
# This is a tagged union for all of the types of events an enhanced
|
2439
|
+
# fan-out consumer can receive over HTTP/2 after a call to
|
2440
|
+
# SubscribeToShard.
|
2441
|
+
#
|
2322
2442
|
# EventStream is an Enumerator of Events.
|
2323
2443
|
# #event_types #=> Array, returns all modeled event types in the stream
|
2324
2444
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kinesis
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.31.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-02-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.112.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.112.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|