aws-sdk-kinesis 1.38.0 → 1.52.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
- require 'aws-sdk-core/plugins/signature_v4.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/request_compression.rb'
32
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
33
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
34
+ require 'aws-sdk-core/plugins/sign.rb'
31
35
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
32
36
  require 'aws-sdk-core/plugins/event_stream_configuration.rb'
33
37
 
@@ -74,9 +78,14 @@ module Aws::Kinesis
74
78
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
75
79
  add_plugin(Aws::Plugins::TransferEncoding)
76
80
  add_plugin(Aws::Plugins::HttpChecksum)
77
- add_plugin(Aws::Plugins::SignatureV4)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
82
+ add_plugin(Aws::Plugins::RequestCompression)
83
+ add_plugin(Aws::Plugins::DefaultsMode)
84
+ add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Sign)
78
86
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
79
87
  add_plugin(Aws::Plugins::EventStreamConfiguration)
88
+ add_plugin(Aws::Kinesis::Plugins::Endpoints)
80
89
 
81
90
  # @overload initialize(options)
82
91
  # @param [Hash] options
@@ -177,10 +186,18 @@ module Aws::Kinesis
177
186
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
178
187
  # a clock skew correction and retry requests with skewed client clocks.
179
188
  #
189
+ # @option options [String] :defaults_mode ("legacy")
190
+ # See {Aws::DefaultsModeConfiguration} for a list of the
191
+ # accepted modes and the configuration defaults that are included.
192
+ #
180
193
  # @option options [Boolean] :disable_host_prefix_injection (false)
181
194
  # Set to true to disable SDK automatically adding host prefix
182
195
  # to default service endpoint when available.
183
196
  #
197
+ # @option options [Boolean] :disable_request_compression (false)
198
+ # When set to 'true' the request body will not be compressed
199
+ # for supported operations.
200
+ #
184
201
  # @option options [String] :endpoint
185
202
  # The client endpoint is normally constructed from the `:region`
186
203
  # option. You should only configure an `:endpoint` when connecting
@@ -204,6 +221,10 @@ module Aws::Kinesis
204
221
  # @option options [Proc] :event_stream_handler
205
222
  # When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
206
223
  #
224
+ # @option options [Boolean] :ignore_configured_endpoint_urls
225
+ # Setting to true disables use of endpoint URLs provided via environment
226
+ # variables and the shared configuration file.
227
+ #
207
228
  # @option options [Proc] :input_event_stream_handler
208
229
  # When an EventStream or Proc object is provided, it can be used for sending events for the event stream.
209
230
  #
@@ -230,6 +251,11 @@ module Aws::Kinesis
230
251
  # Used when loading credentials from the shared credentials file
231
252
  # at HOME/.aws/credentials. When not specified, 'default' is used.
232
253
  #
254
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
255
+ # The minimum size in bytes that triggers compression for request
256
+ # bodies. The value must be non-negative integer value between 0
257
+ # and 10485780 bytes inclusive.
258
+ #
233
259
  # @option options [Proc] :retry_backoff
234
260
  # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
235
261
  # This option is only used in the `legacy` retry mode.
@@ -275,6 +301,11 @@ module Aws::Kinesis
275
301
  # in the future.
276
302
  #
277
303
  #
304
+ # @option options [String] :sdk_ua_app_id
305
+ # A unique and opaque application ID that is appended to the
306
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
307
+ # maximum length of 50.
308
+ #
278
309
  # @option options [String] :secret_access_key
279
310
  #
280
311
  # @option options [String] :session_token
@@ -298,6 +329,19 @@ module Aws::Kinesis
298
329
  # ** Please note ** When response stubbing is enabled, no HTTP
299
330
  # requests are made, and retries are disabled.
300
331
  #
332
+ # @option options [Aws::TokenProvider] :token_provider
333
+ # A Bearer Token Provider. This can be an instance of any one of the
334
+ # following classes:
335
+ #
336
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
337
+ # tokens.
338
+ #
339
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
340
+ # access token generated from `aws login`.
341
+ #
342
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
343
+ # will be used to search for tokens configured for your profile in shared configuration files.
344
+ #
301
345
  # @option options [Boolean] :use_dualstack_endpoint
302
346
  # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
303
347
  # will be used if available.
@@ -311,6 +355,9 @@ module Aws::Kinesis
311
355
  # When `true`, request parameters are validated before
312
356
  # sending the request.
313
357
  #
358
+ # @option options [Aws::Kinesis::EndpointProvider] :endpoint_provider
359
+ # 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`
360
+ #
314
361
  # @option options [URI::HTTP,String] :http_proxy A proxy to send
315
362
  # requests through. Formatted like 'http://proxy.com:123'.
316
363
  #
@@ -318,7 +365,7 @@ module Aws::Kinesis
318
365
  # seconds to wait when opening a HTTP session before raising a
319
366
  # `Timeout::Error`.
320
367
  #
321
- # @option options [Integer] :http_read_timeout (60) The default
368
+ # @option options [Float] :http_read_timeout (60) The default
322
369
  # number of seconds to wait for response data. This value can
323
370
  # safely be set per-request on the session.
324
371
  #
@@ -334,6 +381,9 @@ module Aws::Kinesis
334
381
  # disables this behaviour. This value can safely be set per
335
382
  # request on the session.
336
383
  #
384
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
385
+ # in seconds.
386
+ #
337
387
  # @option options [Boolean] :http_wire_trace (false) When `true`,
338
388
  # HTTP debug output will be sent to the `:logger`.
339
389
  #
@@ -362,6 +412,11 @@ module Aws::Kinesis
362
412
  # Adds or updates tags for the specified Kinesis data stream. You can
363
413
  # assign up to 50 tags to a data stream.
364
414
  #
