UNPKG

17.6 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2013-12-02",
5 "endpointPrefix": "kinesis",
6 "jsonVersion": "1.1",
7 "protocol": "json",
8 "protocolSettings": {
9 "h2": "eventstream"
10 },
11 "serviceAbbreviation": "Kinesis",
12 "serviceFullName": "Amazon Kinesis",
13 "serviceId": "Kinesis",
14 "signatureVersion": "v4",
15 "targetPrefix": "Kinesis_20131202",
16 "uid": "kinesis-2013-12-02"
17 },
18 "operations": {
19 "AddTagsToStream": {
20 "input": {
21 "type": "structure",
22 "required": [
23 "StreamName",
24 "Tags"
25 ],
26 "members": {
27 "StreamName": {},
28 "Tags": {
29 "type": "map",
30 "key": {},
31 "value": {}
32 }
33 }
34 }
35 },
36 "CreateStream": {
37 "input": {
38 "type": "structure",
39 "required": [
40 "StreamName",
41 "ShardCount"
42 ],
43 "members": {
44 "StreamName": {},
45 "ShardCount": {
46 "type": "integer"
47 }
48 }
49 }
50 },
51 "DecreaseStreamRetentionPeriod": {
52 "input": {
53 "type": "structure",
54 "required": [
55 "StreamName",
56 "RetentionPeriodHours"
57 ],
58 "members": {
59 "StreamName": {},
60 "RetentionPeriodHours": {
61 "type": "integer"
62 }
63 }
64 }
65 },
66 "DeleteStream": {
67 "input": {
68 "type": "structure",
69 "required": [
70 "StreamName"
71 ],
72 "members": {
73 "StreamName": {},
74 "EnforceConsumerDeletion": {
75 "type": "boolean"
76 }
77 }
78 }
79 },
80 "DeregisterStreamConsumer": {
81 "input": {
82 "type": "structure",
83 "members": {
84 "StreamARN": {},
85 "ConsumerName": {},
86 "ConsumerARN": {}
87 }
88 }
89 },
90 "DescribeLimits": {
91 "input": {
92 "type": "structure",
93 "members": {}
94 },
95 "output": {
96 "type": "structure",
97 "required": [
98 "ShardLimit",
99 "OpenShardCount"
100 ],
101 "members": {
102 "ShardLimit": {
103 "type": "integer"
104 },
105 "OpenShardCount": {
106 "type": "integer"
107 }
108 }
109 }
110 },
111 "DescribeStream": {
112 "input": {
113 "type": "structure",
114 "required": [
115 "StreamName"
116 ],
117 "members": {
118 "StreamName": {},
119 "Limit": {
120 "type": "integer"
121 },
122 "ExclusiveStartShardId": {}
123 }
124 },
125 "output": {
126 "type": "structure",
127 "required": [
128 "StreamDescription"
129 ],
130 "members": {
131 "StreamDescription": {
132 "type": "structure",
133 "required": [
134 "StreamName",
135 "StreamARN",
136 "StreamStatus",
137 "Shards",
138 "HasMoreShards",
139 "RetentionPeriodHours",
140 "StreamCreationTimestamp",
141 "EnhancedMonitoring"
142 ],
143 "members": {
144 "StreamName": {},
145 "StreamARN": {},
146 "StreamStatus": {},
147 "Shards": {
148 "shape": "Sp"
149 },
150 "HasMoreShards": {
151 "type": "boolean"
152 },
153 "RetentionPeriodHours": {
154 "type": "integer"
155 },
156 "StreamCreationTimestamp": {
157 "type": "timestamp"
158 },
159 "EnhancedMonitoring": {
160 "shape": "Sw"
161 },
162 "EncryptionType": {},
163 "KeyId": {}
164 }
165 }
166 }
167 }
168 },
169 "DescribeStreamConsumer": {
170 "input": {
171 "type": "structure",
172 "members": {
173 "StreamARN": {},
174 "ConsumerName": {},
175 "ConsumerARN": {}
176 }
177 },
178 "output": {
179 "type": "structure",
180 "required": [
181 "ConsumerDescription"
182 ],
183 "members": {
184 "ConsumerDescription": {
185 "type": "structure",
186 "required": [
187 "ConsumerName",
188 "ConsumerARN",
189 "ConsumerStatus",
190 "ConsumerCreationTimestamp",
191 "StreamARN"
192 ],
193 "members": {
194 "ConsumerName": {},
195 "ConsumerARN": {},
196 "ConsumerStatus": {},
197 "ConsumerCreationTimestamp": {
198 "type": "timestamp"
199 },
200 "StreamARN": {}
201 }
202 }
203 }
204 }
205 },
206 "DescribeStreamSummary": {
207 "input": {
208 "type": "structure",
209 "required": [
210 "StreamName"
211 ],
212 "members": {
213 "StreamName": {}
214 }
215 },
216 "output": {
217 "type": "structure",
218 "required": [
219 "StreamDescriptionSummary"
220 ],
221 "members": {
222 "StreamDescriptionSummary": {
223 "type": "structure",
224 "required": [
225 "StreamName",
226 "StreamARN",
227 "StreamStatus",
228 "RetentionPeriodHours",
229 "StreamCreationTimestamp",
230 "EnhancedMonitoring",
231 "OpenShardCount"
232 ],
233 "members": {
234 "StreamName": {},
235 "StreamARN": {},
236 "StreamStatus": {},
237 "RetentionPeriodHours": {
238 "type": "integer"
239 },
240 "StreamCreationTimestamp": {
241 "type": "timestamp"
242 },
243 "EnhancedMonitoring": {
244 "shape": "Sw"
245 },
246 "EncryptionType": {},
247 "KeyId": {},
248 "OpenShardCount": {
249 "type": "integer"
250 },
251 "ConsumerCount": {
252 "type": "integer"
253 }
254 }
255 }
256 }
257 }
258 },
259 "DisableEnhancedMonitoring": {
260 "input": {
261 "type": "structure",
262 "required": [
263 "StreamName",
264 "ShardLevelMetrics"
265 ],
266 "members": {
267 "StreamName": {},
268 "ShardLevelMetrics": {
269 "shape": "Sy"
270 }
271 }
272 },
273 "output": {
274 "shape": "S1b"
275 }
276 },
277 "EnableEnhancedMonitoring": {
278 "input": {
279 "type": "structure",
280 "required": [
281 "StreamName",
282 "ShardLevelMetrics"
283 ],
284 "members": {
285 "StreamName": {},
286 "ShardLevelMetrics": {
287 "shape": "Sy"
288 }
289 }
290 },
291 "output": {
292 "shape": "S1b"
293 }
294 },
295 "GetRecords": {
296 "input": {
297 "type": "structure",
298 "required": [
299 "ShardIterator"
300 ],
301 "members": {
302 "ShardIterator": {},
303 "Limit": {
304 "type": "integer"
305 }
306 }
307 },
308 "output": {
309 "type": "structure",
310 "required": [
311 "Records"
312 ],
313 "members": {
314 "Records": {
315 "type": "list",
316 "member": {
317 "type": "structure",
318 "required": [
319 "SequenceNumber",
320 "Data",
321 "PartitionKey"
322 ],
323 "members": {
324 "SequenceNumber": {},
325 "ApproximateArrivalTimestamp": {
326 "type": "timestamp"
327 },
328 "Data": {
329 "type": "blob"
330 },
331 "PartitionKey": {},
332 "EncryptionType": {}
333 }
334 }
335 },
336 "NextShardIterator": {},
337 "MillisBehindLatest": {
338 "type": "long"
339 }
340 }
341 }
342 },
343 "GetShardIterator": {
344 "input": {
345 "type": "structure",
346 "required": [
347 "StreamName",
348 "ShardId",
349 "ShardIteratorType"
350 ],
351 "members": {
352 "StreamName": {},
353 "ShardId": {},
354 "ShardIteratorType": {},
355 "StartingSequenceNumber": {},
356 "Timestamp": {
357 "type": "timestamp"
358 }
359 }
360 },
361 "output": {
362 "type": "structure",
363 "members": {
364 "ShardIterator": {}
365 }
366 }
367 },
368 "IncreaseStreamRetentionPeriod": {
369 "input": {
370 "type": "structure",
371 "required": [
372 "StreamName",
373 "RetentionPeriodHours"
374 ],
375 "members": {
376 "StreamName": {},
377 "RetentionPeriodHours": {
378 "type": "integer"
379 }
380 }
381 }
382 },
383 "ListShards": {
384 "input": {
385 "type": "structure",
386 "members": {
387 "StreamName": {},
388 "NextToken": {},
389 "ExclusiveStartShardId": {},
390 "MaxResults": {
391 "type": "integer"
392 },
393 "StreamCreationTimestamp": {
394 "type": "timestamp"
395 }
396 }
397 },
398 "output": {
399 "type": "structure",
400 "members": {
401 "Shards": {
402 "shape": "Sp"
403 },
404 "NextToken": {}
405 }
406 }
407 },
408 "ListStreamConsumers": {
409 "input": {
410 "type": "structure",
411 "required": [
412 "StreamARN"
413 ],
414 "members": {
415 "StreamARN": {},
416 "NextToken": {},
417 "MaxResults": {
418 "type": "integer"
419 },
420 "StreamCreationTimestamp": {
421 "type": "timestamp"
422 }
423 }
424 },
425 "output": {
426 "type": "structure",
427 "members": {
428 "Consumers": {
429 "type": "list",
430 "member": {
431 "shape": "S1y"
432 }
433 },
434 "NextToken": {}
435 }
436 }
437 },
438 "ListStreams": {
439 "input": {
440 "type": "structure",
441 "members": {
442 "Limit": {
443 "type": "integer"
444 },
445 "ExclusiveStartStreamName": {}
446 }
447 },
448 "output": {
449 "type": "structure",
450 "required": [
451 "StreamNames",
452 "HasMoreStreams"
453 ],
454 "members": {
455 "StreamNames": {
456 "type": "list",
457 "member": {}
458 },
459 "HasMoreStreams": {
460 "type": "boolean"
461 }
462 }
463 }
464 },
465 "ListTagsForStream": {
466 "input": {
467 "type": "structure",
468 "required": [
469 "StreamName"
470 ],
471 "members": {
472 "StreamName": {},
473 "ExclusiveStartTagKey": {},
474 "Limit": {
475 "type": "integer"
476 }
477 }
478 },
479 "output": {
480 "type": "structure",
481 "required": [
482 "Tags",
483 "HasMoreTags"
484 ],
485 "members": {
486 "Tags": {
487 "type": "list",
488 "member": {
489 "type": "structure",
490 "required": [
491 "Key"
492 ],
493 "members": {
494 "Key": {},
495 "Value": {}
496 }
497 }
498 },
499 "HasMoreTags": {
500 "type": "boolean"
501 }
502 }
503 }
504 },
505 "MergeShards": {
506 "input": {
507 "type": "structure",
508 "required": [
509 "StreamName",
510 "ShardToMerge",
511 "AdjacentShardToMerge"
512 ],
513 "members": {
514 "StreamName": {},
515 "ShardToMerge": {},
516 "AdjacentShardToMerge": {}
517 }
518 }
519 },
520 "PutRecord": {
521 "input": {
522 "type": "structure",
523 "required": [
524 "StreamName",
525 "Data",
526 "PartitionKey"
527 ],
528 "members": {
529 "StreamName": {},
530 "Data": {
531 "type": "blob"
532 },
533 "PartitionKey": {},
534 "ExplicitHashKey": {},
535 "SequenceNumberForOrdering": {}
536 }
537 },
538 "output": {
539 "type": "structure",
540 "required": [
541 "ShardId",
542 "SequenceNumber"
543 ],
544 "members": {
545 "ShardId": {},
546 "SequenceNumber": {},
547 "EncryptionType": {}
548 }
549 }
550 },
551 "PutRecords": {
552 "input": {
553 "type": "structure",
554 "required": [
555 "Records",
556 "StreamName"
557 ],
558 "members": {
559 "Records": {
560 "type": "list",
561 "member": {
562 "type": "structure",
563 "required": [
564 "Data",
565 "PartitionKey"
566 ],
567 "members": {
568 "Data": {
569 "type": "blob"
570 },
571 "ExplicitHashKey": {},
572 "PartitionKey": {}
573 }
574 }
575 },
576 "StreamName": {}
577 }
578 },
579 "output": {
580 "type": "structure",
581 "required": [
582 "Records"
583 ],
584 "members": {
585 "FailedRecordCount": {
586 "type": "integer"
587 },
588 "Records": {
589 "type": "list",
590 "member": {
591 "type": "structure",
592 "members": {
593 "SequenceNumber": {},
594 "ShardId": {},
595 "ErrorCode": {},
596 "ErrorMessage": {}
597 }
598 }
599 },
600 "EncryptionType": {}
601 }
602 }
603 },
604 "RegisterStreamConsumer": {
605 "input": {
606 "type": "structure",
607 "required": [
608 "StreamARN",
609 "ConsumerName"
610 ],
611 "members": {
612 "StreamARN": {},
613 "ConsumerName": {}
614 }
615 },
616 "output": {
617 "type": "structure",
618 "required": [
619 "Consumer"
620 ],
621 "members": {
622 "Consumer": {
623 "shape": "S1y"
624 }
625 }
626 }
627 },
628 "RemoveTagsFromStream": {
629 "input": {
630 "type": "structure",
631 "required": [
632 "StreamName",
633 "TagKeys"
634 ],
635 "members": {
636 "StreamName": {},
637 "TagKeys": {
638 "type": "list",
639 "member": {}
640 }
641 }
642 }
643 },
644 "SplitShard": {
645 "input": {
646 "type": "structure",
647 "required": [
648 "StreamName",
649 "ShardToSplit",
650 "NewStartingHashKey"
651 ],
652 "members": {
653 "StreamName": {},
654 "ShardToSplit": {},
655 "NewStartingHashKey": {}
656 }
657 }
658 },
659 "StartStreamEncryption": {
660 "input": {
661 "type": "structure",
662 "required": [
663 "StreamName",
664 "EncryptionType",
665 "KeyId"
666 ],
667 "members": {
668 "StreamName": {},
669 "EncryptionType": {},
670 "KeyId": {}
671 }
672 }
673 },
674 "StopStreamEncryption": {
675 "input": {
676 "type": "structure",
677 "required": [
678 "StreamName",
679 "EncryptionType",
680 "KeyId"
681 ],
682 "members": {
683 "StreamName": {},
684 "EncryptionType": {},
685 "KeyId": {}
686 }
687 }
688 },
689 "UpdateShardCount": {
690 "input": {
691 "type": "structure",
692 "required": [
693 "StreamName",
694 "TargetShardCount",
695 "ScalingType"
696 ],
697 "members": {
698 "StreamName": {},
699 "TargetShardCount": {
700 "type": "integer"
701 },
702 "ScalingType": {}
703 }
704 },
705 "output": {
706 "type": "structure",
707 "members": {
708 "StreamName": {},
709 "CurrentShardCount": {
710 "type": "integer"
711 },
712 "TargetShardCount": {
713 "type": "integer"
714 }
715 }
716 }
717 }
718 },
719 "shapes": {
720 "Sp": {
721 "type": "list",
722 "member": {
723 "type": "structure",
724 "required": [
725 "ShardId",
726 "HashKeyRange",
727 "SequenceNumberRange"
728 ],
729 "members": {
730 "ShardId": {},
731 "ParentShardId": {},
732 "AdjacentParentShardId": {},
733 "HashKeyRange": {
734 "type": "structure",
735 "required": [
736 "StartingHashKey",
737 "EndingHashKey"
738 ],
739 "members": {
740 "StartingHashKey": {},
741 "EndingHashKey": {}
742 }
743 },
744 "SequenceNumberRange": {
745 "type": "structure",
746 "required": [
747 "StartingSequenceNumber"
748 ],
749 "members": {
750 "StartingSequenceNumber": {},
751 "EndingSequenceNumber": {}
752 }
753 }
754 }
755 }
756 },
757 "Sw": {
758 "type": "list",
759 "member": {
760 "type": "structure",
761 "members": {
762 "ShardLevelMetrics": {
763 "shape": "Sy"
764 }
765 }
766 }
767 },
768 "Sy": {
769 "type": "list",
770 "member": {}
771 },
772 "S1b": {
773 "type": "structure",
774 "members": {
775 "StreamName": {},
776 "CurrentShardLevelMetrics": {
777 "shape": "Sy"
778 },
779 "DesiredShardLevelMetrics": {
780 "shape": "Sy"
781 }
782 }
783 },
784 "S1y": {
785 "type": "structure",
786 "required": [
787 "ConsumerName",
788 "ConsumerARN",
789 "ConsumerStatus",
790 "ConsumerCreationTimestamp"
791 ],
792 "members": {
793 "ConsumerName": {},
794 "ConsumerARN": {},
795 "ConsumerStatus": {},
796 "ConsumerCreationTimestamp": {
797 "type": "timestamp"
798 }
799 }
800 }
801 }
802}
\No newline at end of file