aws-sdk-kinesis 1.42.0 → 1.43.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -10,17 +10,21 @@
10
10
  module Aws::Kinesis
11
11
  module Types
12
12
 
13
- # Represents the input for `AddTagsToStream`.
13
+ # Specifies that you do not have the permissions required to perform
14
+ # this operation.
15
+ #
16
+ # @!attribute [rw] message
17
+ # @return [String]
14
18
  #
15
- # @note When making an API call, you may pass AddTagsToStreamInput
16
- # data as a hash:
19
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/AccessDeniedException AWS API Documentation
17
20
  #
18
- # {
19
- # stream_name: "StreamName", # required
20
- # tags: { # required
21
- # "TagKey" => "TagValue",
22
- # },
23
- # }
21
+ class AccessDeniedException < Struct.new(
22
+ :message)
23
+ SENSITIVE = []
24
+ include Aws::Structure
25
+ end
26
+
27
+ # Represents the input for `AddTagsToStream`.
24
28
  #
25
29
  # @!attribute [rw] stream_name
26
30
  # The name of the stream.
@@ -30,11 +34,16 @@ module Aws::Kinesis
30
34
  # A set of up to 10 key-value pairs to use to create the tags.
31
35
  # @return [Hash<String,String>]
32
36
  #
37
+ # @!attribute [rw] stream_arn
38
+ # The ARN of the stream.
39
+ # @return [String]
40
+ #
33
41
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/AddTagsToStreamInput AWS API Documentation
34
42
  #
35
43
  class AddTagsToStreamInput < Struct.new(
36
44
  :stream_name,
37
- :tags)
45
+ :tags,
46
+ :stream_arn)
38
47
  SENSITIVE = []
39
48
  include Aws::Structure
40
49
  end
@@ -146,17 +155,6 @@ module Aws::Kinesis
146
155
 
147
156
  # Represents the input for `CreateStream`.
148
157
  #
149
- # @note When making an API call, you may pass CreateStreamInput
150
- # data as a hash:
151
- #
152
- # {
153
- # stream_name: "StreamName", # required
154
- # shard_count: 1,
155
- # stream_mode_details: {
156
- # stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
157
- # },
158
- # }
159
- #
160
158
  # @!attribute [rw] stream_name
161
159
  # A name to identify the stream. The stream name is scoped to the
162
160
  # Amazon Web Services account used by the application that creates the
@@ -191,14 +189,6 @@ module Aws::Kinesis
191
189
 
192
190
  # Represents the input for DecreaseStreamRetentionPeriod.
193
191
  #
194
- # @note When making an API call, you may pass DecreaseStreamRetentionPeriodInput
195
- # data as a hash:
196
- #
197
- # {
198
- # stream_name: "StreamName", # required
199
- # retention_period_hours: 1, # required
200
- # }
201
- #
202
192
  # @!attribute [rw] stream_name
203
193
  # The name of the stream to modify.
204
194
  # @return [String]
@@ -208,25 +198,22 @@ module Aws::Kinesis
208
198
  # the current retention period.
209
199
  # @return [Integer]
210
200
  #
201
+ # @!attribute [rw] stream_arn
202
+ # The ARN of the stream.
203
+ # @return [String]
204
+ #
211
205
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DecreaseStreamRetentionPeriodInput AWS API Documentation
212
206
  #
213
207
  class DecreaseStreamRetentionPeriodInput < Struct.new(
214
208
  :stream_name,
215
- :retention_period_hours)
209
+ :retention_period_hours,
210
+ :stream_arn)
216
211
  SENSITIVE = []
217
212
  include Aws::Structure
218
213
  end
219
214
 
220
215
  # Represents the input for DeleteStream.
221
216
  #
222
- # @note When making an API call, you may pass DeleteStreamInput
223
- # data as a hash:
224
- #
225
- # {
226
- # stream_name: "StreamName", # required
227
- # enforce_consumer_deletion: false,
228
- # }
229
- #
230
217
  # @!attribute [rw] stream_name
231
218
  # The name of the stream to delete.
232
219
  # @return [String]
@@ -237,24 +224,20 @@ module Aws::Kinesis
237
224
  # fails with a `ResourceInUseException`.
238
225
  # @return [Boolean]
239
226
  #
227
+ # @!attribute [rw] stream_arn
228
+ # The ARN of the stream.
229
+ # @return [String]
230
+ #
240
231
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DeleteStreamInput AWS API Documentation
241
232
  #
242
233
  class DeleteStreamInput < Struct.new(
243
234
  :stream_name,
244
- :enforce_consumer_deletion)
235
+ :enforce_consumer_deletion,
236
+ :stream_arn)
245
237
  SENSITIVE = []
246
238
  include Aws::Structure
247
239
  end
248
240
 