415
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
416
+ # input parameter rather than the `StreamName` input parameter.
417
+ #
418
+ # </note>
419
+ #
365
420
  # If tags have already been assigned to the stream, `AddTagsToStream`
366
421
  # overwrites any existing tags that correspond to the specified tag
367
422
  # keys.
@@ -369,21 +424,25 @@ module Aws::Kinesis
369
424
  # AddTagsToStream has a limit of five transactions per second per
370
425
  # account.
371
426
  #
372
- # @option params [required, String] :stream_name
427
+ # @option params [String] :stream_name
373
428
  # The name of the stream.
374
429
  #
375
430
  # @option params [required, Hash<String,String>] :tags
376
431
  # A set of up to 10 key-value pairs to use to create the tags.
377
432
  #
433
+ # @option params [String] :stream_arn
434
+ # The ARN of the stream.
435
+ #
378
436
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
379
437
  #
380
438
  # @example Request syntax with placeholder values
381
439
  #
382
440
  # resp = client.add_tags_to_stream({
383
- # stream_name: "StreamName", # required
441
+ # stream_name: "StreamName",
384
442
  # tags: { # required
385
443
  # "TagKey" => "TagValue",
386
444
  # },
445
+ # stream_arn: "StreamARN",
387
446
  # })
388
447
  #
389
448
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/AddTagsToStream AWS API Documentation
@@ -401,12 +460,18 @@ module Aws::Kinesis
401
460
  # means of shards, which are uniquely identified groups of data records
402
461
  # in a stream.
403
462
  #
404
- # You specify and control the number of shards that a stream is composed
405
- # of. Each shard can support reads up to five transactions per second,
406
- # up to a maximum data read total of 2 MiB per second. Each shard can
407
- # support writes up to 1,000 records per second, up to a maximum data
408
- # write total of 1 MiB per second. If the amount of data input increases
409
- # or decreases, you can add or remove shards.
463
+ # You can create your data stream using either on-demand or provisioned
464
+ # capacity mode. Data streams with an on-demand mode require no capacity
465
+ # planning and automatically scale to handle gigabytes of write and read
466
+ # throughput per minute. With the on-demand mode, Kinesis Data Streams
467
+ # automatically manages the shards in order to provide the necessary
468
+ # throughput. For the data streams with a provisioned mode, you must
469
+ # specify the number of shards for the data stream. Each shard can
470
+ # support reads up to five transactions per second, up to a maximum data
471
+ # read total of 2 MiB per second. Each shard can support writes up to
472
+ # 1,000 records per second, up to a maximum data write total of 1 MiB
473
+ # per second. If the amount of data input increases or decreases, you
474
+ # can add or remove shards.
410
475
  #
411
476
  # The stream name identifies the stream. The name is scoped to the
412
477
  # Amazon Web Services account used by the application. It is also scoped
@@ -486,24 +551,33 @@ module Aws::Kinesis
486
551
  # length of time data records are accessible after they are added to the
487
552
  # stream. The minimum value of a stream's retention period is 24 hours.
488
553
  #
554
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
555
+ # input parameter rather than the `StreamName` input parameter.
556
+ #
557
+ # </note>
558
+ #
489
559
  # This operation may result in lost data. For example, if the stream's
490
560
  # retention period is 48 hours and is decreased to 24 hours, any data
491
561
  # already in the stream that is older than 24 hours is inaccessible.
492
562
  #
493
- # @option params [required, String] :stream_name
563
+ # @option params [String] :stream_name
494
564
  # The name of the stream to modify.
495
565
  #
496
566
  # @option params [required, Integer] :retention_period_hours
497
567
  # The new retention period of the stream, in hours. Must be less than
498
568
  # the current retention period.
499
569
  #
570
+ # @option params [String] :stream_arn
571
+ # The ARN of the stream.
572
+ #
500
573
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
501
574
  #
502
575
  # @example Request syntax with placeholder values
503
576
  #
504
577
  # resp = client.decrease_stream_retention_period({
505
- # stream_name: "StreamName", # required
578
+ # stream_name: "StreamName",
506
579
  # retention_period_hours: 1, # required
580
+ # stream_arn: "StreamARN",
507
581
  # })
508
582
  #
509
583
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DecreaseStreamRetentionPeriod AWS API Documentation
@@ -520,6 +594,11 @@ module Aws::Kinesis
520
594
  # delete the stream. If an application attempts to operate on a deleted
521
595
  # stream, it receives the exception `ResourceNotFoundException`.
522
596
  #
597
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
598
+ # input parameter rather than the `StreamName` input parameter.
599
+ #
600
+ # </note>
601
+ #
523
602
  # If the stream is in the `ACTIVE` state, you can delete it. After a
524
603
  # `DeleteStream` request, the specified stream is in the `DELETING`
525
604
  # state until Kinesis Data Streams completes the deletion.
@@ -536,7 +615,7 @@ module Aws::Kinesis
536
615
  #
537
616
  # DeleteStream has a limit of five transactions per second per account.
538
617
  #
539
- # @option params [required, String] :stream_name
618
+ # @option params [String] :stream_name
540
619
  # The name of the stream to delete.
541
620
  #
542
621
  # @option params [Boolean] :enforce_consumer_deletion
@@ -544,13 +623,17 @@ module Aws::Kinesis
544
623
  # the stream has registered consumers, the call to `DeleteStream` fails
545
624
  # with a `ResourceInUseException`.
546
625
  #
626
+ # @option params [String] :stream_arn
627
+ # The ARN of the stream.
628
+ #
547
629
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
548
630
  #
549
631
  # @example Request syntax with placeholder values
550
632
  #
551
633
  # resp = client.delete_stream({
552
- # stream_name: "StreamName", # required
634
+ # stream_name: "StreamName",
553
635
  # enforce_consumer_deletion: false,
