Debian Codegraph @

models/apis/kinesis-video-archived-media/2017-09-30/api-2.json

raw
1 {
2 "version":"2.0",
3 "metadata":{
4 "apiVersion":"2017-09-30",
5 "endpointPrefix":"kinesisvideo",
6 "protocol":"rest-json",
7 "serviceAbbreviation":"Kinesis Video Archived Media",
8 "serviceFullName":"Amazon Kinesis Video Streams Archived Media",
9 "serviceId":"Kinesis Video Archived Media",
10 "signatureVersion":"v4",
11 "uid":"kinesis-video-archived-media-2017-09-30"
12 },
13 "operations":{
14 "GetClip":{
15 "name":"GetClip",
16 "http":{
17 "method":"POST",
18 "requestUri":"/getClip"
19 },
20 "input":{"shape":"GetClipInput"},
21 "output":{"shape":"GetClipOutput"},
22 "errors":[
23 {"shape":"ResourceNotFoundException"},
24 {"shape":"InvalidArgumentException"},
25 {"shape":"ClientLimitExceededException"},
26 {"shape":"NotAuthorizedException"},
27 {"shape":"UnsupportedStreamMediaTypeException"},
28 {"shape":"MissingCodecPrivateDataException"},
29 {"shape":"InvalidCodecPrivateDataException"},
30 {"shape":"InvalidMediaFrameException"},
31 {"shape":"NoDataRetentionException"}
32 ]
33 },
34 "GetDASHStreamingSessionURL":{
35 "name":"GetDASHStreamingSessionURL",
36 "http":{
37 "method":"POST",
38 "requestUri":"/getDASHStreamingSessionURL"
39 },
40 "input":{"shape":"GetDASHStreamingSessionURLInput"},
41 "output":{"shape":"GetDASHStreamingSessionURLOutput"},
42 "errors":[
43 {"shape":"ResourceNotFoundException"},
44 {"shape":"InvalidArgumentException"},
45 {"shape":"ClientLimitExceededException"},
46 {"shape":"NotAuthorizedException"},
47 {"shape":"UnsupportedStreamMediaTypeException"},
48 {"shape":"NoDataRetentionException"},
49 {"shape":"MissingCodecPrivateDataException"},
50 {"shape":"InvalidCodecPrivateDataException"}
51 ]
52 },
53 "GetHLSStreamingSessionURL":{
54 "name":"GetHLSStreamingSessionURL",
55 "http":{
56 "method":"POST",
57 "requestUri":"/getHLSStreamingSessionURL"
58 },
59 "input":{"shape":"GetHLSStreamingSessionURLInput"},
60 "output":{"shape":"GetHLSStreamingSessionURLOutput"},
61 "errors":[
62 {"shape":"ResourceNotFoundException"},
63 {"shape":"InvalidArgumentException"},
64 {"shape":"ClientLimitExceededException"},
65 {"shape":"NotAuthorizedException"},
66 {"shape":"UnsupportedStreamMediaTypeException"},
67 {"shape":"NoDataRetentionException"},
68 {"shape":"MissingCodecPrivateDataException"},
69 {"shape":"InvalidCodecPrivateDataException"}
70 ]
71 },
72 "GetImages":{
73 "name":"GetImages",
74 "http":{
75 "method":"POST",
76 "requestUri":"/getImages"
77 },
78 "input":{"shape":"GetImagesInput"},
79 "output":{"shape":"GetImagesOutput"},
80 "errors":[
81 {"shape":"ResourceNotFoundException"},
82 {"shape":"InvalidArgumentException"},
83 {"shape":"ClientLimitExceededException"},
84 {"shape":"NotAuthorizedException"}
85 ]
86 },
87 "GetMediaForFragmentList":{
88 "name":"GetMediaForFragmentList",
89 "http":{
90 "method":"POST",
91 "requestUri":"/getMediaForFragmentList"
92 },
93 "input":{"shape":"GetMediaForFragmentListInput"},
94 "output":{"shape":"GetMediaForFragmentListOutput"},
95 "errors":[
96 {"shape":"ResourceNotFoundException"},
97 {"shape":"InvalidArgumentException"},
98 {"shape":"ClientLimitExceededException"},
99 {"shape":"NotAuthorizedException"}
100 ]
101 },
102 "ListFragments":{
103 "name":"ListFragments",
104 "http":{
105 "method":"POST",
106 "requestUri":"/listFragments"
107 },
108 "input":{"shape":"ListFragmentsInput"},
109 "output":{"shape":"ListFragmentsOutput"},
110 "errors":[
111 {"shape":"ResourceNotFoundException"},
112 {"shape":"InvalidArgumentException"},
113 {"shape":"ClientLimitExceededException"},
114 {"shape":"NotAuthorizedException"}
115 ]
116 }
117 },
118 "shapes":{
119 "ClientLimitExceededException":{
120 "type":"structure",
121 "members":{
122 "Message":{"shape":"ErrorMessage"}
123 },
124 "error":{"httpStatusCode":400},
125 "exception":true
126 },
127 "ClipFragmentSelector":{
128 "type":"structure",
129 "required":[
130 "FragmentSelectorType",
131 "TimestampRange"
132 ],
133 "members":{
134 "FragmentSelectorType":{"shape":"ClipFragmentSelectorType"},
135 "TimestampRange":{"shape":"ClipTimestampRange"}
136 }
137 },
138 "ClipFragmentSelectorType":{
139 "type":"string",
140 "enum":[
141 "PRODUCER_TIMESTAMP",
142 "SERVER_TIMESTAMP"
143 ]
144 },
145 "ClipTimestampRange":{
146 "type":"structure",
147 "required":[
148 "StartTimestamp",
149 "EndTimestamp"
150 ],
151 "members":{
152 "StartTimestamp":{"shape":"Timestamp"},
153 "EndTimestamp":{"shape":"Timestamp"}
154 }
155 },
156 "ContainerFormat":{
157 "type":"string",
158 "enum":[
159 "FRAGMENTED_MP4",
160 "MPEG_TS"
161 ]
162 },
163 "ContentType":{
164 "type":"string",
165 "max":128,
166 "min":1,
167 "pattern":"^[a-zA-Z0-9_\\.\\-]+$"
168 },
169 "DASHDisplayFragmentNumber":{
170 "type":"string",
171 "enum":[
172 "ALWAYS",
173 "NEVER"
174 ]
175 },
176 "DASHDisplayFragmentTimestamp":{
177 "type":"string",
178 "enum":[
179 "ALWAYS",
180 "NEVER"
181 ]
182 },
183 "DASHFragmentSelector":{
184 "type":"structure",
185 "members":{
186 "FragmentSelectorType":{"shape":"DASHFragmentSelectorType"},
187 "TimestampRange":{"shape":"DASHTimestampRange"}
188 }
189 },
190 "DASHFragmentSelectorType":{
191 "type":"string",
192 "enum":[
193 "PRODUCER_TIMESTAMP",
194 "SERVER_TIMESTAMP"
195 ]
196 },
197 "DASHMaxResults":{
198 "type":"long",
199 "max":5000,
200 "min":1
201 },
202 "DASHPlaybackMode":{
203 "type":"string",
204 "enum":[
205 "LIVE",
206 "LIVE_REPLAY",
207 "ON_DEMAND"
208 ]
209 },
210 "DASHStreamingSessionURL":{"type":"string"},
211 "DASHTimestampRange":{
212 "type":"structure",
213 "members":{
214 "StartTimestamp":{"shape":"Timestamp"},
215 "EndTimestamp":{"shape":"Timestamp"}
216 }
217 },
218 "ErrorMessage":{"type":"string"},
219 "Expires":{
220 "type":"integer",
221 "max":43200,
222 "min":300
223 },
224 "Format":{
225 "type":"string",
226 "enum":[
227 "JPEG",
228 "PNG"
229 ]
230 },
231 "FormatConfig":{
232 "type":"map",
233 "key":{"shape":"FormatConfigKey"},
234 "value":{"shape":"FormatConfigValue"},
235 "max":1,
236 "min":1
237 },
238 "FormatConfigKey":{
239 "type":"string",
240 "enum":["JPEGQuality"]
241 },
242 "FormatConfigValue":{
243 "type":"string",
244 "max":256,
245 "min":0,
246 "pattern":"^[a-zA-Z_0-9]+"
247 },
248 "Fragment":{
249 "type":"structure",
250 "members":{
251 "FragmentNumber":{"shape":"FragmentNumberString"},
252 "FragmentSizeInBytes":{"shape":"Long"},
253 "ProducerTimestamp":{"shape":"Timestamp"},
254 "ServerTimestamp":{"shape":"Timestamp"},
255 "FragmentLengthInMilliseconds":{"shape":"Long"}
256 }
257 },
258 "FragmentList":{
259 "type":"list",
260 "member":{"shape":"Fragment"}
261 },
262 "FragmentNumberList":{
263 "type":"list",
264 "member":{"shape":"FragmentNumberString"},
265 "max":1000,
266 "min":1
267 },
268 "FragmentNumberString":{
269 "type":"string",
270 "max":128,
271 "min":1,
272 "pattern":"^[0-9]+$"
273 },
274 "FragmentSelector":{
275 "type":"structure",
276 "required":[
277 "FragmentSelectorType",
278 "TimestampRange"
279 ],
280 "members":{
281 "FragmentSelectorType":{"shape":"FragmentSelectorType"},
282 "TimestampRange":{"shape":"TimestampRange"}
283 }
284 },
285 "FragmentSelectorType":{
286 "type":"string",
287 "enum":[
288 "PRODUCER_TIMESTAMP",
289 "SERVER_TIMESTAMP"
290 ]
291 },
292 "GetClipInput":{
293 "type":"structure",
294 "required":["ClipFragmentSelector"],
295 "members":{
296 "StreamName":{"shape":"StreamName"},
297 "StreamARN":{"shape":"ResourceARN"},
298 "ClipFragmentSelector":{"shape":"ClipFragmentSelector"}
299 }
300 },
301 "GetClipOutput":{
302 "type":"structure",
303 "members":{
304 "ContentType":{
305 "shape":"ContentType",
306 "location":"header",
307 "locationName":"Content-Type"
308 },
309 "Payload":{"shape":"Payload"}
310 },
311 "payload":"Payload"
312 },
313 "GetDASHStreamingSessionURLInput":{
314 "type":"structure",
315 "members":{
316 "StreamName":{"shape":"StreamName"},
317 "StreamARN":{"shape":"ResourceARN"},
318 "PlaybackMode":{"shape":"DASHPlaybackMode"},
319 "DisplayFragmentTimestamp":{"shape":"DASHDisplayFragmentTimestamp"},
320 "DisplayFragmentNumber":{"shape":"DASHDisplayFragmentNumber"},
321 "DASHFragmentSelector":{"shape":"DASHFragmentSelector"},
322 "Expires":{"shape":"Expires"},
323 "MaxManifestFragmentResults":{"shape":"DASHMaxResults"}
324 }
325 },
326 "GetDASHStreamingSessionURLOutput":{
327 "type":"structure",
328 "members":{
329 "DASHStreamingSessionURL":{"shape":"DASHStreamingSessionURL"}
330 }
331 },
332 "GetHLSStreamingSessionURLInput":{
333 "type":"structure",
334 "members":{
335 "StreamName":{"shape":"StreamName"},
336 "StreamARN":{"shape":"ResourceARN"},
337 "PlaybackMode":{"shape":"HLSPlaybackMode"},
338 "HLSFragmentSelector":{"shape":"HLSFragmentSelector"},
339 "ContainerFormat":{"shape":"ContainerFormat"},
340 "DiscontinuityMode":{"shape":"HLSDiscontinuityMode"},
341 "DisplayFragmentTimestamp":{"shape":"HLSDisplayFragmentTimestamp"},
342 "Expires":{"shape":"Expires"},
343 "MaxMediaPlaylistFragmentResults":{"shape":"HLSMaxResults"}
344 }
345 },
346 "GetHLSStreamingSessionURLOutput":{
347 "type":"structure",
348 "members":{
349 "HLSStreamingSessionURL":{"shape":"HLSStreamingSessionURL"}
350 }
351 },
352 "GetImagesInput":{
353 "type":"structure",
354 "required":[
355 "ImageSelectorType",
356 "StartTimestamp",
357 "EndTimestamp",
358 "Format"
359 ],
360 "members":{
361 "StreamName":{"shape":"StreamName"},
362 "StreamARN":{"shape":"ResourceARN"},
363 "ImageSelectorType":{"shape":"ImageSelectorType"},
364 "StartTimestamp":{"shape":"Timestamp"},
365 "EndTimestamp":{"shape":"Timestamp"},
366 "SamplingInterval":{"shape":"SamplingInterval"},
367 "Format":{"shape":"Format"},
368 "FormatConfig":{"shape":"FormatConfig"},
369 "WidthPixels":{"shape":"WidthPixels"},
370 "HeightPixels":{"shape":"HeightPixels"},
371 "MaxResults":{"shape":"GetImagesMaxResults"},
372 "NextToken":{"shape":"NextToken"}
373 }
374 },
375 "GetImagesMaxResults":{
376 "type":"long",
377 "max":100,
378 "min":1
379 },
380 "GetImagesOutput":{
381 "type":"structure",
382 "members":{
383 "Images":{"shape":"Images"},
384 "NextToken":{"shape":"NextToken"}
385 }
386 },
387 "GetMediaForFragmentListInput":{
388 "type":"structure",
389 "required":["Fragments"],
390 "members":{
391 "StreamName":{"shape":"StreamName"},
392 "StreamARN":{"shape":"ResourceARN"},
393 "Fragments":{"shape":"FragmentNumberList"}
394 }
395 },
396 "GetMediaForFragmentListOutput":{
397 "type":"structure",
398 "members":{
399 "ContentType":{
400 "shape":"ContentType",
401 "location":"header",
402 "locationName":"Content-Type"
403 },
404 "Payload":{"shape":"Payload"}
405 },
406 "payload":"Payload"
407 },
408 "HLSDiscontinuityMode":{
409 "type":"string",
410 "enum":[
411 "ALWAYS",
412 "NEVER",
413 "ON_DISCONTINUITY"
414 ]
415 },
416 "HLSDisplayFragmentTimestamp":{
417 "type":"string",
418 "enum":[
419 "ALWAYS",
420 "NEVER"
421 ]
422 },
423 "HLSFragmentSelector":{
424 "type":"structure",
425 "members":{
426 "FragmentSelectorType":{"shape":"HLSFragmentSelectorType"},
427 "TimestampRange":{"shape":"HLSTimestampRange"}
428 }
429 },
430 "HLSFragmentSelectorType":{
431 "type":"string",
432 "enum":[
433 "PRODUCER_TIMESTAMP",
434 "SERVER_TIMESTAMP"
435 ]
436 },
437 "HLSMaxResults":{
438 "type":"long",
439 "max":5000,
440 "min":1
441 },
442 "HLSPlaybackMode":{
443 "type":"string",
444 "enum":[
445 "LIVE",
446 "LIVE_REPLAY",
447 "ON_DEMAND"
448 ]
449 },
450 "HLSStreamingSessionURL":{"type":"string"},
451 "HLSTimestampRange":{
452 "type":"structure",
453 "members":{
454 "StartTimestamp":{"shape":"Timestamp"},
455 "EndTimestamp":{"shape":"Timestamp"}
456 }
457 },
458 "HeightPixels":{
459 "type":"integer",
460 "max":2160,
461 "min":1
462 },
463 "Image":{
464 "type":"structure",
465 "members":{
466 "TimeStamp":{"shape":"Timestamp"},
467 "Error":{"shape":"ImageError"},
468 "ImageContent":{"shape":"ImageContent"}
469 }
470 },
471 "ImageContent":{
472 "type":"string",
473 "max":6291456,
474 "min":1
475 },
476 "ImageError":{
477 "type":"string",
478 "enum":[
479 "NO_MEDIA",
480 "MEDIA_ERROR"
481 ]
482 },
483 "ImageSelectorType":{
484 "type":"string",
485 "enum":[
486 "PRODUCER_TIMESTAMP",
487 "SERVER_TIMESTAMP"
488 ]
489 },
490 "Images":{
491 "type":"list",
492 "member":{"shape":"Image"}
493 },
494 "InvalidArgumentException":{
495 "type":"structure",
496 "members":{
497 "Message":{"shape":"ErrorMessage"}
498 },
499 "error":{"httpStatusCode":400},
500 "exception":true
501 },
502 "InvalidCodecPrivateDataException":{
503 "type":"structure",
504 "members":{
505 "Message":{"shape":"ErrorMessage"}
506 },
507 "error":{"httpStatusCode":400},
508 "exception":true
509 },
510 "InvalidMediaFrameException":{
511 "type":"structure",
512 "members":{
513 "Message":{"shape":"ErrorMessage"}
514 },
515 "error":{"httpStatusCode":400},
516 "exception":true
517 },
518 "ListFragmentsInput":{
519 "type":"structure",
520 "members":{
521 "StreamName":{"shape":"StreamName"},
522 "StreamARN":{"shape":"ResourceARN"},
523 "MaxResults":{"shape":"ListFragmentsMaxResults"},
524 "NextToken":{"shape":"NextToken"},
525 "FragmentSelector":{"shape":"FragmentSelector"}
526 }
527 },
528 "ListFragmentsMaxResults":{
529 "type":"long",
530 "max":1000,
531 "min":1
532 },
533 "ListFragmentsOutput":{
534 "type":"structure",
535 "members":{
536 "Fragments":{"shape":"FragmentList"},
537 "NextToken":{"shape":"NextToken"}
538 }
539 },
540 "Long":{"type":"long"},
541 "MissingCodecPrivateDataException":{
542 "type":"structure",
543 "members":{
544 "Message":{"shape":"ErrorMessage"}
545 },
546 "error":{"httpStatusCode":400},
547 "exception":true
548 },
549 "NextToken":{
550 "type":"string",
551 "max":4096,
552 "min":1,
553 "pattern":"[a-zA-Z0-9+/]+={0,2}"
554 },
555 "NoDataRetentionException":{
556 "type":"structure",
557 "members":{
558 "Message":{"shape":"ErrorMessage"}
559 },
560 "error":{"httpStatusCode":400},
561 "exception":true
562 },
563 "NotAuthorizedException":{
564 "type":"structure",
565 "members":{
566 "Message":{"shape":"ErrorMessage"}
567 },
568 "error":{"httpStatusCode":401},
569 "exception":true
570 },
571 "Payload":{
572 "type":"blob",
573 "streaming":true
574 },
575 "ResourceARN":{
576 "type":"string",
577 "max":1024,
578 "min":1,
579 "pattern":"arn:[a-z\\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+"
580 },
581 "ResourceNotFoundException":{
582 "type":"structure",
583 "members":{
584 "Message":{"shape":"ErrorMessage"}
585 },
586 "error":{"httpStatusCode":404},
587 "exception":true
588 },
589 "SamplingInterval":{"type":"integer"},
590 "StreamName":{
591 "type":"string",
592 "max":256,
593 "min":1,
594 "pattern":"[a-zA-Z0-9_.-]+"
595 },
596 "Timestamp":{"type":"timestamp"},
597 "TimestampRange":{
598 "type":"structure",
599 "required":[
600 "StartTimestamp",
601 "EndTimestamp"
602 ],
603 "members":{
604 "StartTimestamp":{"shape":"Timestamp"},
605 "EndTimestamp":{"shape":"Timestamp"}
606 }
607 },
608 "UnsupportedStreamMediaTypeException":{
609 "type":"structure",
610 "members":{
611 "Message":{"shape":"ErrorMessage"}
612 },
613 "error":{"httpStatusCode":400},
614 "exception":true
615 },
616 "WidthPixels":{
617 "type":"integer",
618 "max":3840,
619 "min":1
620 }
621 }
622 }