aws-sdk-kinesis 1.34.0 → 1.38.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesis/async_client.rb +21 -9
- data/lib/aws-sdk-kinesis/client.rb +200 -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 +5 -5
@@ -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
|
@@ -296,6 +298,15 @@ module Aws::Kinesis
|
|
296
298
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
297
299
|
# requests are made, and retries are disabled.
|
298
300
|
#
|
301
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
302
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
303
|
+
# will be used if available.
|
304
|
+
#
|
305
|
+
# @option options [Boolean] :use_fips_endpoint
|
306
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
307
|
+
# When a `fips` region is used, the region is normalized and this config
|
308
|
+
# is set to `true`.
|
309
|
+
#
|
299
310
|
# @option options [Boolean] :validate_params (true)
|
300
311
|
# When `true`, request parameters are validated before
|
301
312
|
# sending the request.
|
@@ -348,10 +359,8 @@ module Aws::Kinesis
|
|
348
359
|
|
349
360
|
# @!group API Operations
|
350
361
|
|
351
|
-
# Adds or updates tags for the specified Kinesis data stream.
|
352
|
-
#
|
353
|
-
# to add more than 10 tags to your stream, you can invoke this operation
|
354
|
-
# 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.
|
355
364
|
#
|
356
365
|
# If tags have already been assigned to the stream, `AddTagsToStream`
|
357
366
|
# overwrites any existing tags that correspond to the specified tag
|
@@ -399,11 +408,11 @@ module Aws::Kinesis
|
|
399
408
|
# write total of 1 MiB per second. If the amount of data input increases
|
400
409
|
# or decreases, you can add or remove shards.
|
401
410
|
#
|
402
|
-
# The stream name identifies the stream. The name is scoped to the
|
403
|
-
# account used by the application. It is also scoped
|
404
|
-
# is, two streams in two different
|
405
|
-
#
|
406
|
-
# 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.
|
407
416
|
#
|
408
417
|
# `CreateStream` is an asynchronous operation. Upon receiving a
|
409
418
|
# `CreateStream` request, Kinesis Data Streams immediately returns and
|
@@ -419,11 +428,12 @@ module Aws::Kinesis
|
|
419
428
|
#
|
420
429
|
# * Create more shards than are authorized for your account.
|
421
430
|
#
|
422
|
-
# For the default shard limit for an
|
423
|
-
# Data Streams Limits][1] in the *Amazon Kinesis Data
|
424
|
-
# 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].
|
425
435
|
#
|
426
|
-
# You can use
|
436
|
+
# You can use DescribeStreamSummary to check the stream status, which is
|
427
437
|
# returned in `StreamStatus`.
|
428
438
|
#
|
429
439
|
# CreateStream has a limit of five transactions per second per account.
|
@@ -434,24 +444,33 @@ module Aws::Kinesis
|
|
434
444
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
435
445
|
#
|
436
446
|
# @option params [required, String] :stream_name
|
437
|
-
# A name to identify the stream. The stream name is scoped to the
|
438
|
-
# account used by the application that creates the stream.
|
439
|
-
# scoped by
|
440
|
-
#
|
441
|
-
#
|
442
|
-
#
|
443
|
-
#
|
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
|
444
455
|
# The number of shards that the stream will use. The throughput of the
|
445
456
|
# stream is a function of the number of shards; more shards are required
|
446
457
|
# for greater provisioned throughput.
|
447
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
|
+
#
|
448
464
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
449
465
|
#
|
450
466
|
# @example Request syntax with placeholder values
|
451
467
|
#
|
452
468
|
# resp = client.create_stream({
|
453
469
|
# stream_name: "StreamName", # required
|
454
|
-
# shard_count: 1,
|
470
|
+
# shard_count: 1,
|
471
|
+
# stream_mode_details: {
|
472
|
+
# stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
|
473
|
+
# },
|
455
474
|
# })
|
456
475
|
#
|
457
476
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/CreateStream AWS API Documentation
|
@@ -512,8 +531,8 @@ module Aws::Kinesis
|
|
512
531
|
# When you delete a stream, any shards in that stream are also deleted,
|
513
532
|
# and any tags are dissociated from the stream.
|
514
533
|
#
|
515
|
-
# You can use the
|
516
|
-
# 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`.
|
517
536
|
#
|
518
537
|
# DeleteStream has a limit of five transactions per second per account.
|
519
538
|
#
|
@@ -556,8 +575,8 @@ module Aws::Kinesis
|
|
556
575
|
#
|
557
576
|
# @option params [String] :stream_arn
|
558
577
|
# The ARN of the Kinesis data stream that the consumer is registered
|
559
|
-
# with. For more information, see [Amazon Resource Names (ARNs) and
|
560
|
-
# Service Namespaces][1].
|
578
|
+
# with. For more information, see [Amazon Resource Names (ARNs) and
|
579
|
+
# Amazon Web Services Service Namespaces][1].
|
561
580
|
#
|
562
581
|
#
|
563
582
|
#
|
@@ -604,11 +623,15 @@ module Aws::Kinesis
|
|
604
623
|
#
|
605
624
|
# * {Types::DescribeLimitsOutput#shard_limit #shard_limit} => Integer
|
606
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
|
607
628
|
#
|
608
629
|
# @example Response structure
|
609
630
|
#
|
610
631
|
# resp.shard_limit #=> Integer
|
611
632
|
# resp.open_shard_count #=> Integer
|
633
|
+
# resp.on_demand_stream_count #=> Integer
|
634
|
+
# resp.on_demand_stream_count_limit #=> Integer
|
612
635
|
#
|
613
636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeLimits AWS API Documentation
|
614
637
|
#
|
@@ -621,6 +644,14 @@ module Aws::Kinesis
|
|
621
644
|
|
622
645
|
# Describes the specified Kinesis data stream.
|
623
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
|
+
#
|
624
655
|
# The information returned includes the stream name, Amazon Resource
|
625
656
|
# Name (ARN), creation time, enhanced metric configuration, and shard
|
626
657
|
# map. The shard map is an array of shard objects. For each shard
|
@@ -650,11 +681,19 @@ module Aws::Kinesis
|
|
650
681
|
# @option params [Integer] :limit
|
651
682
|
# The maximum number of shards to return in a single call. The default
|
652
683
|
# value is 100. If you specify a value greater than 100, at most 100
|
653
|
-
#
|
684
|
+
# results are returned.
|
654
685
|
#
|
655
686
|
# @option params [String] :exclusive_start_shard_id
|
656
687
|
# The shard ID of the shard to start with.
|
657
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
|
+
#
|
658
697
|
# @return [Types::DescribeStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
659
698
|
#
|
660
699
|
# * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
|
@@ -674,6 +713,7 @@ module Aws::Kinesis
|
|
674
713
|
# resp.stream_description.stream_name #=> String
|
675
714
|
# resp.stream_description.stream_arn #=> String
|
676
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"
|
677
717
|
# resp.stream_description.shards #=> Array
|
678
718
|
# resp.stream_description.shards[0].shard_id #=> String
|
679
719
|
# resp.stream_description.shards[0].parent_shard_id #=> String
|
@@ -719,8 +759,8 @@ module Aws::Kinesis
|
|
719
759
|
#
|
720
760
|
# @option params [String] :stream_arn
|
721
761
|
# The ARN of the Kinesis data stream that the consumer is registered
|
722
|
-
# with. For more information, see [Amazon Resource Names (ARNs) and
|
723
|
-
# Service Namespaces][1].
|
762
|
+
# with. For more information, see [Amazon Resource Names (ARNs) and
|
763
|
+
# Amazon Web Services Service Namespaces][1].
|
724
764
|
#
|
725
765
|
#
|
726
766
|
#
|
@@ -790,6 +830,7 @@ module Aws::Kinesis
|
|
790
830
|
# resp.stream_description_summary.stream_name #=> String
|
791
831
|
# resp.stream_description_summary.stream_arn #=> String
|
792
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"
|
793
834
|
# resp.stream_description_summary.retention_period_hours #=> Integer
|
794
835
|
# resp.stream_description_summary.stream_creation_timestamp #=> Time
|
795
836
|
# resp.stream_description_summary.enhanced_monitoring #=> Array
|
@@ -973,9 +1014,12 @@ module Aws::Kinesis
|
|
973
1014
|
# The maximum number of records that can be returned per call is 10,000.
|
974
1015
|
#
|
975
1016
|
# The size of the data returned by GetRecords varies depending on the
|
976
|
-
# utilization of the shard.
|
977
|
-
#
|
978
|
-
#
|
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
|
979
1023
|
# `ProvisionedThroughputExceededException`. If there is insufficient
|
980
1024
|
# provisioned throughput on the stream, subsequent calls made within the
|
981
1025
|
# next 1 second throw `ProvisionedThroughputExceededException`.
|
@@ -1178,8 +1222,8 @@ module Aws::Kinesis
|
|
1178
1222
|
|
1179
1223
|
# Increases the Kinesis data stream's retention period, which is the
|
1180
1224
|
# length of time data records are accessible after they are added to the
|
1181
|
-
# stream. The maximum value of a stream's retention period is
|
1182
|
-
# (
|
1225
|
+
# stream. The maximum value of a stream's retention period is 8760
|
1226
|
+
# hours (365 days).
|
1183
1227
|
#
|
1184
1228
|
# If you choose a longer stream retention period, this operation
|
1185
1229
|
# increases the time period during which records that have not yet
|
@@ -1216,18 +1260,23 @@ module Aws::Kinesis
|
|
1216
1260
|
end
|
1217
1261
|
|
1218
1262
|
# Lists the shards in a stream and provides information about each
|
1219
|
-
# shard. This operation has a limit of
|
1263
|
+
# shard. This operation has a limit of 1000 transactions per second per
|
1220
1264
|
# data stream.
|
1221
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
|
+
#
|
1222
1270
|
# This API is a new operation that is used by the Amazon Kinesis Client
|
1223
1271
|
# Library (KCL). If you have a fine-grained IAM policy that only allows
|
1224
1272
|
# specific operations, you must update your policy to allow calls to
|
1225
1273
|
# this API. For more information, see [Controlling Access to Amazon
|
1226
|
-
# Kinesis Data Streams Resources Using IAM][
|
1274
|
+
# Kinesis Data Streams Resources Using IAM][2].
|
1227
1275
|
#
|
1228
1276
|
#
|
1229
1277
|
#
|
1230
|
-
# [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
|
1231
1280
|
#
|
1232
1281
|
# @option params [String] :stream_name
|
1233
1282
|
# The name of the data stream whose shards you want to list.
|
@@ -1272,8 +1321,9 @@ module Aws::Kinesis
|
|
1272
1321
|
#
|
1273
1322
|
# @option params [Integer] :max_results
|
1274
1323
|
# The maximum number of shards to return in a single call to
|
1275
|
-
# `ListShards`. The
|
1276
|
-
#
|
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.
|
1277
1327
|
#
|
1278
1328
|
# When the number of shards to be listed is greater than the value of
|
1279
1329
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1291,6 +1341,28 @@ module Aws::Kinesis
|
|
1291
1341
|
# parameter.
|
1292
1342
|
#
|
1293
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.
|
1294
1366
|
#
|
1295
1367
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1296
1368
|
#
|
@@ -1341,7 +1413,7 @@ module Aws::Kinesis
|
|
1341
1413
|
# @option params [required, String] :stream_arn
|
1342
1414
|
# The ARN of the Kinesis data stream for which you want to list the
|
1343
1415
|
# registered consumers. For more information, see [Amazon Resource Names
|
1344
|
-
# (ARNs) and
|
1416
|
+
# (ARNs) and Amazon Web Services Service Namespaces][1].
|
1345
1417
|
#
|
1346
1418
|
#
|
1347
1419
|
#
|
@@ -1375,7 +1447,8 @@ module Aws::Kinesis
|
|
1375
1447
|
#
|
1376
1448
|
# @option params [Integer] :max_results
|
1377
1449
|
# The maximum number of consumers that you want a single call of
|
1378
|
-
# `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.
|
1379
1452
|
#
|
1380
1453
|
# @option params [Time,DateTime,Date,Integer,String] :stream_creation_timestamp
|
1381
1454
|
# Specify this input parameter to distinguish data streams that have the
|
@@ -1427,7 +1500,7 @@ module Aws::Kinesis
|
|
1427
1500
|
# `ListStreams`. You can limit the number of returned streams using the
|
1428
1501
|
# `Limit` parameter. If you do not specify a value for the `Limit`
|
1429
1502
|
# parameter, Kinesis Data Streams uses the default limit, which is
|
1430
|
-
# currently
|
1503
|
+
# currently 100.
|
1431
1504
|
#
|
1432
1505
|
# You can detect if there are more streams available to list by using
|
1433
1506
|
# the `HasMoreStreams` flag from the returned output. If there are more
|
@@ -1441,7 +1514,9 @@ module Aws::Kinesis
|
|
1441
1514
|
# ListStreams has a limit of five transactions per second per account.
|
1442
1515
|
#
|
1443
1516
|
# @option params [Integer] :limit
|
1444
|
-
# 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.
|
1445
1520
|
#
|
1446
1521
|
# @option params [String] :exclusive_start_stream_name
|
1447
1522
|
# The name of the stream to start the list with.
|
@@ -1544,8 +1619,8 @@ module Aws::Kinesis
|
|
1544
1619
|
# stream does not exist, `MergeShards` returns a
|
1545
1620
|
# `ResourceNotFoundException`.
|
1546
1621
|
#
|
1547
|
-
# You can use
|
1548
|
-
# returned in `StreamStatus`.
|
1622
|
+
# You can use DescribeStreamSummary to check the state of the stream,
|
1623
|
+
# which is returned in `StreamStatus`.
|
1549
1624
|
#
|
1550
1625
|
# `MergeShards` is an asynchronous operation. Upon receiving a
|
1551
1626
|
# `MergeShards` request, Amazon Kinesis Data Streams immediately returns
|
@@ -1554,8 +1629,8 @@ module Aws::Kinesis
|
|
1554
1629
|
# to `ACTIVE`. Read and write operations continue to work while the
|
1555
1630
|
# stream is in the `UPDATING` state.
|
1556
1631
|
#
|
1557
|
-
# You use
|
1558
|
-
# 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.
|
1559
1634
|
#
|
1560
1635
|
# If you try to operate on too many streams in parallel using
|
1561
1636
|
# CreateStream, DeleteStream, `MergeShards`, or SplitShard, you receive
|
@@ -1861,7 +1936,7 @@ module Aws::Kinesis
|
|
1861
1936
|
# @option params [required, String] :stream_arn
|
1862
1937
|
# The ARN of the Kinesis data stream that you want to register the
|
1863
1938
|
# consumer with. For more info, see [Amazon Resource Names (ARNs) and
|
1864
|
-
#
|
1939
|
+
# Amazon Web Services Service Namespaces][1].
|
1865
1940
|
#
|
1866
1941
|
#
|
1867
1942
|
#
|
@@ -1952,9 +2027,10 @@ module Aws::Kinesis
|
|
1952
2027
|
# mapped into the shard. For more information, see [Split a Shard][1] in
|
1953
2028
|
# the *Amazon Kinesis Data Streams Developer Guide*.
|
1954
2029
|
#
|
1955
|
-
# You can use
|
1956
|
-
# values for the `ShardToSplit` and
|
1957
|
-
# 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.
|
1958
2034
|
#
|
1959
2035
|
# `SplitShard` is an asynchronous operation. Upon receiving a
|
1960
2036
|
# `SplitShard` request, Kinesis Data Streams immediately returns a
|
@@ -1963,19 +2039,19 @@ module Aws::Kinesis
|
|
1963
2039
|
# Read and write operations continue to work while the stream is in the
|
1964
2040
|
# `UPDATING` state.
|
1965
2041
|
#
|
1966
|
-
# You can use
|
1967
|
-
# is returned in `StreamStatus`. If the stream is in the `ACTIVE`
|
1968
|
-
# you can call `SplitShard`.
|
1969
|
-
# or `DELETING` states, `DescribeStream` returns a
|
1970
|
-
# `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`.
|
1971
2045
|
#
|
1972
|
-
# If the specified stream does not exist,
|
1973
|
-
# `ResourceNotFoundException`. If you try to create more shards than
|
1974
|
-
# 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`.
|
1975
2050
|
#
|
1976
|
-
# For the default shard limit for an
|
1977
|
-
# Streams Limits][2] in the *Amazon Kinesis Data Streams
|
1978
|
-
# 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].
|
1979
2055
|
#
|
1980
2056
|
# If you try to operate on too many streams simultaneously using
|
1981
2057
|
# CreateStream, DeleteStream, MergeShards, and/or SplitShard, you
|
@@ -2024,8 +2100,8 @@ module Aws::Kinesis
|
|
2024
2100
|
req.send_request(options)
|
2025
2101
|
end
|
2026
2102
|
|
2027
|
-
# Enables or updates server-side encryption using an
|
2028
|
-
# specified stream.
|
2103
|
+
# Enables or updates server-side encryption using an Amazon Web Services
|
2104
|
+
# KMS key for a specified stream.
|
2029
2105
|
#
|
2030
2106
|
# Starting encryption is an asynchronous operation. Upon receiving the
|
2031
2107
|
# request, Kinesis Data Streams returns immediately and sets the status
|
@@ -2036,8 +2112,8 @@ module Aws::Kinesis
|
|
2036
2112
|
# stream while its status is `UPDATING`. Once the status of the stream
|
2037
2113
|
# is `ACTIVE`, encryption begins for records written to the stream.
|
2038
2114
|
#
|
2039
|
-
# API Limits: You can successfully apply a new
|
2040
|
-
# 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.
|
2041
2117
|
#
|
2042
2118
|
# Note: It can take up to 5 seconds after the stream is in an `ACTIVE`
|
2043
2119
|
# status before all records written to the stream are encrypted. After
|
@@ -2051,11 +2127,12 @@ module Aws::Kinesis
|
|
2051
2127
|
# The encryption type to use. The only valid value is `KMS`.
|
2052
2128
|
#
|
2053
2129
|
# @option params [required, String] :key_id
|
2054
|
-
# The GUID for the customer-managed
|
2055
|
-
# This value can be a globally unique identifier, a
|
2056
|
-
# Amazon Resource Name (ARN) to either an alias or a
|
2057
|
-
# name prefixed by "alias/".You can also use a master
|
2058
|
-
# 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`.
|
2059
2136
|
#
|
2060
2137
|
# * Key ARN example:
|
2061
2138
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2117,11 +2194,12 @@ module Aws::Kinesis
|
|
2117
2194
|
# The encryption type. The only valid value is `KMS`.
|
2118
2195
|
#
|
2119
2196
|
# @option params [required, String] :key_id
|
2120
|
-
# The GUID for the customer-managed
|
2121
|
-
# This value can be a globally unique identifier, a
|
2122
|
-
# Amazon Resource Name (ARN) to either an alias or a
|
2123
|
-
# name prefixed by "alias/".You can also use a master
|
2124
|
-
# 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`.
|
2125
2203
|
#
|
2126
2204
|
# * Key ARN example:
|
2127
2205
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2186,17 +2264,17 @@ module Aws::Kinesis
|
|
2186
2264
|
#
|
2187
2265
|
# * Scale down below half your current shard count for a stream
|
2188
2266
|
#
|
2189
|
-
# * Scale up to more than
|
2267
|
+
# * Scale up to more than 10000 shards in a stream
|
2190
2268
|
#
|
2191
|
-
# * Scale a stream with more than
|
2192
|
-
# less than
|
2269
|
+
# * Scale a stream with more than 10000 shards down unless the result is
|
2270
|
+
# less than 10000 shards
|
2193
2271
|
#
|
2194
2272
|
# * Scale up to more than the shard limit for your account
|
2195
2273
|
#
|
2196
|
-
# For the default limits for an
|
2197
|
-
# the *Amazon Kinesis Data Streams Developer
|
2198
|
-
# increase in the call rate limit, the shard limit
|
2199
|
-
# 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].
|
2200
2278
|
#
|
2201
2279
|
#
|
2202
2280
|
#
|
@@ -2215,12 +2293,12 @@ module Aws::Kinesis
|
|
2215
2293
|
#
|
2216
2294
|
# * Set this value below half your current shard count for a stream.
|
2217
2295
|
#
|
2218
|
-
# * Set this value to more than
|
2219
|
-
# 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),
|
2220
2298
|
# unless you request a limit increase.
|
2221
2299
|
#
|
2222
|
-
# * Scale a stream with more than
|
2223
|
-
# 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.
|
2224
2302
|
#
|
2225
2303
|
# @option params [required, String] :scaling_type
|
2226
2304
|
# The scaling type. Uniform scaling creates shards of equal size.
|
@@ -2254,6 +2332,40 @@ module Aws::Kinesis
|
|
2254
2332
|
req.send_request(options)
|
2255
2333
|
end
|
2256
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
|
+
|
2257
2369
|
# @!endgroup
|
2258
2370
|
|
2259
2371
|
# @param params ({})
|
@@ -2267,7 +2379,7 @@ module Aws::Kinesis
|
|
2267
2379
|
params: params,
|
2268
2380
|
config: config)
|
2269
2381
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2270
|
-
context[:gem_version] = '1.
|
2382
|
+
context[:gem_version] = '1.38.0'
|
2271
2383
|
Seahorse::Client::Request.new(handlers, context)
|
2272
2384
|
end
|
2273
2385
|
|