636
+ # stream_arn: "StreamARN",
554
637
  # })
555
638
  #
556
639
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DeleteStream AWS API Documentation
@@ -652,6 +735,11 @@ module Aws::Kinesis
652
735
  #
653
736
  # </note>
654
737
  #
738
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
739
+ # input parameter rather than the `StreamName` input parameter.
740
+ #
741
+ # </note>
742
+ #
655
743
  # The information returned includes the stream name, Amazon Resource
656
744
  # Name (ARN), creation time, enhanced metric configuration, and shard
657
745
  # map. The shard map is an array of shard objects. For each shard
@@ -675,7 +763,7 @@ module Aws::Kinesis
675
763
  #
676
764
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
677
765
  #
678
- # @option params [required, String] :stream_name
766
+ # @option params [String] :stream_name
679
767
  # The name of the stream to describe.
680
768
  #
681
769
  # @option params [Integer] :limit
@@ -694,6 +782,9 @@ module Aws::Kinesis
694
782
  # `DescribeStream` is to describe the stream starting with the first
695
783
  # shard in the stream.
696
784
  #
785
+ # @option params [String] :stream_arn
786
+ # The ARN of the stream.
787
+ #
697
788
  # @return [Types::DescribeStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
698
789
  #
699
790
  # * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
@@ -703,9 +794,10 @@ module Aws::Kinesis
703
794
  # @example Request syntax with placeholder values
704
795
  #
705
796
  # resp = client.describe_stream({
706
- # stream_name: "StreamName", # required
797
+ # stream_name: "StreamName",
707
798
  # limit: 1,
708
799
  # exclusive_start_shard_id: "ShardId",
800
+ # stream_arn: "StreamARN",
709
801
  # })
710
802
  #
711
803
  # @example Response structure
@@ -805,6 +897,11 @@ module Aws::Kinesis
805
897
  # Provides a summarized description of the specified Kinesis data stream
806
898
  # without the shard list.
807
899
  #
900
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
901
+ # input parameter rather than the `StreamName` input parameter.
902
+ #
903
+ # </note>
904
+ #
808
905
  # The information returned includes the stream name, Amazon Resource
809
906
  # Name (ARN), status, record retention period, approximate creation
810
907
  # time, monitoring, encryption details, and open shard count.
@@ -812,9 +909,12 @@ module Aws::Kinesis
812
909
  # DescribeStreamSummary has a limit of 20 transactions per second per
813
910
  # account.
814
911
  #
815
- # @option params [required, String] :stream_name
912
+ # @option params [String] :stream_name
816
913
  # The name of the stream to describe.
817
914
  #
915
+ # @option params [String] :stream_arn
916
+ # The ARN of the stream.
917
+ #
818
918
  # @return [Types::DescribeStreamSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
819
919
  #
820
920
  # * {Types::DescribeStreamSummaryOutput#stream_description_summary #stream_description_summary} => Types::StreamDescriptionSummary
@@ -822,7 +922,8 @@ module Aws::Kinesis
822
922
  # @example Request syntax with placeholder values
823
923
  #
824
924
  # resp = client.describe_stream_summary({
825
- # stream_name: "StreamName", # required
925
+ # stream_name: "StreamName",
926
+ # stream_arn: "StreamARN",
826
927
  # })
827
928
  #
828
929
  # @example Response structure
@@ -852,7 +953,12 @@ module Aws::Kinesis
852
953
 
853
954
  # Disables enhanced monitoring.
854
955
  #
855
- # @option params [required, String] :stream_name
956
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
957
+ # input parameter rather than the `StreamName` input parameter.
958
+ #
959
+ # </note>
960
+ #
961
+ # @option params [String] :stream_name
856
962
  # The name of the Kinesis data stream for which to disable enhanced
857
963
  # monitoring.
858
964
  #
@@ -886,17 +992,22 @@ module Aws::Kinesis
886
992
  #
887
993
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
888
994
  #
995
+ # @option params [String] :stream_arn
996
+ # The ARN of the stream.
997
+ #
889
998
  # @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
890
999
  #
891
1000
  # * {Types::EnhancedMonitoringOutput#stream_name #stream_name} => String
892
1001
  # * {Types::EnhancedMonitoringOutput#current_shard_level_metrics #current_shard_level_metrics} => Array&lt;String&gt;
893
1002
  # * {Types::EnhancedMonitoringOutput#desired_shard_level_metrics #desired_shard_level_metrics} => Array&lt;String&gt;
1003
+ # * {Types::EnhancedMonitoringOutput#stream_arn #stream_arn} => String
894
1004
  #
895
1005
  # @example Request syntax with placeholder values
896
1006
  #
897
1007
  # resp = client.disable_enhanced_monitoring({
898
- # stream_name: "StreamName", # required
1008
+ # stream_name: "StreamName",
899
1009
  # shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
1010
+ # stream_arn: "StreamARN",
900
1011
  # })
901
1012
  #
902
1013
  # @example Response structure
@@ -906,6 +1017,7 @@ module Aws::Kinesis
906
1017
  # resp.current_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
907
1018
  # resp.desired_shard_level_metrics #=> Array
908
1019
  # resp.desired_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
1020
+ # resp.stream_arn #=> String
909
1021
  #
910
1022
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DisableEnhancedMonitoring AWS API Documentation
911
1023
  #
@@ -919,7 +1031,12 @@ module Aws::Kinesis
919
1031
  # Enables enhanced Kinesis data stream monitoring for shard-level
920
1032
  # metrics.
921
1033
  #
922
- # @option params [required, String] :stream_name
1034
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1035
+ # input parameter rather than the `StreamName` input parameter.
1036
+ #
1037
+ # </note>
1038
+ #
1039
+ # @option params [String] :stream_name
923
1040
  # The name of the stream for which to enable enhanced monitoring.