249
- # @note When making an API call, you may pass DeregisterStreamConsumerInput
250
- # data as a hash:
251
- #
252
- # {
253
- # stream_arn: "StreamARN",
254
- # consumer_name: "ConsumerName",
255
- # consumer_arn: "ConsumerARN",
256
- # }
257
- #
258
241
  # @!attribute [rw] stream_arn
259
242
  # The ARN of the Kinesis data stream that the consumer is registered
260
243
  # with. For more information, see [Amazon Resource Names (ARNs) and
@@ -322,15 +305,6 @@ module Aws::Kinesis
322
305
  include Aws::Structure
323
306
  end
324
307
 
325
- # @note When making an API call, you may pass DescribeStreamConsumerInput
326
- # data as a hash:
327
- #
328
- # {
329
- # stream_arn: "StreamARN",
330
- # consumer_name: "ConsumerName",
331
- # consumer_arn: "ConsumerARN",
332
- # }
333
- #
334
308
  # @!attribute [rw] stream_arn
335
309
  # The ARN of the Kinesis data stream that the consumer is registered
336
310
  # with. For more information, see [Amazon Resource Names (ARNs) and
@@ -374,15 +348,6 @@ module Aws::Kinesis
374
348
 
375
349
  # Represents the input for `DescribeStream`.
376
350
  #
377
- # @note When making an API call, you may pass DescribeStreamInput
378
- # data as a hash:
379
- #
380
- # {
381
- # stream_name: "StreamName", # required
382
- # limit: 1,
383
- # exclusive_start_shard_id: "ShardId",
384
- # }
385
- #
386
351
  # @!attribute [rw] stream_name
387
352
  # The name of the stream to describe.
388
353
  # @return [String]
@@ -405,12 +370,17 @@ module Aws::Kinesis
405
370
  # shard in the stream.
406
371
  # @return [String]
407
372
  #
373
+ # @!attribute [rw] stream_arn
374
+ # The ARN of the stream.
375
+ # @return [String]
376
+ #
408
377
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamInput AWS API Documentation
409
378
  #
410
379
  class DescribeStreamInput < Struct.new(
411
380
  :stream_name,
412
381
  :limit,
413
- :exclusive_start_shard_id)
382
+ :exclusive_start_shard_id,
383
+ :stream_arn)
414
384
  SENSITIVE = []
415
385
  include Aws::Structure
416
386
  end
@@ -431,21 +401,19 @@ module Aws::Kinesis
431
401
  include Aws::Structure
432
402
  end
433
403
 
434
- # @note When making an API call, you may pass DescribeStreamSummaryInput
435
- # data as a hash:
436
- #
437
- # {
438
- # stream_name: "StreamName", # required
439
- # }
440
- #
441
404
  # @!attribute [rw] stream_name
442
405
  # The name of the stream to describe.
443
406
  # @return [String]
444
407
  #
408
+ # @!attribute [rw] stream_arn
409
+ # The ARN of the stream.
410
+ # @return [String]
411
+ #
445
412
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamSummaryInput AWS API Documentation
446
413
  #
447
414
  class DescribeStreamSummaryInput < Struct.new(
448
- :stream_name)
415
+ :stream_name,
416
+ :stream_arn)
449
417
  SENSITIVE = []
450
418
  include Aws::Structure
451
419
  end
@@ -464,14 +432,6 @@ module Aws::Kinesis
464
432
 
465
433
  # Represents the input for DisableEnhancedMonitoring.
466
434
  #
467
- # @note When making an API call, you may pass DisableEnhancedMonitoringInput
468
- # data as a hash:
469
- #
470
- # {
471
- # stream_name: "StreamName", # required
472
- # shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
473
- # }
474
- #
475
435
  # @!attribute [rw] stream_name
476
436
  # The name of the Kinesis data stream for which to disable enhanced
477
437
  # monitoring.
@@ -508,25 +468,22 @@ module Aws::Kinesis
508
468
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
509
469
  # @return [Array<String>]
510
470
  #
471
+ # @!attribute [rw] stream_arn
472
+ # The ARN of the stream.
473
+ # @return [String]
474
+ #
511
475
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DisableEnhancedMonitoringInput AWS API Documentation
512
476
  #
513
477
  class DisableEnhancedMonitoringInput < Struct.new(
514
478
  :stream_name,
515
- :shard_level_metrics)
479
+ :shard_level_metrics,
480
+ :stream_arn)
516
481
  SENSITIVE = []
517
482
  include Aws::Structure
518
483
  end
519
484
 
520
485
  # Represents the input for EnableEnhancedMonitoring.
521
486
  #
522
- # @note When making an API call, you may pass EnableEnhancedMonitoringInput
523
- # data as a hash:
524
- #
525
- # {
526
- # stream_name: "StreamName", # required
527
- # shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
528
- # }
529
- #
530
487
  # @!attribute [rw] stream_name
531
488
  # The name of the stream for which to enable enhanced monitoring.
532
489
  # @return [String]
