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            "ChildShards": {
341              "type": "list",
342              "member": {
343                "type": "structure",
344                "required": [
345                  "ShardId",
346                  "ParentShards",
347                  "HashKeyRange"
348                ],
349                "members": {
350                  "ShardId": {},
351                  "ParentShards": {
352                    "type": "list",
353                    "member": {}
354                  },
355                  "HashKeyRange": {
356                    "shape": "Sr"
357                  }
358                }
359              }
360            }
361          }
362        }
363      },
364      "GetShardIterator": {
365        "input": {
366          "type": "structure",
367          "required": [
368            "StreamName",
369            "ShardId",
370            "ShardIteratorType"
371          ],
372          "members": {
373            "StreamName": {},
374            "ShardId": {},
375            "ShardIteratorType": {},
376            "StartingSequenceNumber": {},
377            "Timestamp": {
378              "type": "timestamp"
379            }
380          }
381        },
382        "output": {
383          "type": "structure",
384          "members": {
385            "ShardIterator": {}
386          }
387        }
388      },
389      "IncreaseStreamRetentionPeriod": {
390        "input": {
391          "type": "structure",
392          "required": [
393            "StreamName",
394            "RetentionPeriodHours"
395          ],
396          "members": {
397            "StreamName": {},
398            "RetentionPeriodHours": {
399              "type": "integer"
400            }
401          }
402        }
403      },
404      "ListShards": {
405        "input": {
406          "type": "structure",
407          "members": {
408            "StreamName": {},
409            "NextToken": {},
410            "ExclusiveStartShardId": {},
411            "MaxResults": {
412              "type": "integer"
413            },
414            "StreamCreationTimestamp": {
415              "type": "timestamp"
416            },
417            "ShardFilter": {
418              "type": "structure",
419              "required": [
420                "Type"
421              ],
422              "members": {
423                "Type": {},
424                "ShardId": {},
425                "Timestamp": {
426                  "type": "timestamp"
427                }
428              }
429            }
430          }
431        },
432        "output": {
433          "type": "structure",
434          "members": {
435            "Shards": {
436              "shape": "Sp"
437            },
438            "NextToken": {}
439          }
440        }
441      },
442      "ListStreamConsumers": {
443        "input": {
444          "type": "structure",
445          "required": [
446            "StreamARN"
447          ],
448          "members": {
449            "StreamARN": {},
450            "NextToken": {},
451            "MaxResults": {
452              "type": "integer"
453            },
454            "StreamCreationTimestamp": {
455              "type": "timestamp"
456            }
457          }
458        },
459        "output": {
460          "type": "structure",
461          "members": {
462            "Consumers": {
463              "type": "list",
464              "member": {
465                "shape": "S23"
466              }
467            },
468            "NextToken": {}
469          }
470        }
471      },
472      "ListStreams": {
473        "input": {
474          "type": "structure",
475          "members": {
476            "Limit": {
477              "type": "integer"
478            },
479            "ExclusiveStartStreamName": {}
480          }
481        },
482        "output": {
483          "type": "structure",
484          "required": [
485            "StreamNames",
486            "HasMoreStreams"
487          ],
488          "members": {
489            "StreamNames": {
490              "type": "list",
491              "member": {}
492            },
493            "HasMoreStreams": {
494              "type": "boolean"
495            }
496          }
497        }
498      },
499      "ListTagsForStream": {
500        "input": {
501          "type": "structure",
502          "required": [
503            "StreamName"
504          ],
505          "members": {
506            "StreamName": {},
507            "ExclusiveStartTagKey": {},
508            "Limit": {
509              "type": "integer"
510            }
511          }
512        },
513        "output": {
514          "type": "structure",
515          "required": [
516            "Tags",
517            "HasMoreTags"
518          ],
519          "members": {
520            "Tags": {
521              "type": "list",
522              "member": {
523                "type": "structure",
524                "required": [
525                  "Key"
526                ],
527                "members": {
528                  "Key": {},
529                  "Value": {}
530                }
531              }
532            },
533            "HasMoreTags": {
534              "type": "boolean"
535            }
536          }
537        }
538      },
539      "MergeShards": {
540        "input": {
541          "type": "structure",
542          "required": [
543            "StreamName",
544            "ShardToMerge",
545            "AdjacentShardToMerge"
546          ],
547          "members": {
548            "StreamName": {},
549            "ShardToMerge": {},
550            "AdjacentShardToMerge": {}
551          }
552        }
553      },
554      "PutRecord": {
555        "input": {
556          "type": "structure",
557          "required": [
558            "StreamName",
559            "Data",
560            "PartitionKey"
561          ],
562          "members": {
563            "StreamName": {},
564            "Data": {
565              "type": "blob"
566            },
567            "PartitionKey": {},
568            "ExplicitHashKey": {},
569            "SequenceNumberForOrdering": {}
570          }
571        },
572        "output": {
573          "type": "structure",
574          "required": [
575            "ShardId",
576            "SequenceNumber"
577          ],
578          "members": {
579            "ShardId": {},
580            "SequenceNumber": {},
581            "EncryptionType": {}
582          }
583        }
584      },
585      "PutRecords": {
586        "input": {
587          "type": "structure",
588          "required": [
589            "Records",
590            "StreamName"
591          ],
592          "members": {
593            "Records": {
594              "type": "list",
595              "member": {
596                "type": "structure",
597                "required": [
598                  "Data",
599                  "PartitionKey"
600                ],
601                "members": {
602                  "Data": {
603                    "type": "blob"
604                  },
605                  "ExplicitHashKey": {},
606                  "PartitionKey": {}
607                }
608              }
609            },
610            "StreamName": {}
611          }
612        },
613        "output": {
614          "type": "structure",
615          "required": [
616            "Records"
617          ],
618          "members": {
619            "FailedRecordCount": {
620              "type": "integer"
621            },
622            "Records": {
623              "type": "list",
624              "member": {
625                "type": "structure",
626                "members": {
627                  "SequenceNumber": {},
628                  "ShardId": {},
629                  "ErrorCode": {},
630                  "ErrorMessage": {}
631                }
632              }
633            },
634            "EncryptionType": {}
635          }
636        }
637      },
638      "RegisterStreamConsumer": {
639        "input": {
640          "type": "structure",
641          "required": [
642            "StreamARN",
643            "ConsumerName"
644          ],
645          "members": {
646            "StreamARN": {},
647            "ConsumerName": {}
648          }
649        },
650        "output": {
651          "type": "structure",
652          "required": [
653            "Consumer"
654          ],
655          "members": {
656            "Consumer": {
657              "shape": "S23"
658            }
659          }
660        }
661      },
662      "RemoveTagsFromStream": {
663        "input": {
664          "type": "structure",
665          "required": [
666            "StreamName",
667            "TagKeys"
668          ],
669          "members": {
670            "StreamName": {},
671            "TagKeys": {
672              "type": "list",
673              "member": {}
674            }
675          }
676        }
677      },
678      "SplitShard": {
679        "input": {
680          "type": "structure",
681          "required": [
682            "StreamName",
683            "ShardToSplit",
684            "NewStartingHashKey"
685          ],
686          "members": {
687            "StreamName": {},
688            "ShardToSplit": {},
689            "NewStartingHashKey": {}
690          }
691        }
692      },
693      "StartStreamEncryption": {
694        "input": {
695          "type": "structure",
696          "required": [
697            "StreamName",
698            "EncryptionType",
699            "KeyId"
700          ],
701          "members": {
702            "StreamName": {},
703            "EncryptionType": {},
704            "KeyId": {}
705          }
706        }
707      },
708      "StopStreamEncryption": {
709        "input": {
710          "type": "structure",
711          "required": [
712            "StreamName",
713            "EncryptionType",
714            "KeyId"
715          ],
716          "members": {
717            "StreamName": {},
718            "EncryptionType": {},
719            "KeyId": {}
720          }
721        }
722      },
723      "UpdateShardCount": {
724        "input": {
725          "type": "structure",
726          "required": [
727            "StreamName",
728            "TargetShardCount",
729            "ScalingType"
730          ],
731          "members": {
732            "StreamName": {},
733            "TargetShardCount": {
734              "type": "integer"
735            },
736            "ScalingType": {}
737          }
738        },
739        "output": {
740          "type": "structure",
741          "members": {
742            "StreamName": {},
743            "CurrentShardCount": {
744              "type": "integer"
745            },
746            "TargetShardCount": {
747              "type": "integer"
748            }
749          }
750        }
751      }
752    },
753    "shapes": {
754      "Sp": {
755        "type": "list",
756        "member": {
757          "type": "structure",
758          "required": [
759            "ShardId",
760            "HashKeyRange",
761            "SequenceNumberRange"
762          ],
763          "members": {
764            "ShardId": {},
765            "ParentShardId": {},
766            "AdjacentParentShardId": {},
767            "HashKeyRange": {
768              "shape": "Sr"
769            },
770            "SequenceNumberRange": {
771              "type": "structure",
772              "required": [
773                "StartingSequenceNumber"
774              ],
775              "members": {
776                "StartingSequenceNumber": {},
777                "EndingSequenceNumber": {}
778              }
779            }
780          }
781        }
782      },
783      "Sr": {
784        "type": "structure",
785        "required": [
786          "StartingHashKey",
787          "EndingHashKey"
788        ],
789        "members": {
790          "StartingHashKey": {},
791          "EndingHashKey": {}
792        }
793      },
794      "Sw": {
795        "type": "list",
796        "member": {
797          "type": "structure",
798          "members": {
799            "ShardLevelMetrics": {
800              "shape": "Sy"
801            }
802          }
803        }
804      },
805      "Sy": {
806        "type": "list",
807        "member": {}
808      },
809      "S1b": {
810        "type": "structure",
811        "members": {
812          "StreamName": {},
813          "CurrentShardLevelMetrics": {
814            "shape": "Sy"
815          },
816          "DesiredShardLevelMetrics": {
817            "shape": "Sy"
818          }
819        }
820      },
821      "S23": {
822        "type": "structure",
823        "required": [
824          "ConsumerName",
825          "ConsumerARN",
826          "ConsumerStatus",
827          "ConsumerCreationTimestamp"
828        ],
829        "members": {
830          "ConsumerName": {},
831          "ConsumerARN": {},
832          "ConsumerStatus": {},
833          "ConsumerCreationTimestamp": {
834            "type": "timestamp"
835          }
836        }
837      }
838    }
839  }