924
1041
  #
925
1042
  # @option params [required, Array<String>] :shard_level_metrics
@@ -952,17 +1069,22 @@ module Aws::Kinesis
952
1069
  #
953
1070
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
954
1071
  #
1072
+ # @option params [String] :stream_arn
1073
+ # The ARN of the stream.
1074
+ #
955
1075
  # @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
956
1076
  #
957
1077
  # * {Types::EnhancedMonitoringOutput#stream_name #stream_name} => String
958
1078
  # * {Types::EnhancedMonitoringOutput#current_shard_level_metrics #current_shard_level_metrics} => Array&lt;String&gt;
959
1079
  # * {Types::EnhancedMonitoringOutput#desired_shard_level_metrics #desired_shard_level_metrics} => Array&lt;String&gt;
1080
+ # * {Types::EnhancedMonitoringOutput#stream_arn #stream_arn} => String
960
1081
  #
961
1082
  # @example Request syntax with placeholder values
962
1083
  #
963
1084
  # resp = client.enable_enhanced_monitoring({
964
- # stream_name: "StreamName", # required
1085
+ # stream_name: "StreamName",
965
1086
  # shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
1087
+ # stream_arn: "StreamARN",
966
1088
  # })
967
1089
  #
968
1090
  # @example Response structure
@@ -972,6 +1094,7 @@ module Aws::Kinesis
972
1094
  # resp.current_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
973
1095
  # resp.desired_shard_level_metrics #=> Array
974
1096
  # resp.desired_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
1097
+ # resp.stream_arn #=> String
975
1098
  #
976
1099
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnableEnhancedMonitoring AWS API Documentation
977
1100
  #
@@ -984,6 +1107,11 @@ module Aws::Kinesis
984
1107
 
985
1108
  # Gets data records from a Kinesis data stream's shard.
986
1109
  #
1110
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1111
+ # input parameter in addition to the `ShardIterator` parameter.
1112
+ #
1113
+ # </note>
1114
+ #
987
1115
  # Specify a shard iterator using the `ShardIterator` parameter. The
988
1116
  # shard iterator specifies the position in the shard from which you want
989
1117
  # to start reading data records sequentially. If there are no records
@@ -1061,6 +1189,9 @@ module Aws::Kinesis
1061
1189
  # 10,000. If you specify a value that is greater than 10,000, GetRecords
1062
1190
  # throws `InvalidArgumentException`. The default value is 10,000.
1063
1191
  #
1192
+ # @option params [String] :stream_arn
1193
+ # The ARN of the stream.
1194
+ #
1064
1195
  # @return [Types::GetRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1065
1196
  #
1066
1197
  # * {Types::GetRecordsOutput#records #records} => Array&lt;Types::Record&gt;
@@ -1073,6 +1204,7 @@ module Aws::Kinesis
1073
1204
  # resp = client.get_records({
1074
1205
  # shard_iterator: "ShardIterator", # required
1075
1206
  # limit: 1,
1207
+ # stream_arn: "StreamARN",
1076
1208
  # })
1077
1209
  #
1078
1210
  # @example Response structure
@@ -1104,6 +1236,11 @@ module Aws::Kinesis
1104
1236
  # Gets an Amazon Kinesis shard iterator. A shard iterator expires 5
1105
1237
  # minutes after it is returned to the requester.
1106
1238
  #
1239
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1240
+ # input parameter rather than the `StreamName` input parameter.
1241
+ #
1242
+ # </note>
1243
+ #
1107
1244
  # A shard iterator specifies the shard position from which to start
1108
1245
  # reading data records sequentially. The position is specified using the
1109
1246
  # sequence number of a data record in a shard. A sequence number is the
@@ -1148,7 +1285,7 @@ module Aws::Kinesis
1148
1285
  #
1149
1286
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
1150
1287
  #
1151
- # @option params [required, String] :stream_name
1288
+ # @option params [String] :stream_name
1152
1289
  # The name of the Amazon Kinesis data stream.
1153
1290
  #
1154
1291
  # @option params [required, String] :shard_id
@@ -1193,6 +1330,9 @@ module Aws::Kinesis
1193
1330
  # horizon, the iterator returned is for the oldest untrimmed data record
1194
1331
  # (TRIM\_HORIZON).
1195
1332
  #
1333
+ # @option params [String] :stream_arn
1334
+ # The ARN of the stream.
1335
+ #
1196
1336
  # @return [Types::GetShardIteratorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1197
1337
  #
1198
1338
  # * {Types::GetShardIteratorOutput#shard_iterator #shard_iterator} => String
@@ -1200,11 +1340,12 @@ module Aws::Kinesis
1200
1340
  # @example Request syntax with placeholder values
1201
1341
  #
1202
1342
  # resp = client.get_shard_iterator({
1203
- # stream_name: "StreamName", # required
1343
+ # stream_name: "StreamName",
1204
1344
  # shard_id: "ShardId", # required
1205
1345
  # shard_iterator_type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
1206
1346
  # starting_sequence_number: "SequenceNumber",
1207
1347
  # timestamp: Time.now,
1348
+ # stream_arn: "StreamARN",
1208
1349
  # })
1209
1350
  #
1210
1351
  # @example Response structure
@@ -1225,6 +1366,11 @@ module Aws::Kinesis
1225
1366
  # stream. The maximum value of a stream's retention period is 8760
1226
1367
  # hours (365 days).
1227
1368
  #
1369
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1370
+ # input parameter rather than the `StreamName` input parameter.
1371
+ #
1372
+ # </note>
1373
+ #
1228
1374
  # If you choose a longer stream retention period, this operation