@@ -562,11 +519,16 @@ module Aws::Kinesis
562
519
  # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
563
520
  # @return [Array<String>]
564
521
  #
522
+ # @!attribute [rw] stream_arn
523
+ # The ARN of the stream.
524
+ # @return [String]
525
+ #
565
526
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnableEnhancedMonitoringInput AWS API Documentation
566
527
  #
567
528
  class EnableEnhancedMonitoringInput < Struct.new(
568
529
  :stream_name,
569
- :shard_level_metrics)
530
+ :shard_level_metrics,
531
+ :stream_arn)
570
532
  SENSITIVE = []
571
533
  include Aws::Structure
572
534
  end
@@ -629,12 +591,17 @@ module Aws::Kinesis
629
591
  # state after the operation.
630
592
  # @return [Array<String>]
631
593
  #
594
+ # @!attribute [rw] stream_arn
595
+ # The ARN of the stream.
596
+ # @return [String]
597
+ #
632
598
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnhancedMonitoringOutput AWS API Documentation
633
599
  #
634
600
  class EnhancedMonitoringOutput < Struct.new(
635
601
  :stream_name,
636
602
  :current_shard_level_metrics,
637
- :desired_shard_level_metrics)
603
+ :desired_shard_level_metrics,
604
+ :stream_arn)
638
605
  SENSITIVE = []
639
606
  include Aws::Structure
640
607
  end
@@ -668,14 +635,6 @@ module Aws::Kinesis
668
635
 
669
636
  # Represents the input for GetRecords.
670
637
  #
671
- # @note When making an API call, you may pass GetRecordsInput
672
- # data as a hash:
673
- #
674
- # {
675
- # shard_iterator: "ShardIterator", # required
676
- # limit: 1,
677
- # }
678
- #
679
638
  # @!attribute [rw] shard_iterator
680
639
  # The position in the shard from which you want to start sequentially
681
640
  # reading data records. A shard iterator specifies this position using
@@ -689,11 +648,16 @@ module Aws::Kinesis
689
648
  # 10,000.
690
649
  # @return [Integer]
691
650
  #
651
+ # @!attribute [rw] stream_arn
652
+ # The ARN of the stream.
653
+ # @return [String]
654
+ #
692
655
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecordsInput AWS API Documentation
693
656
  #
694
657
  class GetRecordsInput < Struct.new(
695
658
  :shard_iterator,
696
- :limit)
659
+ :limit,
660
+ :stream_arn)
697
661
  SENSITIVE = []
698
662
  include Aws::Structure
699
663
  end
@@ -736,17 +700,6 @@ module Aws::Kinesis
736
700
 
737
701
  # Represents the input for `GetShardIterator`.
738
702
  #
739
- # @note When making an API call, you may pass GetShardIteratorInput
740
- # data as a hash:
741
- #
742
- # {
743
- # stream_name: "StreamName", # required
744
- # shard_id: "ShardId", # required
745
- # shard_iterator_type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
746
- # starting_sequence_number: "SequenceNumber",
747
- # timestamp: Time.now,
748
- # }
749
- #
750
703
  # @!attribute [rw] stream_name
751
704
  # The name of the Amazon Kinesis data stream.
752
705
  # @return [String]
@@ -797,6 +750,10 @@ module Aws::Kinesis
797
750
  # untrimmed data record (TRIM\_HORIZON).
798
751
  # @return [Time]
799
752
  #
753
+ # @!attribute [rw] stream_arn
754
+ # The ARN of the stream.
755
+ # @return [String]
756
+ #
800
757
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetShardIteratorInput AWS API Documentation
801
758
  #
802
759
  class GetShardIteratorInput < Struct.new(
@@ -804,7 +761,8 @@ module Aws::Kinesis
804
761
  :shard_id,
805
762
  :shard_iterator_type,
806
763
  :starting_sequence_number,
807
- :timestamp)
764
+ :timestamp,
765
+ :stream_arn)
808
766
  SENSITIVE = []
809
767
  include Aws::Structure
810
768
  end
@@ -847,14 +805,6 @@ module Aws::Kinesis
847
805
 
848
806
  # Represents the input for IncreaseStreamRetentionPeriod.
849
807
  #
850
- # @note When making an API call, you may pass IncreaseStreamRetentionPeriodInput
851
- # data as a hash:
852
- #
853
- # {
854
- # stream_name: "StreamName", # required
855
- # retention_period_hours: 1, # required
856
- # }
857
- #
858
808
  # @!attribute [rw] stream_name
859
809
  # The name of the stream to modify.
860
810
  # @return [String]
@@ -864,11 +814,16 @@ module Aws::Kinesis
864
814
  # the current retention period.
865
815
  # @return [Integer]
866
816
  #
817
+ # @!attribute [rw] stream_arn
818
+ # The ARN of the stream.
819
+ # @return [String]
820
+ #
867
821
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/IncreaseStreamRetentionPeriodInput AWS API Documentation
868
822
  #
