aws-sdk-kinesis 1.41.0 → 1.43.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesis/async_client.rb +21 -4
- data/lib/aws-sdk-kinesis/client.rb +279 -55
- data/lib/aws-sdk-kinesis/client_api.rb +93 -27
- data/lib/aws-sdk-kinesis/endpoint_parameters.rb +93 -0
- data/lib/aws-sdk-kinesis/endpoint_provider.rb +326 -0
- data/lib/aws-sdk-kinesis/endpoints.rb +508 -0
- data/lib/aws-sdk-kinesis/errors.rb +16 -0
- data/lib/aws-sdk-kinesis/plugins/endpoints.rb +126 -0
- data/lib/aws-sdk-kinesis/types.rb +200 -323
- data/lib/aws-sdk-kinesis.rb +5 -1
- metadata +8 -4
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
35
35
|
require 'aws-sdk-core/plugins/event_stream_configuration.rb'
|
36
36
|
|
@@ -80,9 +80,10 @@ module Aws::Kinesis
|
|
80
80
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
81
81
|
add_plugin(Aws::Plugins::DefaultsMode)
|
82
82
|
add_plugin(Aws::Plugins::RecursionDetection)
|
83
|
-
add_plugin(Aws::Plugins::
|
83
|
+
add_plugin(Aws::Plugins::Sign)
|
84
84
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
85
85
|
add_plugin(Aws::Plugins::EventStreamConfiguration)
|
86
|
+
add_plugin(Aws::Kinesis::Plugins::Endpoints)
|
86
87
|
|
87
88
|
# @overload initialize(options)
|
88
89
|
# @param [Hash] options
|
@@ -308,6 +309,19 @@ module Aws::Kinesis
|
|
308
309
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
309
310
|
# requests are made, and retries are disabled.
|
310
311
|
#
|
312
|
+
# @option options [Aws::TokenProvider] :token_provider
|
313
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
314
|
+
# following classes:
|
315
|
+
#
|
316
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
317
|
+
# tokens.
|
318
|
+
#
|
319
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
320
|
+
# access token generated from `aws login`.
|
321
|
+
#
|
322
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
323
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
324
|
+
#
|
311
325
|
# @option options [Boolean] :use_dualstack_endpoint
|
312
326
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
313
327
|
# will be used if available.
|
@@ -321,6 +335,9 @@ module Aws::Kinesis
|
|
321
335
|
# When `true`, request parameters are validated before
|
322
336
|
# sending the request.
|
323
337
|
#
|
338
|
+
# @option options [Aws::Kinesis::EndpointProvider] :endpoint_provider
|
339
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Kinesis::EndpointParameters`
|
340
|
+
#
|
324
341
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
325
342
|
# requests through. Formatted like 'http://proxy.com:123'.
|
326
343
|
#
|
@@ -375,6 +392,11 @@ module Aws::Kinesis
|
|
375
392
|
# Adds or updates tags for the specified Kinesis data stream. You can
|
376
393
|
# assign up to 50 tags to a data stream.
|
377
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
|
+
#
|
378
400
|
# If tags have already been assigned to the stream, `AddTagsToStream`
|
379
401
|
# overwrites any existing tags that correspond to the specified tag
|
380
402
|
# keys.
|
@@ -382,21 +404,25 @@ module Aws::Kinesis
|
|
382
404
|
# AddTagsToStream has a limit of five transactions per second per
|
383
405
|
# account.
|
384
406
|
#
|
385
|
-
# @option params [
|
407
|
+
# @option params [String] :stream_name
|
386
408
|
# The name of the stream.
|
387
409
|
#
|
388
410
|
# @option params [required, Hash<String,String>] :tags
|
389
411
|
# A set of up to 10 key-value pairs to use to create the tags.
|
390
412
|
#
|
413
|
+
# @option params [String] :stream_arn
|
414
|
+
# The ARN of the stream.
|
415
|
+
#
|
391
416
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
392
417
|
#
|
393
418
|
# @example Request syntax with placeholder values
|
394
419
|
#
|
395
420
|
# resp = client.add_tags_to_stream({
|
396
|
-
# stream_name: "StreamName",
|
421
|
+
# stream_name: "StreamName",
|
397
422
|
# tags: { # required
|
398
423
|
# "TagKey" => "TagValue",
|
399
424
|
# },
|
425
|
+
# stream_arn: "StreamARN",
|
400
426
|
# })
|
401
427
|
#
|
402
428
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/AddTagsToStream AWS API Documentation
|
@@ -414,12 +440,18 @@ module Aws::Kinesis
|
|
414
440
|
# means of shards, which are uniquely identified groups of data records
|
415
441
|
# in a stream.
|
416
442
|
#
|
417
|
-
# You
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
#
|
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.
|
423
455
|
#
|
424
456
|
# The stream name identifies the stream. The name is scoped to the
|
425
457
|
# Amazon Web Services account used by the application. It is also scoped
|
@@ -499,24 +531,33 @@ module Aws::Kinesis
|
|
499
531
|
# length of time data records are accessible after they are added to the
|
500
532
|
# stream. The minimum value of a stream's retention period is 24 hours.
|
501
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
|
+
#
|
502
539
|
# This operation may result in lost data. For example, if the stream's
|
503
540
|
# retention period is 48 hours and is decreased to 24 hours, any data
|
504
541
|
# already in the stream that is older than 24 hours is inaccessible.
|
505
542
|
#
|
506
|
-
# @option params [
|
543
|
+
# @option params [String] :stream_name
|
507
544
|
# The name of the stream to modify.
|
508
545
|
#
|
509
546
|
# @option params [required, Integer] :retention_period_hours
|
510
547
|
# The new retention period of the stream, in hours. Must be less than
|
511
548
|
# the current retention period.
|
512
549
|
#
|
550
|
+
# @option params [String] :stream_arn
|
551
|
+
# The ARN of the stream.
|
552
|
+
#
|
513
553
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
514
554
|
#
|
515
555
|
# @example Request syntax with placeholder values
|
516
556
|
#
|
517
557
|
# resp = client.decrease_stream_retention_period({
|
518
|
-
# stream_name: "StreamName",
|
558
|
+
# stream_name: "StreamName",
|
519
559
|
# retention_period_hours: 1, # required
|
560
|
+
# stream_arn: "StreamARN",
|
520
561
|
# })
|
521
562
|
#
|
522
563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DecreaseStreamRetentionPeriod AWS API Documentation
|
@@ -533,6 +574,11 @@ module Aws::Kinesis
|
|
533
574
|
# delete the stream. If an application attempts to operate on a deleted
|
534
575
|
# stream, it receives the exception `ResourceNotFoundException`.
|
535
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
|
+
#
|
536
582
|
# If the stream is in the `ACTIVE` state, you can delete it. After a
|
537
583
|
# `DeleteStream` request, the specified stream is in the `DELETING`
|
538
584
|
# state until Kinesis Data Streams completes the deletion.
|
@@ -549,7 +595,7 @@ module Aws::Kinesis
|
|
549
595
|
#
|
550
596
|
# DeleteStream has a limit of five transactions per second per account.
|
551
597
|
#
|
552
|
-
# @option params [
|
598
|
+
# @option params [String] :stream_name
|
553
599
|
# The name of the stream to delete.
|
554
600
|
#
|
555
601
|
# @option params [Boolean] :enforce_consumer_deletion
|
@@ -557,13 +603,17 @@ module Aws::Kinesis
|
|
557
603
|
# the stream has registered consumers, the call to `DeleteStream` fails
|
558
604
|
# with a `ResourceInUseException`.
|
559
605
|
#
|
606
|
+
# @option params [String] :stream_arn
|
607
|
+
# The ARN of the stream.
|
608
|
+
#
|
560
609
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
561
610
|
#
|
562
611
|
# @example Request syntax with placeholder values
|
563
612
|
#
|
564
613
|
# resp = client.delete_stream({
|
565
|
-
# stream_name: "StreamName",
|
614
|
+
# stream_name: "StreamName",
|
566
615
|
# enforce_consumer_deletion: false,
|
616
|
+
# stream_arn: "StreamARN",
|
567
617
|
# })
|
568
618
|
#
|
569
619
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DeleteStream AWS API Documentation
|
@@ -665,6 +715,11 @@ module Aws::Kinesis
|
|
665
715
|
#
|
666
716
|
# </note>
|
667
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
|
+
#
|
668
723
|
# The information returned includes the stream name, Amazon Resource
|
669
724
|
# Name (ARN), creation time, enhanced metric configuration, and shard
|
670
725
|
# map. The shard map is an array of shard objects. For each shard
|
@@ -688,7 +743,7 @@ module Aws::Kinesis
|
|
688
743
|
#
|
689
744
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
|
690
745
|
#
|
691
|
-
# @option params [
|
746
|
+
# @option params [String] :stream_name
|
692
747
|
# The name of the stream to describe.
|
693
748
|
#
|
694
749
|
# @option params [Integer] :limit
|
@@ -707,6 +762,9 @@ module Aws::Kinesis
|
|
707
762
|
# `DescribeStream` is to describe the stream starting with the first
|
708
763
|
# shard in the stream.
|
709
764
|
#
|
765
|
+
# @option params [String] :stream_arn
|
766
|
+
# The ARN of the stream.
|
767
|
+
#
|
710
768
|
# @return [Types::DescribeStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
711
769
|
#
|
712
770
|
# * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
|
@@ -716,9 +774,10 @@ module Aws::Kinesis
|
|
716
774
|
# @example Request syntax with placeholder values
|
717
775
|
#
|
718
776
|
# resp = client.describe_stream({
|
719
|
-
# stream_name: "StreamName",
|
777
|
+
# stream_name: "StreamName",
|
720
778
|
# limit: 1,
|
721
779
|
# exclusive_start_shard_id: "ShardId",
|
780
|
+
# stream_arn: "StreamARN",
|
722
781
|
# })
|
723
782
|
#
|
724
783
|
# @example Response structure
|
@@ -818,6 +877,11 @@ module Aws::Kinesis
|
|
818
877
|
# Provides a summarized description of the specified Kinesis data stream
|
819
878
|
# without the shard list.
|
820
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
|
+
#
|
821
885
|
# The information returned includes the stream name, Amazon Resource
|
822
886
|
# Name (ARN), status, record retention period, approximate creation
|
823
887
|
# time, monitoring, encryption details, and open shard count.
|
@@ -825,9 +889,12 @@ module Aws::Kinesis
|
|
825
889
|
# DescribeStreamSummary has a limit of 20 transactions per second per
|
826
890
|
# account.
|
827
891
|
#
|
828
|
-
# @option params [
|
892
|
+
# @option params [String] :stream_name
|
829
893
|
# The name of the stream to describe.
|
830
894
|
#
|
895
|
+
# @option params [String] :stream_arn
|
896
|
+
# The ARN of the stream.
|
897
|
+
#
|
831
898
|
# @return [Types::DescribeStreamSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
832
899
|
#
|
833
900
|
# * {Types::DescribeStreamSummaryOutput#stream_description_summary #stream_description_summary} => Types::StreamDescriptionSummary
|
@@ -835,7 +902,8 @@ module Aws::Kinesis
|
|
835
902
|
# @example Request syntax with placeholder values
|
836
903
|
#
|
837
904
|
# resp = client.describe_stream_summary({
|
838
|
-
# stream_name: "StreamName",
|
905
|
+
# stream_name: "StreamName",
|
906
|
+
# stream_arn: "StreamARN",
|
839
907
|
# })
|
840
908
|
#
|
841
909
|
# @example Response structure
|
@@ -865,7 +933,12 @@ module Aws::Kinesis
|
|
865
933
|
|
866
934
|
# Disables enhanced monitoring.
|
867
935
|
#
|
868
|
-
#
|
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
|
869
942
|
# The name of the Kinesis data stream for which to disable enhanced
|
870
943
|
# monitoring.
|
871
944
|
#
|
@@ -899,17 +972,22 @@ module Aws::Kinesis
|
|
899
972
|
#
|
900
973
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
901
974
|
#
|
975
|
+
# @option params [String] :stream_arn
|
976
|
+
# The ARN of the stream.
|
977
|
+
#
|
902
978
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
903
979
|
#
|
904
980
|
# * {Types::EnhancedMonitoringOutput#stream_name #stream_name} => String
|
905
981
|
# * {Types::EnhancedMonitoringOutput#current_shard_level_metrics #current_shard_level_metrics} => Array<String>
|
906
982
|
# * {Types::EnhancedMonitoringOutput#desired_shard_level_metrics #desired_shard_level_metrics} => Array<String>
|
983
|
+
# * {Types::EnhancedMonitoringOutput#stream_arn #stream_arn} => String
|
907
984
|
#
|
908
985
|
# @example Request syntax with placeholder values
|
909
986
|
#
|
910
987
|
# resp = client.disable_enhanced_monitoring({
|
911
|
-
# stream_name: "StreamName",
|
988
|
+
# stream_name: "StreamName",
|
912
989
|
# shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
|
990
|
+
# stream_arn: "StreamARN",
|
913
991
|
# })
|
914
992
|
#
|
915
993
|
# @example Response structure
|
@@ -919,6 +997,7 @@ module Aws::Kinesis
|
|
919
997
|
# resp.current_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
|
920
998
|
# resp.desired_shard_level_metrics #=> Array
|
921
999
|
# resp.desired_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
|
1000
|
+
# resp.stream_arn #=> String
|
922
1001
|
#
|
923
1002
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DisableEnhancedMonitoring AWS API Documentation
|
924
1003
|
#
|
@@ -932,7 +1011,12 @@ module Aws::Kinesis
|
|
932
1011
|
# Enables enhanced Kinesis data stream monitoring for shard-level
|
933
1012
|
# metrics.
|
934
1013
|
#
|
935
|
-
#
|
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
|
936
1020
|
# The name of the stream for which to enable enhanced monitoring.
|
937
1021
|
#
|
938
1022
|
# @option params [required, Array<String>] :shard_level_metrics
|
@@ -965,17 +1049,22 @@ module Aws::Kinesis
|
|
965
1049
|
#
|
966
1050
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
|
967
1051
|
#
|
1052
|
+
# @option params [String] :stream_arn
|
1053
|
+
# The ARN of the stream.
|
1054
|
+
#
|
968
1055
|
# @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
969
1056
|
#
|
970
1057
|
# * {Types::EnhancedMonitoringOutput#stream_name #stream_name} => String
|
971
1058
|
# * {Types::EnhancedMonitoringOutput#current_shard_level_metrics #current_shard_level_metrics} => Array<String>
|
972
1059
|
# * {Types::EnhancedMonitoringOutput#desired_shard_level_metrics #desired_shard_level_metrics} => Array<String>
|
1060
|
+
# * {Types::EnhancedMonitoringOutput#stream_arn #stream_arn} => String
|
973
1061
|
#
|
974
1062
|
# @example Request syntax with placeholder values
|
975
1063
|
#
|
976
1064
|
# resp = client.enable_enhanced_monitoring({
|
977
|
-
# stream_name: "StreamName",
|
1065
|
+
# stream_name: "StreamName",
|
978
1066
|
# shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
|
1067
|
+
# stream_arn: "StreamARN",
|
979
1068
|
# })
|
980
1069
|
#
|
981
1070
|
# @example Response structure
|
@@ -985,6 +1074,7 @@ module Aws::Kinesis
|
|
985
1074
|
# resp.current_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
|
986
1075
|
# resp.desired_shard_level_metrics #=> Array
|
987
1076
|
# resp.desired_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
|
1077
|
+
# resp.stream_arn #=> String
|
988
1078
|
#
|
989
1079
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnableEnhancedMonitoring AWS API Documentation
|
990
1080
|
#
|
@@ -997,6 +1087,11 @@ module Aws::Kinesis
|
|
997
1087
|
|
998
1088
|
# Gets data records from a Kinesis data stream's shard.
|
999
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
|
+
#
|
1000
1095
|
# Specify a shard iterator using the `ShardIterator` parameter. The
|
1001
1096
|
# shard iterator specifies the position in the shard from which you want
|
1002
1097
|
# to start reading data records sequentially. If there are no records
|
@@ -1074,6 +1169,9 @@ module Aws::Kinesis
|
|
1074
1169
|
# 10,000. If you specify a value that is greater than 10,000, GetRecords
|
1075
1170
|
# throws `InvalidArgumentException`. The default value is 10,000.
|
1076
1171
|
#
|
1172
|
+
# @option params [String] :stream_arn
|
1173
|
+
# The ARN of the stream.
|
1174
|
+
#
|
1077
1175
|
# @return [Types::GetRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1078
1176
|
#
|
1079
1177
|
# * {Types::GetRecordsOutput#records #records} => Array<Types::Record>
|
@@ -1086,6 +1184,7 @@ module Aws::Kinesis
|
|
1086
1184
|
# resp = client.get_records({
|
1087
1185
|
# shard_iterator: "ShardIterator", # required
|
1088
1186
|
# limit: 1,
|
1187
|
+
# stream_arn: "StreamARN",
|
1089
1188
|
# })
|
1090
1189
|
#
|
1091
1190
|
# @example Response structure
|
@@ -1117,6 +1216,11 @@ module Aws::Kinesis
|
|
1117
1216
|
# Gets an Amazon Kinesis shard iterator. A shard iterator expires 5
|
1118
1217
|
# minutes after it is returned to the requester.
|
1119
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
|
+
#
|
1120
1224
|
# A shard iterator specifies the shard position from which to start
|
1121
1225
|
# reading data records sequentially. The position is specified using the
|
1122
1226
|
# sequence number of a data record in a shard. A sequence number is the
|
@@ -1161,7 +1265,7 @@ module Aws::Kinesis
|
|
1161
1265
|
#
|
1162
1266
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
1163
1267
|
#
|
1164
|
-
# @option params [
|
1268
|
+
# @option params [String] :stream_name
|
1165
1269
|
# The name of the Amazon Kinesis data stream.
|
1166
1270
|
#
|
1167
1271
|
# @option params [required, String] :shard_id
|
@@ -1206,6 +1310,9 @@ module Aws::Kinesis
|
|
1206
1310
|
# horizon, the iterator returned is for the oldest untrimmed data record
|
1207
1311
|
# (TRIM\_HORIZON).
|
1208
1312
|
#
|
1313
|
+
# @option params [String] :stream_arn
|
1314
|
+
# The ARN of the stream.
|
1315
|
+
#
|
1209
1316
|
# @return [Types::GetShardIteratorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1210
1317
|
#
|
1211
1318
|
# * {Types::GetShardIteratorOutput#shard_iterator #shard_iterator} => String
|
@@ -1213,11 +1320,12 @@ module Aws::Kinesis
|
|
1213
1320
|
# @example Request syntax with placeholder values
|
1214
1321
|
#
|
1215
1322
|
# resp = client.get_shard_iterator({
|
1216
|
-
# stream_name: "StreamName",
|
1323
|
+
# stream_name: "StreamName",
|
1217
1324
|
# shard_id: "ShardId", # required
|
1218
1325
|
# shard_iterator_type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
|
1219
1326
|
# starting_sequence_number: "SequenceNumber",
|
1220
1327
|
# timestamp: Time.now,
|
1328
|
+
# stream_arn: "StreamARN",
|
1221
1329
|
# })
|
1222
1330
|
#
|
1223
1331
|
# @example Response structure
|
@@ -1238,6 +1346,11 @@ module Aws::Kinesis
|
|
1238
1346
|
# stream. The maximum value of a stream's retention period is 8760
|
1239
1347
|
# hours (365 days).
|
1240
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
|
+
#
|
1241
1354
|
# If you choose a longer stream retention period, this operation
|
1242
1355
|
# increases the time period during which records that have not yet
|
1243
1356
|
# expired are accessible. However, it does not make previous, expired
|
@@ -1247,20 +1360,24 @@ module Aws::Kinesis
|
|
1247
1360
|
# data that is older than 24 hours remains inaccessible to consumer
|
1248
1361
|
# applications.
|
1249
1362
|
#
|
1250
|
-
# @option params [
|
1363
|
+
# @option params [String] :stream_name
|
1251
1364
|
# The name of the stream to modify.
|
1252
1365
|
#
|
1253
1366
|
# @option params [required, Integer] :retention_period_hours
|
1254
1367
|
# The new retention period of the stream, in hours. Must be more than
|
1255
1368
|
# the current retention period.
|
1256
1369
|
#
|
1370
|
+
# @option params [String] :stream_arn
|
1371
|
+
# The ARN of the stream.
|
1372
|
+
#
|
1257
1373
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1258
1374
|
#
|
1259
1375
|
# @example Request syntax with placeholder values
|
1260
1376
|
#
|
1261
1377
|
# resp = client.increase_stream_retention_period({
|
1262
|
-
# stream_name: "StreamName",
|
1378
|
+
# stream_name: "StreamName",
|
1263
1379
|
# retention_period_hours: 1, # required
|
1380
|
+
# stream_arn: "StreamARN",
|
1264
1381
|
# })
|
1265
1382
|
#
|
1266
1383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/IncreaseStreamRetentionPeriod AWS API Documentation
|
@@ -1276,6 +1393,11 @@ module Aws::Kinesis
|
|
1276
1393
|
# shard. This operation has a limit of 1000 transactions per second per
|
1277
1394
|
# data stream.
|
1278
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
|
+
#
|
1279
1401
|
# This action does not list expired shards. For information about
|
1280
1402
|
# expired shards, see [Data Routing, Data Persistence, and Shard State
|
1281
1403
|
# after a Reshard][1].
|
@@ -1377,6 +1499,9 @@ module Aws::Kinesis
|
|
1377
1499
|
# FROM\_TIMESTAMP type, then all shards starting from the provided
|
1378
1500
|
# timestamp to TIP are returned.
|
1379
1501
|
#
|
1502
|
+
# @option params [String] :stream_arn
|
1503
|
+
# The ARN of the stream.
|
1504
|
+
#
|
1380
1505
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1381
1506
|
#
|
1382
1507
|
# * {Types::ListShardsOutput#shards #shards} => Array<Types::Shard>
|
@@ -1395,6 +1520,7 @@ module Aws::Kinesis
|
|
1395
1520
|
# shard_id: "ShardId",
|
1396
1521
|
# timestamp: Time.now,
|
1397
1522
|
# },
|
1523
|
+
# stream_arn: "StreamARN",
|
1398
1524
|
# })
|
1399
1525
|
#
|
1400
1526
|
# @example Response structure
|
@@ -1534,10 +1660,14 @@ module Aws::Kinesis
|
|
1534
1660
|
# @option params [String] :exclusive_start_stream_name
|
1535
1661
|
# The name of the stream to start the list with.
|
1536
1662
|
#
|
1663
|
+
# @option params [String] :next_token
|
1664
|
+
#
|
1537
1665
|
# @return [Types::ListStreamsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1538
1666
|
#
|
1539
1667
|
# * {Types::ListStreamsOutput#stream_names #stream_names} => Array<String>
|
1540
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>
|
1541
1671
|
#
|
1542
1672
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1543
1673
|
#
|
@@ -1546,6 +1676,7 @@ module Aws::Kinesis
|
|
1546
1676
|
# resp = client.list_streams({
|
1547
1677
|
# limit: 1,
|
1548
1678
|
# exclusive_start_stream_name: "StreamName",
|
1679
|
+
# next_token: "NextToken",
|
1549
1680
|
# })
|
1550
1681
|
#
|
1551
1682
|
# @example Response structure
|
@@ -1553,6 +1684,13 @@ module Aws::Kinesis
|
|
1553
1684
|
# resp.stream_names #=> Array
|
1554
1685
|
# resp.stream_names[0] #=> String
|
1555
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
|
1556
1694
|
#
|
1557
1695
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListStreams AWS API Documentation
|
1558
1696
|
#
|
@@ -1566,7 +1704,12 @@ module Aws::Kinesis
|
|
1566
1704
|
# Lists the tags for the specified Kinesis data stream. This operation
|
1567
1705
|
# has a limit of five transactions per second per account.
|
1568
1706
|
#
|
1569
|
-
#
|
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
|
1570
1713
|
# The name of the stream.
|
1571
1714
|
#
|
1572
1715
|
# @option params [String] :exclusive_start_tag_key
|
@@ -1580,6 +1723,9 @@ module Aws::Kinesis
|
|
1580
1723
|
# `true`. To list additional tags, set `ExclusiveStartTagKey` to the
|
1581
1724
|
# last key in the response.
|
1582
1725
|
#
|
1726
|
+
# @option params [String] :stream_arn
|
1727
|
+
# The ARN of the stream.
|
1728
|
+
#
|
1583
1729
|
# @return [Types::ListTagsForStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1584
1730
|
#
|
1585
1731
|
# * {Types::ListTagsForStreamOutput#tags #tags} => Array<Types::Tag>
|
@@ -1588,9 +1734,10 @@ module Aws::Kinesis
|
|
1588
1734
|
# @example Request syntax with placeholder values
|
1589
1735
|
#
|
1590
1736
|
# resp = client.list_tags_for_stream({
|
1591
|
-
# stream_name: "StreamName",
|
1737
|
+
# stream_name: "StreamName",
|
1592
1738
|
# exclusive_start_tag_key: "TagKey",
|
1593
1739
|
# limit: 1,
|
1740
|
+
# stream_arn: "StreamARN",
|
1594
1741
|
# })
|
1595
1742
|
#
|
1596
1743
|
# @example Response structure
|
@@ -1611,14 +1758,20 @@ module Aws::Kinesis
|
|
1611
1758
|
|
1612
1759
|
# Merges two adjacent shards in a Kinesis data stream and combines them
|
1613
1760
|
# into a single shard to reduce the stream's capacity to ingest and
|
1614
|
-
# transport data.
|
1615
|
-
#
|
1616
|
-
#
|
1617
|
-
#
|
1618
|
-
#
|
1619
|
-
#
|
1620
|
-
#
|
1621
|
-
#
|
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>
|
1622
1775
|
#
|
1623
1776
|
# `MergeShards` is called when there is a need to reduce the overall
|
1624
1777
|
# capacity of a stream because of excess capacity that is not being
|
@@ -1655,7 +1808,7 @@ module Aws::Kinesis
|
|
1655
1808
|
#
|
1656
1809
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
|
1657
1810
|
#
|
1658
|
-
# @option params [
|
1811
|
+
# @option params [String] :stream_name
|
1659
1812
|
# The name of the stream for the merge.
|
1660
1813
|
#
|
1661
1814
|
# @option params [required, String] :shard_to_merge
|
@@ -1665,14 +1818,18 @@ module Aws::Kinesis
|
|
1665
1818
|
# @option params [required, String] :adjacent_shard_to_merge
|
1666
1819
|
# The shard ID of the adjacent shard for the merge.
|
1667
1820
|
#
|
1821
|
+
# @option params [String] :stream_arn
|
1822
|
+
# The ARN of the stream.
|
1823
|
+
#
|
1668
1824
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1669
1825
|
#
|
1670
1826
|
# @example Request syntax with placeholder values
|
1671
1827
|
#
|
1672
1828
|
# resp = client.merge_shards({
|
1673
|
-
# stream_name: "StreamName",
|
1829
|
+
# stream_name: "StreamName",
|
1674
1830
|
# shard_to_merge: "ShardId", # required
|
1675
1831
|
# adjacent_shard_to_merge: "ShardId", # required
|
1832
|
+
# stream_arn: "StreamARN",
|
1676
1833
|
# })
|
1677
1834
|
#
|
1678
1835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/MergeShards AWS API Documentation
|
@@ -1690,6 +1847,11 @@ module Aws::Kinesis
|
|
1690
1847
|
# writes up to 1,000 records per second, up to a maximum data write
|
1691
1848
|
# total of 1 MiB per second.
|
1692
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
|
+
#
|
1693
1855
|
# You must specify the name of the stream that captures, stores, and
|
1694
1856
|
# transports the data; a partition key; and the data blob itself.
|
1695
1857
|
#
|
@@ -1738,7 +1900,7 @@ module Aws::Kinesis
|
|
1738
1900
|
#
|
1739
1901
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
|
1740
1902
|
#
|
1741
|
-
# @option params [
|
1903
|
+
# @option params [String] :stream_name
|
1742
1904
|
# The name of the stream to put the data record into.
|
1743
1905
|
#
|
1744
1906
|
# @option params [required, String, StringIO, File] :data
|
@@ -1770,6 +1932,9 @@ module Aws::Kinesis
|
|
1770
1932
|
# this parameter is not set, records are coarsely ordered based on
|
1771
1933
|
# arrival time.
|
1772
1934
|
#
|
1935
|
+
# @option params [String] :stream_arn
|
1936
|
+
# The ARN of the stream.
|
1937
|
+
#
|
1773
1938
|
# @return [Types::PutRecordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1774
1939
|
#
|
1775
1940
|
# * {Types::PutRecordOutput#shard_id #shard_id} => String
|
@@ -1779,11 +1944,12 @@ module Aws::Kinesis
|
|
1779
1944
|
# @example Request syntax with placeholder values
|
1780
1945
|
#
|
1781
1946
|
# resp = client.put_record({
|
1782
|
-
# stream_name: "StreamName",
|
1947
|
+
# stream_name: "StreamName",
|
1783
1948
|
# data: "data", # required
|
1784
1949
|
# partition_key: "PartitionKey", # required
|
1785
1950
|
# explicit_hash_key: "HashKey",
|
1786
1951
|
# sequence_number_for_ordering: "SequenceNumber",
|
1952
|
+
# stream_arn: "StreamARN",
|
1787
1953
|
# })
|
1788
1954
|
#
|
1789
1955
|
# @example Response structure
|
@@ -1805,6 +1971,11 @@ module Aws::Kinesis
|
|
1805
1971
|
# call (also referred to as a `PutRecords` request). Use this operation
|
1806
1972
|
# to send data into the stream for data ingestion and processing.
|
1807
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
|
+
#
|
1808
1979
|
# Each `PutRecords` request can support up to 500 records. Each record
|
1809
1980
|
# in the request can be as large as 1 MiB, up to a limit of 5 MiB for
|
1810
1981
|
# the entire request, including partition keys. Each shard can support
|
@@ -1885,9 +2056,12 @@ module Aws::Kinesis
|
|
1885
2056
|
# @option params [required, Array<Types::PutRecordsRequestEntry>] :records
|
1886
2057
|
# The records associated with the request.
|
1887
2058
|
#
|
1888
|
-
# @option params [
|
2059
|
+
# @option params [String] :stream_name
|
1889
2060
|
# The stream name associated with the request.
|
1890
2061
|
#
|
2062
|
+
# @option params [String] :stream_arn
|
2063
|
+
# The ARN of the stream.
|
2064
|
+
#
|
1891
2065
|
# @return [Types::PutRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1892
2066
|
#
|
1893
2067
|
# * {Types::PutRecordsOutput#failed_record_count #failed_record_count} => Integer
|
@@ -1904,7 +2078,8 @@ module Aws::Kinesis
|
|
1904
2078
|
# partition_key: "PartitionKey", # required
|
1905
2079
|
# },
|
1906
2080
|
# ],
|
1907
|
-
# stream_name: "StreamName",
|
2081
|
+
# stream_name: "StreamName",
|
2082
|
+
# stream_arn: "StreamARN",
|
1908
2083
|
# })
|
1909
2084
|
#
|
1910
2085
|
# @example Response structure
|
@@ -1991,24 +2166,33 @@ module Aws::Kinesis
|
|
1991
2166
|
# deleted and cannot be recovered after this operation successfully
|
1992
2167
|
# completes.
|
1993
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
|
+
#
|
1994
2174
|
# If you specify a tag that does not exist, it is ignored.
|
1995
2175
|
#
|
1996
2176
|
# RemoveTagsFromStream has a limit of five transactions per second per
|
1997
2177
|
# account.
|
1998
2178
|
#
|
1999
|
-
# @option params [
|
2179
|
+
# @option params [String] :stream_name
|
2000
2180
|
# The name of the stream.
|
2001
2181
|
#
|
2002
2182
|
# @option params [required, Array<String>] :tag_keys
|
2003
2183
|
# A list of tag keys. Each corresponding tag is removed from the stream.
|
2004
2184
|
#
|
2185
|
+
# @option params [String] :stream_arn
|
2186
|
+
# The ARN of the stream.
|
2187
|
+
#
|
2005
2188
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2006
2189
|
#
|
2007
2190
|
# @example Request syntax with placeholder values
|
2008
2191
|
#
|
2009
2192
|
# resp = client.remove_tags_from_stream({
|
2010
|
-
# stream_name: "StreamName",
|
2193
|
+
# stream_name: "StreamName",
|
2011
2194
|
# tag_keys: ["TagKey"], # required
|
2195
|
+
# stream_arn: "StreamARN",
|
2012
2196
|
# })
|
2013
2197
|
#
|
2014
2198
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/RemoveTagsFromStream AWS API Documentation
|
@@ -2024,7 +2208,13 @@ module Aws::Kinesis
|
|
2024
2208
|
# increase the stream's capacity to ingest and transport data.
|
2025
2209
|
# `SplitShard` is called when there is a need to increase the overall
|
2026
2210
|
# capacity of a stream because of an expected increase in the volume of
|
2027
|
-
# 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>
|
2028
2218
|
#
|
2029
2219
|
# You can also use `SplitShard` when a shard appears to be approaching
|
2030
2220
|
# its maximum utilization; for example, the producers sending data into
|
@@ -2078,7 +2268,7 @@ module Aws::Kinesis
|
|
2078
2268
|
# [2]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
2079
2269
|
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
2080
2270
|
#
|
2081
|
-
# @option params [
|
2271
|
+
# @option params [String] :stream_name
|
2082
2272
|
# The name of the stream for the shard split.
|
2083
2273
|
#
|
2084
2274
|
# @option params [required, String] :shard_to_split
|
@@ -2094,14 +2284,18 @@ module Aws::Kinesis
|
|
2094
2284
|
# shards. All the lower hash key values in the range are distributed to
|
2095
2285
|
# the other child shard.
|
2096
2286
|
#
|
2287
|
+
# @option params [String] :stream_arn
|
2288
|
+
# The ARN of the stream.
|
2289
|
+
#
|
2097
2290
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2098
2291
|
#
|
2099
2292
|
# @example Request syntax with placeholder values
|
2100
2293
|
#
|
2101
2294
|
# resp = client.split_shard({
|
2102
|
-
# stream_name: "StreamName",
|
2295
|
+
# stream_name: "StreamName",
|
2103
2296
|
# shard_to_split: "ShardId", # required
|
2104
2297
|
# new_starting_hash_key: "HashKey", # required
|
2298
|
+
# stream_arn: "StreamARN",
|
2105
2299
|
# })
|
2106
2300
|
#
|
2107
2301
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SplitShard AWS API Documentation
|
@@ -2133,7 +2327,12 @@ module Aws::Kinesis
|
|
2133
2327
|
# you enable encryption, you can verify that encryption is applied by
|
2134
2328
|
# inspecting the API response from `PutRecord` or `PutRecords`.
|
2135
2329
|
#
|
2136
|
-
#
|
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
|
2137
2336
|
# The name of the stream for which to start encrypting records.
|
2138
2337
|
#
|
2139
2338
|
# @option params [required, String] :encryption_type
|
@@ -2160,14 +2359,18 @@ module Aws::Kinesis
|
|
2160
2359
|
#
|
2161
2360
|
# * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
|
2162
2361
|
#
|
2362
|
+
# @option params [String] :stream_arn
|
2363
|
+
# The ARN of the stream.
|
2364
|
+
#
|
2163
2365
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2164
2366
|
#
|
2165
2367
|
# @example Request syntax with placeholder values
|
2166
2368
|
#
|
2167
2369
|
# resp = client.start_stream_encryption({
|
2168
|
-
# stream_name: "StreamName",
|
2370
|
+
# stream_name: "StreamName",
|
2169
2371
|
# encryption_type: "NONE", # required, accepts NONE, KMS
|
2170
2372
|
# key_id: "KeyId", # required
|
2373
|
+
# stream_arn: "StreamARN",
|
2171
2374
|
# })
|
2172
2375
|
#
|
2173
2376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartStreamEncryption AWS API Documentation
|
@@ -2181,6 +2384,11 @@ module Aws::Kinesis
|
|
2181
2384
|
|
2182
2385
|
# Disables server-side encryption for a specified stream.
|
2183
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
|
+
#
|
2184
2392
|
# Stopping encryption is an asynchronous operation. Upon receiving the
|
2185
2393
|
# request, Kinesis Data Streams returns immediately and sets the status
|
2186
2394
|
# of the stream to `UPDATING`. After the update is complete, Kinesis
|
@@ -2200,7 +2408,7 @@ module Aws::Kinesis
|
|
2200
2408
|
# encryption is not applied by inspecting the API response from
|
2201
2409
|
# `PutRecord` or `PutRecords`.
|
2202
2410
|
#
|
2203
|
-
# @option params [
|
2411
|
+
# @option params [String] :stream_name
|
2204
2412
|
# The name of the stream on which to stop encrypting records.
|
2205
2413
|
#
|
2206
2414
|
# @option params [required, String] :encryption_type
|
@@ -2227,14 +2435,18 @@ module Aws::Kinesis
|
|
2227
2435
|
#
|
2228
2436
|
# * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
|
2229
2437
|
#
|
2438
|
+
# @option params [String] :stream_arn
|
2439
|
+
# The ARN of the stream.
|
2440
|
+
#
|
2230
2441
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2231
2442
|
#
|
2232
2443
|
# @example Request syntax with placeholder values
|
2233
2444
|
#
|
2234
2445
|
# resp = client.stop_stream_encryption({
|
2235
|
-
# stream_name: "StreamName",
|
2446
|
+
# stream_name: "StreamName",
|
2236
2447
|
# encryption_type: "NONE", # required, accepts NONE, KMS
|
2237
2448
|
# key_id: "KeyId", # required
|
2449
|
+
# stream_arn: "StreamARN",
|
2238
2450
|
# })
|
2239
2451
|
#
|
2240
2452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StopStreamEncryption AWS API Documentation
|
@@ -2247,7 +2459,13 @@ module Aws::Kinesis
|
|
2247
2459
|
end
|
2248
2460
|
|
2249
2461
|
# Updates the shard count of the specified stream to the specified
|
2250
|
-
# 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>
|
2251
2469
|
#
|
2252
2470
|
# Updating the shard count is an asynchronous operation. Upon receiving
|
2253
2471
|
# the request, Kinesis Data Streams returns immediately and sets the
|
@@ -2294,7 +2512,7 @@ module Aws::Kinesis
|
|
2294
2512
|
# [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
|
2295
2513
|
# [2]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis
|
2296
2514
|
#
|
2297
|
-
# @option params [
|
2515
|
+
# @option params [String] :stream_name
|
2298
2516
|
# The name of the stream.
|
2299
2517
|
#
|
2300
2518
|
# @option params [required, Integer] :target_shard_count
|
@@ -2316,18 +2534,23 @@ module Aws::Kinesis
|
|
2316
2534
|
# @option params [required, String] :scaling_type
|
2317
2535
|
# The scaling type. Uniform scaling creates shards of equal size.
|
2318
2536
|
#
|
2537
|
+
# @option params [String] :stream_arn
|
2538
|
+
# The ARN of the stream.
|
2539
|
+
#
|
2319
2540
|
# @return [Types::UpdateShardCountOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2320
2541
|
#
|
2321
2542
|
# * {Types::UpdateShardCountOutput#stream_name #stream_name} => String
|
2322
2543
|
# * {Types::UpdateShardCountOutput#current_shard_count #current_shard_count} => Integer
|
2323
2544
|
# * {Types::UpdateShardCountOutput#target_shard_count #target_shard_count} => Integer
|
2545
|
+
# * {Types::UpdateShardCountOutput#stream_arn #stream_arn} => String
|
2324
2546
|
#
|
2325
2547
|
# @example Request syntax with placeholder values
|
2326
2548
|
#
|
2327
2549
|
# resp = client.update_shard_count({
|
2328
|
-
# stream_name: "StreamName",
|
2550
|
+
# stream_name: "StreamName",
|
2329
2551
|
# target_shard_count: 1, # required
|
2330
2552
|
# scaling_type: "UNIFORM_SCALING", # required, accepts UNIFORM_SCALING
|
2553
|
+
# stream_arn: "StreamARN",
|
2331
2554
|
# })
|
2332
2555
|
#
|
2333
2556
|
# @example Response structure
|
@@ -2335,6 +2558,7 @@ module Aws::Kinesis
|
|
2335
2558
|
# resp.stream_name #=> String
|
2336
2559
|
# resp.current_shard_count #=> Integer
|
2337
2560
|
# resp.target_shard_count #=> Integer
|
2561
|
+
# resp.stream_arn #=> String
|
2338
2562
|
#
|
2339
2563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateShardCount AWS API Documentation
|
2340
2564
|
#
|
@@ -2392,7 +2616,7 @@ module Aws::Kinesis
|
|
2392
2616
|
params: params,
|
2393
2617
|
config: config)
|
2394
2618
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2395
|
-
context[:gem_version] = '1.
|
2619
|
+
context[:gem_version] = '1.43.0'
|
2396
2620
|
Seahorse::Client::Request.new(handlers, context)
|
2397
2621
|
end
|
2398
2622
|
|