1229
1375
  # increases the time period during which records that have not yet
1230
1376
  # expired are accessible. However, it does not make previous, expired
@@ -1234,20 +1380,24 @@ module Aws::Kinesis
1234
1380
  # data that is older than 24 hours remains inaccessible to consumer
1235
1381
  # applications.
1236
1382
  #
1237
- # @option params [required, String] :stream_name
1383
+ # @option params [String] :stream_name
1238
1384
  # The name of the stream to modify.
1239
1385
  #
1240
1386
  # @option params [required, Integer] :retention_period_hours
1241
1387
  # The new retention period of the stream, in hours. Must be more than
1242
1388
  # the current retention period.
1243
1389
  #
1390
+ # @option params [String] :stream_arn
1391
+ # The ARN of the stream.
1392
+ #
1244
1393
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1245
1394
  #
1246
1395
  # @example Request syntax with placeholder values
1247
1396
  #
1248
1397
  # resp = client.increase_stream_retention_period({
1249
- # stream_name: "StreamName", # required
1398
+ # stream_name: "StreamName",
1250
1399
  # retention_period_hours: 1, # required
1400
+ # stream_arn: "StreamARN",
1251
1401
  # })
1252
1402
  #
1253
1403
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/IncreaseStreamRetentionPeriod AWS API Documentation
@@ -1263,6 +1413,11 @@ module Aws::Kinesis
1263
1413
  # shard. This operation has a limit of 1000 transactions per second per
1264
1414
  # data stream.
1265
1415
  #
1416
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1417
+ # input parameter rather than the `StreamName` input parameter.
1418
+ #
1419
+ # </note>
1420
+ #
1266
1421
  # This action does not list expired shards. For information about
1267
1422
  # expired shards, see [Data Routing, Data Persistence, and Shard State
1268
1423
  # after a Reshard][1].
@@ -1364,6 +1519,9 @@ module Aws::Kinesis
1364
1519
  # FROM\_TIMESTAMP type, then all shards starting from the provided
1365
1520
  # timestamp to TIP are returned.
1366
1521
  #
1522
+ # @option params [String] :stream_arn
1523
+ # The ARN of the stream.
1524
+ #
1367
1525
  # @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1368
1526
  #
1369
1527
  # * {Types::ListShardsOutput#shards #shards} => Array&lt;Types::Shard&gt;
@@ -1382,6 +1540,7 @@ module Aws::Kinesis
1382
1540
  # shard_id: "ShardId",
1383
1541
  # timestamp: Time.now,
1384
1542
  # },
1543
+ # stream_arn: "StreamARN",
1385
1544
  # })
1386
1545
  #
1387
1546
  # @example Response structure
@@ -1521,10 +1680,14 @@ module Aws::Kinesis
1521
1680
  # @option params [String] :exclusive_start_stream_name
1522
1681
  # The name of the stream to start the list with.
1523
1682
  #
1683
+ # @option params [String] :next_token
1684
+ #
1524
1685
  # @return [Types::ListStreamsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1525
1686
  #
1526
1687
  # * {Types::ListStreamsOutput#stream_names #stream_names} => Array&lt;String&gt;
1527
1688
  # * {Types::ListStreamsOutput#has_more_streams #has_more_streams} => Boolean
1689
+ # * {Types::ListStreamsOutput#next_token #next_token} => String
1690
+ # * {Types::ListStreamsOutput#stream_summaries #stream_summaries} => Array&lt;Types::StreamSummary&gt;
1528
1691
  #
1529
1692
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1530
1693
  #
@@ -1533,6 +1696,7 @@ module Aws::Kinesis
1533
1696
  # resp = client.list_streams({
1534
1697
  # limit: 1,
1535
1698
  # exclusive_start_stream_name: "StreamName",
1699
+ # next_token: "NextToken",
1536
1700
  # })
1537
1701
  #
1538
1702
  # @example Response structure
@@ -1540,6 +1704,13 @@ module Aws::Kinesis
1540
1704
  # resp.stream_names #=> Array
1541
1705
  # resp.stream_names[0] #=> String
1542
1706
  # resp.has_more_streams #=> Boolean
1707
+ # resp.next_token #=> String
1708
+ # resp.stream_summaries #=> Array
1709
+ # resp.stream_summaries[0].stream_name #=> String
1710
+ # resp.stream_summaries[0].stream_arn #=> String
1711
+ # resp.stream_summaries[0].stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
1712
+ # resp.stream_summaries[0].stream_mode_details.stream_mode #=> String, one of "PROVISIONED", "ON_DEMAND"
1713
+ # resp.stream_summaries[0].stream_creation_timestamp #=> Time
1543
1714
  #
1544
1715
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListStreams AWS API Documentation
1545
1716
  #
@@ -1553,7 +1724,12 @@ module Aws::Kinesis
1553
1724
  # Lists the tags for the specified Kinesis data stream. This operation
1554
1725
  # has a limit of five transactions per second per account.
1555
1726
  #
1556
- # @option params [required, String] :stream_name
1727
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1728
+ # input parameter rather than the `StreamName` input parameter.
1729
+ #
1730
+ # </note>
1731
+ #
1732
+ # @option params [String] :stream_name
1557
1733
  # The name of the stream.
1558
1734
  #
1559
1735
  # @option params [String] :exclusive_start_tag_key
@@ -1567,6 +1743,9 @@ module Aws::Kinesis
1567
1743
  # `true`. To list additional tags, set `ExclusiveStartTagKey` to the
1568
1744
  # last key in the response.
1569
1745
  #
1746
+ # @option params [String] :stream_arn
1747
+ # The ARN of the stream.
1748
+ #
1570
1749
  # @return [Types::ListTagsForStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1571
1750
  #