869
823
  class IncreaseStreamRetentionPeriodInput < Struct.new(
870
824
  :stream_name,
871
- :retention_period_hours)
825
+ :retention_period_hours,
826
+ :stream_arn)
872
827
  SENSITIVE = []
873
828
  include Aws::Structure
874
829
  end
@@ -1026,22 +981,6 @@ module Aws::Kinesis
1026
981
  include Aws::Structure
1027
982
  end
1028
983
 
1029
- # @note When making an API call, you may pass ListShardsInput
1030
- # data as a hash:
1031
- #
1032
- # {
1033
- # stream_name: "StreamName",
1034
- # next_token: "NextToken",
1035
- # exclusive_start_shard_id: "ShardId",
1036
- # max_results: 1,
1037
- # stream_creation_timestamp: Time.now,
1038
- # shard_filter: {
1039
- # type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
1040
- # shard_id: "ShardId",
1041
- # timestamp: Time.now,
1042
- # },
1043
- # }
1044
- #
1045
984
  # @!attribute [rw] stream_name
1046
985
  # The name of the data stream whose shards you want to list.
1047
986
  #
@@ -1134,6 +1073,10 @@ module Aws::Kinesis
1134
1073
  # timestamp to TIP are returned.
1135
1074
  # @return [Types::ShardFilter]
1136
1075
  #
1076
+ # @!attribute [rw] stream_arn
1077
+ # The ARN of the stream.
1078
+ # @return [String]
1079
+ #
1137
1080
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListShardsInput AWS API Documentation
1138
1081
  #
1139
1082
  class ListShardsInput < Struct.new(
@@ -1142,7 +1085,8 @@ module Aws::Kinesis
1142
1085
  :exclusive_start_shard_id,
1143
1086
  :max_results,
1144
1087
  :stream_creation_timestamp,
1145
- :shard_filter)
1088
+ :shard_filter,
1089
+ :stream_arn)
1146
1090
  SENSITIVE = []
1147
1091
  include Aws::Structure
1148
1092
  end
@@ -1180,16 +1124,6 @@ module Aws::Kinesis
1180
1124
  include Aws::Structure
1181
1125
  end
1182
1126
 
1183
- # @note When making an API call, you may pass ListStreamConsumersInput
1184
- # data as a hash:
1185
- #
1186
- # {
1187
- # stream_arn: "StreamARN", # required
1188
- # next_token: "NextToken",
1189
- # max_results: 1,
1190
- # stream_creation_timestamp: Time.now,
1191
- # }
1192
- #
1193
1127
  # @!attribute [rw] stream_arn
1194
1128
  # The ARN of the Kinesis data stream for which you want to list the
1195
1129
  # registered consumers. For more information, see [Amazon Resource
@@ -1292,14 +1226,6 @@ module Aws::Kinesis
1292
1226
 
1293
1227
  # Represents the input for `ListStreams`.
1294
1228
  #
1295
- # @note When making an API call, you may pass ListStreamsInput
1296
- # data as a hash:
1297
- #
1298
- # {
1299
- # limit: 1,
1300
- # exclusive_start_stream_name: "StreamName",
1301
- # }
1302
- #
1303
1229
  # @!attribute [rw] limit
1304
1230
  # The maximum number of streams to list. The default value is 100. If
1305
1231
  # you specify a value greater than 100, at most 100 results are
@@ -1310,11 +1236,15 @@ module Aws::Kinesis
1310
1236
  # The name of the stream to start the list with.
1311
1237
  # @return [String]
1312
1238
  #
1239
+ # @!attribute [rw] next_token
1240
+ # @return [String]
1241
+ #
1313
1242
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListStreamsInput AWS API Documentation
1314
1243
  #
1315
1244
  class ListStreamsInput < Struct.new(
1316
1245
  :limit,
1317
- :exclusive_start_stream_name)
1246
+ :exclusive_start_stream_name,
1247
+ :next_token)
1318
1248
  SENSITIVE = []
1319
1249
  include Aws::Structure
1320
1250
  end
@@ -1330,26 +1260,25 @@ module Aws::Kinesis
1330
1260
  # If set to `true`, there are more streams available to list.
1331
1261
  # @return [Boolean]
1332
1262
  #
1263
+ # @!attribute [rw] next_token
1264
+ # @return [String]
1265
+ #
1266
+ # @!attribute [rw] stream_summaries
1267
+ # @return [Array<Types::StreamSummary>]
1268
+ #
1333
1269
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListStreamsOutput AWS API Documentation
1334
1270
  #
1335
1271
  class ListStreamsOutput < Struct.new(
1336
1272
  :stream_names,
1337
- :has_more_streams)
1273
+ :has_more_streams,
1274
+ :next_token,
1275
+ :stream_summaries)
1338
1276
  SENSITIVE = []
