aws-sdk-kinesis 1.42.0 → 1.44.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 +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesis/async_client.rb +1 -1
- data/lib/aws-sdk-kinesis/client.rb +260 -53
- data/lib/aws-sdk-kinesis/client_api.rb +93 -27
- data/lib/aws-sdk-kinesis/endpoint_parameters.rb +27 -0
- data/lib/aws-sdk-kinesis/endpoint_provider.rb +134 -95
- data/lib/aws-sdk-kinesis/endpoints.rb +87 -0
- data/lib/aws-sdk-kinesis/errors.rb +16 -0
- data/lib/aws-sdk-kinesis/types.rb +200 -323
- data/lib/aws-sdk-kinesis.rb +1 -1
- metadata +2 -2
@@ -392,6 +392,11 @@ module Aws::Kinesis
|
|
392
392
|
# Adds or updates tags for the specified Kinesis data stream. You can
|
393
393
|
# assign up to 50 tags to a data stream.
|
394
394
|
#
|
395
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
396
|
+
# input parameter rather than the `StreamName` input parameter.
|
397
|
+
#
|
398
|
+
# </note>
|
399
|
+
#
|
395
400
|
# If tags have already been assigned to the stream, `AddTagsToStream`
|
396
401
|
# overwrites any existing tags that correspond to the specified tag
|
397
402
|
# keys.
|
@@ -399,21 +404,25 @@ module Aws::Kinesis
|
|
399
404
|
# AddTagsToStream has a limit of five transactions per second per
|
400
405
|
# account.
|
401
406
|
#
|
402
|
-
# @option params [
|
407
|
+
# @option params [String] :stream_name
|
403
408
|
# The name of the stream.
|
404
409
|
#
|
405
410
|
# @option params [required, Hash<String,String>] :tags
|
406
411
|
# A set of up to 10 key-value pairs to use to create the tags.
|
407
412
|
#
|
413
|
+
# @option params [String] :stream_arn
|
414
|
+
# The ARN of the stream.
|
415
|
+
#
|
408
416
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
409
417
|
#
|
410
418
|
# @example Request syntax with placeholder values
|
411
419
|
#
|
412
420
|
# resp = client.add_tags_to_stream({
|
413
|
-
# stream_name: "StreamName",
|
421
|
+
# stream_name: "StreamName",
|
414
422
|
# tags: { # required
|
415
423
|
# "TagKey" => "TagValue",
|
416
424
|
# },
|
425
|
+
# stream_arn: "StreamARN",
|
417
426
|
# })
|
418
427
|
#
|
419
428
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/AddTagsToStream AWS API Documentation
|
@@ -431,12 +440,18 @@ module Aws::Kinesis
|
|
431
440
|
# means of shards, which are uniquely identified groups of data records
|
432
441
|
# in a stream.
|
433
442
|
#
|
434
|
-
# You
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
439
|
-
#
|
443
|
+
# You can create your data stream using either on-demand or provisioned
|
444
|
+
# capacity mode. Data streams with an on-demand mode require no capacity
|
445
|
+
# planning and automatically scale to handle gigabytes of write and read
|
446
|
+
# throughput per minute. With the on-demand mode, Kinesis Data Streams
|
447
|
+
# automatically manages the shards in order to provide the necessary
|
448
|
+
# throughput. For the data streams with a provisioned mode, you must
|
449
|
+
# specify the number of shards for the data stream. Each shard can
|
450
|
+
# support reads up to five transactions per second, up to a maximum data
|
451
|
+
# read total of 2 MiB per second. Each shard can support writes up to
|
452
|
+
# 1,000 records per second, up to a maximum data write total of 1 MiB
|
453
|
+
# per second. If the amount of data input increases or decreases, you
|
454
|
+
# can add or remove shards.
|
440
455
|
#
|
441
456
|
# The stream name identifies the stream. The name is scoped to the
|
442
457
|
# Amazon Web Services account used by the application. It is also scoped
|
@@ -516,24 +531,33 @@ module Aws::Kinesis
|
|
516
531
|
# length of time data records are accessible after they are added to the
|
517
532
|
# stream. The minimum value of a stream's retention period is 24 hours.
|
518
533
|
#
|
534
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
535
|
+
# input parameter rather than the `StreamName` input parameter.
|
536
|
+
#
|
537
|
+
# </note>
|
538
|
+
#
|
519
539
|
# This operation may result in lost data. For example, if the stream's
|
520
540
|
# retention period is 48 hours and is decreased to 24 hours, any data
|
521
541
|
# already in the stream that is older than 24 hours is inaccessible.
|
522
542
|
#
|
523
|
-
# @option params [
|
543
|
+
# @option params [String] :stream_name
|
524
544
|
# The name of the stream to modify.
|
525
545
|
#
|
526
546
|
# @option params [required, Integer] :retention_period_hours
|
527
547
|
# The new retention period of the stream, in hours. Must be less than
|
528
548
|
# the current retention period.
|
529
549
|
#
|
550
|
+
# @option params [String] :stream_arn
|
551
|
+
# The ARN of the stream.
|
552
|
+
#
|
530
553
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
531
554
|
#
|
532
555
|
# @example Request syntax with placeholder values
|
533
556
|
#
|
534
557
|
# resp = client.decrease_stream_retention_period({
|
535
|
-
# stream_name: "StreamName",
|
558
|
+
# stream_name: "StreamName",
|
536
559
|
# retention_period_hours: 1, # required
|
560
|
+
# stream_arn: "StreamARN",
|
537
561
|
# })
|
538
562
|
#
|
539
563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DecreaseStreamRetentionPeriod AWS API Documentation
|
@@ -550,6 +574,11 @@ module Aws::Kinesis
|
|
550
574
|
# delete the stream. If an application attempts to operate on a deleted
|
551
575
|
# stream, it receives the exception `ResourceNotFoundException`.
|
552
576
|
#
|
577
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
578
|
+
# input parameter rather than the `StreamName` input parameter.
|
579
|
+
#
|
580
|
+
# </note>
|
581
|
+
#
|
553
582
|
# If the stream is in the `ACTIVE` state, you can delete it. After a
|
554
583
|
# `DeleteStream` request, the specified stream is in the `DELETING`
|
555
584
|
# state until Kinesis Data Streams completes the deletion.
|
@@ -566,7 +595,7 @@ module Aws::Kinesis
|
|
566
595
|
#
|
567
596
|
# DeleteStream has a limit of five transactions per second per account.
|
568
597
|
#
|
569
|
-
# @option params [
|
598
|
+
# @option params [String] :stream_name
|
570
599
|
# The name of the stream to delete.
|
571
600
|
#
|
572
601
|
# @option params [Boolean] :enforce_consumer_deletion
|
@@ -574,13 +603,17 @@ module Aws::Kinesis
|
|
574
603
|
# the stream has registered consumers, the call to `DeleteStream` fails
|
575
604
|
# with a `ResourceInUseException`.
|
576
605
|
#
|
606
|
+
# @option params [String] :stream_arn
|
607
|
+
# The ARN of the stream.
|
608
|
+
#
|
577
609
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
578
610
|
#
|
579
611
|
# @example Request syntax with placeholder values
|
580
612
|
#
|
581
613
|
# resp = client.delete_stream({
|
582
|
-
# stream_name: "StreamName",
|
614
|
+
# stream_name: "StreamName",
|
583
615
|
# enforce_consumer_deletion: false,
|
616
|
+
# stream_arn: "StreamARN",
|
584
617
|
# })
|
585
618
|
#
|
586
619
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DeleteStream AWS API Documentation
|
@@ -682,6 +715,11 @@ module Aws::Kinesis
|
|
682
715
|
#
|
683
716
|
# </note>
|
684
717
|
#
|
718
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
719
|
+
# input parameter rather than the `StreamName` input parameter.
|
720
|
+
#
|
721
|
+
# </note>
|
722
|
+
#
|
685
723
|
# The information returned includes the stream name, Amazon Resource
|
686
724
|
# Name (ARN), creation time, enhanced metric configuration, and shard
|
687
725
|
# map. The shard map is an array of shard objects. For each shard
|
@@ -705,7 +743,7 @@ module Aws::Kinesis
|
|
705
743
|
#
|
706
744
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
|
707
745
|
#
|
708
|
-
# @option params [
|
746
|
+
# @option params [String] :stream_name
|
709
747
|
# The name of the stream to describe.
|
710
748
|
#
|
711
749
|
# @option params [Integer] :limit
|
@@ -724,6 +762,9 @@ module Aws::Kinesis
|
|
724
762
|
# `DescribeStream` is to describe the stream starting with the first
|
725
763
|
# shard in the stream.
|
726
764
|
#
|
765
|
+
# @option params [String] :stream_arn
|
766
|
+
# The ARN of the stream.
|
767
|
+
#
|
727
768
|
# @return [Types::DescribeStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
728
769
|
#
|
729
770
|
# * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
|
@@ -733,9 +774,10 @@ module Aws::Kinesis
|
|
733
774
|
# @example Request syntax with placeholder values
|
734
775
|
#
|
735
776
|
# resp = client.describe_stream({
|
736
|
-
# stream_name: "StreamName",
|
777
|
+
# stream_name: "StreamName",
|
737
778
|
# limit: 1,
|
738
779
|
# exclusive_start_shard_id: "ShardId",
|
780
|
+
# stream_arn: "StreamARN",
|
739
781
|
# })
|
740
782
|
#
|
741
783
|
# @example Response structure
|
@@ -835,6 +877,11 @@ module Aws::Kinesis
|
|
835
877
|
# Provides a summarized description of the specified Kinesis data stream
|
836
878
|
# without the shard list.
|
837
879
|
#
|
880
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
881
|
+
# input parameter rather than the `StreamName` input parameter.
|
882
|
+
#
|
883
|
+
# </note>
|
884
|
+
#
|
838
885
|
# The information returned includes the stream name, Amazon Resource
|
839
886
|
# Name (ARN), status, record retention period, approximate creation
|
840
887
|
# time, monitoring, encryption details, and open shard count.
|
@@ -842,9 +889,12 @@ module Aws::Kinesis
|
|
842
889
|
# DescribeStreamSummary has a limit of 20 transactions per second per
|
843
890
|
# account.
|
844
891
|
#
|
845
|
-
# @option params [
|
892
|
+
# @option params [String] :stream_name
|
846
893
|
# The name of the stream to describe.
|
847
894
|
#
|
895
|
+
# @option params [String] :stream_arn
|
896
|
+
# The ARN of the stream.
|
897
|
+
#
|
848
898
|
# @return [Types::DescribeStreamSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
849
899
|
#
|
850
900
|
# * {Types::DescribeStreamSummaryOutput#stream_description_summary #stream_description_summary} => Types::StreamDescriptionSummary
|
@@ -852,7 +902,8 @@ module Aws::Kinesis
|
|
852
902
|
# @example Request syntax with placeholder values
|
853
903
|
#
|
854
904
|
# resp = client.describe_stream_summary({
|
855
|
-
# stream_name: "StreamName",
|
905
|
+
# stream_name: "StreamName",
|
906
|
+
# stream_arn: "StreamARN",
|
856
907
|
# })
|
857
908
|
#
|
858
909
|
# @example Response structure
|
@@ -882,7 +933,12 @@ module Aws::Kinesis
|
|
882
933
|
|
883
934
|
# Disables enhanced monitoring.
|
884
935
|
#
|
885
|
-
#
|
936
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
937
|
+
# input parameter rather than the `StreamName` input parameter.
|
938
|
+
#
|
939
|
+
# </note>
|
940
|
+
#
|
941
|
+
# @option params [String] :stream_name
|
886
942
|
# The name of the Kinesis data stream for which to disable enhanced
|
887
943
|
# monitoring.
|
888
944
|
#
|
@@ -916,17 +972,22 @@ module Aws::Kinesis
|
|
916
972
|
#
|
917
973
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
918
974
|
#
|
975
|
+
# @option params [String] :stream_arn
|
976
|
+
# The ARN of the stream.
|
977
|
+
#
|
919
978
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
920
979
|
#
|
921
980
|
# * {Types::EnhancedMonitoringOutput#stream_name #stream_name} => String
|
922
981
|
# * {Types::EnhancedMonitoringOutput#current_shard_level_metrics #current_shard_level_metrics} => Array<String>
|
923
982
|
# * {Types::EnhancedMonitoringOutput#desired_shard_level_metrics #desired_shard_level_metrics} => Array<String>
|
983
|
+
# * {Types::EnhancedMonitoringOutput#stream_arn #stream_arn} => String
|
924
984
|
#
|
925
985
|
# @example Request syntax with placeholder values
|
926
986
|
#
|
927
987
|
# resp = client.disable_enhanced_monitoring({
|
928
|
-
# stream_name: "StreamName",
|
988
|
+
# stream_name: "StreamName",
|
929
989
|
# shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
|
990
|
+
# stream_arn: "StreamARN",
|
930
991
|
# })
|
931
992
|
#
|
932
993
|
# @example Response structure
|
@@ -936,6 +997,7 @@ module Aws::Kinesis
|
|
936
997
|
# resp.current_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
|
937
998
|
# resp.desired_shard_level_metrics #=> Array
|
938
999
|
# resp.desired_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
|
1000
|
+
# resp.stream_arn #=> String
|
939
1001
|
#
|
940
1002
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DisableEnhancedMonitoring AWS API Documentation
|
941
1003
|
#
|
@@ -949,7 +1011,12 @@ module Aws::Kinesis
|
|
949
1011
|
# Enables enhanced Kinesis data stream monitoring for shard-level
|
950
1012
|
# metrics.
|
951
1013
|
#
|
952
|
-
#
|
1014
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1015
|
+
# input parameter rather than the `StreamName` input parameter.
|
1016
|
+
#
|
1017
|
+
# </note>
|
1018
|
+
#
|
1019
|
+
# @option params [String] :stream_name
|
953
1020
|
# The name of the stream for which to enable enhanced monitoring.
|
954
1021
|
#
|
955
1022
|
# @option params [required, Array<String>] :shard_level_metrics
|
@@ -982,17 +1049,22 @@ module Aws::Kinesis
|
|
982
1049
|
#
|
983
1050
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
984
1051
|
#
|
1052
|
+
# @option params [String] :stream_arn
|
1053
|
+
# The ARN of the stream.
|
1054
|
+
#
|
985
1055
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
986
1056
|
#
|
987
1057
|
# * {Types::EnhancedMonitoringOutput#stream_name #stream_name} => String
|
988
1058
|
# * {Types::EnhancedMonitoringOutput#current_shard_level_metrics #current_shard_level_metrics} => Array<String>
|
989
1059
|
# * {Types::EnhancedMonitoringOutput#desired_shard_level_metrics #desired_shard_level_metrics} => Array<String>
|
1060
|
+
# * {Types::EnhancedMonitoringOutput#stream_arn #stream_arn} => String
|
990
1061
|
#
|
991
1062
|
# @example Request syntax with placeholder values
|
992
1063
|
#
|
993
1064
|
# resp = client.enable_enhanced_monitoring({
|
994
|
-
# stream_name: "StreamName",
|
1065
|
+
# stream_name: "StreamName",
|
995
1066
|
# shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
|
1067
|
+
# stream_arn: "StreamARN",
|
996
1068
|
# })
|
997
1069
|
#
|
998
1070
|
# @example Response structure
|
@@ -1002,6 +1074,7 @@ module Aws::Kinesis
|
|
1002
1074
|
# resp.current_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
|
1003
1075
|
# resp.desired_shard_level_metrics #=> Array
|
1004
1076
|
# resp.desired_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
|
1077
|
+
# resp.stream_arn #=> String
|
1005
1078
|
#
|
1006
1079
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnableEnhancedMonitoring AWS API Documentation
|
1007
1080
|
#
|
@@ -1014,6 +1087,11 @@ module Aws::Kinesis
|
|
1014
1087
|
|
1015
1088
|
# Gets data records from a Kinesis data stream's shard.
|
1016
1089
|
#
|
1090
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1091
|
+
# input parameter in addition to the `ShardIterator` parameter.
|
1092
|
+
#
|
1093
|
+
# </note>
|
1094
|
+
#
|
1017
1095
|
# Specify a shard iterator using the `ShardIterator` parameter. The
|
1018
1096
|
# shard iterator specifies the position in the shard from which you want
|
1019
1097
|
# to start reading data records sequentially. If there are no records
|
@@ -1091,6 +1169,9 @@ module Aws::Kinesis
|
|
1091
1169
|
# 10,000. If you specify a value that is greater than 10,000, GetRecords
|
1092
1170
|
# throws `InvalidArgumentException`. The default value is 10,000.
|
1093
1171
|
#
|
1172
|
+
# @option params [String] :stream_arn
|
1173
|
+
# The ARN of the stream.
|
1174
|
+
#
|
1094
1175
|
# @return [Types::GetRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1095
1176
|
#
|
1096
1177
|
# * {Types::GetRecordsOutput#records #records} => Array<Types::Record>
|
@@ -1103,6 +1184,7 @@ module Aws::Kinesis
|
|
1103
1184
|
# resp = client.get_records({
|
1104
1185
|
# shard_iterator: "ShardIterator", # required
|
1105
1186
|
# limit: 1,
|
1187
|
+
# stream_arn: "StreamARN",
|
1106
1188
|
# })
|
1107
1189
|
#
|
1108
1190
|
# @example Response structure
|
@@ -1134,6 +1216,11 @@ module Aws::Kinesis
|
|
1134
1216
|
# Gets an Amazon Kinesis shard iterator. A shard iterator expires 5
|
1135
1217
|
# minutes after it is returned to the requester.
|
1136
1218
|
#
|
1219
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1220
|
+
# input parameter rather than the `StreamName` input parameter.
|
1221
|
+
#
|
1222
|
+
# </note>
|
1223
|
+
#
|
1137
1224
|
# A shard iterator specifies the shard position from which to start
|
1138
1225
|
# reading data records sequentially. The position is specified using the
|
1139
1226
|
# sequence number of a data record in a shard. A sequence number is the
|
@@ -1178,7 +1265,7 @@ module Aws::Kinesis
|
|
1178
1265
|
#
|
1179
1266
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1180
1267
|
#
|
1181
|
-
# @option params [
|
1268
|
+
# @option params [String] :stream_name
|
1182
1269
|
# The name of the Amazon Kinesis data stream.
|
1183
1270
|
#
|
1184
1271
|
# @option params [required, String] :shard_id
|
@@ -1223,6 +1310,9 @@ module Aws::Kinesis
|
|
1223
1310
|
# horizon, the iterator returned is for the oldest untrimmed data record
|
1224
1311
|
# (TRIM\_HORIZON).
|
1225
1312
|
#
|
1313
|
+
# @option params [String] :stream_arn
|
1314
|
+
# The ARN of the stream.
|
1315
|
+
#
|
1226
1316
|
# @return [Types::GetShardIteratorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1227
1317
|
#
|
1228
1318
|
# * {Types::GetShardIteratorOutput#shard_iterator #shard_iterator} => String
|
@@ -1230,11 +1320,12 @@ module Aws::Kinesis
|
|
1230
1320
|
# @example Request syntax with placeholder values
|
1231
1321
|
#
|
1232
1322
|
# resp = client.get_shard_iterator({
|
1233
|
-
# stream_name: "StreamName",
|
1323
|
+
# stream_name: "StreamName",
|
1234
1324
|
# shard_id: "ShardId", # required
|
1235
1325
|
# shard_iterator_type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
|
1236
1326
|
# starting_sequence_number: "SequenceNumber",
|
1237
1327
|
# timestamp: Time.now,
|
1328
|
+
# stream_arn: "StreamARN",
|
1238
1329
|
# })
|
1239
1330
|
#
|
1240
1331
|
# @example Response structure
|
@@ -1255,6 +1346,11 @@ module Aws::Kinesis
|
|
1255
1346
|
# stream. The maximum value of a stream's retention period is 8760
|
1256
1347
|
# hours (365 days).
|
1257
1348
|
#
|
1349
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1350
|
+
# input parameter rather than the `StreamName` input parameter.
|
1351
|
+
#
|
1352
|
+
# </note>
|
1353
|
+
#
|
1258
1354
|
# If you choose a longer stream retention period, this operation
|
1259
1355
|
# increases the time period during which records that have not yet
|
1260
1356
|
# expired are accessible. However, it does not make previous, expired
|
@@ -1264,20 +1360,24 @@ module Aws::Kinesis
|
|
1264
1360
|
# data that is older than 24 hours remains inaccessible to consumer
|
1265
1361
|
# applications.
|
1266
1362
|
#
|
1267
|
-
# @option params [
|
1363
|
+
# @option params [String] :stream_name
|
1268
1364
|
# The name of the stream to modify.
|
1269
1365
|
#
|
1270
1366
|
# @option params [required, Integer] :retention_period_hours
|
1271
1367
|
# The new retention period of the stream, in hours. Must be more than
|
1272
1368
|
# the current retention period.
|
1273
1369
|
#
|
1370
|
+
# @option params [String] :stream_arn
|
1371
|
+
# The ARN of the stream.
|
1372
|
+
#
|
1274
1373
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1275
1374
|
#
|
1276
1375
|
# @example Request syntax with placeholder values
|
1277
1376
|
#
|
1278
1377
|
# resp = client.increase_stream_retention_period({
|
1279
|
-
# stream_name: "StreamName",
|
1378
|
+
# stream_name: "StreamName",
|
1280
1379
|
# retention_period_hours: 1, # required
|
1380
|
+
# stream_arn: "StreamARN",
|
1281
1381
|
# })
|
1282
1382
|
#
|
1283
1383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/IncreaseStreamRetentionPeriod AWS API Documentation
|
@@ -1293,6 +1393,11 @@ module Aws::Kinesis
|
|
1293
1393
|
# shard. This operation has a limit of 1000 transactions per second per
|
1294
1394
|
# data stream.
|
1295
1395
|
#
|
1396
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1397
|
+
# input parameter rather than the `StreamName` input parameter.
|
1398
|
+
#
|
1399
|
+
# </note>
|
1400
|
+
#
|
1296
1401
|
# This action does not list expired shards. For information about
|
1297
1402
|
# expired shards, see [Data Routing, Data Persistence, and Shard State
|
1298
1403
|
# after a Reshard][1].
|
@@ -1394,6 +1499,9 @@ module Aws::Kinesis
|
|
1394
1499
|
# FROM\_TIMESTAMP type, then all shards starting from the provided
|
1395
1500
|
# timestamp to TIP are returned.
|
1396
1501
|
#
|
1502
|
+
# @option params [String] :stream_arn
|
1503
|
+
# The ARN of the stream.
|
1504
|
+
#
|
1397
1505
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1398
1506
|
#
|
1399
1507
|
# * {Types::ListShardsOutput#shards #shards} => Array<Types::Shard>
|
@@ -1412,6 +1520,7 @@ module Aws::Kinesis
|
|
1412
1520
|
# shard_id: "ShardId",
|
1413
1521
|
# timestamp: Time.now,
|
1414
1522
|
# },
|
1523
|
+
# stream_arn: "StreamARN",
|
1415
1524
|
# })
|
1416
1525
|
#
|
1417
1526
|
# @example Response structure
|
@@ -1551,10 +1660,14 @@ module Aws::Kinesis
|
|
1551
1660
|
# @option params [String] :exclusive_start_stream_name
|
1552
1661
|
# The name of the stream to start the list with.
|
1553
1662
|
#
|
1663
|
+
# @option params [String] :next_token
|
1664
|
+
#
|
1554
1665
|
# @return [Types::ListStreamsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1555
1666
|
#
|
1556
1667
|
# * {Types::ListStreamsOutput#stream_names #stream_names} => Array<String>
|
1557
1668
|
# * {Types::ListStreamsOutput#has_more_streams #has_more_streams} => Boolean
|
1669
|
+
# * {Types::ListStreamsOutput#next_token #next_token} => String
|
1670
|
+
# * {Types::ListStreamsOutput#stream_summaries #stream_summaries} => Array<Types::StreamSummary>
|
1558
1671
|
#
|
1559
1672
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1560
1673
|
#
|
@@ -1563,6 +1676,7 @@ module Aws::Kinesis
|
|
1563
1676
|
# resp = client.list_streams({
|
1564
1677
|
# limit: 1,
|
1565
1678
|
# exclusive_start_stream_name: "StreamName",
|
1679
|
+
# next_token: "NextToken",
|
1566
1680
|
# })
|
1567
1681
|
#
|
1568
1682
|
# @example Response structure
|
@@ -1570,6 +1684,13 @@ module Aws::Kinesis
|
|
1570
1684
|
# resp.stream_names #=> Array
|
1571
1685
|
# resp.stream_names[0] #=> String
|
1572
1686
|
# resp.has_more_streams #=> Boolean
|
1687
|
+
# resp.next_token #=> String
|
1688
|
+
# resp.stream_summaries #=> Array
|
1689
|
+
# resp.stream_summaries[0].stream_name #=> String
|
1690
|
+
# resp.stream_summaries[0].stream_arn #=> String
|
1691
|
+
# resp.stream_summaries[0].stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
|
1692
|
+
# resp.stream_summaries[0].stream_mode_details.stream_mode #=> String, one of "PROVISIONED", "ON_DEMAND"
|
1693
|
+
# resp.stream_summaries[0].stream_creation_timestamp #=> Time
|
1573
1694
|
#
|
1574
1695
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListStreams AWS API Documentation
|
1575
1696
|
#
|
@@ -1583,7 +1704,12 @@ module Aws::Kinesis
|
|
1583
1704
|
# Lists the tags for the specified Kinesis data stream. This operation
|
1584
1705
|
# has a limit of five transactions per second per account.
|
1585
1706
|
#
|
1586
|
-
#
|
1707
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1708
|
+
# input parameter rather than the `StreamName` input parameter.
|
1709
|
+
#
|
1710
|
+
# </note>
|
1711
|
+
#
|
1712
|
+
# @option params [String] :stream_name
|
1587
1713
|
# The name of the stream.
|
1588
1714
|
#
|
1589
1715
|
# @option params [String] :exclusive_start_tag_key
|
@@ -1597,6 +1723,9 @@ module Aws::Kinesis
|
|
1597
1723
|
# `true`. To list additional tags, set `ExclusiveStartTagKey` to the
|
1598
1724
|
# last key in the response.
|
1599
1725
|
#
|
1726
|
+
# @option params [String] :stream_arn
|
1727
|
+
# The ARN of the stream.
|
1728
|
+
#
|
1600
1729
|
# @return [Types::ListTagsForStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1601
1730
|
#
|
1602
1731
|
# * {Types::ListTagsForStreamOutput#tags #tags} => Array<Types::Tag>
|
@@ -1605,9 +1734,10 @@ module Aws::Kinesis
|
|
1605
1734
|
# @example Request syntax with placeholder values
|
1606
1735
|
#
|
1607
1736
|
# resp = client.list_tags_for_stream({
|
1608
|
-
# stream_name: "StreamName",
|
1737
|
+
# stream_name: "StreamName",
|
1609
1738
|
# exclusive_start_tag_key: "TagKey",
|
1610
1739
|
# limit: 1,
|
1740
|
+
# stream_arn: "StreamARN",
|
1611
1741
|
# })
|
1612
1742
|
#
|
1613
1743
|
# @example Response structure
|
@@ -1628,14 +1758,20 @@ module Aws::Kinesis
|
|
1628
1758
|
|
1629
1759
|
# Merges two adjacent shards in a Kinesis data stream and combines them
|
1630
1760
|
# into a single shard to reduce the stream's capacity to ingest and
|
1631
|
-
# transport data.
|
1632
|
-
#
|
1633
|
-
#
|
1634
|
-
#
|
1635
|
-
#
|
1636
|
-
#
|
1637
|
-
#
|
1638
|
-
#
|
1761
|
+
# transport data. This API is only supported for the data streams with
|
1762
|
+
# the provisioned capacity mode. Two shards are considered adjacent if
|
1763
|
+
# the union of the hash key ranges for the two shards form a contiguous
|
1764
|
+
# set with no gaps. For example, if you have two shards, one with a hash
|
1765
|
+
# key range of 276...381 and the other with a hash key range of
|
1766
|
+
# 382...454, then you could merge these two shards into a single shard
|
1767
|
+
# that would have a hash key range of 276...454. After the merge, the
|
1768
|
+
# single child shard receives data for all hash key values covered by
|
1769
|
+
# the two parent shards.
|
1770
|
+
#
|
1771
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1772
|
+
# input parameter rather than the `StreamName` input parameter.
|
1773
|
+
#
|
1774
|
+
# </note>
|
1639
1775
|
#
|
1640
1776
|
# `MergeShards` is called when there is a need to reduce the overall
|
1641
1777
|
# capacity of a stream because of excess capacity that is not being
|
@@ -1672,7 +1808,7 @@ module Aws::Kinesis
|
|
1672
1808
|
#
|
1673
1809
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
|
1674
1810
|
#
|
1675
|
-
# @option params [
|
1811
|
+
# @option params [String] :stream_name
|
1676
1812
|
# The name of the stream for the merge.
|
1677
1813
|
#
|
1678
1814
|
# @option params [required, String] :shard_to_merge
|
@@ -1682,14 +1818,18 @@ module Aws::Kinesis
|
|
1682
1818
|
# @option params [required, String] :adjacent_shard_to_merge
|
1683
1819
|
# The shard ID of the adjacent shard for the merge.
|
1684
1820
|
#
|
1821
|
+
# @option params [String] :stream_arn
|
1822
|
+
# The ARN of the stream.
|
1823
|
+
#
|
1685
1824
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1686
1825
|
#
|
1687
1826
|
# @example Request syntax with placeholder values
|
1688
1827
|
#
|
1689
1828
|
# resp = client.merge_shards({
|
1690
|
-
# stream_name: "StreamName",
|
1829
|
+
# stream_name: "StreamName",
|
1691
1830
|
# shard_to_merge: "ShardId", # required
|
1692
1831
|
# adjacent_shard_to_merge: "ShardId", # required
|
1832
|
+
# stream_arn: "StreamARN",
|
1693
1833
|
# })
|
1694
1834
|
#
|
1695
1835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/MergeShards AWS API Documentation
|
@@ -1707,6 +1847,11 @@ module Aws::Kinesis
|
|
1707
1847
|
# writes up to 1,000 records per second, up to a maximum data write
|
1708
1848
|
# total of 1 MiB per second.
|
1709
1849
|
#
|
1850
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1851
|
+
# input parameter rather than the `StreamName` input parameter.
|
1852
|
+
#
|
1853
|
+
# </note>
|
1854
|
+
#
|
1710
1855
|
# You must specify the name of the stream that captures, stores, and
|
1711
1856
|
# transports the data; a partition key; and the data blob itself.
|
1712
1857
|
#
|
@@ -1755,7 +1900,7 @@ module Aws::Kinesis
|
|
1755
1900
|
#
|
1756
1901
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
|
1757
1902
|
#
|
1758
|
-
# @option params [
|
1903
|
+
# @option params [String] :stream_name
|
1759
1904
|
# The name of the stream to put the data record into.
|
1760
1905
|
#
|
1761
1906
|
# @option params [required, String, StringIO, File] :data
|
@@ -1787,6 +1932,9 @@ module Aws::Kinesis
|
|
1787
1932
|
# this parameter is not set, records are coarsely ordered based on
|
1788
1933
|
# arrival time.
|
1789
1934
|
#
|
1935
|
+
# @option params [String] :stream_arn
|
1936
|
+
# The ARN of the stream.
|
1937
|
+
#
|
1790
1938
|
# @return [Types::PutRecordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1791
1939
|
#
|
1792
1940
|
# * {Types::PutRecordOutput#shard_id #shard_id} => String
|
@@ -1796,11 +1944,12 @@ module Aws::Kinesis
|
|
1796
1944
|
# @example Request syntax with placeholder values
|
1797
1945
|
#
|
1798
1946
|
# resp = client.put_record({
|
1799
|
-
# stream_name: "StreamName",
|
1947
|
+
# stream_name: "StreamName",
|
1800
1948
|
# data: "data", # required
|
1801
1949
|
# partition_key: "PartitionKey", # required
|
1802
1950
|
# explicit_hash_key: "HashKey",
|
1803
1951
|
# sequence_number_for_ordering: "SequenceNumber",
|
1952
|
+
# stream_arn: "StreamARN",
|
1804
1953
|
# })
|
1805
1954
|
#
|
1806
1955
|
# @example Response structure
|
@@ -1822,6 +1971,11 @@ module Aws::Kinesis
|
|
1822
1971
|
# call (also referred to as a `PutRecords` request). Use this operation
|
1823
1972
|
# to send data into the stream for data ingestion and processing.
|
1824
1973
|
#
|
1974
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
1975
|
+
# input parameter rather than the `StreamName` input parameter.
|
1976
|
+
#
|
1977
|
+
# </note>
|
1978
|
+
#
|
1825
1979
|
# Each `PutRecords` request can support up to 500 records. Each record
|
1826
1980
|
# in the request can be as large as 1 MiB, up to a limit of 5 MiB for
|
1827
1981
|
# the entire request, including partition keys. Each shard can support
|
@@ -1902,9 +2056,12 @@ module Aws::Kinesis
|
|
1902
2056
|
# @option params [required, Array<Types::PutRecordsRequestEntry>] :records
|
1903
2057
|
# The records associated with the request.
|
1904
2058
|
#
|
1905
|
-
# @option params [
|
2059
|
+
# @option params [String] :stream_name
|
1906
2060
|
# The stream name associated with the request.
|
1907
2061
|
#
|
2062
|
+
# @option params [String] :stream_arn
|
2063
|
+
# The ARN of the stream.
|
2064
|
+
#
|
1908
2065
|
# @return [Types::PutRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1909
2066
|
#
|
1910
2067
|
# * {Types::PutRecordsOutput#failed_record_count #failed_record_count} => Integer
|
@@ -1921,7 +2078,8 @@ module Aws::Kinesis
|
|
1921
2078
|
# partition_key: "PartitionKey", # required
|
1922
2079
|
# },
|
1923
2080
|
# ],
|
1924
|
-
# stream_name: "StreamName",
|
2081
|
+
# stream_name: "StreamName",
|
2082
|
+
# stream_arn: "StreamARN",
|
1925
2083
|
# })
|
1926
2084
|
#
|
1927
2085
|
# @example Response structure
|
@@ -2008,24 +2166,33 @@ module Aws::Kinesis
|
|
2008
2166
|
# deleted and cannot be recovered after this operation successfully
|
2009
2167
|
# completes.
|
2010
2168
|
#
|
2169
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
2170
|
+
# input parameter rather than the `StreamName` input parameter.
|
2171
|
+
#
|
2172
|
+
# </note>
|
2173
|
+
#
|
2011
2174
|
# If you specify a tag that does not exist, it is ignored.
|
2012
2175
|
#
|
2013
2176
|
# RemoveTagsFromStream has a limit of five transactions per second per
|
2014
2177
|
# account.
|
2015
2178
|
#
|
2016
|
-
# @option params [
|
2179
|
+
# @option params [String] :stream_name
|
2017
2180
|
# The name of the stream.
|
2018
2181
|
#
|
2019
2182
|
# @option params [required, Array<String>] :tag_keys
|
2020
2183
|
# A list of tag keys. Each corresponding tag is removed from the stream.
|
2021
2184
|
#
|
2185
|
+
# @option params [String] :stream_arn
|
2186
|
+
# The ARN of the stream.
|
2187
|
+
#
|
2022
2188
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2023
2189
|
#
|
2024
2190
|
# @example Request syntax with placeholder values
|
2025
2191
|
#
|
2026
2192
|
# resp = client.remove_tags_from_stream({
|
2027
|
-
# stream_name: "StreamName",
|
2193
|
+
# stream_name: "StreamName",
|
2028
2194
|
# tag_keys: ["TagKey"], # required
|
2195
|
+
# stream_arn: "StreamARN",
|
2029
2196
|
# })
|
2030
2197
|
#
|
2031
2198
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/RemoveTagsFromStream AWS API Documentation
|
@@ -2041,7 +2208,13 @@ module Aws::Kinesis
|
|
2041
2208
|
# increase the stream's capacity to ingest and transport data.
|
2042
2209
|
# `SplitShard` is called when there is a need to increase the overall
|
2043
2210
|
# capacity of a stream because of an expected increase in the volume of
|
2044
|
-
# data records being ingested.
|
2211
|
+
# data records being ingested. This API is only supported for the data
|
2212
|
+
# streams with the provisioned capacity mode.
|
2213
|
+
#
|
2214
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
2215
|
+
# input parameter rather than the `StreamName` input parameter.
|
2216
|
+
#
|
2217
|
+
# </note>
|
2045
2218
|
#
|
2046
2219
|
# You can also use `SplitShard` when a shard appears to be approaching
|
2047
2220
|
# its maximum utilization; for example, the producers sending data into
|
@@ -2095,7 +2268,7 @@ module Aws::Kinesis
|
|
2095
2268
|
# [2]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
2096
2269
|
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
2097
2270
|
#
|
2098
|
-
# @option params [
|
2271
|
+
# @option params [String] :stream_name
|
2099
2272
|
# The name of the stream for the shard split.
|
2100
2273
|
#
|
2101
2274
|
# @option params [required, String] :shard_to_split
|
@@ -2111,14 +2284,18 @@ module Aws::Kinesis
|
|
2111
2284
|
# shards. All the lower hash key values in the range are distributed to
|
2112
2285
|
# the other child shard.
|
2113
2286
|
#
|
2287
|
+
# @option params [String] :stream_arn
|
2288
|
+
# The ARN of the stream.
|
2289
|
+
#
|
2114
2290
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2115
2291
|
#
|
2116
2292
|
# @example Request syntax with placeholder values
|
2117
2293
|
#
|
2118
2294
|
# resp = client.split_shard({
|
2119
|
-
# stream_name: "StreamName",
|
2295
|
+
# stream_name: "StreamName",
|
2120
2296
|
# shard_to_split: "ShardId", # required
|
2121
2297
|
# new_starting_hash_key: "HashKey", # required
|
2298
|
+
# stream_arn: "StreamARN",
|
2122
2299
|
# })
|
2123
2300
|
#
|
2124
2301
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SplitShard AWS API Documentation
|
@@ -2150,7 +2327,12 @@ module Aws::Kinesis
|
|
2150
2327
|
# you enable encryption, you can verify that encryption is applied by
|
2151
2328
|
# inspecting the API response from `PutRecord` or `PutRecords`.
|
2152
2329
|
#
|
2153
|
-
#
|
2330
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
2331
|
+
# input parameter rather than the `StreamName` input parameter.
|
2332
|
+
#
|
2333
|
+
# </note>
|
2334
|
+
#
|
2335
|
+
# @option params [String] :stream_name
|
2154
2336
|
# The name of the stream for which to start encrypting records.
|
2155
2337
|
#
|
2156
2338
|
# @option params [required, String] :encryption_type
|
@@ -2177,14 +2359,18 @@ module Aws::Kinesis
|
|
2177
2359
|
#
|
2178
2360
|
# * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
|
2179
2361
|
#
|
2362
|
+
# @option params [String] :stream_arn
|
2363
|
+
# The ARN of the stream.
|
2364
|
+
#
|
2180
2365
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2181
2366
|
#
|
2182
2367
|
# @example Request syntax with placeholder values
|
2183
2368
|
#
|
2184
2369
|
# resp = client.start_stream_encryption({
|
2185
|
-
# stream_name: "StreamName",
|
2370
|
+
# stream_name: "StreamName",
|
2186
2371
|
# encryption_type: "NONE", # required, accepts NONE, KMS
|
2187
2372
|
# key_id: "KeyId", # required
|
2373
|
+
# stream_arn: "StreamARN",
|
2188
2374
|
# })
|
2189
2375
|
#
|
2190
2376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartStreamEncryption AWS API Documentation
|
@@ -2198,6 +2384,11 @@ module Aws::Kinesis
|
|
2198
2384
|
|
2199
2385
|
# Disables server-side encryption for a specified stream.
|
2200
2386
|
#
|
2387
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
2388
|
+
# input parameter rather than the `StreamName` input parameter.
|
2389
|
+
#
|
2390
|
+
# </note>
|
2391
|
+
#
|
2201
2392
|
# Stopping encryption is an asynchronous operation. Upon receiving the
|
2202
2393
|
# request, Kinesis Data Streams returns immediately and sets the status
|
2203
2394
|
# of the stream to `UPDATING`. After the update is complete, Kinesis
|
@@ -2217,7 +2408,7 @@ module Aws::Kinesis
|
|
2217
2408
|
# encryption is not applied by inspecting the API response from
|
2218
2409
|
# `PutRecord` or `PutRecords`.
|
2219
2410
|
#
|
2220
|
-
# @option params [
|
2411
|
+
# @option params [String] :stream_name
|
2221
2412
|
# The name of the stream on which to stop encrypting records.
|
2222
2413
|
#
|
2223
2414
|
# @option params [required, String] :encryption_type
|
@@ -2244,14 +2435,18 @@ module Aws::Kinesis
|
|
2244
2435
|
#
|
2245
2436
|
# * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
|
2246
2437
|
#
|
2438
|
+
# @option params [String] :stream_arn
|
2439
|
+
# The ARN of the stream.
|
2440
|
+
#
|
2247
2441
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2248
2442
|
#
|
2249
2443
|
# @example Request syntax with placeholder values
|
2250
2444
|
#
|
2251
2445
|
# resp = client.stop_stream_encryption({
|
2252
|
-
# stream_name: "StreamName",
|
2446
|
+
# stream_name: "StreamName",
|
2253
2447
|
# encryption_type: "NONE", # required, accepts NONE, KMS
|
2254
2448
|
# key_id: "KeyId", # required
|
2449
|
+
# stream_arn: "StreamARN",
|
2255
2450
|
# })
|
2256
2451
|
#
|
2257
2452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StopStreamEncryption AWS API Documentation
|
@@ -2264,7 +2459,13 @@ module Aws::Kinesis
|
|
2264
2459
|
end
|
2265
2460
|
|
2266
2461
|
# Updates the shard count of the specified stream to the specified
|
2267
|
-
# number of shards.
|
2462
|
+
# number of shards. This API is only supported for the data streams with
|
2463
|
+
# the provisioned capacity mode.
|
2464
|
+
#
|
2465
|
+
# <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
|
2466
|
+
# input parameter rather than the `StreamName` input parameter.
|
2467
|
+
#
|
2468
|
+
# </note>
|
2268
2469
|
#
|
2269
2470
|
# Updating the shard count is an asynchronous operation. Upon receiving
|
2270
2471
|
# the request, Kinesis Data Streams returns immediately and sets the
|
@@ -2311,7 +2512,7 @@ module Aws::Kinesis
|
|
2311
2512
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
2312
2513
|
# [2]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis
|
2313
2514
|
#
|
2314
|
-
# @option params [
|
2515
|
+
# @option params [String] :stream_name
|
2315
2516
|
# The name of the stream.
|
2316
2517
|
#
|
2317
2518
|
# @option params [required, Integer] :target_shard_count
|
@@ -2333,18 +2534,23 @@ module Aws::Kinesis
|
|
2333
2534
|
# @option params [required, String] :scaling_type
|
2334
2535
|
# The scaling type. Uniform scaling creates shards of equal size.
|
2335
2536
|
#
|
2537
|
+
# @option params [String] :stream_arn
|
2538
|
+
# The ARN of the stream.
|
2539
|
+
#
|
2336
2540
|
# @return [Types::UpdateShardCountOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2337
2541
|
#
|
2338
2542
|
# * {Types::UpdateShardCountOutput#stream_name #stream_name} => String
|
2339
2543
|
# * {Types::UpdateShardCountOutput#current_shard_count #current_shard_count} => Integer
|
2340
2544
|
# * {Types::UpdateShardCountOutput#target_shard_count #target_shard_count} => Integer
|
2545
|
+
# * {Types::UpdateShardCountOutput#stream_arn #stream_arn} => String
|
2341
2546
|
#
|
2342
2547
|
# @example Request syntax with placeholder values
|
2343
2548
|
#
|
2344
2549
|
# resp = client.update_shard_count({
|
2345
|
-
# stream_name: "StreamName",
|
2550
|
+
# stream_name: "StreamName",
|
2346
2551
|
# target_shard_count: 1, # required
|
2347
2552
|
# scaling_type: "UNIFORM_SCALING", # required, accepts UNIFORM_SCALING
|
2553
|
+
# stream_arn: "StreamARN",
|
2348
2554
|
# })
|
2349
2555
|
#
|
2350
2556
|
# @example Response structure
|
@@ -2352,6 +2558,7 @@ module Aws::Kinesis
|
|
2352
2558
|
# resp.stream_name #=> String
|
2353
2559
|
# resp.current_shard_count #=> Integer
|
2354
2560
|
# resp.target_shard_count #=> Integer
|
2561
|
+
# resp.stream_arn #=> String
|
2355
2562
|
#
|
2356
2563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateShardCount AWS API Documentation
|
2357
2564
|
#
|
@@ -2409,7 +2616,7 @@ module Aws::Kinesis
|
|
2409
2616
|
params: params,
|
2410
2617
|
config: config)
|
2411
2618
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2412
|
-
context[:gem_version] = '1.
|
2619
|
+
context[:gem_version] = '1.44.0'
|
2413
2620
|
Seahorse::Client::Request.new(handlers, context)
|
2414
2621
|
end
|
2415
2622
|
|