1572
1751
  # * {Types::ListTagsForStreamOutput#tags #tags} => Array&lt;Types::Tag&gt;
@@ -1575,9 +1754,10 @@ module Aws::Kinesis
1575
1754
  # @example Request syntax with placeholder values
1576
1755
  #
1577
1756
  # resp = client.list_tags_for_stream({
1578
- # stream_name: "StreamName", # required
1757
+ # stream_name: "StreamName",
1579
1758
  # exclusive_start_tag_key: "TagKey",
1580
1759
  # limit: 1,
1760
+ # stream_arn: "StreamARN",
1581
1761
  # })
1582
1762
  #
1583
1763
  # @example Response structure
@@ -1598,14 +1778,20 @@ module Aws::Kinesis
1598
1778
 
1599
1779
  # Merges two adjacent shards in a Kinesis data stream and combines them
1600
1780
  # into a single shard to reduce the stream's capacity to ingest and
1601
- # transport data. Two shards are considered adjacent if the union of the
1602
- # hash key ranges for the two shards form a contiguous set with no gaps.
1603
- # For example, if you have two shards, one with a hash key range of
1604
- # 276...381 and the other with a hash key range of 382...454, then you
1605
- # could merge these two shards into a single shard that would have a
1606
- # hash key range of 276...454. After the merge, the single child shard
1607
- # receives data for all hash key values covered by the two parent
1608
- # shards.
1781
+ # transport data. This API is only supported for the data streams with
1782
+ # the provisioned capacity mode. Two shards are considered adjacent if
1783
+ # the union of the hash key ranges for the two shards form a contiguous
1784
+ # set with no gaps. For example, if you have two shards, one with a hash
1785
+ # key range of 276...381 and the other with a hash key range of
1786
+ # 382...454, then you could merge these two shards into a single shard
1787
+ # that would have a hash key range of 276...454. After the merge, the
1788
+ # single child shard receives data for all hash key values covered by
1789
+ # the two parent shards.
1790
+ #
1791
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1792
+ # input parameter rather than the `StreamName` input parameter.
1793
+ #
1794
+ # </note>
1609
1795
  #
1610
1796
  # `MergeShards` is called when there is a need to reduce the overall
1611
1797
  # capacity of a stream because of excess capacity that is not being
@@ -1642,7 +1828,7 @@ module Aws::Kinesis
1642
1828
  #
1643
1829
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
1644
1830
  #
1645
- # @option params [required, String] :stream_name
1831
+ # @option params [String] :stream_name
1646
1832
  # The name of the stream for the merge.
1647
1833
  #
1648
1834
  # @option params [required, String] :shard_to_merge
@@ -1652,14 +1838,18 @@ module Aws::Kinesis
1652
1838
  # @option params [required, String] :adjacent_shard_to_merge
1653
1839
  # The shard ID of the adjacent shard for the merge.
1654
1840
  #
1841
+ # @option params [String] :stream_arn
1842
+ # The ARN of the stream.
1843
+ #
1655
1844
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1656
1845
  #
1657
1846
  # @example Request syntax with placeholder values
1658
1847
  #
1659
1848
  # resp = client.merge_shards({
1660
- # stream_name: "StreamName", # required
1849
+ # stream_name: "StreamName",
1661
1850
  # shard_to_merge: "ShardId", # required
1662
1851
  # adjacent_shard_to_merge: "ShardId", # required
1852
+ # stream_arn: "StreamARN",
1663
1853
  # })
1664
1854
  #
1665
1855
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/MergeShards AWS API Documentation
@@ -1677,6 +1867,11 @@ module Aws::Kinesis
1677
1867
  # writes up to 1,000 records per second, up to a maximum data write
1678
1868
  # total of 1 MiB per second.
1679
1869
  #
1870
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1871
+ # input parameter rather than the `StreamName` input parameter.
1872
+ #
1873
+ # </note>
1874
+ #
1680
1875
  # You must specify the name of the stream that captures, stores, and
1681
1876
  # transports the data; a partition key; and the data blob itself.
1682
1877
  #
@@ -1725,7 +1920,7 @@ module Aws::Kinesis
1725
1920
  #
1726
1921
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
1727
1922
  #
1728
- # @option params [required, String] :stream_name
1923
+ # @option params [String] :stream_name
1729
1924
  # The name of the stream to put the data record into.
1730
1925
  #
1731
1926
  # @option params [required, String, StringIO, File] :data
@@ -1757,6 +1952,9 @@ module Aws::Kinesis
1757
1952
  # this parameter is not set, records are coarsely ordered based on
1758
1953
  # arrival time.
1759
1954
  #
1955
+ # @option params [String] :stream_arn
1956
+ # The ARN of the stream.
1957
+ #
1760
1958
  # @return [Types::PutRecordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1761
1959
  #
1762
1960
  # * {Types::PutRecordOutput#shard_id #shard_id} => String
@@ -1766,11 +1964,12 @@ module Aws::Kinesis
1766
1964
  # @example Request syntax with placeholder values
1767
1965
  #
1768
1966
  # resp = client.put_record({
1769
- # stream_name: "StreamName", # required
1967
+ # stream_name: "StreamName",
1770
1968
  # data: "data", # required
1771
1969
  # partition_key: "PartitionKey", # required
1772
1970
  # explicit_hash_key: "HashKey",
1773
1971
  # sequence_number_for_ordering: "SequenceNumber",
1972
+ # stream_arn: "StreamARN",
1774
1973
  # })
1775
1974
  #
1776
1975
  # @example Response structure
@@ -1792,6 +1991,11 @@ module Aws::Kinesis
1792
1991
  # call (also referred to as a `PutRecords` request). Use this operation
1793
1992
  # to send data into the stream for data ingestion and processing.
1794
1993
  #
