aws-sdk-kinesis 1.36.0 → 1.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesis/async_client.rb +26 -4
- data/lib/aws-sdk-kinesis/client.rb +212 -89
- data/lib/aws-sdk-kinesis/client_api.rb +37 -1
- data/lib/aws-sdk-kinesis/errors.rb +16 -0
- data/lib/aws-sdk-kinesis/types.rb +256 -56
- data/lib/aws-sdk-kinesis.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,8 @@ 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/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
34
|
require 'aws-sdk-core/plugins/event_stream_configuration.rb'
|
@@ -74,6 +76,8 @@ module Aws::Kinesis
|
|
74
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
75
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
76
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
80
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
77
81
|
add_plugin(Aws::Plugins::SignatureV4)
|
78
82
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
79
83
|
add_plugin(Aws::Plugins::EventStreamConfiguration)
|
@@ -121,7 +125,9 @@ module Aws::Kinesis
|
|
121
125
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
122
126
|
# are very aggressive. Construct and pass an instance of
|
123
127
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
124
|
-
# enable retries and extended timeouts.
|
128
|
+
# enable retries and extended timeouts. Instance profile credential
|
129
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
130
|
+
# to true.
|
125
131
|
#
|
126
132
|
# @option options [required, String] :region
|
127
133
|
# The AWS region to connect to. The configured `:region` is
|
@@ -175,6 +181,10 @@ module Aws::Kinesis
|
|
175
181
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
182
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
183
|
#
|
184
|
+
# @option options [String] :defaults_mode ("legacy")
|
185
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
186
|
+
# accepted modes and the configuration defaults that are included.
|
187
|
+
#
|
178
188
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
189
|
# Set to true to disable SDK automatically adding host prefix
|
180
190
|
# to default service endpoint when available.
|
@@ -296,6 +306,15 @@ module Aws::Kinesis
|
|
296
306
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
297
307
|
# requests are made, and retries are disabled.
|
298
308
|
#
|
309
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
310
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
311
|
+
# will be used if available.
|
312
|
+
#
|
313
|
+
# @option options [Boolean] :use_fips_endpoint
|
314
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
315
|
+
# When a `fips` region is used, the region is normalized and this config
|
316
|
+
# is set to `true`.
|
317
|
+
#
|
299
318
|
# @option options [Boolean] :validate_params (true)
|
300
319
|
# When `true`, request parameters are validated before
|
301
320
|
# sending the request.
|
@@ -307,7 +326,7 @@ module Aws::Kinesis
|
|
307
326
|
# seconds to wait when opening a HTTP session before raising a
|
308
327
|
# `Timeout::Error`.
|
309
328
|
#
|
310
|
-
# @option options [
|
329
|
+
# @option options [Float] :http_read_timeout (60) The default
|
311
330
|
# number of seconds to wait for response data. This value can
|
312
331
|
# safely be set per-request on the session.
|
313
332
|
#
|
@@ -323,6 +342,9 @@ module Aws::Kinesis
|
|
323
342
|
# disables this behaviour. This value can safely be set per
|
324
343
|
# request on the session.
|
325
344
|
#
|
345
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
346
|
+
# in seconds.
|
347
|
+
#
|
326
348
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
327
349
|
# HTTP debug output will be sent to the `:logger`.
|
328
350
|
#
|
@@ -348,10 +370,8 @@ module Aws::Kinesis
|
|
348
370
|
|
349
371
|
# @!group API Operations
|
350
372
|
|
351
|
-
# Adds or updates tags for the specified Kinesis data stream.
|
352
|
-
#
|
353
|
-
# to add more than 10 tags to your stream, you can invoke this operation
|
354
|
-
# multiple times. In total, each stream can have up to 50 tags.
|
373
|
+
# Adds or updates tags for the specified Kinesis data stream. You can
|
374
|
+
# assign up to 50 tags to a data stream.
|
355
375
|
#
|
356
376
|
# If tags have already been assigned to the stream, `AddTagsToStream`
|
357
377
|
# overwrites any existing tags that correspond to the specified tag
|
@@ -399,11 +419,11 @@ module Aws::Kinesis
|
|
399
419
|
# write total of 1 MiB per second. If the amount of data input increases
|
400
420
|
# or decreases, you can add or remove shards.
|
401
421
|
#
|
402
|
-
# The stream name identifies the stream. The name is scoped to the
|
403
|
-
# account used by the application. It is also scoped
|
404
|
-
# is, two streams in two different
|
405
|
-
#
|
406
|
-
# have the same name.
|
422
|
+
# The stream name identifies the stream. The name is scoped to the
|
423
|
+
# Amazon Web Services account used by the application. It is also scoped
|
424
|
+
# by Amazon Web Services Region. That is, two streams in two different
|
425
|
+
# accounts can have the same name, and two streams in the same account,
|
426
|
+
# but in two different Regions, can have the same name.
|
407
427
|
#
|
408
428
|
# `CreateStream` is an asynchronous operation. Upon receiving a
|
409
429
|
# `CreateStream` request, Kinesis Data Streams immediately returns and
|
@@ -419,11 +439,12 @@ module Aws::Kinesis
|
|
419
439
|
#
|
420
440
|
# * Create more shards than are authorized for your account.
|
421
441
|
#
|
422
|
-
# For the default shard limit for an
|
423
|
-
# Data Streams Limits][1] in the *Amazon Kinesis Data
|
424
|
-
# Guide*. To increase this limit, [contact
|
442
|
+
# For the default shard limit for an Amazon Web Services account, see
|
443
|
+
# [Amazon Kinesis Data Streams Limits][1] in the *Amazon Kinesis Data
|
444
|
+
# Streams Developer Guide*. To increase this limit, [contact Amazon Web
|
445
|
+
# Services Support][2].
|
425
446
|
#
|
426
|
-
# You can use
|
447
|
+
# You can use DescribeStreamSummary to check the stream status, which is
|
427
448
|
# returned in `StreamStatus`.
|
428
449
|
#
|
429
450
|
# CreateStream has a limit of five transactions per second per account.
|
@@ -434,24 +455,33 @@ module Aws::Kinesis
|
|
434
455
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
|
435
456
|
#
|
436
457
|
# @option params [required, String] :stream_name
|
437
|
-
# A name to identify the stream. The stream name is scoped to the
|
438
|
-
# account used by the application that creates the stream.
|
439
|
-
# scoped by
|
440
|
-
#
|
441
|
-
#
|
442
|
-
#
|
443
|
-
#
|
458
|
+
# A name to identify the stream. The stream name is scoped to the Amazon
|
459
|
+
# Web Services account used by the application that creates the stream.
|
460
|
+
# It is also scoped by Amazon Web Services Region. That is, two streams
|
461
|
+
# in two different Amazon Web Services accounts can have the same name.
|
462
|
+
# Two streams in the same Amazon Web Services account but in two
|
463
|
+
# different Regions can also have the same name.
|
464
|
+
#
|
465
|
+
# @option params [Integer] :shard_count
|
444
466
|
# The number of shards that the stream will use. The throughput of the
|
445
467
|
# stream is a function of the number of shards; more shards are required
|
446
468
|
# for greater provisioned throughput.
|
447
469
|
#
|
470
|
+
# @option params [Types::StreamModeDetails] :stream_mode_details
|
471
|
+
# Indicates the capacity mode of the data stream. Currently, in Kinesis
|
472
|
+
# Data Streams, you can choose between an **on-demand** capacity mode
|
473
|
+
# and a **provisioned** capacity mode for your data streams.
|
474
|
+
#
|
448
475
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
449
476
|
#
|
450
477
|
# @example Request syntax with placeholder values
|
451
478
|
#
|
452
479
|
# resp = client.create_stream({
|
453
480
|
# stream_name: "StreamName", # required
|
454
|
-
# shard_count: 1,
|
481
|
+
# shard_count: 1,
|
482
|
+
# stream_mode_details: {
|
483
|
+
# stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
|
484
|
+
# },
|
455
485
|
# })
|
456
486
|
#
|
457
487
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/CreateStream AWS API Documentation
|
@@ -512,8 +542,8 @@ module Aws::Kinesis
|
|
512
542
|
# When you delete a stream, any shards in that stream are also deleted,
|
513
543
|
# and any tags are dissociated from the stream.
|
514
544
|
#
|
515
|
-
# You can use the
|
516
|
-
# stream, which is returned in `StreamStatus`.
|
545
|
+
# You can use the DescribeStreamSummary operation to check the state of
|
546
|
+
# the stream, which is returned in `StreamStatus`.
|
517
547
|
#
|
518
548
|
# DeleteStream has a limit of five transactions per second per account.
|
519
549
|
#
|
@@ -556,8 +586,8 @@ module Aws::Kinesis
|
|
556
586
|
#
|
557
587
|
# @option params [String] :stream_arn
|
558
588
|
# The ARN of the Kinesis data stream that the consumer is registered
|
559
|
-
# with. For more information, see [Amazon Resource Names (ARNs) and
|
560
|
-
# Service Namespaces][1].
|
589
|
+
# with. For more information, see [Amazon Resource Names (ARNs) and
|
590
|
+
# Amazon Web Services Service Namespaces][1].
|
561
591
|
#
|
562
592
|
#
|
563
593
|
#
|
@@ -604,11 +634,15 @@ module Aws::Kinesis
|
|
604
634
|
#
|
605
635
|
# * {Types::DescribeLimitsOutput#shard_limit #shard_limit} => Integer
|
606
636
|
# * {Types::DescribeLimitsOutput#open_shard_count #open_shard_count} => Integer
|
637
|
+
# * {Types::DescribeLimitsOutput#on_demand_stream_count #on_demand_stream_count} => Integer
|
638
|
+
# * {Types::DescribeLimitsOutput#on_demand_stream_count_limit #on_demand_stream_count_limit} => Integer
|
607
639
|
#
|
608
640
|
# @example Response structure
|
609
641
|
#
|
610
642
|
# resp.shard_limit #=> Integer
|
611
643
|
# resp.open_shard_count #=> Integer
|
644
|
+
# resp.on_demand_stream_count #=> Integer
|
645
|
+
# resp.on_demand_stream_count_limit #=> Integer
|
612
646
|
#
|
613
647
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeLimits AWS API Documentation
|
614
648
|
#
|
@@ -621,6 +655,14 @@ module Aws::Kinesis
|
|
621
655
|
|
622
656
|
# Describes the specified Kinesis data stream.
|
623
657
|
#
|
658
|
+
# <note markdown="1"> This API has been revised. It's highly recommended that you use the
|
659
|
+
# DescribeStreamSummary API to get a summarized description of the
|
660
|
+
# specified Kinesis data stream and the ListShards API to list the
|
661
|
+
# shards in a specified data stream and obtain information about each
|
662
|
+
# shard.
|
663
|
+
#
|
664
|
+
# </note>
|
665
|
+
#
|
624
666
|
# The information returned includes the stream name, Amazon Resource
|
625
667
|
# Name (ARN), creation time, enhanced metric configuration, and shard
|
626
668
|
# map. The shard map is an array of shard objects. For each shard
|
@@ -650,11 +692,19 @@ module Aws::Kinesis
|
|
650
692
|
# @option params [Integer] :limit
|
651
693
|
# The maximum number of shards to return in a single call. The default
|
652
694
|
# value is 100. If you specify a value greater than 100, at most 100
|
653
|
-
#
|
695
|
+
# results are returned.
|
654
696
|
#
|
655
697
|
# @option params [String] :exclusive_start_shard_id
|
656
698
|
# The shard ID of the shard to start with.
|
657
699
|
#
|
700
|
+
# Specify this parameter to indicate that you want to describe the
|
701
|
+
# stream starting with the shard whose ID immediately follows
|
702
|
+
# `ExclusiveStartShardId`.
|
703
|
+
#
|
704
|
+
# If you don't specify this parameter, the default behavior for
|
705
|
+
# `DescribeStream` is to describe the stream starting with the first
|
706
|
+
# shard in the stream.
|
707
|
+
#
|
658
708
|
# @return [Types::DescribeStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
659
709
|
#
|
660
710
|
# * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
|
@@ -674,6 +724,7 @@ module Aws::Kinesis
|
|
674
724
|
# resp.stream_description.stream_name #=> String
|
675
725
|
# resp.stream_description.stream_arn #=> String
|
676
726
|
# resp.stream_description.stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
|
727
|
+
# resp.stream_description.stream_mode_details.stream_mode #=> String, one of "PROVISIONED", "ON_DEMAND"
|
677
728
|
# resp.stream_description.shards #=> Array
|
678
729
|
# resp.stream_description.shards[0].shard_id #=> String
|
679
730
|
# resp.stream_description.shards[0].parent_shard_id #=> String
|
@@ -719,8 +770,8 @@ module Aws::Kinesis
|
|
719
770
|
#
|
720
771
|
# @option params [String] :stream_arn
|
721
772
|
# The ARN of the Kinesis data stream that the consumer is registered
|
722
|
-
# with. For more information, see [Amazon Resource Names (ARNs) and
|
723
|
-
# Service Namespaces][1].
|
773
|
+
# with. For more information, see [Amazon Resource Names (ARNs) and
|
774
|
+
# Amazon Web Services Service Namespaces][1].
|
724
775
|
#
|
725
776
|
#
|
726
777
|
#
|
@@ -790,6 +841,7 @@ module Aws::Kinesis
|
|
790
841
|
# resp.stream_description_summary.stream_name #=> String
|
791
842
|
# resp.stream_description_summary.stream_arn #=> String
|
792
843
|
# resp.stream_description_summary.stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
|
844
|
+
# resp.stream_description_summary.stream_mode_details.stream_mode #=> String, one of "PROVISIONED", "ON_DEMAND"
|
793
845
|
# resp.stream_description_summary.retention_period_hours #=> Integer
|
794
846
|
# resp.stream_description_summary.stream_creation_timestamp #=> Time
|
795
847
|
# resp.stream_description_summary.enhanced_monitoring #=> Array
|
@@ -973,9 +1025,12 @@ module Aws::Kinesis
|
|
973
1025
|
# The maximum number of records that can be returned per call is 10,000.
|
974
1026
|
#
|
975
1027
|
# The size of the data returned by GetRecords varies depending on the
|
976
|
-
# utilization of the shard.
|
977
|
-
#
|
978
|
-
#
|
1028
|
+
# utilization of the shard. It is recommended that consumer applications
|
1029
|
+
# retrieve records via the `GetRecords` command using the 5 TPS limit to
|
1030
|
+
# remain caught up. Retrieving records less frequently can lead to
|
1031
|
+
# consumer applications falling behind. The maximum size of data that
|
1032
|
+
# GetRecords can return is 10 MiB. If a call returns this amount of
|
1033
|
+
# data, subsequent calls made within the next 5 seconds throw
|
979
1034
|
# `ProvisionedThroughputExceededException`. If there is insufficient
|
980
1035
|
# provisioned throughput on the stream, subsequent calls made within the
|
981
1036
|
# next 1 second throw `ProvisionedThroughputExceededException`.
|
@@ -1178,8 +1233,8 @@ module Aws::Kinesis
|
|
1178
1233
|
|
1179
1234
|
# Increases the Kinesis data stream's retention period, which is the
|
1180
1235
|
# length of time data records are accessible after they are added to the
|
1181
|
-
# stream. The maximum value of a stream's retention period is
|
1182
|
-
# (
|
1236
|
+
# stream. The maximum value of a stream's retention period is 8760
|
1237
|
+
# hours (365 days).
|
1183
1238
|
#
|
1184
1239
|
# If you choose a longer stream retention period, this operation
|
1185
1240
|
# increases the time period during which records that have not yet
|
@@ -1216,18 +1271,23 @@ module Aws::Kinesis
|
|
1216
1271
|
end
|
1217
1272
|
|
1218
1273
|
# Lists the shards in a stream and provides information about each
|
1219
|
-
# shard. This operation has a limit of
|
1274
|
+
# shard. This operation has a limit of 1000 transactions per second per
|
1220
1275
|
# data stream.
|
1221
1276
|
#
|
1277
|
+
# This action does not list expired shards. For information about
|
1278
|
+
# expired shards, see [Data Routing, Data Persistence, and Shard State
|
1279
|
+
# after a Reshard][1].
|
1280
|
+
#
|
1222
1281
|
# This API is a new operation that is used by the Amazon Kinesis Client
|
1223
1282
|
# Library (KCL). If you have a fine-grained IAM policy that only allows
|
1224
1283
|
# specific operations, you must update your policy to allow calls to
|
1225
1284
|
# this API. For more information, see [Controlling Access to Amazon
|
1226
|
-
# Kinesis Data Streams Resources Using IAM][
|
1285
|
+
# Kinesis Data Streams Resources Using IAM][2].
|
1227
1286
|
#
|
1228
1287
|
#
|
1229
1288
|
#
|
1230
|
-
# [1]: https://docs.aws.amazon.com/streams/latest/dev/
|
1289
|
+
# [1]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing
|
1290
|
+
# [2]: https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html
|
1231
1291
|
#
|
1232
1292
|
# @option params [String] :stream_name
|
1233
1293
|
# The name of the data stream whose shards you want to list.
|
@@ -1272,8 +1332,9 @@ module Aws::Kinesis
|
|
1272
1332
|
#
|
1273
1333
|
# @option params [Integer] :max_results
|
1274
1334
|
# The maximum number of shards to return in a single call to
|
1275
|
-
# `ListShards`. The
|
1276
|
-
#
|
1335
|
+
# `ListShards`. The maximum number of shards to return in a single call.
|
1336
|
+
# The default value is 1000. If you specify a value greater than 1000,
|
1337
|
+
# at most 1000 results are returned.
|
1277
1338
|
#
|
1278
1339
|
# When the number of shards to be listed is greater than the value of
|
1279
1340
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1291,6 +1352,28 @@ module Aws::Kinesis
|
|
1291
1352
|
# parameter.
|
1292
1353
|
#
|
1293
1354
|
# @option params [Types::ShardFilter] :shard_filter
|
1355
|
+
# Enables you to filter out the response of the `ListShards` API. You
|
1356
|
+
# can only specify one filter at a time.
|
1357
|
+
#
|
1358
|
+
# If you use the `ShardFilter` parameter when invoking the ListShards
|
1359
|
+
# API, the `Type` is the required property and must be specified. If you
|
1360
|
+
# specify the `AT_TRIM_HORIZON`, `FROM_TRIM_HORIZON`, or `AT_LATEST`
|
1361
|
+
# types, you do not need to specify either the `ShardId` or the
|
1362
|
+
# `Timestamp` optional properties.
|
1363
|
+
#
|
1364
|
+
# If you specify the `AFTER_SHARD_ID` type, you must also provide the
|
1365
|
+
# value for the optional `ShardId` property. The `ShardId` property is
|
1366
|
+
# identical in fuctionality to the `ExclusiveStartShardId` parameter of
|
1367
|
+
# the `ListShards` API. When `ShardId` property is specified, the
|
1368
|
+
# response includes the shards starting with the shard whose ID
|
1369
|
+
# immediately follows the `ShardId` that you provided.
|
1370
|
+
#
|
1371
|
+
# If you specify the `AT_TIMESTAMP` or `FROM_TIMESTAMP_ID` type, you
|
1372
|
+
# must also provide the value for the optional `Timestamp` property. If
|
1373
|
+
# you specify the AT\_TIMESTAMP type, then all shards that were open at
|
1374
|
+
# the provided timestamp are returned. If you specify the
|
1375
|
+
# FROM\_TIMESTAMP type, then all shards starting from the provided
|
1376
|
+
# timestamp to TIP are returned.
|
1294
1377
|
#
|
1295
1378
|
# @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1296
1379
|
#
|
@@ -1341,7 +1424,7 @@ module Aws::Kinesis
|
|
1341
1424
|
# @option params [required, String] :stream_arn
|
1342
1425
|
# The ARN of the Kinesis data stream for which you want to list the
|
1343
1426
|
# registered consumers. For more information, see [Amazon Resource Names
|
1344
|
-
# (ARNs) and
|
1427
|
+
# (ARNs) and Amazon Web Services Service Namespaces][1].
|
1345
1428
|
#
|
1346
1429
|
#
|
1347
1430
|
#
|
@@ -1375,7 +1458,8 @@ module Aws::Kinesis
|
|
1375
1458
|
#
|
1376
1459
|
# @option params [Integer] :max_results
|
1377
1460
|
# The maximum number of consumers that you want a single call of
|
1378
|
-
# `ListStreamConsumers` to return.
|
1461
|
+
# `ListStreamConsumers` to return. The default value is 100. If you
|
1462
|
+
# specify a value greater than 100, at most 100 results are returned.
|
1379
1463
|
#
|
1380
1464
|
# @option params [Time,DateTime,Date,Integer,String] :stream_creation_timestamp
|
1381
1465
|
# Specify this input parameter to distinguish data streams that have the
|
@@ -1427,7 +1511,7 @@ module Aws::Kinesis
|
|
1427
1511
|
# `ListStreams`. You can limit the number of returned streams using the
|
1428
1512
|
# `Limit` parameter. If you do not specify a value for the `Limit`
|
1429
1513
|
# parameter, Kinesis Data Streams uses the default limit, which is
|
1430
|
-
# currently
|
1514
|
+
# currently 100.
|
1431
1515
|
#
|
1432
1516
|
# You can detect if there are more streams available to list by using
|
1433
1517
|
# the `HasMoreStreams` flag from the returned output. If there are more
|
@@ -1441,7 +1525,9 @@ module Aws::Kinesis
|
|
1441
1525
|
# ListStreams has a limit of five transactions per second per account.
|
1442
1526
|
#
|
1443
1527
|
# @option params [Integer] :limit
|
1444
|
-
# The maximum number of streams to list.
|
1528
|
+
# The maximum number of streams to list. The default value is 100. If
|
1529
|
+
# you specify a value greater than 100, at most 100 results are
|
1530
|
+
# returned.
|
1445
1531
|
#
|
1446
1532
|
# @option params [String] :exclusive_start_stream_name
|
1447
1533
|
# The name of the stream to start the list with.
|
@@ -1544,8 +1630,8 @@ module Aws::Kinesis
|
|
1544
1630
|
# stream does not exist, `MergeShards` returns a
|
1545
1631
|
# `ResourceNotFoundException`.
|
1546
1632
|
#
|
1547
|
-
# You can use
|
1548
|
-
# returned in `StreamStatus`.
|
1633
|
+
# You can use DescribeStreamSummary to check the state of the stream,
|
1634
|
+
# which is returned in `StreamStatus`.
|
1549
1635
|
#
|
1550
1636
|
# `MergeShards` is an asynchronous operation. Upon receiving a
|
1551
1637
|
# `MergeShards` request, Amazon Kinesis Data Streams immediately returns
|
@@ -1554,8 +1640,8 @@ module Aws::Kinesis
|
|
1554
1640
|
# to `ACTIVE`. Read and write operations continue to work while the
|
1555
1641
|
# stream is in the `UPDATING` state.
|
1556
1642
|
#
|
1557
|
-
# You use
|
1558
|
-
# in the `MergeShards` request.
|
1643
|
+
# You use DescribeStreamSummary and the ListShards APIs to determine the
|
1644
|
+
# shard IDs that are specified in the `MergeShards` request.
|
1559
1645
|
#
|
1560
1646
|
# If you try to operate on too many streams in parallel using
|
1561
1647
|
# CreateStream, DeleteStream, `MergeShards`, or SplitShard, you receive
|
@@ -1861,7 +1947,7 @@ module Aws::Kinesis
|
|
1861
1947
|
# @option params [required, String] :stream_arn
|
1862
1948
|
# The ARN of the Kinesis data stream that you want to register the
|
1863
1949
|
# consumer with. For more info, see [Amazon Resource Names (ARNs) and
|
1864
|
-
#
|
1950
|
+
# Amazon Web Services Service Namespaces][1].
|
1865
1951
|
#
|
1866
1952
|
#
|
1867
1953
|
#
|
@@ -1952,9 +2038,10 @@ module Aws::Kinesis
|
|
1952
2038
|
# mapped into the shard. For more information, see [Split a Shard][1] in
|
1953
2039
|
# the *Amazon Kinesis Data Streams Developer Guide*.
|
1954
2040
|
#
|
1955
|
-
# You can use
|
1956
|
-
# values for the `ShardToSplit` and
|
1957
|
-
# are specified in the `SplitShard`
|
2041
|
+
# You can use DescribeStreamSummary and the ListShards APIs to determine
|
2042
|
+
# the shard ID and hash key values for the `ShardToSplit` and
|
2043
|
+
# `NewStartingHashKey` parameters that are specified in the `SplitShard`
|
2044
|
+
# request.
|
1958
2045
|
#
|
1959
2046
|
# `SplitShard` is an asynchronous operation. Upon receiving a
|
1960
2047
|
# `SplitShard` request, Kinesis Data Streams immediately returns a
|
@@ -1963,19 +2050,19 @@ module Aws::Kinesis
|
|
1963
2050
|
# Read and write operations continue to work while the stream is in the
|
1964
2051
|
# `UPDATING` state.
|
1965
2052
|
#
|
1966
|
-
# You can use
|
1967
|
-
# is returned in `StreamStatus`. If the stream is in the `ACTIVE`
|
1968
|
-
# you can call `SplitShard`.
|
1969
|
-
# or `DELETING` states, `DescribeStream` returns a
|
1970
|
-
# `ResourceInUseException`.
|
2053
|
+
# You can use DescribeStreamSummary to check the status of the stream,
|
2054
|
+
# which is returned in `StreamStatus`. If the stream is in the `ACTIVE`
|
2055
|
+
# state, you can call `SplitShard`.
|
1971
2056
|
#
|
1972
|
-
# If the specified stream does not exist,
|
1973
|
-
# `ResourceNotFoundException`. If you try to create more shards than
|
1974
|
-
# authorized for your account, you receive a
|
2057
|
+
# If the specified stream does not exist, DescribeStreamSummary returns
|
2058
|
+
# a `ResourceNotFoundException`. If you try to create more shards than
|
2059
|
+
# are authorized for your account, you receive a
|
2060
|
+
# `LimitExceededException`.
|
1975
2061
|
#
|
1976
|
-
# For the default shard limit for an
|
1977
|
-
# Streams Limits][2] in the *Amazon Kinesis Data Streams
|
1978
|
-
# Guide*. To increase this limit, [contact
|
2062
|
+
# For the default shard limit for an Amazon Web Services account, see
|
2063
|
+
# [Kinesis Data Streams Limits][2] in the *Amazon Kinesis Data Streams
|
2064
|
+
# Developer Guide*. To increase this limit, [contact Amazon Web Services
|
2065
|
+
# Support][3].
|
1979
2066
|
#
|
1980
2067
|
# If you try to operate on too many streams simultaneously using
|
1981
2068
|
# CreateStream, DeleteStream, MergeShards, and/or SplitShard, you
|
@@ -2024,8 +2111,8 @@ module Aws::Kinesis
|
|
2024
2111
|
req.send_request(options)
|
2025
2112
|
end
|
2026
2113
|
|
2027
|
-
# Enables or updates server-side encryption using an
|
2028
|
-
# specified stream.
|
2114
|
+
# Enables or updates server-side encryption using an Amazon Web Services
|
2115
|
+
# KMS key for a specified stream.
|
2029
2116
|
#
|
2030
2117
|
# Starting encryption is an asynchronous operation. Upon receiving the
|
2031
2118
|
# request, Kinesis Data Streams returns immediately and sets the status
|
@@ -2036,8 +2123,8 @@ module Aws::Kinesis
|
|
2036
2123
|
# stream while its status is `UPDATING`. Once the status of the stream
|
2037
2124
|
# is `ACTIVE`, encryption begins for records written to the stream.
|
2038
2125
|
#
|
2039
|
-
# API Limits: You can successfully apply a new
|
2040
|
-
# server-side encryption 25 times in a rolling 24-hour period.
|
2126
|
+
# API Limits: You can successfully apply a new Amazon Web Services KMS
|
2127
|
+
# key for server-side encryption 25 times in a rolling 24-hour period.
|
2041
2128
|
#
|
2042
2129
|
# Note: It can take up to 5 seconds after the stream is in an `ACTIVE`
|
2043
2130
|
# status before all records written to the stream are encrypted. After
|
@@ -2051,11 +2138,12 @@ module Aws::Kinesis
|
|
2051
2138
|
# The encryption type to use. The only valid value is `KMS`.
|
2052
2139
|
#
|
2053
2140
|
# @option params [required, String] :key_id
|
2054
|
-
# The GUID for the customer-managed
|
2055
|
-
# This value can be a globally unique identifier, a
|
2056
|
-
# Amazon Resource Name (ARN) to either an alias or a
|
2057
|
-
# name prefixed by "alias/".You can also use a master
|
2058
|
-
# Kinesis Data Streams by specifying the alias
|
2141
|
+
# The GUID for the customer-managed Amazon Web Services KMS key to use
|
2142
|
+
# for encryption. This value can be a globally unique identifier, a
|
2143
|
+
# fully specified Amazon Resource Name (ARN) to either an alias or a
|
2144
|
+
# key, or an alias name prefixed by "alias/".You can also use a master
|
2145
|
+
# key owned by Kinesis Data Streams by specifying the alias
|
2146
|
+
# `aws/kinesis`.
|
2059
2147
|
#
|
2060
2148
|
# * Key ARN example:
|
2061
2149
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2117,11 +2205,12 @@ module Aws::Kinesis
|
|
2117
2205
|
# The encryption type. The only valid value is `KMS`.
|
2118
2206
|
#
|
2119
2207
|
# @option params [required, String] :key_id
|
2120
|
-
# The GUID for the customer-managed
|
2121
|
-
# This value can be a globally unique identifier, a
|
2122
|
-
# Amazon Resource Name (ARN) to either an alias or a
|
2123
|
-
# name prefixed by "alias/".You can also use a master
|
2124
|
-
# Kinesis Data Streams by specifying the alias
|
2208
|
+
# The GUID for the customer-managed Amazon Web Services KMS key to use
|
2209
|
+
# for encryption. This value can be a globally unique identifier, a
|
2210
|
+
# fully specified Amazon Resource Name (ARN) to either an alias or a
|
2211
|
+
# key, or an alias name prefixed by "alias/".You can also use a master
|
2212
|
+
# key owned by Kinesis Data Streams by specifying the alias
|
2213
|
+
# `aws/kinesis`.
|
2125
2214
|
#
|
2126
2215
|
# * Key ARN example:
|
2127
2216
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2186,17 +2275,17 @@ module Aws::Kinesis
|
|
2186
2275
|
#
|
2187
2276
|
# * Scale down below half your current shard count for a stream
|
2188
2277
|
#
|
2189
|
-
# * Scale up to more than
|
2278
|
+
# * Scale up to more than 10000 shards in a stream
|
2190
2279
|
#
|
2191
|
-
# * Scale a stream with more than
|
2192
|
-
# less than
|
2280
|
+
# * Scale a stream with more than 10000 shards down unless the result is
|
2281
|
+
# less than 10000 shards
|
2193
2282
|
#
|
2194
2283
|
# * Scale up to more than the shard limit for your account
|
2195
2284
|
#
|
2196
|
-
# For the default limits for an
|
2197
|
-
# the *Amazon Kinesis Data Streams Developer
|
2198
|
-
# increase in the call rate limit, the shard limit
|
2199
|
-
# overall shard limit, use the [limits form][2].
|
2285
|
+
# For the default limits for an Amazon Web Services account, see
|
2286
|
+
# [Streams Limits][1] in the *Amazon Kinesis Data Streams Developer
|
2287
|
+
# Guide*. To request an increase in the call rate limit, the shard limit
|
2288
|
+
# for this API, or your overall shard limit, use the [limits form][2].
|
2200
2289
|
#
|
2201
2290
|
#
|
2202
2291
|
#
|
@@ -2215,12 +2304,12 @@ module Aws::Kinesis
|
|
2215
2304
|
#
|
2216
2305
|
# * Set this value below half your current shard count for a stream.
|
2217
2306
|
#
|
2218
|
-
# * Set this value to more than
|
2219
|
-
# limit for shard count per stream is
|
2307
|
+
# * Set this value to more than 10000 shards in a stream (the default
|
2308
|
+
# limit for shard count per stream is 10000 per account per region),
|
2220
2309
|
# unless you request a limit increase.
|
2221
2310
|
#
|
2222
|
-
# * Scale a stream with more than
|
2223
|
-
# value to less than
|
2311
|
+
# * Scale a stream with more than 10000 shards down unless you set this
|
2312
|
+
# value to less than 10000 shards.
|
2224
2313
|
#
|
2225
2314
|
# @option params [required, String] :scaling_type
|
2226
2315
|
# The scaling type. Uniform scaling creates shards of equal size.
|
@@ -2254,6 +2343,40 @@ module Aws::Kinesis
|
|
2254
2343
|
req.send_request(options)
|
2255
2344
|
end
|
2256
2345
|
|
2346
|
+
# Updates the capacity mode of the data stream. Currently, in Kinesis
|
2347
|
+
# Data Streams, you can choose between an **on-demand** capacity mode
|
2348
|
+
# and a **provisioned** capacity mode for your data stream.
|
2349
|
+
#
|
2350
|
+
# @option params [required, String] :stream_arn
|
2351
|
+
# Specifies the ARN of the data stream whose capacity mode you want to
|
2352
|
+
# update.
|
2353
|
+
#
|
2354
|
+
# @option params [required, Types::StreamModeDetails] :stream_mode_details
|
2355
|
+
# Specifies the capacity mode to which you want to set your data stream.
|
2356
|
+
# Currently, in Kinesis Data Streams, you can choose between an
|
2357
|
+
# **on-demand** capacity mode and a **provisioned** capacity mode for
|
2358
|
+
# your data streams.
|
2359
|
+
#
|
2360
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2361
|
+
#
|
2362
|
+
# @example Request syntax with placeholder values
|
2363
|
+
#
|
2364
|
+
# resp = client.update_stream_mode({
|
2365
|
+
# stream_arn: "StreamARN", # required
|
2366
|
+
# stream_mode_details: { # required
|
2367
|
+
# stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
|
2368
|
+
# },
|
2369
|
+
# })
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateStreamMode AWS API Documentation
|
2372
|
+
#
|
2373
|
+
# @overload update_stream_mode(params = {})
|
2374
|
+
# @param [Hash] params ({})
|
2375
|
+
def update_stream_mode(params = {}, options = {})
|
2376
|
+
req = build_request(:update_stream_mode, params)
|
2377
|
+
req.send_request(options)
|
2378
|
+
end
|
2379
|
+
|
2257
2380
|
# @!endgroup
|
2258
2381
|
|
2259
2382
|
# @param params ({})
|
@@ -2267,7 +2390,7 @@ module Aws::Kinesis
|
|
2267
2390
|
params: params,
|
2268
2391
|
config: config)
|
2269
2392
|
context[:gem_name] = 'aws-sdk-kinesis'
|
2270
|
-
context[:gem_version] = '1.
|
2393
|
+
context[:gem_version] = '1.40.0'
|
2271
2394
|
Seahorse::Client::Request.new(handlers, context)
|
2272
2395
|
end
|
2273
2396
|
|