1339
1277
  include Aws::Structure
1340
1278
  end
1341
1279
 
1342
1280
  # Represents the input for `ListTagsForStream`.
1343
1281
  #
1344
- # @note When making an API call, you may pass ListTagsForStreamInput
1345
- # data as a hash:
1346
- #
1347
- # {
1348
- # stream_name: "StreamName", # required
1349
- # exclusive_start_tag_key: "TagKey",
1350
- # limit: 1,
1351
- # }
1352
- #
1353
1282
  # @!attribute [rw] stream_name
1354
1283
  # The name of the stream.
1355
1284
  # @return [String]
@@ -1367,12 +1296,17 @@ module Aws::Kinesis
1367
1296
  # last key in the response.
1368
1297
  # @return [Integer]
1369
1298
  #
1299
+ # @!attribute [rw] stream_arn
1300
+ # The ARN of the stream.
1301
+ # @return [String]
1302
+ #
1370
1303
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListTagsForStreamInput AWS API Documentation
1371
1304
  #
1372
1305
  class ListTagsForStreamInput < Struct.new(
1373
1306
  :stream_name,
1374
1307
  :exclusive_start_tag_key,
1375
- :limit)
1308
+ :limit,
1309
+ :stream_arn)
1376
1310
  SENSITIVE = []
1377
1311
  include Aws::Structure
1378
1312
  end
@@ -1401,15 +1335,6 @@ module Aws::Kinesis
1401
1335
 
1402
1336
  # Represents the input for `MergeShards`.
1403
1337
  #
1404
- # @note When making an API call, you may pass MergeShardsInput
1405
- # data as a hash:
1406
- #
1407
- # {
1408
- # stream_name: "StreamName", # required
1409
- # shard_to_merge: "ShardId", # required
1410
- # adjacent_shard_to_merge: "ShardId", # required
1411
- # }
1412
- #
1413
1338
  # @!attribute [rw] stream_name
1414
1339
  # The name of the stream for the merge.
1415
1340
  # @return [String]
@@ -1423,12 +1348,17 @@ module Aws::Kinesis
1423
1348
  # The shard ID of the adjacent shard for the merge.
1424
1349
  # @return [String]
1425
1350
  #
1351
+ # @!attribute [rw] stream_arn
1352
+ # The ARN of the stream.
1353
+ # @return [String]
1354
+ #
1426
1355
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/MergeShardsInput AWS API Documentation
1427
1356
  #
1428
1357
  class MergeShardsInput < Struct.new(
1429
1358
  :stream_name,
1430
1359
  :shard_to_merge,
1431
- :adjacent_shard_to_merge)
1360
+ :adjacent_shard_to_merge,
1361
+ :stream_arn)
1432
1362
  SENSITIVE = []
1433
1363
  include Aws::Structure
1434
1364
  end
@@ -1459,17 +1389,6 @@ module Aws::Kinesis
1459
1389
 
1460
1390
  # Represents the input for `PutRecord`.
1461
1391
  #
1462
- # @note When making an API call, you may pass PutRecordInput
1463
- # data as a hash:
1464
- #
1465
- # {
1466
- # stream_name: "StreamName", # required
1467
- # data: "data", # required
1468
- # partition_key: "PartitionKey", # required
1469
- # explicit_hash_key: "HashKey",
1470
- # sequence_number_for_ordering: "SequenceNumber",
1471
- # }
1472
- #
1473
1392
  # @!attribute [rw] stream_name
1474
1393
  # The name of the stream to put the data record into.
1475
1394
  # @return [String]
@@ -1507,6 +1426,10 @@ module Aws::Kinesis
1507
1426
  # arrival time.
1508
1427
  # @return [String]
1509
1428
  #
1429
+ # @!attribute [rw] stream_arn
1430
+ # The ARN of the stream.
1431
+ # @return [String]
1432
+ #
1510
1433
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordInput AWS API Documentation
1511
1434
  #
1512
1435
  class PutRecordInput < Struct.new(
@@ -1514,7 +1437,8 @@ module Aws::Kinesis
1514
1437
  :data,
1515
1438
  :partition_key,
1516
1439
  :explicit_hash_key,
1517
- :sequence_number_for_ordering)
1440
+ :sequence_number_for_ordering,
1441
+ :stream_arn)
1518
1442
  SENSITIVE = []
1519
1443
  include Aws::Structure
1520
1444
  end
@@ -1554,20 +1478,6 @@ module Aws::Kinesis
1554
1478
 
1555
1479
  # A `PutRecords` request.
1556
1480
  #
1557
- # @note When making an API call, you may pass PutRecordsInput
1558
- # data as a hash:
1559
- #
1560
- # {
1561
- # records: [ # required
1562
- # {
1563
- # data: "data", # required
1564
- # explicit_hash_key: "HashKey",
1565
- # partition_key: "PartitionKey", # required
1566
- # },
1567
- # ],
1568
- # stream_name: "StreamName", # required
1569
- # }
1570
- #
1571
1481
  # @!attribute [rw] records