1994
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
1995
+ # input parameter rather than the `StreamName` input parameter.
1996
+ #
1997
+ # </note>
1998
+ #
1795
1999
  # Each `PutRecords` request can support up to 500 records. Each record
1796
2000
  # in the request can be as large as 1 MiB, up to a limit of 5 MiB for
1797
2001
  # the entire request, including partition keys. Each shard can support
@@ -1872,9 +2076,12 @@ module Aws::Kinesis
1872
2076
  # @option params [required, Array<Types::PutRecordsRequestEntry>] :records
1873
2077
  # The records associated with the request.
1874
2078
  #
1875
- # @option params [required, String] :stream_name
2079
+ # @option params [String] :stream_name
1876
2080
  # The stream name associated with the request.
1877
2081
  #
2082
+ # @option params [String] :stream_arn
2083
+ # The ARN of the stream.
2084
+ #
1878
2085
  # @return [Types::PutRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1879
2086
  #
1880
2087
  # * {Types::PutRecordsOutput#failed_record_count #failed_record_count} => Integer
@@ -1891,7 +2098,8 @@ module Aws::Kinesis
1891
2098
  # partition_key: "PartitionKey", # required
1892
2099
  # },
1893
2100
  # ],
1894
- # stream_name: "StreamName", # required
2101
+ # stream_name: "StreamName",
2102
+ # stream_arn: "StreamARN",
1895
2103
  # })
1896
2104
  #
1897
2105
  # @example Response structure
@@ -1978,24 +2186,33 @@ module Aws::Kinesis
1978
2186
  # deleted and cannot be recovered after this operation successfully
1979
2187
  # completes.
1980
2188
  #
2189
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
2190
+ # input parameter rather than the `StreamName` input parameter.
2191
+ #
2192
+ # </note>
2193
+ #
1981
2194
  # If you specify a tag that does not exist, it is ignored.
1982
2195
  #
1983
2196
  # RemoveTagsFromStream has a limit of five transactions per second per
1984
2197
  # account.
1985
2198
  #
1986
- # @option params [required, String] :stream_name
2199
+ # @option params [String] :stream_name
1987
2200
  # The name of the stream.
1988
2201
  #
1989
2202
  # @option params [required, Array<String>] :tag_keys
1990
2203
  # A list of tag keys. Each corresponding tag is removed from the stream.
1991
2204
  #
2205
+ # @option params [String] :stream_arn
2206
+ # The ARN of the stream.
2207
+ #
1992
2208
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1993
2209
  #
1994
2210
  # @example Request syntax with placeholder values
1995
2211
  #
1996
2212
  # resp = client.remove_tags_from_stream({
1997
- # stream_name: "StreamName", # required
2213
+ # stream_name: "StreamName",
1998
2214
  # tag_keys: ["TagKey"], # required
2215
+ # stream_arn: "StreamARN",
1999
2216
  # })
2000
2217
  #
2001
2218
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/RemoveTagsFromStream AWS API Documentation
@@ -2011,7 +2228,13 @@ module Aws::Kinesis
2011
2228
  # increase the stream's capacity to ingest and transport data.
2012
2229
  # `SplitShard` is called when there is a need to increase the overall
2013
2230
  # capacity of a stream because of an expected increase in the volume of
2014
- # data records being ingested.
2231
+ # data records being ingested. This API is only supported for the data
2232
+ # streams with the provisioned capacity mode.
2233
+ #
2234
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
2235
+ # input parameter rather than the `StreamName` input parameter.
2236
+ #
2237
+ # </note>
2015
2238
  #
2016
2239
  # You can also use `SplitShard` when a shard appears to be approaching
2017
2240
  # its maximum utilization; for example, the producers sending data into
@@ -2065,7 +2288,7 @@ module Aws::Kinesis
2065
2288
  # [2]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
2066
2289
  # [3]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
2067
2290
  #
2068
- # @option params [required, String] :stream_name
2291
+ # @option params [String] :stream_name
2069
2292
  # The name of the stream for the shard split.
2070
2293
  #
2071
2294
  # @option params [required, String] :shard_to_split
@@ -2081,14 +2304,18 @@ module Aws::Kinesis
2081
2304
  # shards. All the lower hash key values in the range are distributed to
2082
2305
  # the other child shard.
2083
2306
  #
2307
+ # @option params [String] :stream_arn
2308
+ # The ARN of the stream.
2309
+ #
2084
2310
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2085
2311
  #
2086
2312
  # @example Request syntax with placeholder values
2087
2313
  #
2088
2314
  # resp = client.split_shard({
2089
- # stream_name: "StreamName", # required
2315
+ # stream_name: "StreamName",
2090
2316
  # shard_to_split: "ShardId", # required
2091
2317
  # new_starting_hash_key: "HashKey", # required
2318
+ # stream_arn: "StreamARN",
2092
2319
  # })
2093
2320
  #
2094
2321
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SplitShard AWS API Documentation
@@ -2120,7 +2347,12 @@ module Aws::Kinesis
2120
2347
  # you enable encryption, you can verify that encryption is applied by
2121
2348
  # inspecting the API response from `PutRecord` or `PutRecords`.
2122
2349
  #
2123
- # @option params [required, String] :stream_name
2350
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
2351
+ # input parameter rather than the `StreamName` input parameter.
2352
+ #
2353
+ # </note>
2354
+ #
2355
+ # @option params [String] :stream_name
2124
2356
  # The name of the stream for which to start encrypting records.
2125
2357
  #
2126
2358
  # @option params [required, String] :encryption_type
@@ -2147,14 +2379,18 @@ module Aws::Kinesis
2147
2379
  #
2148
2380
  # * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
2149
2381
  #
