aws-sdk-kinesis 1.37.0 → 1.38.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesis/async_client.rb +9 -4
- data/lib/aws-sdk-kinesis/client.rb +191 -88
- data/lib/aws-sdk-kinesis/client_api.rb +37 -1
- data/lib/aws-sdk-kinesis/errors.rb +16 -0
- data/lib/aws-sdk-kinesis/types.rb +256 -56
- data/lib/aws-sdk-kinesis.rb +1 -1
- metadata +2 -2
@@ -39,10 +39,15 @@ module Aws::Kinesis
|
|
39
39
|
include Aws::Structure
|
40
40
|
end
|
41
41
|
|
42
|
+
# Output parameter of the GetRecords API. The existing child shard of
|
43
|
+
# the current shard.
|
44
|
+
#
|
42
45
|
# @!attribute [rw] shard_id
|
46
|
+
# The shard ID of the existing child shard of the current shard.
|
43
47
|
# @return [String]
|
44
48
|
#
|
45
49
|
# @!attribute [rw] parent_shards
|
50
|
+
# The current shard that is the parent of the existing child shard.
|
46
51
|
# @return [Array<String>]
|
47
52
|
#
|
48
53
|
# @!attribute [rw] hash_key_range
|
@@ -146,14 +151,18 @@ module Aws::Kinesis
|
|
146
151
|
#
|
147
152
|
# {
|
148
153
|
# stream_name: "StreamName", # required
|
149
|
-
# shard_count: 1,
|
154
|
+
# shard_count: 1,
|
155
|
+
# stream_mode_details: {
|
156
|
+
# stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
|
157
|
+
# },
|
150
158
|
# }
|
151
159
|
#
|
152
160
|
# @!attribute [rw] stream_name
|
153
|
-
# A name to identify the stream. The stream name is scoped to the
|
154
|
-
# account used by the application that creates the
|
155
|
-
# scoped by
|
156
|
-
#
|
161
|
+
# A name to identify the stream. The stream name is scoped to the
|
162
|
+
# Amazon Web Services account used by the application that creates the
|
163
|
+
# stream. It is also scoped by Amazon Web Services Region. That is,
|
164
|
+
# two streams in two different Amazon Web Services accounts can have
|
165
|
+
# the same name. Two streams in the same Amazon Web Services account
|
157
166
|
# but in two different Regions can also have the same name.
|
158
167
|
# @return [String]
|
159
168
|
#
|
@@ -163,11 +172,19 @@ module Aws::Kinesis
|
|
163
172
|
# required for greater provisioned throughput.
|
164
173
|
# @return [Integer]
|
165
174
|
#
|
175
|
+
# @!attribute [rw] stream_mode_details
|
176
|
+
# Indicates the capacity mode of the data stream. Currently, in
|
177
|
+
# Kinesis Data Streams, you can choose between an **on-demand**
|
178
|
+
# capacity mode and a **provisioned** capacity mode for your data
|
179
|
+
# streams.
|
180
|
+
# @return [Types::StreamModeDetails]
|
181
|
+
#
|
166
182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/CreateStreamInput AWS API Documentation
|
167
183
|
#
|
168
184
|
class CreateStreamInput < Struct.new(
|
169
185
|
:stream_name,
|
170
|
-
:shard_count
|
186
|
+
:shard_count,
|
187
|
+
:stream_mode_details)
|
171
188
|
SENSITIVE = []
|
172
189
|
include Aws::Structure
|
173
190
|
end
|
@@ -241,7 +258,7 @@ module Aws::Kinesis
|
|
241
258
|
# @!attribute [rw] stream_arn
|
242
259
|
# The ARN of the Kinesis data stream that the consumer is registered
|
243
260
|
# with. For more information, see [Amazon Resource Names (ARNs) and
|
244
|
-
#
|
261
|
+
# Amazon Web Services Service Namespaces][1].
|
245
262
|
#
|
246
263
|
#
|
247
264
|
#
|
@@ -285,11 +302,22 @@ module Aws::Kinesis
|
|
285
302
|
# The number of open shards.
|
286
303
|
# @return [Integer]
|
287
304
|
#
|
305
|
+
# @!attribute [rw] on_demand_stream_count
|
306
|
+
# Indicates the number of data streams with the on-demand capacity
|
307
|
+
# mode.
|
308
|
+
# @return [Integer]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] on_demand_stream_count_limit
|
311
|
+
# The maximum number of data streams with the on-demand capacity mode.
|
312
|
+
# @return [Integer]
|
313
|
+
#
|
288
314
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeLimitsOutput AWS API Documentation
|
289
315
|
#
|
290
316
|
class DescribeLimitsOutput < Struct.new(
|
291
317
|
:shard_limit,
|
292
|
-
:open_shard_count
|
318
|
+
:open_shard_count,
|
319
|
+
:on_demand_stream_count,
|
320
|
+
:on_demand_stream_count_limit)
|
293
321
|
SENSITIVE = []
|
294
322
|
include Aws::Structure
|
295
323
|
end
|
@@ -306,7 +334,7 @@ module Aws::Kinesis
|
|
306
334
|
# @!attribute [rw] stream_arn
|
307
335
|
# The ARN of the Kinesis data stream that the consumer is registered
|
308
336
|
# with. For more information, see [Amazon Resource Names (ARNs) and
|
309
|
-
#
|
337
|
+
# Amazon Web Services Service Namespaces][1].
|
310
338
|
#
|
311
339
|
#
|
312
340
|
#
|
@@ -362,11 +390,19 @@ module Aws::Kinesis
|
|
362
390
|
# @!attribute [rw] limit
|
363
391
|
# The maximum number of shards to return in a single call. The default
|
364
392
|
# value is 100. If you specify a value greater than 100, at most 100
|
365
|
-
#
|
393
|
+
# results are returned.
|
366
394
|
# @return [Integer]
|
367
395
|
#
|
368
396
|
# @!attribute [rw] exclusive_start_shard_id
|
369
397
|
# The shard ID of the shard to start with.
|
398
|
+
#
|
399
|
+
# Specify this parameter to indicate that you want to describe the
|
400
|
+
# stream starting with the shard whose ID immediately follows
|
401
|
+
# `ExclusiveStartShardId`.
|
402
|
+
#
|
403
|
+
# If you don't specify this parameter, the default behavior for
|
404
|
+
# `DescribeStream` is to describe the stream starting with the first
|
405
|
+
# shard in the stream.
|
370
406
|
# @return [String]
|
371
407
|
#
|
372
408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamInput AWS API Documentation
|
@@ -682,6 +718,9 @@ module Aws::Kinesis
|
|
682
718
|
# @return [Integer]
|
683
719
|
#
|
684
720
|
# @!attribute [rw] child_shards
|
721
|
+
# The list of the current shard's child shards, returned in the
|
722
|
+
# `GetRecords` API's response only when the end of the current shard
|
723
|
+
# is reached.
|
685
724
|
# @return [Array<Types::ChildShard>]
|
686
725
|
#
|
687
726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecordsOutput AWS API Documentation
|
@@ -898,8 +937,8 @@ module Aws::Kinesis
|
|
898
937
|
|
899
938
|
# The request was rejected because the state of the specified resource
|
900
939
|
# isn't valid for this request. For more information, see [How Key
|
901
|
-
# State Affects Use of a Customer Master Key][1] in the *
|
902
|
-
# Management Service Developer Guide*.
|
940
|
+
# State Affects Use of a Customer Master Key][1] in the *Amazon Web
|
941
|
+
# Services Key Management Service Developer Guide*.
|
903
942
|
#
|
904
943
|
#
|
905
944
|
#
|
@@ -934,7 +973,8 @@ module Aws::Kinesis
|
|
934
973
|
include Aws::Structure
|
935
974
|
end
|
936
975
|
|
937
|
-
# The
|
976
|
+
# The Amazon Web Services access key ID needs a subscription for the
|
977
|
+
# service.
|
938
978
|
#
|
939
979
|
# @!attribute [rw] message
|
940
980
|
# A message that provides information about the error.
|
@@ -950,8 +990,8 @@ module Aws::Kinesis
|
|
950
990
|
end
|
951
991
|
|
952
992
|
# The request was denied due to request throttling. For more information
|
953
|
-
# about throttling, see [Limits][1] in the *
|
954
|
-
# Developer Guide*.
|
993
|
+
# about throttling, see [Limits][1] in the *Amazon Web Services Key
|
994
|
+
# Management Service Developer Guide*.
|
955
995
|
#
|
956
996
|
#
|
957
997
|
#
|
@@ -1048,8 +1088,9 @@ module Aws::Kinesis
|
|
1048
1088
|
#
|
1049
1089
|
# @!attribute [rw] max_results
|
1050
1090
|
# The maximum number of shards to return in a single call to
|
1051
|
-
# `ListShards`. The
|
1052
|
-
#
|
1091
|
+
# `ListShards`. The maximum number of shards to return in a single
|
1092
|
+
# call. The default value is 1000. If you specify a value greater than
|
1093
|
+
# 1000, at most 1000 results are returned.
|
1053
1094
|
#
|
1054
1095
|
# When the number of shards to be listed is greater than the value of
|
1055
1096
|
# `MaxResults`, the response contains a `NextToken` value that you can
|
@@ -1069,6 +1110,28 @@ module Aws::Kinesis
|
|
1069
1110
|
# @return [Time]
|
1070
1111
|
#
|
1071
1112
|
# @!attribute [rw] shard_filter
|
1113
|
+
# Enables you to filter out the response of the `ListShards` API. You
|
1114
|
+
# can only specify one filter at a time.
|
1115
|
+
#
|
1116
|
+
# If you use the `ShardFilter` parameter when invoking the ListShards
|
1117
|
+
# API, the `Type` is the required property and must be specified. If
|
1118
|
+
# you specify the `AT_TRIM_HORIZON`, `FROM_TRIM_HORIZON`, or
|
1119
|
+
# `AT_LATEST` types, you do not need to specify either the `ShardId`
|
1120
|
+
# or the `Timestamp` optional properties.
|
1121
|
+
#
|
1122
|
+
# If you specify the `AFTER_SHARD_ID` type, you must also provide the
|
1123
|
+
# value for the optional `ShardId` property. The `ShardId` property is
|
1124
|
+
# identical in fuctionality to the `ExclusiveStartShardId` parameter
|
1125
|
+
# of the `ListShards` API. When `ShardId` property is specified, the
|
1126
|
+
# response includes the shards starting with the shard whose ID
|
1127
|
+
# immediately follows the `ShardId` that you provided.
|
1128
|
+
#
|
1129
|
+
# If you specify the `AT_TIMESTAMP` or `FROM_TIMESTAMP_ID` type, you
|
1130
|
+
# must also provide the value for the optional `Timestamp` property.
|
1131
|
+
# If you specify the AT\_TIMESTAMP type, then all shards that were
|
1132
|
+
# open at the provided timestamp are returned. If you specify the
|
1133
|
+
# FROM\_TIMESTAMP type, then all shards starting from the provided
|
1134
|
+
# timestamp to TIP are returned.
|
1072
1135
|
# @return [Types::ShardFilter]
|
1073
1136
|
#
|
1074
1137
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListShardsInput AWS API Documentation
|
@@ -1130,7 +1193,7 @@ module Aws::Kinesis
|
|
1130
1193
|
# @!attribute [rw] stream_arn
|
1131
1194
|
# The ARN of the Kinesis data stream for which you want to list the
|
1132
1195
|
# registered consumers. For more information, see [Amazon Resource
|
1133
|
-
# Names (ARNs) and
|
1196
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][1].
|
1134
1197
|
#
|
1135
1198
|
#
|
1136
1199
|
#
|
@@ -1168,7 +1231,8 @@ module Aws::Kinesis
|
|
1168
1231
|
#
|
1169
1232
|
# @!attribute [rw] max_results
|
1170
1233
|
# The maximum number of consumers that you want a single call of
|
1171
|
-
# `ListStreamConsumers` to return.
|
1234
|
+
# `ListStreamConsumers` to return. The default value is 100. If you
|
1235
|
+
# specify a value greater than 100, at most 100 results are returned.
|
1172
1236
|
# @return [Integer]
|
1173
1237
|
#
|
1174
1238
|
# @!attribute [rw] stream_creation_timestamp
|
@@ -1237,7 +1301,9 @@ module Aws::Kinesis
|
|
1237
1301
|
# }
|
1238
1302
|
#
|
1239
1303
|
# @!attribute [rw] limit
|
1240
|
-
# The maximum number of streams to list.
|
1304
|
+
# The maximum number of streams to list. The default value is 100. If
|
1305
|
+
# you specify a value greater than 100, at most 100 results are
|
1306
|
+
# returned.
|
1241
1307
|
# @return [Integer]
|
1242
1308
|
#
|
1243
1309
|
# @!attribute [rw] exclusive_start_stream_name
|
@@ -1256,8 +1322,8 @@ module Aws::Kinesis
|
|
1256
1322
|
# Represents the output for `ListStreams`.
|
1257
1323
|
#
|
1258
1324
|
# @!attribute [rw] stream_names
|
1259
|
-
# The names of the streams that are associated with the
|
1260
|
-
# making the `ListStreams` request.
|
1325
|
+
# The names of the streams that are associated with the Amazon Web
|
1326
|
+
# Services account making the `ListStreams` request.
|
1261
1327
|
# @return [Array<String>]
|
1262
1328
|
#
|
1263
1329
|
# @!attribute [rw] has_more_streams
|
@@ -1371,7 +1437,8 @@ module Aws::Kinesis
|
|
1371
1437
|
# too large for the available throughput. Reduce the frequency or size
|
1372
1438
|
# of your requests. For more information, see [Streams Limits][1] in the
|
1373
1439
|
# *Amazon Kinesis Data Streams Developer Guide*, and [Error Retries and
|
1374
|
-
# Exponential Backoff in
|
1440
|
+
# Exponential Backoff in Amazon Web Services][2] in the *Amazon Web
|
1441
|
+
# Services General Reference*.
|
1375
1442
|
#
|
1376
1443
|
#
|
1377
1444
|
#
|
@@ -1472,7 +1539,7 @@ module Aws::Kinesis
|
|
1472
1539
|
# * `NONE`\: Do not encrypt the records in the stream.
|
1473
1540
|
#
|
1474
1541
|
# * `KMS`\: Use server-side encryption on the records in the stream
|
1475
|
-
# using a customer-managed
|
1542
|
+
# using a customer-managed Amazon Web Services KMS key.
|
1476
1543
|
# @return [String]
|
1477
1544
|
#
|
1478
1545
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordOutput AWS API Documentation
|
@@ -1527,10 +1594,10 @@ module Aws::Kinesis
|
|
1527
1594
|
#
|
1528
1595
|
# @!attribute [rw] records
|
1529
1596
|
# An array of successfully and unsuccessfully processed record
|
1530
|
-
# results
|
1531
|
-
#
|
1532
|
-
#
|
1533
|
-
#
|
1597
|
+
# results. A record that is successfully added to a stream includes
|
1598
|
+
# `SequenceNumber` and `ShardId` in the result. A record that fails to
|
1599
|
+
# be added to a stream includes `ErrorCode` and `ErrorMessage` in the
|
1600
|
+
# result.
|
1534
1601
|
# @return [Array<Types::PutRecordsResultEntry>]
|
1535
1602
|
#
|
1536
1603
|
# @!attribute [rw] encryption_type
|
@@ -1540,7 +1607,7 @@ module Aws::Kinesis
|
|
1540
1607
|
# * `NONE`\: Do not encrypt the records.
|
1541
1608
|
#
|
1542
1609
|
# * `KMS`\: Use server-side encryption on the records using a
|
1543
|
-
# customer-managed
|
1610
|
+
# customer-managed Amazon Web Services KMS key.
|
1544
1611
|
# @return [String]
|
1545
1612
|
#
|
1546
1613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordsOutput AWS API Documentation
|
@@ -1667,7 +1734,7 @@ module Aws::Kinesis
|
|
1667
1734
|
# * `NONE`\: Do not encrypt the records in the stream.
|
1668
1735
|
#
|
1669
1736
|
# * `KMS`\: Use server-side encryption on the records in the stream
|
1670
|
-
# using a customer-managed
|
1737
|
+
# using a customer-managed Amazon Web Services KMS key.
|
1671
1738
|
# @return [String]
|
1672
1739
|
#
|
1673
1740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/Record AWS API Documentation
|
@@ -1693,7 +1760,7 @@ module Aws::Kinesis
|
|
1693
1760
|
# @!attribute [rw] stream_arn
|
1694
1761
|
# The ARN of the Kinesis data stream that you want to register the
|
1695
1762
|
# consumer with. For more info, see [Amazon Resource Names (ARNs) and
|
1696
|
-
#
|
1763
|
+
# Amazon Web Services Service Namespaces][1].
|
1697
1764
|
#
|
1698
1765
|
#
|
1699
1766
|
#
|
@@ -1844,6 +1911,9 @@ module Aws::Kinesis
|
|
1844
1911
|
include Aws::Structure
|
1845
1912
|
end
|
1846
1913
|
|
1914
|
+
# The request parameter used to filter out the response of the
|
1915
|
+
# `ListShards` API.
|
1916
|
+
#
|
1847
1917
|
# @note When making an API call, you may pass ShardFilter
|
1848
1918
|
# data as a hash:
|
1849
1919
|
#
|
@@ -1854,12 +1924,48 @@ module Aws::Kinesis
|
|
1854
1924
|
# }
|
1855
1925
|
#
|
1856
1926
|
# @!attribute [rw] type
|
1927
|
+
# The shard type specified in the `ShardFilter` parameter. This is a
|
1928
|
+
# required property of the `ShardFilter` parameter.
|
1929
|
+
#
|
1930
|
+
# You can specify the following valid values:
|
1931
|
+
#
|
1932
|
+
# * `AFTER_SHARD_ID` - the response includes all the shards, starting
|
1933
|
+
# with the shard whose ID immediately follows the `ShardId` that you
|
1934
|
+
# provided.
|
1935
|
+
#
|
1936
|
+
# * `AT_TRIM_HORIZON` - the response includes all the shards that were
|
1937
|
+
# open at `TRIM_HORIZON`.
|
1938
|
+
#
|
1939
|
+
# * `FROM_TRIM_HORIZON` - (default), the response includes all the
|
1940
|
+
# shards within the retention period of the data stream (trim to
|
1941
|
+
# tip).
|
1942
|
+
#
|
1943
|
+
# * `AT_LATEST` - the response includes only the currently open shards
|
1944
|
+
# of the data stream.
|
1945
|
+
#
|
1946
|
+
# * `AT_TIMESTAMP` - the response includes all shards whose start
|
1947
|
+
# timestamp is less than or equal to the given timestamp and end
|
1948
|
+
# timestamp is greater than or equal to the given timestamp or still
|
1949
|
+
# open.
|
1950
|
+
#
|
1951
|
+
# * `FROM_TIMESTAMP` - the response incldues all closed shards whose
|
1952
|
+
# end timestamp is greater than or equal to the given timestamp and
|
1953
|
+
# also all open shards. Corrected to `TRIM_HORIZON` of the data
|
1954
|
+
# stream if `FROM_TIMESTAMP` is less than the `TRIM_HORIZON` value.
|
1857
1955
|
# @return [String]
|
1858
1956
|
#
|
1859
1957
|
# @!attribute [rw] shard_id
|
1958
|
+
# The exclusive start `shardID` speified in the `ShardFilter`
|
1959
|
+
# parameter. This property can only be used if the `AFTER_SHARD_ID`
|
1960
|
+
# shard type is specified.
|
1860
1961
|
# @return [String]
|
1861
1962
|
#
|
1862
1963
|
# @!attribute [rw] timestamp
|
1964
|
+
# The timestamps specified in the `ShardFilter` parameter. A timestamp
|
1965
|
+
# is a Unix epoch date with precision in milliseconds. For example,
|
1966
|
+
# 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can
|
1967
|
+
# only be used if `FROM_TIMESTAMP` or `AT_TIMESTAMP` shard types are
|
1968
|
+
# specified.
|
1863
1969
|
# @return [Time]
|
1864
1970
|
#
|
1865
1971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ShardFilter AWS API Documentation
|
@@ -1930,11 +2036,12 @@ module Aws::Kinesis
|
|
1930
2036
|
# @return [String]
|
1931
2037
|
#
|
1932
2038
|
# @!attribute [rw] key_id
|
1933
|
-
# The GUID for the customer-managed
|
1934
|
-
# This value can be a globally unique identifier, a
|
1935
|
-
# Amazon Resource Name (ARN) to either an alias or a
|
1936
|
-
# name prefixed by "alias/".You can also use a
|
1937
|
-
# Kinesis Data Streams by specifying the alias
|
2039
|
+
# The GUID for the customer-managed Amazon Web Services KMS key to use
|
2040
|
+
# for encryption. This value can be a globally unique identifier, a
|
2041
|
+
# fully specified Amazon Resource Name (ARN) to either an alias or a
|
2042
|
+
# key, or an alias name prefixed by "alias/".You can also use a
|
2043
|
+
# master key owned by Kinesis Data Streams by specifying the alias
|
2044
|
+
# `aws/kinesis`.
|
1938
2045
|
#
|
1939
2046
|
# * Key ARN example:
|
1940
2047
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -1960,6 +2067,9 @@ module Aws::Kinesis
|
|
1960
2067
|
include Aws::Structure
|
1961
2068
|
end
|
1962
2069
|
|
2070
|
+
# The starting position in the data stream from which to start
|
2071
|
+
# streaming.
|
2072
|
+
#
|
1963
2073
|
# @note When making an API call, you may pass StartingPosition
|
1964
2074
|
# data as a hash:
|
1965
2075
|
#
|
@@ -2035,11 +2145,12 @@ module Aws::Kinesis
|
|
2035
2145
|
# @return [String]
|
2036
2146
|
#
|
2037
2147
|
# @!attribute [rw] key_id
|
2038
|
-
# The GUID for the customer-managed
|
2039
|
-
# This value can be a globally unique identifier, a
|
2040
|
-
# Amazon Resource Name (ARN) to either an alias or a
|
2041
|
-
# name prefixed by "alias/".You can also use a
|
2042
|
-
# Kinesis Data Streams by specifying the alias
|
2148
|
+
# The GUID for the customer-managed Amazon Web Services KMS key to use
|
2149
|
+
# for encryption. This value can be a globally unique identifier, a
|
2150
|
+
# fully specified Amazon Resource Name (ARN) to either an alias or a
|
2151
|
+
# key, or an alias name prefixed by "alias/".You can also use a
|
2152
|
+
# master key owned by Kinesis Data Streams by specifying the alias
|
2153
|
+
# `aws/kinesis`.
|
2043
2154
|
#
|
2044
2155
|
# * Key ARN example:
|
2045
2156
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2095,6 +2206,13 @@ module Aws::Kinesis
|
|
2095
2206
|
# `UPDATING` state.
|
2096
2207
|
# @return [String]
|
2097
2208
|
#
|
2209
|
+
# @!attribute [rw] stream_mode_details
|
2210
|
+
# Specifies the capacity mode to which you want to set your data
|
2211
|
+
# stream. Currently, in Kinesis Data Streams, you can choose between
|
2212
|
+
# an **on-demand** capacity mode and a **provisioned** capacity mode
|
2213
|
+
# for your data streams.
|
2214
|
+
# @return [Types::StreamModeDetails]
|
2215
|
+
#
|
2098
2216
|
# @!attribute [rw] shards
|
2099
2217
|
# The shards that comprise the stream.
|
2100
2218
|
# @return [Array<Types::Shard>]
|
@@ -2124,15 +2242,15 @@ module Aws::Kinesis
|
|
2124
2242
|
# * `NONE`\: Do not encrypt the records in the stream.
|
2125
2243
|
#
|
2126
2244
|
# * `KMS`\: Use server-side encryption on the records in the stream
|
2127
|
-
# using a customer-managed
|
2245
|
+
# using a customer-managed Amazon Web Services KMS key.
|
2128
2246
|
# @return [String]
|
2129
2247
|
#
|
2130
2248
|
# @!attribute [rw] key_id
|
2131
|
-
# The GUID for the customer-managed
|
2132
|
-
# This value can be a globally unique identifier, a
|
2133
|
-
# ARN to either an alias or a key, or an alias name
|
2134
|
-
# "alias/".You can also use a master key owned by
|
2135
|
-
# Streams by specifying the alias `aws/kinesis`.
|
2249
|
+
# The GUID for the customer-managed Amazon Web Services KMS key to use
|
2250
|
+
# for encryption. This value can be a globally unique identifier, a
|
2251
|
+
# fully specified ARN to either an alias or a key, or an alias name
|
2252
|
+
# prefixed by "alias/".You can also use a master key owned by
|
2253
|
+
# Kinesis Data Streams by specifying the alias `aws/kinesis`.
|
2136
2254
|
#
|
2137
2255
|
# * Key ARN example:
|
2138
2256
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2154,6 +2272,7 @@ module Aws::Kinesis
|
|
2154
2272
|
:stream_name,
|
2155
2273
|
:stream_arn,
|
2156
2274
|
:stream_status,
|
2275
|
+
:stream_mode_details,
|
2157
2276
|
:shards,
|
2158
2277
|
:has_more_shards,
|
2159
2278
|
:retention_period_hours,
|
@@ -2195,6 +2314,13 @@ module Aws::Kinesis
|
|
2195
2314
|
# `UPDATING` state.
|
2196
2315
|
# @return [String]
|
2197
2316
|
#
|
2317
|
+
# @!attribute [rw] stream_mode_details
|
2318
|
+
# Specifies the capacity mode to which you want to set your data
|
2319
|
+
# stream. Currently, in Kinesis Data Streams, you can choose between
|
2320
|
+
# an **on-demand** ycapacity mode and a **provisioned** capacity mode
|
2321
|
+
# for your data streams.
|
2322
|
+
# @return [Types::StreamModeDetails]
|
2323
|
+
#
|
2198
2324
|
# @!attribute [rw] retention_period_hours
|
2199
2325
|
# The current retention period, in hours.
|
2200
2326
|
# @return [Integer]
|
@@ -2216,11 +2342,11 @@ module Aws::Kinesis
|
|
2216
2342
|
# @return [String]
|
2217
2343
|
#
|
2218
2344
|
# @!attribute [rw] key_id
|
2219
|
-
# The GUID for the customer-managed
|
2220
|
-
# This value can be a globally unique identifier, a
|
2221
|
-
# ARN to either an alias or a key, or an alias name
|
2222
|
-
# "alias/".You can also use a master key owned by
|
2223
|
-
# Streams by specifying the alias `aws/kinesis`.
|
2345
|
+
# The GUID for the customer-managed Amazon Web Services KMS key to use
|
2346
|
+
# for encryption. This value can be a globally unique identifier, a
|
2347
|
+
# fully specified ARN to either an alias or a key, or an alias name
|
2348
|
+
# prefixed by "alias/".You can also use a master key owned by
|
2349
|
+
# Kinesis Data Streams by specifying the alias `aws/kinesis`.
|
2224
2350
|
#
|
2225
2351
|
# * Key ARN example:
|
2226
2352
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -2250,6 +2376,7 @@ module Aws::Kinesis
|
|
2250
2376
|
:stream_name,
|
2251
2377
|
:stream_arn,
|
2252
2378
|
:stream_status,
|
2379
|
+
:stream_mode_details,
|
2253
2380
|
:retention_period_hours,
|
2254
2381
|
:stream_creation_timestamp,
|
2255
2382
|
:enhanced_monitoring,
|
@@ -2261,6 +2388,33 @@ module Aws::Kinesis
|
|
2261
2388
|
include Aws::Structure
|
2262
2389
|
end
|
2263
2390
|
|
2391
|
+
# Specifies the capacity mode to which you want to set your data stream.
|
2392
|
+
# Currently, in Kinesis Data Streams, you can choose between an
|
2393
|
+
# **on-demand** capacity mode and a **provisioned** capacity mode for
|
2394
|
+
# your data streams.
|
2395
|
+
#
|
2396
|
+
# @note When making an API call, you may pass StreamModeDetails
|
2397
|
+
# data as a hash:
|
2398
|
+
#
|
2399
|
+
# {
|
2400
|
+
# stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
|
2401
|
+
# }
|
2402
|
+
#
|
2403
|
+
# @!attribute [rw] stream_mode
|
2404
|
+
# Specifies the capacity mode to which you want to set your data
|
2405
|
+
# stream. Currently, in Kinesis Data Streams, you can choose between
|
2406
|
+
# an **on-demand** capacity mode and a **provisioned** capacity mode
|
2407
|
+
# for your data streams.
|
2408
|
+
# @return [String]
|
2409
|
+
#
|
2410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StreamModeDetails AWS API Documentation
|
2411
|
+
#
|
2412
|
+
class StreamModeDetails < Struct.new(
|
2413
|
+
:stream_mode)
|
2414
|
+
SENSITIVE = []
|
2415
|
+
include Aws::Structure
|
2416
|
+
end
|
2417
|
+
|
2264
2418
|
# After you call SubscribeToShard, Kinesis Data Streams sends events of
|
2265
2419
|
# this type over an HTTP/2 connection to your consumer.
|
2266
2420
|
#
|
@@ -2283,6 +2437,8 @@ module Aws::Kinesis
|
|
2283
2437
|
# @return [Integer]
|
2284
2438
|
#
|
2285
2439
|
# @!attribute [rw] child_shards
|
2440
|
+
# The list of the child shards of the current shard, returned only at
|
2441
|
+
# the end of the current shard.
|
2286
2442
|
# @return [Array<Types::ChildShard>]
|
2287
2443
|
#
|
2288
2444
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SubscribeToShardEvent AWS API Documentation
|
@@ -2321,6 +2477,8 @@ module Aws::Kinesis
|
|
2321
2477
|
# @return [String]
|
2322
2478
|
#
|
2323
2479
|
# @!attribute [rw] starting_position
|
2480
|
+
# The starting position in the data stream from which to start
|
2481
|
+
# streaming.
|
2324
2482
|
# @return [Types::StartingPosition]
|
2325
2483
|
#
|
2326
2484
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SubscribeToShardInput AWS API Documentation
|
@@ -2391,12 +2549,12 @@ module Aws::Kinesis
|
|
2391
2549
|
#
|
2392
2550
|
# * Set this value below half your current shard count for a stream.
|
2393
2551
|
#
|
2394
|
-
# * Set this value to more than
|
2395
|
-
# limit for shard count per stream is
|
2552
|
+
# * Set this value to more than 10000 shards in a stream (the default
|
2553
|
+
# limit for shard count per stream is 10000 per account per region),
|
2396
2554
|
# unless you request a limit increase.
|
2397
2555
|
#
|
2398
|
-
# * Scale a stream with more than
|
2399
|
-
# value to less than
|
2556
|
+
# * Scale a stream with more than 10000 shards down unless you set
|
2557
|
+
# this value to less than 10000 shards.
|
2400
2558
|
# @return [Integer]
|
2401
2559
|
#
|
2402
2560
|
# @!attribute [rw] scaling_type
|
@@ -2435,6 +2593,48 @@ module Aws::Kinesis
|
|
2435
2593
|
include Aws::Structure
|
2436
2594
|
end
|
2437
2595
|
|
2596
|
+
# @note When making an API call, you may pass UpdateStreamModeInput
|
2597
|
+
# data as a hash:
|
2598
|
+
#
|
2599
|
+
# {
|
2600
|
+
# stream_arn: "StreamARN", # required
|
2601
|
+
# stream_mode_details: { # required
|
2602
|
+
# stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
|
2603
|
+
# },
|
2604
|
+
# }
|
2605
|
+
#
|
2606
|
+
# @!attribute [rw] stream_arn
|
2607
|
+
# Specifies the ARN of the data stream whose capacity mode you want to
|
2608
|
+
# update.
|
2609
|
+
# @return [String]
|
2610
|
+
#
|
2611
|
+
# @!attribute [rw] stream_mode_details
|
2612
|
+
# Specifies the capacity mode to which you want to set your data
|
2613
|
+
# stream. Currently, in Kinesis Data Streams, you can choose between
|
2614
|
+
# an **on-demand** capacity mode and a **provisioned** capacity mode
|
2615
|
+
# for your data streams.
|
2616
|
+
# @return [Types::StreamModeDetails]
|
2617
|
+
#
|
2618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateStreamModeInput AWS API Documentation
|
2619
|
+
#
|
2620
|
+
class UpdateStreamModeInput < Struct.new(
|
2621
|
+
:stream_arn,
|
2622
|
+
:stream_mode_details)
|
2623
|
+
SENSITIVE = []
|
2624
|
+
include Aws::Structure
|
2625
|
+
end
|
2626
|
+
|
2627
|
+
# @!attribute [rw] message
|
2628
|
+
# @return [String]
|
2629
|
+
#
|
2630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ValidationException AWS API Documentation
|
2631
|
+
#
|
2632
|
+
class ValidationException < Struct.new(
|
2633
|
+
:message)
|
2634
|
+
SENSITIVE = []
|
2635
|
+
include Aws::Structure
|
2636
|
+
end
|
2637
|
+
|
2438
2638
|
# This is a tagged union for all of the types of events an enhanced
|
2439
2639
|
# fan-out consumer can receive over HTTP/2 after a call to
|
2440
2640
|
# SubscribeToShard.
|
data/lib/aws-sdk-kinesis.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kinesis
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.38.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-11-
|
11
|
+
date: 2021-11-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|