1572
1482
  # The records associated with the request.
1573
1483
  # @return [Array<Types::PutRecordsRequestEntry>]
@@ -1576,11 +1486,16 @@ module Aws::Kinesis
1576
1486
  # The stream name associated with the request.
1577
1487
  # @return [String]
1578
1488
  #
1489
+ # @!attribute [rw] stream_arn
1490
+ # The ARN of the stream.
1491
+ # @return [String]
1492
+ #
1579
1493
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordsInput AWS API Documentation
1580
1494
  #
1581
1495
  class PutRecordsInput < Struct.new(
1582
1496
  :records,
1583
- :stream_name)
1497
+ :stream_name,
1498
+ :stream_arn)
1584
1499
  SENSITIVE = []
1585
1500
  include Aws::Structure
1586
1501
  end
@@ -1622,15 +1537,6 @@ module Aws::Kinesis
1622
1537
 
1623
1538
  # Represents the output for `PutRecords`.
1624
1539
  #
1625
- # @note When making an API call, you may pass PutRecordsRequestEntry
1626
- # data as a hash:
1627
- #
1628
- # {
1629
- # data: "data", # required
1630
- # explicit_hash_key: "HashKey",
1631
- # partition_key: "PartitionKey", # required
1632
- # }
1633
- #
1634
1540
  # @!attribute [rw] data
1635
1541
  # The data blob to put into the record, which is base64-encoded when
1636
1542
  # the blob is serialized. When the data blob (the payload before
@@ -1749,14 +1655,6 @@ module Aws::Kinesis
1749
1655
  include Aws::Structure
1750
1656
  end
1751
1657
 
1752
- # @note When making an API call, you may pass RegisterStreamConsumerInput
1753
- # data as a hash:
1754
- #
1755
- # {
1756
- # stream_arn: "StreamARN", # required
1757
- # consumer_name: "ConsumerName", # required
1758
- # }
1759
- #
1760
1658
  # @!attribute [rw] stream_arn
1761
1659
  # The ARN of the Kinesis data stream that you want to register the
1762
1660
  # consumer with. For more info, see [Amazon Resource Names (ARNs) and
@@ -1798,14 +1696,6 @@ module Aws::Kinesis
1798
1696
 
1799
1697
  # Represents the input for `RemoveTagsFromStream`.
1800
1698
  #
1801
- # @note When making an API call, you may pass RemoveTagsFromStreamInput
1802
- # data as a hash:
1803
- #
1804
- # {
1805
- # stream_name: "StreamName", # required
1806
- # tag_keys: ["TagKey"], # required
1807
- # }
1808
- #
1809
1699
  # @!attribute [rw] stream_name
1810
1700
  # The name of the stream.
1811
1701
  # @return [String]
@@ -1815,11 +1705,16 @@ module Aws::Kinesis
1815
1705
  # stream.
1816
1706
  # @return [Array<String>]
1817
1707
  #
1708
+ # @!attribute [rw] stream_arn
1709
+ # The ARN of the stream.
1710
+ # @return [String]
1711
+ #
1818
1712
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/RemoveTagsFromStreamInput AWS API Documentation
1819
1713
  #
1820
1714
  class RemoveTagsFromStreamInput < Struct.new(
1821
1715
  :stream_name,
1822
- :tag_keys)
1716
+ :tag_keys,
1717
+ :stream_arn)
1823
1718
  SENSITIVE = []
1824
1719
  include Aws::Structure
1825
1720
  end
@@ -1914,15 +1809,6 @@ module Aws::Kinesis
1914
1809
  # The request parameter used to filter out the response of the
1915
1810
  # `ListShards` API.
1916
1811
  #
1917
- # @note When making an API call, you may pass ShardFilter
1918
- # data as a hash:
1919
- #
1920
- # {
1921
- # type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
1922
- # shard_id: "ShardId",
1923
- # timestamp: Time.now,
1924
- # }
1925
- #
1926
1812
  # @!attribute [rw] type
1927
1813
  # The shard type specified in the `ShardFilter` parameter. This is a
1928
1814
  # required property of the `ShardFilter` parameter.
@@ -1980,15 +1866,6 @@ module Aws::Kinesis
1980
1866
 
1981
1867
  # Represents the input for `SplitShard`.
1982
1868
  #
1983
- # @note When making an API call, you may pass SplitShardInput
1984
- # data as a hash:
1985
- #
1986
- # {
1987
- # stream_name: "StreamName", # required
1988
- # shard_to_split: "ShardId", # required
1989
- # new_starting_hash_key: "HashKey", # required
1990
- # }
1991
- #
1992
1869
  # @!attribute [rw] stream_name
1993
1870
  # The name of the stream for the shard split.