2382
+ # @option params [String] :stream_arn
2383
+ # The ARN of the stream.
2384
+ #
2150
2385
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2151
2386
  #
2152
2387
  # @example Request syntax with placeholder values
2153
2388
  #
2154
2389
  # resp = client.start_stream_encryption({
2155
- # stream_name: "StreamName", # required
2390
+ # stream_name: "StreamName",
2156
2391
  # encryption_type: "NONE", # required, accepts NONE, KMS
2157
2392
  # key_id: "KeyId", # required
2393
+ # stream_arn: "StreamARN",
2158
2394
  # })
2159
2395
  #
2160
2396
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartStreamEncryption AWS API Documentation
@@ -2168,6 +2404,11 @@ module Aws::Kinesis
2168
2404
 
2169
2405
  # Disables server-side encryption for a specified stream.
2170
2406
  #
2407
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
2408
+ # input parameter rather than the `StreamName` input parameter.
2409
+ #
2410
+ # </note>
2411
+ #
2171
2412
  # Stopping encryption is an asynchronous operation. Upon receiving the
2172
2413
  # request, Kinesis Data Streams returns immediately and sets the status
2173
2414
  # of the stream to `UPDATING`. After the update is complete, Kinesis
@@ -2187,7 +2428,7 @@ module Aws::Kinesis
2187
2428
  # encryption is not applied by inspecting the API response from
2188
2429
  # `PutRecord` or `PutRecords`.
2189
2430
  #
2190
- # @option params [required, String] :stream_name
2431
+ # @option params [String] :stream_name
2191
2432
  # The name of the stream on which to stop encrypting records.
2192
2433
  #
2193
2434
  # @option params [required, String] :encryption_type
@@ -2214,14 +2455,18 @@ module Aws::Kinesis
2214
2455
  #
2215
2456
  # * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
2216
2457
  #
2458
+ # @option params [String] :stream_arn
2459
+ # The ARN of the stream.
2460
+ #
2217
2461
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2218
2462
  #
2219
2463
  # @example Request syntax with placeholder values
2220
2464
  #
2221
2465
  # resp = client.stop_stream_encryption({
2222
- # stream_name: "StreamName", # required
2466
+ # stream_name: "StreamName",
2223
2467
  # encryption_type: "NONE", # required, accepts NONE, KMS
2224
2468
  # key_id: "KeyId", # required
2469
+ # stream_arn: "StreamARN",
2225
2470
  # })
2226
2471
  #
2227
2472
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StopStreamEncryption AWS API Documentation
@@ -2234,7 +2479,13 @@ module Aws::Kinesis
2234
2479
  end
2235
2480
 
2236
2481
  # Updates the shard count of the specified stream to the specified
2237
- # number of shards.
2482
+ # number of shards. This API is only supported for the data streams with
2483
+ # the provisioned capacity mode.
2484
+ #
2485
+ # <note markdown="1"> When invoking this API, it is recommended you use the `StreamARN`
2486
+ # input parameter rather than the `StreamName` input parameter.
2487
+ #
2488
+ # </note>
2238
2489
  #
2239
2490
  # Updating the shard count is an asynchronous operation. Upon receiving
2240
2491
  # the request, Kinesis Data Streams returns immediately and sets the
@@ -2281,7 +2532,7 @@ module Aws::Kinesis
2281
2532
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
2282
2533
  # [2]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&amp;limitType=service-code-kinesis
2283
2534
  #
2284
- # @option params [required, String] :stream_name
2535
+ # @option params [String] :stream_name
2285
2536
  # The name of the stream.
2286
2537
  #
2287
2538
  # @option params [required, Integer] :target_shard_count
@@ -2303,18 +2554,23 @@ module Aws::Kinesis
2303
2554
  # @option params [required, String] :scaling_type
2304
2555
  # The scaling type. Uniform scaling creates shards of equal size.
2305
2556
  #
2557
+ # @option params [String] :stream_arn
2558
+ # The ARN of the stream.
2559
+ #
2306
2560
  # @return [Types::UpdateShardCountOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2307
2561
  #
2308
2562
  # * {Types::UpdateShardCountOutput#stream_name #stream_name} => String
2309
2563
  # * {Types::UpdateShardCountOutput#current_shard_count #current_shard_count} => Integer
2310
2564
  # * {Types::UpdateShardCountOutput#target_shard_count #target_shard_count} => Integer
2565
+ # * {Types::UpdateShardCountOutput#stream_arn #stream_arn} => String
2311
2566
  #
2312
2567
  # @example Request syntax with placeholder values
2313
2568
  #
2314
2569
  # resp = client.update_shard_count({
2315
- # stream_name: "StreamName", # required
2570
+ # stream_name: "StreamName",
2316
2571
  # target_shard_count: 1, # required
2317
2572
  # scaling_type: "UNIFORM_SCALING", # required, accepts UNIFORM_SCALING
2573
+ # stream_arn: "StreamARN",
2318
2574
  # })
2319
2575
  #
2320
2576
  # @example Response structure
@@ -2322,6 +2578,7 @@ module Aws::Kinesis
2322
2578
  # resp.stream_name #=> String
2323
2579
  # resp.current_shard_count #=> Integer
2324
2580
  # resp.target_shard_count #=> Integer
2581
+ # resp.stream_arn #=> String
2325
2582
  #
2326
2583
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateShardCount AWS API Documentation
2327
2584
  #
@@ -2379,7 +2636,7 @@ module Aws::Kinesis
2379
2636
  params: params,
2380
2637
  config: config)
2381
2638
  context[:gem_name] = 'aws-sdk-kinesis'
2382
- context[:gem_version] = '1.38.0'
2639
+ context[:gem_version] = '1.52.0'
2383
2640
  Seahorse::Client::Request.new(handlers, context)
2384
2641
  end
2385
2642