aws-sdk-kinesis 1.37.0 → 1.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesis/async_client.rb +9 -4
- data/lib/aws-sdk-kinesis/client.rb +191 -88
- data/lib/aws-sdk-kinesis/client_api.rb +37 -1
- data/lib/aws-sdk-kinesis/errors.rb +16 -0
- data/lib/aws-sdk-kinesis/types.rb +256 -56
- data/lib/aws-sdk-kinesis.rb +1 -1
- 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: eac4d4cecdba7a2a01bf4c7eaa8fdb618c1241b2095425c14fdee808a03f06d8
|
4
|
+
data.tar.gz: 6140ade32140e09d1e732a489dcb41642cbb4dda3b4831260d7c3ca173c304ae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9c54f5ba41fd45fccf416c1654397e3fc48a84c33973b5f36f2047968c4478518701f76fedbaea75ace5fb4c44f71897587d48585ff932b08070c7674943e93c
|
7
|
+
data.tar.gz: 6feebd9c5ebc17f96ddb23398534b9128359c25bd7290c7940252e0acea54418badb2e469121eecfcf06f6c6a529377bc00e10924539888db517c8a8c3e804c2
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.38.0
|
@@ -98,7 +98,9 @@ module Aws::Kinesis
|
|
98
98
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
99
99
|
# are very aggressive. Construct and pass an instance of
|
100
100
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
101
|
-
# enable retries and extended timeouts.
|
101
|
+
# enable retries and extended timeouts. Instance profile credential
|
102
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
103
|
+
# to true.
|
102
104
|
#
|
103
105
|
# @option options [required, String] :region
|
104
106
|
# The AWS region to connect to. The configured `:region` is
|
@@ -276,8 +278,9 @@ module Aws::Kinesis
|
|
276
278
|
# If you call `SubscribeToShard` again with the same `ConsumerARN` and
|
277
279
|
# `ShardId` within 5 seconds of a successful call, you'll get a
|
278
280
|
# `ResourceInUseException`. If you call `SubscribeToShard` 5 seconds or
|
279
|
-
# more after a successful call, the
|
280
|
-
#
|
281
|
+
# more after a successful call, the second call takes over the
|
282
|
+
# subscription and the previous connection expires or fails with a
|
283
|
+
# `ResourceInUseException`.
|
281
284
|
#
|
282
285
|
# For an example of how to use this operations, see [Enhanced Fan-Out
|
283
286
|
# Using the Kinesis Data Streams
|
@@ -292,6 +295,8 @@ module Aws::Kinesis
|
|
292
295
|
# shards for a given stream, use ListShards.
|
293
296
|
#
|
294
297
|
# @option params [required, Types::StartingPosition] :starting_position
|
298
|
+
# The starting position in the data stream from which to start
|
299
|
+
# streaming.
|
295
300
|
#
|
296
301
|
# @return [Types::SubscribeToShardOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
297
302
|
#
|
@@ -563,7 +568,7 @@ module Aws::Kinesis
|
|
563
568
|
http_response: Seahorse::Client::Http::AsyncResponse.new,
|
564
569
|
config: config)
|
565
570
|
context[:gem_name] = 'aws-sdk-kinesis'
|
566
|
-
context[:gem_version] = '1.
|
571
|
+
context[:gem_version] = '1.38.0'
|
567
572
|
Seahorse::Client::Request.new(handlers, context)
|
568
573
|
end
|
569
574
|
|
@@ -121,7 +121,9 @@ module Aws::Kinesis
|
|
121
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
122
122
|
# are very aggressive. Construct and pass an instance of
|
123
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
124
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
125
127
|
#
|
126
128
|
# @option options [required, String] :region
|
127
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -357,10 +359,8 @@ module Aws::Kinesis
|
|
357
359
|
|
358
360
|
# @!group API Operations
|
359
361
|
|
360
|
-
# Adds or updates tags for the specified Kinesis data stream.
|
361
|
-
#
|
362
|
-
# to add more than 10 tags to your stream, you can invoke this operation
|
363
|
-
# multiple times. In total, each stream can have up to 50 tags.
|
362
|
+
# Adds or updates tags for the specified Kinesis data stream. You can
|
363
|
+
# assign up to 50 tags to a data stream.
|
364
364
|
#
|
365
365
|
# If tags have already been assigned to the stream, `AddTagsToStream`
|
366
366
|
# overwrites any existing tags that correspond to the specified tag
|
@@ -408,11 +408,11 @@ module Aws::Kinesis
|
|
408
408
|
# write total of 1 MiB per second. If the amount of data input increases
|
409
409
|
# or decreases, you can add or remove shards.
|
410
410
|
#
|
411
|
-
# The stream name identifies the stream. The name is scoped to the
|
412
|
-
# account used by the application. It is also scoped
|
413
|
-
# is, two streams in two different
|
414
|
-
#
|
415
|
-
# have the same name.
|
411
|
+
# The stream name identifies the stream. The name is scoped to the
|
412
|
+
# Amazon Web Services account used by the application. It is also scoped
|
413
|
+
# by Amazon Web Services Region. That is, two streams in two different
|
414
|
+
# accounts can have the same name, and two streams in the same account,
|
415
|
+
# but in two different Regions, can have the same name.
|
416
416
|
#
|
417
417
|
# `CreateStream` is an asynchronous operation. Upon receiving a
|
418
418
|
# `CreateStream` request, Kinesis Data Streams immediately returns and
|
@@ -428,11 +428,12 @@ module Aws::Kinesis
|
|
428
428
|
#
|
429
429
|
# * Create more shards than are authorized for your account.
|
430
430
|
#
|
431
|
-
# For the default shard limit for an
|
432
|
-
# Data Streams Limits][1] in the *Amazon Kinesis Data
|
433
|
-
# Guide*. To increase this limit, [contact
|
431
|
+
# For the default shard limit for an Amazon Web Services account, see
|
432
|
+
# [Amazon Kinesis Data Streams Limits][1] in the *Amazon Kinesis Data
|
433
|
+
# Streams Developer Guide*. To increase this limit, [contact Amazon Web
|
434
|
+
# Services Support][2].
|
434
435
|
#
|
435
|
-
# You can use
|
436
|
+
# You can use DescribeStreamSummary to check the stream status, which is
|
436
437
|
# returned in `StreamStatus`.
|
437
438
|
#
|
438
439
|
# CreateStream has a limit of five transactions per second per account.
|
@@ -443,24 +444,33 @@ module Aws::Kinesis
|
|
443
444
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
444
445
|
#
|
445
446
|
# @option params [required, String] :stream_name
|
446
|
-
# A name to identify the stream. The stream name is scoped to the
|
447
|
-
# account used by the application that creates the stream.
|
448
|
-
# scoped by
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
447
|
+
# A name to identify the stream. The stream name is scoped to the Amazon
|
448
|
+
# Web Services account used by the application that creates the stream.
|
449
|
+
# It is also scoped by Amazon Web Services Region. That is, two streams
|
450
|
+
# in two different Amazon Web Services accounts can have the same name.
|
451
|
+
# Two streams in the same Amazon Web Services account but in two
|
452
|
+
# different Regions can also have the same name.
|
453
|
+
#
|
454
|
+
# @option params [Integer] :shard_count
|
453
455
|
# The number of shards that the stream will use. The throughput of the
|
454
456
|
# stream is a function of the number of shards; more shards are required
|
455
457
|
# for greater provisioned throughput.
|
456
458
|
#
|
459
|
+
# @option params [Types::StreamModeDetails] :stream_mode_details
|
460
|
+
# Indicates the capacity mode of the data stream. Currently, in Kinesis
|
461
|
+
# Data Streams, you can choose between an **on-demand** capacity mode
|
462
|
+
# and a **provisioned** capacity mode for your data streams.
|
463
|
+
#
|
457
464
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
458
465
|
#
|
459
466
|
# @example Request syntax with placeholder values
|
460
467
|
#
|
461
468
|
# resp = client.create_stream({
|
462
469
|
# stream_name: "StreamName", # required
|
463
|
-
# shard_count: 1,
|
470
|
+
# shard_count: 1,
|
471
|
+
# stream_mode_details: {
|
472
|
+
# stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
|
473
|
+
# },
|
464
474
|
# })
|
465
475
|
#
|
466
476
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/CreateStream AWS API Documentation
|
@@ -521,8 +531,8 @@ module Aws::Kinesis
|
|
521
531
|
# When you delete a stream, any shards in that stream are also deleted,
|
522
532
|
# and any tags are dissociated from the stream.
|
523
533
|
#
|
524
|
-
# You can use the
|
525
|
-
# stream, which is returned in `StreamStatus`.
|
534
|
+
# You can use the DescribeStreamSummary operation to check the state of
|
535
|
+
# the stream, which is returned in `StreamStatus`.
|
526
536
|
#
|
527
537
|
# DeleteStream has a limit of five transactions per second per account.
|
528
538
|
#
|
@@ -565,8 +575,8 @@ module Aws::Kinesis
|
|
565
575
|
#
|
566
576
|
# @option params [String] :stream_arn
|
567
577
|
# The ARN of the Kinesis data stream that the consumer is registered
|
568
|
-
# with. For more information, see [Amazon Resource Names (ARNs) and
|
569
|
-
# Service Namespaces][1].
|
578
|
+
# with. For more information, see [Amazon Resource Names (ARNs) and
|
579
|
+
# Amazon Web Services Service Namespaces][1].
|
570
580
|
#
|
571
581
|
#
|
572
582
|
#
|
@@ -613,11 +623,15 @@ module Aws::Kinesis
|
|
613
623
|
#
|
614
624
|
# * {Types::DescribeLimitsOutput#shard_limit #shard_limit} => Integer
|
615
625
|
# * {Types::DescribeLimitsOutput#open_shard_count #open_shard_count} => Integer
|
626
|
+
# * {Types::DescribeLimitsOutput#on_demand_stream_count #on_demand_stream_count} => Integer
|
627
|
+
# * {Types::DescribeLimitsOutput#on_demand_stream_count_limit #on_demand_stream_count_limit} => Integer
|
616
628
|
#
|
617
629
|
# @example Response structure
|
618
630
|
#
|
619
631
|
# resp.shard_limit #=> Integer
|
620
632
|
# resp.open_shard_count #=> Integer
|
633
|
+
# resp.on_demand_stream_count #=> Integer
|
634
|
+
# resp.on_demand_stream_count_limit #=> Integer
|
621
635
|
#
|
622
636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeLimits AWS API Documentation
|
623
637
|
#
|
@@ -630,6 +644,14 @@ module Aws::Kinesis
|
|
630
644
|
|
631
645
|
# Describes the specified Kinesis data stream.
|
632
646
|
#
|
647
|
+
# <note markdown="1"> This API has been revised. It's highly recommended that you use the
|
648
|
+
# DescribeStreamSummary API to get a summarized description of the
|
649
|
+
# specified Kinesis data stream and the ListShards API to list the
|
650
|
+
# shards in a specified data stream and obtain information about each
|
651
|
+
# shard.
|
652
|
+
#
|
653
|
+
# </note>
|
654
|
+
#
|
633
655
|
# The information returned includes the stream name, Amazon Resource
|
634
656
|
# Name (ARN), creation time, enhanced metric configuration, and shard
|
635
657
|
# map. The shard map is an array of shard objects. For each shard
|
@@ -659,11 +681,19 @@ module Aws::Kinesis
|
|
659
681
|
# @option params [Integer] :limit
|
660
682
|
# The maximum number of shards to return in a single call. The default
|
661
683
|
# value is 100. If you specify a value greater than 100, at most 100
|
662
|
-
#
|
684
|
+
# results are returned.
|
663
685
|
#
|
664
686
|
# @option params [String] :exclusive_start_shard_id
|
665
687
|
# The shard ID of the shard to start with.
|
666
688
|
#
|
689
|
+
# Specify this parameter to indicate that you want to describe the
|
690
|
+
# stream starting with the shard whose ID immediately follows
|
691
|
+
# `ExclusiveStartShardId`.
|
692
|
+
#
|
693
|
+
# If you don't specify this parameter, the default behavior for
|
694
|
+
# `DescribeStream` is to describe the stream starting with the first
|
695
|
+
# shard in the stream.
|
696
|
+
#
|
667
697
|
# @return [Types::DescribeStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
668
698
|
#
|
669
699
|
# * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
|
@@ -683,6 +713,7 @@ module Aws::Kinesis
|
|
683
713
|
# resp.stream_description.stream_name #=> String
|
684
714
|
# resp.stream_description.stream_arn #=> String
|
685
715
|
# resp.stream_description.stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
|
716
|
+
# resp.stream_description.stream_mode_details.stream_mode #=> String, one of "PROVISIONED", "ON_DEMAND"
|
686
717
|
# resp.stream_description.shards #=> Array
|
687
718
|
# resp.stream_description.shards[0].shard_id #=> String
|
688
719
|
# resp.stream_description.shards[0].parent_shard_id #=> String
|
@@ -728,8 +759,8 @@ module Aws::Kinesis
|
|
728
759
|
#
|
729
760
|
# @option params [String] :stream_arn
|
730
761
|
# The ARN of the Kinesis data stream that the consumer is registered
|
731
|
-
# with. For more information, see [Amazon Resource Names (ARNs) and
|
732
|
-
# Service Namespaces][1].
|
762
|
+
# with. For more information, see [Amazon Resource Names (ARNs) and
|
763
|
+
# Amazon Web Services Service Namespaces][1].
|
733
764
|
#
|
734
765
|
#
|
735
766
|
#
|
@@ -799,6 +830,7 @@ module Aws::Kinesis
|
|
799
830
|
# resp.stream_description_summary.stream_name #=> String
|
800
831
|
# resp.stream_description_summary.stream_arn #=> String
|
801
832
|
# resp.stream_description_summary.stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
|
833
|
+
# resp.stream_description_summary.stream_mode_details.stream_mode #=> String, one of "PROVISIONED", "ON_DEMAND"
|
802
834
|
# resp.stream_description_summary.retention_period_hours #=> Integer
|
803
835
|
# resp.stream_description_summary.stream_creation_timestamp #=> Time
|
804
836
|
# resp.stream_description_summary.enhanced_monitoring #=> Array
|
@@ -982,9 +1014,12 @@ module Aws::Kinesis
|
|
982
1014
|
# The maximum number of records that can be returned per call is 10,000.
|
983
1015
|
#
|
984
1016
|
# The size of the data returned by GetRecords varies depending on the
|
985
|
-
# utilization of the shard.
|
986
|
-
#
|
987
|
-
#
|
1017
|
+
# utilization of the shard. It is recommended that consumer applications
|
1018
|
+
# retrieve records via the `GetRecords` command using the 5 TPS limit to
|
1019
|
+
# remain caught up. Retrieving records less frequently can lead to
|
1020
|
+
# consumer applications falling behind. The maximum size of data that
|
1021
|
+
# GetRecords can return is 10 MiB. If a call returns this amount of
|
1022
|
+
# data, subsequent calls made within the next 5 seconds throw
|
988
1023
|
# `ProvisionedThroughputExceededException`. If there is insufficient
|
989
1024
|
# provisioned throughput on the stream, subsequent calls made within the
|
990
1025
|
# next 1 second throw `ProvisionedThroughputExceededException`.
|
@@ -1187,8 +1222,8 @@ module Aws::Kinesis
|
|
1187
1222
|
|
1188
1223
|
# Increases the Kinesis data stream's retention period, which is the
|
1189
1224
|
# length of time data records are accessible after they are added to the
|
1190
|
-
# stream. The maximum value of a stream's retention period is
|
1191
|
-
# (
|
1225
|
+
# stream. The maximum value of a stream's retention period is 8760
|
1226
|
+
# hours (365 days).
|
1192
1227
|
#
|
1193
1228
|
# If you choose a longer stream retention period, this operation
|
1194
1229
|
# increases the time period during which records that have not yet
|
@@ -1225,18 +1260,23 @@ module Aws::Kinesis
|
|
1225
1260
|
end
|
1226
1261
|
|
1227
1262
|
# Lists the shards in a stream and provides information about each
|
1228
|
-
# shard. This operation has a limit of
|
1263
|
+
# shard. This operation has a limit of 1000 transactions per second per
|
1229
1264
|
# data stream.
|
1230
1265
|
#
|
1266
|
+
# This action does not list expired shards. For information about
|
1267
|
+
# expired shards, see [Data Routing, Data Persistence, and Shard State
|
1268
|
+
# after a Reshard][1].
|
1269
|
+
#
|
1231
1270
|
# This API is a new operation that is used by the Amazon Kinesis Client
|
1232
1271
|
# Library (KCL). If you have a fine-grained IAM policy that only allows
|
1233
1272
|
# specific operations, you must update your policy to allow calls to
|
1234
1273
|
# this API. For more information, see [Controlling Access to Amazon
|
1235
|
-
# Kinesis Data Streams Resources Using IAM][
|
1274
|
+
# Kinesis Data Streams Resources Using IAM][2].
|
1236
1275
|
#
|
1237
1276
|
#
|
1238
1277
|
#
|
1239
|
-
# [1]: https://docs.aws.amazon.com/streams/latest/dev/
|
1278
|
+
# [1]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing
|
1279
|
+
# [2]: https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html
|
1240
1280
|
#
|
1241
1281
|
# @option params [String] :stream_name
|
1242
1282
|
# The name of the data stream whose shards you want to list.
|
@@ -1281,8 +1321,9 @@ module Aws::Kinesis
|
|
1281
1321
|
#
|
1282
1322
|
# @option params [Integer] :max_results
|
1283
1323
|
# The maximum number of shards to return in a single call to
|
1284
|
-
# `ListShards`. The
|
1285
|
-
#
|
1324
|
+
# `ListShards`. The maximum number of shards to return in a single call.
|
1325
|
+
# The default value is 1000. If you specify a value greater than 1000,
|
1326
|
+
# at most 1000 results are returned.
|
1286
1327
|
#
|
1287
1328
|
# When the number of shards to be listed is greater than the value of
|
1288
1329
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1300,6 +1341,28 @@ module Aws::Kinesis
|
|
1300
1341
|
# parameter.
|
1301
1342
|
#
|
1302
1343
|
# @option params [Types::ShardFilter] :shard_filter
|
1344
|
+
# Enables you to filter out the response of the `ListShards` API. You
|
1345
|
+
# can only specify one filter at a time.
|
1346
|
+
#
|
1347
|
+
# If you use the `ShardFilter` parameter when invoking the ListShards
|
1348
|
+
# API, the `Type` is the required property and must be specified. If you
|
1349
|
+
# specify the `AT_TRIM_HORIZON`, `FROM_TRIM_HORIZON`, or `AT_LATEST`
|
1350
|
+
# types, you do not need to specify either the `ShardId` or the
|
1351
|
+
# `Timestamp` optional properties.
|
1352
|
+
#
|
1353
|
+
# If you specify the `AFTER_SHARD_ID` type, you must also provide the
|
1354
|
+
# value for the optional `ShardId` property. The `ShardId` property is
|
1355
|
+
# identical in fuctionality to the `ExclusiveStartShardId` parameter of
|
1356
|
+
# the `ListShards` API. When `ShardId` property is specified, the
|
1357
|
+
# response includes the shards starting with the shard whose ID
|
1358
|
+
# immediately follows the `ShardId` that you provided.
|
1359
|
+
#
|
1360
|
+
# If you specify the `AT_TIMESTAMP` or `FROM_TIMESTAMP_ID` type, you
|
1361
|
+
# must also provide the value for the optional `Timestamp` property. If
|
1362
|
+
# you specify the AT\_TIMESTAMP type, then all shards that were open at
|
1363
|
+
# the provided timestamp are returned. If you specify the
|
1364
|
+
# FROM\_TIMESTAMP type, then all shards starting from the provided
|
1365
|
+
# timestamp to TIP are returned.
|
1303
1366
|
#
|
1304
1367
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1305
1368
|
#
|
@@ -1350,7 +1413,7 @@ module Aws::Kinesis
|
|
1350
1413
|
# @option params [required, String] :stream_arn
|
1351
1414
|
# The ARN of the Kinesis data stream for which you want to list the
|
1352
1415
|
# registered consumers. For more information, see [Amazon Resource Names
|
1353
|
-
# (ARNs) and
|
1416
|
+
# (ARNs) and Amazon Web Services Service Namespaces][1].
|
1354
1417
|
#
|
1355
1418
|
#
|
1356
1419
|
#
|
@@ -1384,7 +1447,8 @@ module Aws::Kinesis
|
|
1384
1447
|
#
|
1385
1448
|
# @option params [Integer] :max_results
|
1386
1449
|
# The maximum number of consumers that you want a single call of
|
1387
|
-
# `ListStreamConsumers` to return.
|
1450
|
+
# `ListStreamConsumers` to return. The default value is 100. If you
|
1451
|
+
# specify a value greater than 100, at most 100 results are returned.
|
1388
1452
|
#
|
1389
1453
|
# @option params [Time,DateTime,Date,Integer,String] :stream_creation_timestamp
|
1390
1454
|
# Specify this input parameter to distinguish data streams that have the
|
@@ -1436,7 +1500,7 @@ module Aws::Kinesis
|
|
1436
1500
|
# `ListStreams`. You can limit the number of returned streams using the
|
1437
1501
|
# `Limit` parameter. If you do not specify a value for the `Limit`
|
1438
1502
|
# parameter, Kinesis Data Streams uses the default limit, which is
|
1439
|
-
# currently
|
1503
|
+
# currently 100.
|
1440
1504
|
#
|
1441
1505
|
# You can detect if there are more streams available to list by using
|
1442
1506
|
# the `HasMoreStreams` flag from the returned output. If there are more
|
@@ -1450,7 +1514,9 @@ module Aws::Kinesis
|
|
1450
1514
|
# ListStreams has a limit of five transactions per second per account.
|
1451
1515
|
#
|
1452
1516
|
# @option params [Integer] :limit
|
1453
|
-
# The maximum number of streams to list.
|
1517
|
+
# The maximum number of streams to list. The default value is 100. If
|
1518
|
+
# you specify a value greater than 100, at most 100 results are
|
1519
|
+
# returned.
|
1454
1520
|
#
|
1455
1521
|
# @option params [String] :exclusive_start_stream_name
|
1456
1522
|
# The name of the stream to start the list with.
|
@@ -1553,8 +1619,8 @@ module Aws::Kinesis
|
|
1553
1619
|
# stream does not exist, `MergeShards` returns a
|
1554
1620
|
# `ResourceNotFoundException`.
|
1555
1621
|
#
|
1556
|
-
# You can use
|
1557
|
-
# returned in `StreamStatus`.
|
1622
|
+
# You can use DescribeStreamSummary to check the state of the stream,
|
1623
|
+
# which is returned in `StreamStatus`.
|
1558
1624
|
#
|
1559
1625
|
# `MergeShards` is an asynchronous operation. Upon receiving a
|
1560
1626
|
# `MergeShards` request, Amazon Kinesis Data Streams immediately returns
|
@@ -1563,8 +1629,8 @@ module Aws::Kinesis
|
|
1563
1629
|
# to `ACTIVE`. Read and write operations continue to work while the
|
1564
1630
|
# stream is in the `UPDATING` state.
|
1565
1631
|
#
|
1566
|
-
# You use
|
1567
|
-
# in the `MergeShards` request.
|
1632
|
+
# You use DescribeStreamSummary and the ListShards APIs to determine the
|
1633
|
+
# shard IDs that are specified in the `MergeShards` request.
|
1568
1634
|
#
|
1569
1635
|
# If you try to operate on too many streams in parallel using
|
1570
1636
|
# CreateStream, DeleteStream, `MergeShards`, or SplitShard, you receive
|
@@ -1870,7 +1936,7 @@ module Aws::Kinesis
|
|
1870
1936
|
# @option params [required, String] :stream_arn
|
1871
1937
|
# The ARN of the Kinesis data stream that you want to register the
|
1872
1938
|
# consumer with. For more info, see [Amazon Resource Names (ARNs) and
|
1873
|
-
#
|
1939
|
+
# Amazon Web Services Service Namespaces][1].
|
1874
1940
|
#
|
1875
1941
|
#
|
1876
1942
|
#
|
@@ -1961,9 +2027,10 @@ module Aws::Kinesis
|
|
1961
2027
|
# mapped into the shard. For more information, see [Split a Shard][1] in
|
1962
2028
|
# the *Amazon Kinesis Data Streams Developer Guide*.
|
1963
2029
|
#
|
1964
|
-
# You can use
|
1965
|
-
# values for the `ShardToSplit` and
|
1966
|
-
# are specified in the `SplitShard`
|
2030
|
+
# You can use DescribeStreamSummary and the ListShards APIs to determine
|
2031
|
+
# the shard ID and hash key values for the `ShardToSplit` and
|
2032
|
+
# `NewStartingHashKey` parameters that are specified in the `SplitShard`
|
2033
|
+
# request.
|
1967
2034
|
#
|
1968
2035
|
# `SplitShard` is an asynchronous operation. Upon receiving a
|
1969
2036
|
# `SplitShard` request, Kinesis Data Streams immediately returns a
|
@@ -1972,19 +2039,19 @@ module Aws::Kinesis
|
|
1972
2039
|
# Read and write operations continue to work while the stream is in the
|
1973
2040
|
# `UPDATING` state.
|
1974
2041
|
#
|
1975
|
-
# You can use
|
1976
|
-
# is returned in `StreamStatus`. If the stream is in the `ACTIVE`
|
1977
|
-
# you can call `SplitShard`.
|
1978
|
-
# or `DELETING` states, `DescribeStream` returns a
|
1979
|
-
# `ResourceInUseException`.
|
2042
|
+
# You can use DescribeStreamSummary to check the status of the stream,
|
2043
|
+
# which is returned in `StreamStatus`. If the stream is in the `ACTIVE`
|
2044
|
+
# state, you can call `SplitShard`.
|
1980
2045
|
#
|
1981
|
-
# If the specified stream does not exist,
|
1982
|
-
# `ResourceNotFoundException`. If you try to create more shards than
|
1983
|
-
# authorized for your account, you receive a
|
2046
|
+
# If the specified stream does not exist, DescribeStreamSummary returns
|
2047
|
+
# a `ResourceNotFoundException`. If you try to create more shards than
|
2048
|
+
# are authorized for your account, you receive a
|
2049
|
+
# `LimitExceededException`.
|
1984
2050
|
#
|
1985
|
-
# For the default shard limit for an
|
1986
|
-
# Streams Limits][2] in the *Amazon Kinesis Data Streams
|
1987
|
-
# Guide*. To increase this limit, [contact
|
2051
|
+
# For the default shard limit for an Amazon Web Services account, see
|
2052
|
+
# [Kinesis Data Streams Limits][2] in the *Amazon Kinesis Data Streams
|
2053
|
+
# Developer Guide*. To increase this limit, [contact Amazon Web Services
|
2054
|
+
# Support][3].
|
1988
2055
|
#
|
1989
2056
|
# If you try to operate on too many streams simultaneously using
|
1990
2057
|
# CreateStream, DeleteStream, MergeShards, and/or SplitShard, you
|
@@ -2033,8 +2100,8 @@ module Aws::Kinesis
|
|
2033
2100
|
req.send_request(options)
|
2034
2101
|
end
|
2035
2102
|
|
2036
|
-
# Enables or updates server-side encryption using an
|
2037
|
-
# specified stream.
|
2103
|
+
# Enables or updates server-side encryption using an Amazon Web Services
|
2104
|
+
# KMS key for a specified stream.
|
2038
2105
|
#
|
2039
2106
|
# Starting encryption is an asynchronous operation. Upon receiving the
|
2040
2107
|
# request, Kinesis Data Streams returns immediately and sets the status
|
@@ -2045,8 +2112,8 @@ module Aws::Kinesis
|
|
2045
2112
|
# stream while its status is `UPDATING`. Once the status of the stream
|
2046
2113
|
# is `ACTIVE`, encryption begins for records written to the stream.
|
2047
2114
|
#
|
2048
|
-
# API Limits: You can successfully apply a new
|
2049
|
-
# server-side encryption 25 times in a rolling 24-hour period.
|
2115
|
+
# API Limits: You can successfully apply a new Amazon Web Services KMS
|
2116
|
+
# key for server-side encryption 25 times in a rolling 24-hour period.
|
2050
2117
|
#
|
2051
2118
|
# Note: It can take up to 5 seconds after the stream is in an `ACTIVE`
|
2052
2119
|
# status before all records written to the stream are encrypted. After
|
@@ -2060,11 +2127,12 @@ module Aws::Kinesis
|
|
2060
2127
|
# The encryption type to use. The only valid value is `KMS`.
|
2061
2128
|
#
|
2062
2129
|
# @option params [required, String] :key_id
|
2063
|
-
# The GUID for the customer-managed
|
2064
|
-
# This value can be a globally unique identifier, a
|
2065
|
-
# Amazon Resource Name (ARN) to either an alias or a
|
2066
|
-
# name prefixed by "alias/".You can also use a master
|
2067
|
-
# Kinesis Data Streams by specifying the alias
|
2130
|
+
# The GUID for the customer-managed Amazon Web Services KMS key to use
|
2131
|
+
# for encryption. This value can be a globally unique identifier, a
|
2132
|
+
# fully specified Amazon Resource Name (ARN) to either an alias or a
|
2133
|
+
# key, or an alias name prefixed by "alias/".You can also use a master
|
2134
|
+
# key owned by Kinesis Data Streams by specifying the alias
|
2135
|
+
# `aws/kinesis`.
|
2068
2136
|
#
|
2069
2137
|
# * Key ARN example:
|
2070
2138
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2126,11 +2194,12 @@ module Aws::Kinesis
|
|
2126
2194
|
# The encryption type. The only valid value is `KMS`.
|
2127
2195
|
#
|
2128
2196
|
# @option params [required, String] :key_id
|
2129
|
-
# The GUID for the customer-managed
|
2130
|
-
# This value can be a globally unique identifier, a
|
2131
|
-
# Amazon Resource Name (ARN) to either an alias or a
|
2132
|
-
# name prefixed by "alias/".You can also use a master
|
2133
|
-
# Kinesis Data Streams by specifying the alias
|
2197
|
+
# The GUID for the customer-managed Amazon Web Services KMS key to use
|
2198
|
+
# for encryption. This value can be a globally unique identifier, a
|
2199
|
+
# fully specified Amazon Resource Name (ARN) to either an alias or a
|
2200
|
+
# key, or an alias name prefixed by "alias/".You can also use a master
|
2201
|
+
# key owned by Kinesis Data Streams by specifying the alias
|
2202
|
+
# `aws/kinesis`.
|
2134
2203
|
#
|
2135
2204
|
# * Key ARN example:
|
2136
2205
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2195,17 +2264,17 @@ module Aws::Kinesis
|
|
2195
2264
|
#
|
2196
2265
|
# * Scale down below half your current shard count for a stream
|
2197
2266
|
#
|
2198
|
-
# * Scale up to more than
|
2267
|
+
# * Scale up to more than 10000 shards in a stream
|
2199
2268
|
#
|
2200
|
-
# * Scale a stream with more than
|
2201
|
-
# less than
|
2269
|
+
# * Scale a stream with more than 10000 shards down unless the result is
|
2270
|
+
# less than 10000 shards
|
2202
2271
|
#
|
2203
2272
|
# * Scale up to more than the shard limit for your account
|
2204
2273
|
#
|
2205
|
-
# For the default limits for an
|
2206
|
-
# the *Amazon Kinesis Data Streams Developer
|
2207
|
-
# increase in the call rate limit, the shard limit
|
2208
|
-
# overall shard limit, use the [limits form][2].
|
2274
|
+
# For the default limits for an Amazon Web Services account, see
|
2275
|
+
# [Streams Limits][1] in the *Amazon Kinesis Data Streams Developer
|
2276
|
+
# Guide*. To request an increase in the call rate limit, the shard limit
|
2277
|
+
# for this API, or your overall shard limit, use the [limits form][2].
|
2209
2278
|
#
|
2210
2279
|
#
|
2211
2280
|
#
|
@@ -2224,12 +2293,12 @@ module Aws::Kinesis
|
|
2224
2293
|
#
|
2225
2294
|
# * Set this value below half your current shard count for a stream.
|
2226
2295
|
#
|
2227
|
-
# * Set this value to more than
|
2228
|
-
# limit for shard count per stream is
|
2296
|
+
# * Set this value to more than 10000 shards in a stream (the default
|
2297
|
+
# limit for shard count per stream is 10000 per account per region),
|
2229
2298
|
# unless you request a limit increase.
|
2230
2299
|
#
|
2231
|
-
# * Scale a stream with more than
|
2232
|
-
# value to less than
|
2300
|
+
# * Scale a stream with more than 10000 shards down unless you set this
|
2301
|
+
# value to less than 10000 shards.
|
2233
2302
|
#
|
2234
2303
|
# @option params [required, String] :scaling_type
|
2235
2304
|
# The scaling type. Uniform scaling creates shards of equal size.
|
@@ -2263,6 +2332,40 @@ module Aws::Kinesis
|
|
2263
2332
|
req.send_request(options)
|
2264
2333
|
end
|
2265
2334
|
|
2335
|
+
# Updates the capacity mode of the data stream. Currently, in Kinesis
|
2336
|
+
# Data Streams, you can choose between an **on-demand** capacity mode
|
2337
|
+
# and a **provisioned** capacity mode for your data stream.
|
2338
|
+
#
|
2339
|
+
# @option params [required, String] :stream_arn
|
2340
|
+
# Specifies the ARN of the data stream whose capacity mode you want to
|
2341
|
+
# update.
|
2342
|
+
#
|
2343
|
+
# @option params [required, Types::StreamModeDetails] :stream_mode_details
|
2344
|
+
# Specifies the capacity mode to which you want to set your data stream.
|
2345
|
+
# Currently, in Kinesis Data Streams, you can choose between an
|
2346
|
+
# **on-demand** capacity mode and a **provisioned** capacity mode for
|
2347
|
+
# your data streams.
|
2348
|
+
#
|
2349
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2350
|
+
#
|
2351
|
+
# @example Request syntax with placeholder values
|
2352
|
+
#
|
2353
|
+
# resp = client.update_stream_mode({
|
2354
|
+
# stream_arn: "StreamARN", # required
|
2355
|
+
# stream_mode_details: { # required
|
2356
|
+
# stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
|
2357
|
+
# },
|
2358
|
+
# })
|
2359
|
+
#
|
2360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateStreamMode AWS API Documentation
|
2361
|
+
#
|
2362
|
+
# @overload update_stream_mode(params = {})
|
2363
|
+
# @param [Hash] params ({})
|
2364
|
+
def update_stream_mode(params = {}, options = {})
|
2365
|
+
req = build_request(:update_stream_mode, params)
|
2366
|
+
req.send_request(options)
|
2367
|
+
end
|
2368
|
+
|
2266
2369
|
# @!endgroup
|
2267
2370
|
|
2268
2371
|
# @param params ({})
|
@@ -2276,7 +2379,7 @@ module Aws::Kinesis
|
|
2276
2379
|
params: params,
|
2277
2380
|
config: config)
|
2278
2381
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2279
|
-
context[:gem_version] = '1.
|
2382
|
+
context[:gem_version] = '1.38.0'
|
2280
2383
|
Seahorse::Client::Request.new(handlers, context)
|
2281
2384
|
end
|
2282
2385
|
|