1994
1871
  # @return [String]
@@ -2008,25 +1885,21 @@ module Aws::Kinesis
2008
1885
  # distributed to the other child shard.
2009
1886
  # @return [String]
2010
1887
  #
1888
+ # @!attribute [rw] stream_arn
1889
+ # The ARN of the stream.
1890
+ # @return [String]
1891
+ #
2011
1892
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SplitShardInput AWS API Documentation
2012
1893
  #
2013
1894
  class SplitShardInput < Struct.new(
2014
1895
  :stream_name,
2015
1896
  :shard_to_split,
2016
- :new_starting_hash_key)
1897
+ :new_starting_hash_key,
1898
+ :stream_arn)
2017
1899
  SENSITIVE = []
2018
1900
  include Aws::Structure
2019
1901
  end
2020
1902
 
2021
- # @note When making an API call, you may pass StartStreamEncryptionInput
2022
- # data as a hash:
2023
- #
2024
- # {
2025
- # stream_name: "StreamName", # required
2026
- # encryption_type: "NONE", # required, accepts NONE, KMS
2027
- # key_id: "KeyId", # required
2028
- # }
2029
- #
2030
1903
  # @!attribute [rw] stream_name
2031
1904
  # The name of the stream for which to start encrypting records.
2032
1905
  # @return [String]
@@ -2057,12 +1930,17 @@ module Aws::Kinesis
2057
1930
  # * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
2058
1931
  # @return [String]
2059
1932
  #
1933
+ # @!attribute [rw] stream_arn
1934
+ # The ARN of the stream.
1935
+ # @return [String]
1936
+ #
2060
1937
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartStreamEncryptionInput AWS API Documentation
2061
1938
  #
2062
1939
  class StartStreamEncryptionInput < Struct.new(
2063
1940
  :stream_name,
2064
1941
  :encryption_type,
2065
- :key_id)
1942
+ :key_id,
1943
+ :stream_arn)
2066
1944
  SENSITIVE = []
2067
1945
  include Aws::Structure
2068
1946
  end
@@ -2070,15 +1948,6 @@ module Aws::Kinesis
2070
1948
  # The starting position in the data stream from which to start
2071
1949
  # streaming.
2072
1950
  #
2073
- # @note When making an API call, you may pass StartingPosition
2074
- # data as a hash:
2075
- #
2076
- # {
2077
- # type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
2078
- # sequence_number: "SequenceNumber",
2079
- # timestamp: Time.now,
2080
- # }
2081
- #
2082
1951
  # @!attribute [rw] type
2083
1952
  # You can set the starting position to one of the following values:
2084
1953
  #
@@ -2127,15 +1996,6 @@ module Aws::Kinesis
2127
1996
  include Aws::Structure
2128
1997
  end
2129
1998
 
2130
- # @note When making an API call, you may pass StopStreamEncryptionInput
2131
- # data as a hash:
2132
- #
2133
- # {
2134
- # stream_name: "StreamName", # required
2135
- # encryption_type: "NONE", # required, accepts NONE, KMS
2136
- # key_id: "KeyId", # required
2137
- # }
2138
- #
2139
1999
  # @!attribute [rw] stream_name
2140
2000
  # The name of the stream on which to stop encrypting records.
2141
2001
  # @return [String]
@@ -2166,12 +2026,17 @@ module Aws::Kinesis
2166
2026
  # * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
2167
2027
  # @return [String]
2168
2028
  #
2029
+ # @!attribute [rw] stream_arn
2030
+ # The ARN of the stream.
2031
+ # @return [String]
2032
+ #
2169
2033
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StopStreamEncryptionInput AWS API Documentation
2170
2034
  #
2171
2035
  class StopStreamEncryptionInput < Struct.new(
2172
2036
  :stream_name,
2173
2037
  :encryption_type,
2174
- :key_id)
2038
+ :key_id,
2039
+ :stream_arn)
2175
2040
  SENSITIVE = []
2176
2041
  include Aws::Structure
2177
2042
  end
@@ -2393,13 +2258,6 @@ module Aws::Kinesis
2393
2258
  # **on-demand** capacity mode and a **provisioned** capacity mode for
2394
2259
  # your data streams.
2395
2260
  #
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
2261
  # @!attribute [rw] stream_mode
2404
2262
  # Specifies the capacity mode to which you want to set your data
2405
2263
  # stream. Currently, in Kinesis Data Streams, you can choose between
@@ -2415,6 +2273,43 @@ module Aws::Kinesis
2415
2273
  include Aws::Structure
2416
2274
  end
2417
2275
 
