UNPKG

18.1 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2015-08-04",
5 "endpointPrefix": "firehose",
6 "jsonVersion": "1.1",
7 "protocol": "json",
8 "serviceAbbreviation": "Firehose",
9 "serviceFullName": "Amazon Kinesis Firehose",
10 "signatureVersion": "v4",
11 "targetPrefix": "Firehose_20150804",
12 "uid": "firehose-2015-08-04"
13 },
14 "operations": {
15 "CreateDeliveryStream": {
16 "input": {
17 "type": "structure",
18 "required": [
19 "DeliveryStreamName"
20 ],
21 "members": {
22 "DeliveryStreamName": {},
23 "S3DestinationConfiguration": {
24 "shape": "S3",
25 "deprecated": true
26 },
27 "ExtendedS3DestinationConfiguration": {
28 "type": "structure",
29 "required": [
30 "RoleARN",
31 "BucketARN"
32 ],
33 "members": {
34 "RoleARN": {},
35 "BucketARN": {},
36 "Prefix": {},
37 "BufferingHints": {
38 "shape": "S7"
39 },
40 "CompressionFormat": {},
41 "EncryptionConfiguration": {
42 "shape": "Sb"
43 },
44 "CloudWatchLoggingOptions": {
45 "shape": "Sf"
46 },
47 "ProcessingConfiguration": {
48 "shape": "Sk"
49 },
50 "S3BackupMode": {},
51 "S3BackupConfiguration": {
52 "shape": "S3"
53 }
54 }
55 },
56 "RedshiftDestinationConfiguration": {
57 "type": "structure",
58 "required": [
59 "RoleARN",
60 "ClusterJDBCURL",
61 "CopyCommand",
62 "Username",
63 "Password",
64 "S3Configuration"
65 ],
66 "members": {
67 "RoleARN": {},
68 "ClusterJDBCURL": {},
69 "CopyCommand": {
70 "shape": "Sv"
71 },
72 "Username": {
73 "shape": "Sz"
74 },
75 "Password": {
76 "shape": "S10"
77 },
78 "RetryOptions": {
79 "shape": "S11"
80 },
81 "S3Configuration": {
82 "shape": "S3"
83 },
84 "ProcessingConfiguration": {
85 "shape": "Sk"
86 },
87 "S3BackupMode": {},
88 "S3BackupConfiguration": {
89 "shape": "S3"
90 },
91 "CloudWatchLoggingOptions": {
92 "shape": "Sf"
93 }
94 }
95 },
96 "ElasticsearchDestinationConfiguration": {
97 "type": "structure",
98 "required": [
99 "RoleARN",
100 "DomainARN",
101 "IndexName",
102 "TypeName",
103 "S3Configuration"
104 ],
105 "members": {
106 "RoleARN": {},
107 "DomainARN": {},
108 "IndexName": {},
109 "TypeName": {},
110 "IndexRotationPeriod": {},
111 "BufferingHints": {
112 "shape": "S19"
113 },
114 "RetryOptions": {
115 "shape": "S1c"
116 },
117 "S3BackupMode": {},
118 "S3Configuration": {
119 "shape": "S3"
120 },
121 "ProcessingConfiguration": {
122 "shape": "Sk"
123 },
124 "CloudWatchLoggingOptions": {
125 "shape": "Sf"
126 }
127 }
128 }
129 }
130 },
131 "output": {
132 "type": "structure",
133 "members": {
134 "DeliveryStreamARN": {}
135 }
136 }
137 },
138 "DeleteDeliveryStream": {
139 "input": {
140 "type": "structure",
141 "required": [
142 "DeliveryStreamName"
143 ],
144 "members": {
145 "DeliveryStreamName": {}
146 }
147 },
148 "output": {
149 "type": "structure",
150 "members": {}
151 }
152 },
153 "DescribeDeliveryStream": {
154 "input": {
155 "type": "structure",
156 "required": [
157 "DeliveryStreamName"
158 ],
159 "members": {
160 "DeliveryStreamName": {},
161 "Limit": {
162 "type": "integer"
163 },
164 "ExclusiveStartDestinationId": {}
165 }
166 },
167 "output": {
168 "type": "structure",
169 "required": [
170 "DeliveryStreamDescription"
171 ],
172 "members": {
173 "DeliveryStreamDescription": {
174 "type": "structure",
175 "required": [
176 "DeliveryStreamName",
177 "DeliveryStreamARN",
178 "DeliveryStreamStatus",
179 "VersionId",
180 "Destinations",
181 "HasMoreDestinations"
182 ],
183 "members": {
184 "DeliveryStreamName": {},
185 "DeliveryStreamARN": {},
186 "DeliveryStreamStatus": {},
187 "VersionId": {},
188 "CreateTimestamp": {
189 "type": "timestamp"
190 },
191 "LastUpdateTimestamp": {
192 "type": "timestamp"
193 },
194 "Destinations": {
195 "type": "list",
196 "member": {
197 "type": "structure",
198 "required": [
199 "DestinationId"
200 ],
201 "members": {
202 "DestinationId": {},
203 "S3DestinationDescription": {
204 "shape": "S1t"
205 },
206 "ExtendedS3DestinationDescription": {
207 "type": "structure",
208 "required": [
209 "RoleARN",
210 "BucketARN",
211 "BufferingHints",
212 "CompressionFormat",
213 "EncryptionConfiguration"
214 ],
215 "members": {
216 "RoleARN": {},
217 "BucketARN": {},
218 "Prefix": {},
219 "BufferingHints": {
220 "shape": "S7"
221 },
222 "CompressionFormat": {},
223 "EncryptionConfiguration": {
224 "shape": "Sb"
225 },
226 "CloudWatchLoggingOptions": {
227 "shape": "Sf"
228 },
229 "ProcessingConfiguration": {
230 "shape": "Sk"
231 },
232 "S3BackupMode": {},
233 "S3BackupDescription": {
234 "shape": "S1t"
235 }
236 }
237 },
238 "RedshiftDestinationDescription": {
239 "type": "structure",
240 "required": [
241 "RoleARN",
242 "ClusterJDBCURL",
243 "CopyCommand",
244 "Username",
245 "S3DestinationDescription"
246 ],
247 "members": {
248 "RoleARN": {},
249 "ClusterJDBCURL": {},
250 "CopyCommand": {
251 "shape": "Sv"
252 },
253 "Username": {
254 "shape": "Sz"
255 },
256 "RetryOptions": {
257 "shape": "S11"
258 },
259 "S3DestinationDescription": {
260 "shape": "S1t"
261 },
262 "ProcessingConfiguration": {
263 "shape": "Sk"
264 },
265 "S3BackupMode": {},
266 "S3BackupDescription": {
267 "shape": "S1t"
268 },
269 "CloudWatchLoggingOptions": {
270 "shape": "Sf"
271 }
272 }
273 },
274 "ElasticsearchDestinationDescription": {
275 "type": "structure",
276 "members": {
277 "RoleARN": {},
278 "DomainARN": {},
279 "IndexName": {},
280 "TypeName": {},
281 "IndexRotationPeriod": {},
282 "BufferingHints": {
283 "shape": "S19"
284 },
285 "RetryOptions": {
286 "shape": "S1c"
287 },
288 "S3BackupMode": {},
289 "S3DestinationDescription": {
290 "shape": "S1t"
291 },
292 "ProcessingConfiguration": {
293 "shape": "Sk"
294 },
295 "CloudWatchLoggingOptions": {
296 "shape": "Sf"
297 }
298 }
299 }
300 }
301 }
302 },
303 "HasMoreDestinations": {
304 "type": "boolean"
305 }
306 }
307 }
308 }
309 }
310 },
311 "ListDeliveryStreams": {
312 "input": {
313 "type": "structure",
314 "members": {
315 "Limit": {
316 "type": "integer"
317 },
318 "ExclusiveStartDeliveryStreamName": {}
319 }
320 },
321 "output": {
322 "type": "structure",
323 "required": [
324 "DeliveryStreamNames",
325 "HasMoreDeliveryStreams"
326 ],
327 "members": {
328 "DeliveryStreamNames": {
329 "type": "list",
330 "member": {}
331 },
332 "HasMoreDeliveryStreams": {
333 "type": "boolean"
334 }
335 }
336 }
337 },
338 "PutRecord": {
339 "input": {
340 "type": "structure",
341 "required": [
342 "DeliveryStreamName",
343 "Record"
344 ],
345 "members": {
346 "DeliveryStreamName": {},
347 "Record": {
348 "shape": "S22"
349 }
350 }
351 },
352 "output": {
353 "type": "structure",
354 "required": [
355 "RecordId"
356 ],
357 "members": {
358 "RecordId": {}
359 }
360 }
361 },
362 "PutRecordBatch": {
363 "input": {
364 "type": "structure",
365 "required": [
366 "DeliveryStreamName",
367 "Records"
368 ],
369 "members": {
370 "DeliveryStreamName": {},
371 "Records": {
372 "type": "list",
373 "member": {
374 "shape": "S22"
375 }
376 }
377 }
378 },
379 "output": {
380 "type": "structure",
381 "required": [
382 "FailedPutCount",
383 "RequestResponses"
384 ],
385 "members": {
386 "FailedPutCount": {
387 "type": "integer"
388 },
389 "RequestResponses": {
390 "type": "list",
391 "member": {
392 "type": "structure",
393 "members": {
394 "RecordId": {},
395 "ErrorCode": {},
396 "ErrorMessage": {}
397 }
398 }
399 }
400 }
401 }
402 },
403 "UpdateDestination": {
404 "input": {
405 "type": "structure",
406 "required": [
407 "DeliveryStreamName",
408 "CurrentDeliveryStreamVersionId",
409 "DestinationId"
410 ],
411 "members": {
412 "DeliveryStreamName": {},
413 "CurrentDeliveryStreamVersionId": {},
414 "DestinationId": {},
415 "S3DestinationUpdate": {
416 "shape": "S2f",
417 "deprecated": true
418 },
419 "ExtendedS3DestinationUpdate": {
420 "type": "structure",
421 "members": {
422 "RoleARN": {},
423 "BucketARN": {},
424 "Prefix": {},
425 "BufferingHints": {
426 "shape": "S7"
427 },
428 "CompressionFormat": {},
429 "EncryptionConfiguration": {
430 "shape": "Sb"
431 },
432 "CloudWatchLoggingOptions": {
433 "shape": "Sf"
434 },
435 "ProcessingConfiguration": {
436 "shape": "Sk"
437 },
438 "S3BackupMode": {},
439 "S3BackupUpdate": {
440 "shape": "S2f"
441 }
442 }
443 },
444 "RedshiftDestinationUpdate": {
445 "type": "structure",
446 "members": {
447 "RoleARN": {},
448 "ClusterJDBCURL": {},
449 "CopyCommand": {
450 "shape": "Sv"
451 },
452 "Username": {
453 "shape": "Sz"
454 },
455 "Password": {
456 "shape": "S10"
457 },
458 "RetryOptions": {
459 "shape": "S11"
460 },
461 "S3Update": {
462 "shape": "S2f"
463 },
464 "ProcessingConfiguration": {
465 "shape": "Sk"
466 },
467 "S3BackupMode": {},
468 "S3BackupUpdate": {
469 "shape": "S2f"
470 },
471 "CloudWatchLoggingOptions": {
472 "shape": "Sf"
473 }
474 }
475 },
476 "ElasticsearchDestinationUpdate": {
477 "type": "structure",
478 "members": {
479 "RoleARN": {},
480 "DomainARN": {},
481 "IndexName": {},
482 "TypeName": {},
483 "IndexRotationPeriod": {},
484 "BufferingHints": {
485 "shape": "S19"
486 },
487 "RetryOptions": {
488 "shape": "S1c"
489 },
490 "S3Update": {
491 "shape": "S2f"
492 },
493 "ProcessingConfiguration": {
494 "shape": "Sk"
495 },
496 "CloudWatchLoggingOptions": {
497 "shape": "Sf"
498 }
499 }
500 }
501 }
502 },
503 "output": {
504 "type": "structure",
505 "members": {}
506 }
507 }
508 },
509 "shapes": {
510 "S3": {
511 "type": "structure",
512 "required": [
513 "RoleARN",
514 "BucketARN"
515 ],
516 "members": {
517 "RoleARN": {},
518 "BucketARN": {},
519 "Prefix": {},
520 "BufferingHints": {
521 "shape": "S7"
522 },
523 "CompressionFormat": {},
524 "EncryptionConfiguration": {
525 "shape": "Sb"
526 },
527 "CloudWatchLoggingOptions": {
528 "shape": "Sf"
529 }
530 }
531 },
532 "S7": {
533 "type": "structure",
534 "members": {
535 "SizeInMBs": {
536 "type": "integer"
537 },
538 "IntervalInSeconds": {
539 "type": "integer"
540 }
541 }
542 },
543 "Sb": {
544 "type": "structure",
545 "members": {
546 "NoEncryptionConfig": {},
547 "KMSEncryptionConfig": {
548 "type": "structure",
549 "required": [
550 "AWSKMSKeyARN"
551 ],
552 "members": {
553 "AWSKMSKeyARN": {}
554 }
555 }
556 }
557 },
558 "Sf": {
559 "type": "structure",
560 "members": {
561 "Enabled": {
562 "type": "boolean"
563 },
564 "LogGroupName": {},
565 "LogStreamName": {}
566 }
567 },
568 "Sk": {
569 "type": "structure",
570 "members": {
571 "Enabled": {
572 "type": "boolean"
573 },
574 "Processors": {
575 "type": "list",
576 "member": {
577 "type": "structure",
578 "required": [
579 "Type"
580 ],
581 "members": {
582 "Type": {},
583 "Parameters": {
584 "type": "list",
585 "member": {
586 "type": "structure",
587 "required": [
588 "ParameterName",
589 "ParameterValue"
590 ],
591 "members": {
592 "ParameterName": {},
593 "ParameterValue": {}
594 }
595 }
596 }
597 }
598 }
599 }
600 }
601 },
602 "Sv": {
603 "type": "structure",
604 "required": [
605 "DataTableName"
606 ],
607 "members": {
608 "DataTableName": {},
609 "DataTableColumns": {},
610 "CopyOptions": {}
611 }
612 },
613 "Sz": {
614 "type": "string",
615 "sensitive": true
616 },
617 "S10": {
618 "type": "string",
619 "sensitive": true
620 },
621 "S11": {
622 "type": "structure",
623 "members": {
624 "DurationInSeconds": {
625 "type": "integer"
626 }
627 }
628 },
629 "S19": {
630 "type": "structure",
631 "members": {
632 "IntervalInSeconds": {
633 "type": "integer"
634 },
635 "SizeInMBs": {
636 "type": "integer"
637 }
638 }
639 },
640 "S1c": {
641 "type": "structure",
642 "members": {
643 "DurationInSeconds": {
644 "type": "integer"
645 }
646 }
647 },
648 "S1t": {
649 "type": "structure",
650 "required": [
651 "RoleARN",
652 "BucketARN",
653 "BufferingHints",
654 "CompressionFormat",
655 "EncryptionConfiguration"
656 ],
657 "members": {
658 "RoleARN": {},
659 "BucketARN": {},
660 "Prefix": {},
661 "BufferingHints": {
662 "shape": "S7"
663 },
664 "CompressionFormat": {},
665 "EncryptionConfiguration": {
666 "shape": "Sb"
667 },
668 "CloudWatchLoggingOptions": {
669 "shape": "Sf"
670 }
671 }
672 },
673 "S22": {
674 "type": "structure",
675 "required": [
676 "Data"
677 ],
678 "members": {
679 "Data": {
680 "type": "blob"
681 }
682 }
683 },
684 "S2f": {
685 "type": "structure",
686 "members": {
687 "RoleARN": {},
688 "BucketARN": {},
689 "Prefix": {},
690 "BufferingHints": {
691 "shape": "S7"
692 },
693 "CompressionFormat": {},
694 "EncryptionConfiguration": {
695 "shape": "Sb"
696 },
697 "CloudWatchLoggingOptions": {
698 "shape": "Sf"
699 }
700 }
701 }
702 }
703}
\No newline at end of file