2276
+ # The summary of a stream.
2277
+ #
2278
+ # @!attribute [rw] stream_name
2279
+ # The name of a stream.
2280
+ # @return [String]
2281
+ #
2282
+ # @!attribute [rw] stream_arn
2283
+ # The ARN of the stream.
2284
+ # @return [String]
2285
+ #
2286
+ # @!attribute [rw] stream_status
2287
+ # The status of the stream.
2288
+ # @return [String]
2289
+ #
2290
+ # @!attribute [rw] stream_mode_details
2291
+ # Specifies the capacity mode to which you want to set your data
2292
+ # stream. Currently, in Kinesis Data Streams, you can choose between
2293
+ # an **on-demand** capacity mode and a **provisioned** capacity mode
2294
+ # for your data streams.
2295
+ # @return [Types::StreamModeDetails]
2296
+ #
2297
+ # @!attribute [rw] stream_creation_timestamp
2298
+ # The timestamp at which the stream was created.
2299
+ # @return [Time]
2300
+ #
2301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StreamSummary AWS API Documentation
2302
+ #
2303
+ class StreamSummary < Struct.new(
2304
+ :stream_name,
2305
+ :stream_arn,
2306
+ :stream_status,
2307
+ :stream_mode_details,
2308
+ :stream_creation_timestamp)
2309
+ SENSITIVE = []
2310
+ include Aws::Structure
2311
+ end
2312
+
2418
2313
  # After you call SubscribeToShard, Kinesis Data Streams sends events of
2419
2314
  # this type over an HTTP/2 connection to your consumer.
2420
2315
  #
@@ -2453,19 +2348,6 @@ module Aws::Kinesis
2453
2348
  include Aws::Structure
2454
2349
  end
2455
2350
 
2456
- # @note When making an API call, you may pass SubscribeToShardInput
2457
- # data as a hash:
2458
- #
2459
- # {
2460
- # consumer_arn: "ConsumerARN", # required
2461
- # shard_id: "ShardId", # required
2462
- # starting_position: { # required
2463
- # type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
2464
- # sequence_number: "SequenceNumber",
2465
- # timestamp: Time.now,
2466
- # },
2467
- # }
2468
- #
2469
2351
  # @!attribute [rw] consumer_arn
2470
2352
  # For this parameter, use the value you obtained when you called
2471
2353
  # RegisterStreamConsumer.
@@ -2527,15 +2409,6 @@ module Aws::Kinesis
2527
2409
  include Aws::Structure
2528
2410
  end
2529
2411
 
2530
- # @note When making an API call, you may pass UpdateShardCountInput
2531
- # data as a hash:
2532
- #
2533
- # {
2534
- # stream_name: "StreamName", # required
2535
- # target_shard_count: 1, # required
2536
- # scaling_type: "UNIFORM_SCALING", # required, accepts UNIFORM_SCALING
2537
- # }
2538
- #
2539
2412
  # @!attribute [rw] stream_name
2540
2413
  # The name of the stream.
2541
2414
  # @return [String]
@@ -2561,12 +2434,17 @@ module Aws::Kinesis
2561
2434
  # The scaling type. Uniform scaling creates shards of equal size.
2562
2435
  # @return [String]
2563
2436
  #
2437
+ # @!attribute [rw] stream_arn
2438
+ # The ARN of the stream.
2439
+ # @return [String]
2440
+ #
2564
2441
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateShardCountInput AWS API Documentation
2565
2442
  #
2566
2443
  class UpdateShardCountInput < Struct.new(
2567
2444
  :stream_name,
2568
2445
  :target_shard_count,
2569
- :scaling_type)
2446
+ :scaling_type,
2447
+ :stream_arn)
2570
2448
  SENSITIVE = []
2571
2449
  include Aws::Structure
2572
2450
  end
@@ -2583,26 +2461,21 @@ module Aws::Kinesis
2583
2461
  # The updated number of shards.
2584
2462
  # @return [Integer]
2585
2463
  #
2464
+ # @!attribute [rw] stream_arn
2465
+ # The ARN of the stream.
2466
+ # @return [String]
2467
+ #
2586
2468
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateShardCountOutput AWS API Documentation
2587
2469
  #
2588
2470
  class UpdateShardCountOutput < Struct.new(
2589
2471
  :stream_name,
2590
2472
  :current_shard_count,
2591
- :target_shard_count)
2473
+ :target_shard_count,
2474
+ :stream_arn)
2592
2475
  SENSITIVE = []
2593
2476
  include Aws::Structure
2594
2477
  end
2595
2478
 
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
2479
  # @!attribute [rw] stream_arn
2607
2480
  # Specifies the ARN of the data stream whose capacity mode you want to
2608
2481
  # update.
@@ -2624,6 +2497,10 @@ module Aws::Kinesis
2624
2497
  include Aws::Structure
2625
2498
  end
2626
2499
 
2500
+ # Specifies that you tried to invoke this API for a data stream with the
2501
+ # on-demand capacity mode. This API is only supported for data streams
2502
+ # with the provisioned capacity mode.
2503
+ #
2627
2504
  # @!attribute [rw] message
2628
2505
  # @return [String]
2629
2506
  #