UNPKG

18.5 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2018-07-27",
5 "endpointPrefix": "iotevents",
6 "protocol": "rest-json",
7 "serviceFullName": "AWS IoT Events",
8 "serviceId": "IoT Events",
9 "signatureVersion": "v4",
10 "signingName": "iotevents",
11 "uid": "iotevents-2018-07-27"
12 },
13 "operations": {
14 "CreateDetectorModel": {
15 "http": {
16 "requestUri": "/detector-models"
17 },
18 "input": {
19 "type": "structure",
20 "required": [
21 "detectorModelName",
22 "detectorModelDefinition",
23 "roleArn"
24 ],
25 "members": {
26 "detectorModelName": {},
27 "detectorModelDefinition": {
28 "shape": "S3"
29 },
30 "detectorModelDescription": {},
31 "key": {},
32 "roleArn": {},
33 "tags": {
34 "shape": "S15"
35 },
36 "evaluationMethod": {}
37 }
38 },
39 "output": {
40 "type": "structure",
41 "members": {
42 "detectorModelConfiguration": {
43 "shape": "S1b"
44 }
45 }
46 }
47 },
48 "CreateInput": {
49 "http": {
50 "requestUri": "/inputs",
51 "responseCode": 201
52 },
53 "input": {
54 "type": "structure",
55 "required": [
56 "inputName",
57 "inputDefinition"
58 ],
59 "members": {
60 "inputName": {},
61 "inputDescription": {},
62 "inputDefinition": {
63 "shape": "S1i"
64 },
65 "tags": {
66 "shape": "S15"
67 }
68 }
69 },
70 "output": {
71 "type": "structure",
72 "members": {
73 "inputConfiguration": {
74 "shape": "S1m"
75 }
76 }
77 }
78 },
79 "DeleteDetectorModel": {
80 "http": {
81 "method": "DELETE",
82 "requestUri": "/detector-models/{detectorModelName}",
83 "responseCode": 204
84 },
85 "input": {
86 "type": "structure",
87 "required": [
88 "detectorModelName"
89 ],
90 "members": {
91 "detectorModelName": {
92 "location": "uri",
93 "locationName": "detectorModelName"
94 }
95 }
96 },
97 "output": {
98 "type": "structure",
99 "members": {}
100 }
101 },
102 "DeleteInput": {
103 "http": {
104 "method": "DELETE",
105 "requestUri": "/inputs/{inputName}"
106 },
107 "input": {
108 "type": "structure",
109 "required": [
110 "inputName"
111 ],
112 "members": {
113 "inputName": {
114 "location": "uri",
115 "locationName": "inputName"
116 }
117 }
118 },
119 "output": {
120 "type": "structure",
121 "members": {}
122 }
123 },
124 "DescribeDetectorModel": {
125 "http": {
126 "method": "GET",
127 "requestUri": "/detector-models/{detectorModelName}"
128 },
129 "input": {
130 "type": "structure",
131 "required": [
132 "detectorModelName"
133 ],
134 "members": {
135 "detectorModelName": {
136 "location": "uri",
137 "locationName": "detectorModelName"
138 },
139 "detectorModelVersion": {
140 "location": "querystring",
141 "locationName": "version"
142 }
143 }
144 },
145 "output": {
146 "type": "structure",
147 "members": {
148 "detectorModel": {
149 "type": "structure",
150 "members": {
151 "detectorModelDefinition": {
152 "shape": "S3"
153 },
154 "detectorModelConfiguration": {
155 "shape": "S1b"
156 }
157 }
158 }
159 }
160 }
161 },
162 "DescribeInput": {
163 "http": {
164 "method": "GET",
165 "requestUri": "/inputs/{inputName}"
166 },
167 "input": {
168 "type": "structure",
169 "required": [
170 "inputName"
171 ],
172 "members": {
173 "inputName": {
174 "location": "uri",
175 "locationName": "inputName"
176 }
177 }
178 },
179 "output": {
180 "type": "structure",
181 "members": {
182 "input": {
183 "type": "structure",
184 "members": {
185 "inputConfiguration": {
186 "shape": "S1m"
187 },
188 "inputDefinition": {
189 "shape": "S1i"
190 }
191 }
192 }
193 }
194 }
195 },
196 "DescribeLoggingOptions": {
197 "http": {
198 "method": "GET",
199 "requestUri": "/logging"
200 },
201 "input": {
202 "type": "structure",
203 "members": {}
204 },
205 "output": {
206 "type": "structure",
207 "members": {
208 "loggingOptions": {
209 "shape": "S21"
210 }
211 }
212 }
213 },
214 "ListDetectorModelVersions": {
215 "http": {
216 "method": "GET",
217 "requestUri": "/detector-models/{detectorModelName}/versions"
218 },
219 "input": {
220 "type": "structure",
221 "required": [
222 "detectorModelName"
223 ],
224 "members": {
225 "detectorModelName": {
226 "location": "uri",
227 "locationName": "detectorModelName"
228 },
229 "nextToken": {
230 "location": "querystring",
231 "locationName": "nextToken"
232 },
233 "maxResults": {
234 "location": "querystring",
235 "locationName": "maxResults",
236 "type": "integer"
237 }
238 }
239 },
240 "output": {
241 "type": "structure",
242 "members": {
243 "detectorModelVersionSummaries": {
244 "type": "list",
245 "member": {
246 "type": "structure",
247 "members": {
248 "detectorModelName": {},
249 "detectorModelVersion": {},
250 "detectorModelArn": {},
251 "roleArn": {},
252 "creationTime": {
253 "type": "timestamp"
254 },
255 "lastUpdateTime": {
256 "type": "timestamp"
257 },
258 "status": {},
259 "evaluationMethod": {}
260 }
261 }
262 },
263 "nextToken": {}
264 }
265 }
266 },
267 "ListDetectorModels": {
268 "http": {
269 "method": "GET",
270 "requestUri": "/detector-models"
271 },
272 "input": {
273 "type": "structure",
274 "members": {
275 "nextToken": {
276 "location": "querystring",
277 "locationName": "nextToken"
278 },
279 "maxResults": {
280 "location": "querystring",
281 "locationName": "maxResults",
282 "type": "integer"
283 }
284 }
285 },
286 "output": {
287 "type": "structure",
288 "members": {
289 "detectorModelSummaries": {
290 "type": "list",
291 "member": {
292 "type": "structure",
293 "members": {
294 "detectorModelName": {},
295 "detectorModelDescription": {},
296 "creationTime": {
297 "type": "timestamp"
298 }
299 }
300 }
301 },
302 "nextToken": {}
303 }
304 }
305 },
306 "ListInputs": {
307 "http": {
308 "method": "GET",
309 "requestUri": "/inputs"
310 },
311 "input": {
312 "type": "structure",
313 "members": {
314 "nextToken": {
315 "location": "querystring",
316 "locationName": "nextToken"
317 },
318 "maxResults": {
319 "location": "querystring",
320 "locationName": "maxResults",
321 "type": "integer"
322 }
323 }
324 },
325 "output": {
326 "type": "structure",
327 "members": {
328 "inputSummaries": {
329 "type": "list",
330 "member": {
331 "type": "structure",
332 "members": {
333 "inputName": {},
334 "inputDescription": {},
335 "inputArn": {},
336 "creationTime": {
337 "type": "timestamp"
338 },
339 "lastUpdateTime": {
340 "type": "timestamp"
341 },
342 "status": {}
343 }
344 }
345 },
346 "nextToken": {}
347 }
348 }
349 },
350 "ListTagsForResource": {
351 "http": {
352 "method": "GET",
353 "requestUri": "/tags"
354 },
355 "input": {
356 "type": "structure",
357 "required": [
358 "resourceArn"
359 ],
360 "members": {
361 "resourceArn": {
362 "location": "querystring",
363 "locationName": "resourceArn"
364 }
365 }
366 },
367 "output": {
368 "type": "structure",
369 "members": {
370 "tags": {
371 "shape": "S15"
372 }
373 }
374 }
375 },
376 "PutLoggingOptions": {
377 "http": {
378 "method": "PUT",
379 "requestUri": "/logging"
380 },
381 "input": {
382 "type": "structure",
383 "required": [
384 "loggingOptions"
385 ],
386 "members": {
387 "loggingOptions": {
388 "shape": "S21"
389 }
390 }
391 }
392 },
393 "TagResource": {
394 "http": {
395 "requestUri": "/tags"
396 },
397 "input": {
398 "type": "structure",
399 "required": [
400 "resourceArn",
401 "tags"
402 ],
403 "members": {
404 "resourceArn": {
405 "location": "querystring",
406 "locationName": "resourceArn"
407 },
408 "tags": {
409 "shape": "S15"
410 }
411 }
412 },
413 "output": {
414 "type": "structure",
415 "members": {}
416 }
417 },
418 "UntagResource": {
419 "http": {
420 "method": "DELETE",
421 "requestUri": "/tags"
422 },
423 "input": {
424 "type": "structure",
425 "required": [
426 "resourceArn",
427 "tagKeys"
428 ],
429 "members": {
430 "resourceArn": {
431 "location": "querystring",
432 "locationName": "resourceArn"
433 },
434 "tagKeys": {
435 "location": "querystring",
436 "locationName": "tagKeys",
437 "type": "list",
438 "member": {}
439 }
440 }
441 },
442 "output": {
443 "type": "structure",
444 "members": {}
445 }
446 },
447 "UpdateDetectorModel": {
448 "http": {
449 "requestUri": "/detector-models/{detectorModelName}"
450 },
451 "input": {
452 "type": "structure",
453 "required": [
454 "detectorModelName",
455 "detectorModelDefinition",
456 "roleArn"
457 ],
458 "members": {
459 "detectorModelName": {
460 "location": "uri",
461 "locationName": "detectorModelName"
462 },
463 "detectorModelDefinition": {
464 "shape": "S3"
465 },
466 "detectorModelDescription": {},
467 "roleArn": {},
468 "evaluationMethod": {}
469 }
470 },
471 "output": {
472 "type": "structure",
473 "members": {
474 "detectorModelConfiguration": {
475 "shape": "S1b"
476 }
477 }
478 }
479 },
480 "UpdateInput": {
481 "http": {
482 "method": "PUT",
483 "requestUri": "/inputs/{inputName}"
484 },
485 "input": {
486 "type": "structure",
487 "required": [
488 "inputName",
489 "inputDefinition"
490 ],
491 "members": {
492 "inputName": {
493 "location": "uri",
494 "locationName": "inputName"
495 },
496 "inputDescription": {},
497 "inputDefinition": {
498 "shape": "S1i"
499 }
500 }
501 },
502 "output": {
503 "type": "structure",
504 "members": {
505 "inputConfiguration": {
506 "shape": "S1m"
507 }
508 }
509 }
510 }
511 },
512 "shapes": {
513 "S3": {
514 "type": "structure",
515 "required": [
516 "states",
517 "initialStateName"
518 ],
519 "members": {
520 "states": {
521 "type": "list",
522 "member": {
523 "type": "structure",
524 "required": [
525 "stateName"
526 ],
527 "members": {
528 "stateName": {},
529 "onInput": {
530 "type": "structure",
531 "members": {
532 "events": {
533 "shape": "S8"
534 },
535 "transitionEvents": {
536 "type": "list",
537 "member": {
538 "type": "structure",
539 "required": [
540 "eventName",
541 "condition",
542 "nextState"
543 ],
544 "members": {
545 "eventName": {},
546 "condition": {},
547 "actions": {
548 "shape": "Sc"
549 },
550 "nextState": {}
551 }
552 }
553 }
554 }
555 },
556 "onEnter": {
557 "type": "structure",
558 "members": {
559 "events": {
560 "shape": "S8"
561 }
562 }
563 },
564 "onExit": {
565 "type": "structure",
566 "members": {
567 "events": {
568 "shape": "S8"
569 }
570 }
571 }
572 }
573 }
574 },
575 "initialStateName": {}
576 }
577 },
578 "S8": {
579 "type": "list",
580 "member": {
581 "type": "structure",
582 "required": [
583 "eventName"
584 ],
585 "members": {
586 "eventName": {},
587 "condition": {},
588 "actions": {
589 "shape": "Sc"
590 }
591 }
592 }
593 },
594 "Sc": {
595 "type": "list",
596 "member": {
597 "type": "structure",
598 "members": {
599 "setVariable": {
600 "type": "structure",
601 "required": [
602 "variableName",
603 "value"
604 ],
605 "members": {
606 "variableName": {},
607 "value": {}
608 }
609 },
610 "sns": {
611 "type": "structure",
612 "required": [
613 "targetArn"
614 ],
615 "members": {
616 "targetArn": {}
617 }
618 },
619 "iotTopicPublish": {
620 "type": "structure",
621 "required": [
622 "mqttTopic"
623 ],
624 "members": {
625 "mqttTopic": {}
626 }
627 },
628 "setTimer": {
629 "type": "structure",
630 "required": [
631 "timerName"
632 ],
633 "members": {
634 "timerName": {},
635 "seconds": {
636 "deprecated": true,
637 "deprecatedMessage": "seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression.",
638 "type": "integer"
639 },
640 "durationExpression": {}
641 }
642 },
643 "clearTimer": {
644 "type": "structure",
645 "required": [
646 "timerName"
647 ],
648 "members": {
649 "timerName": {}
650 }
651 },
652 "resetTimer": {
653 "type": "structure",
654 "required": [
655 "timerName"
656 ],
657 "members": {
658 "timerName": {}
659 }
660 },
661 "lambda": {
662 "type": "structure",
663 "required": [
664 "functionArn"
665 ],
666 "members": {
667 "functionArn": {}
668 }
669 },
670 "iotEvents": {
671 "type": "structure",
672 "required": [
673 "inputName"
674 ],
675 "members": {
676 "inputName": {}
677 }
678 },
679 "sqs": {
680 "type": "structure",
681 "required": [
682 "queueUrl"
683 ],
684 "members": {
685 "queueUrl": {},
686 "useBase64": {
687 "type": "boolean"
688 }
689 }
690 },
691 "firehose": {
692 "type": "structure",
693 "required": [
694 "deliveryStreamName"
695 ],
696 "members": {
697 "deliveryStreamName": {},
698 "separator": {}
699 }
700 }
701 }
702 }
703 },
704 "S15": {
705 "type": "list",
706 "member": {
707 "type": "structure",
708 "required": [
709 "key",
710 "value"
711 ],
712 "members": {
713 "key": {},
714 "value": {}
715 }
716 }
717 },
718 "S1b": {
719 "type": "structure",
720 "members": {
721 "detectorModelName": {},
722 "detectorModelVersion": {},
723 "detectorModelDescription": {},
724 "detectorModelArn": {},
725 "roleArn": {},
726 "creationTime": {
727 "type": "timestamp"
728 },
729 "lastUpdateTime": {
730 "type": "timestamp"
731 },
732 "status": {},
733 "key": {},
734 "evaluationMethod": {}
735 }
736 },
737 "S1i": {
738 "type": "structure",
739 "required": [
740 "attributes"
741 ],
742 "members": {
743 "attributes": {
744 "type": "list",
745 "member": {
746 "type": "structure",
747 "required": [
748 "jsonPath"
749 ],
750 "members": {
751 "jsonPath": {}
752 }
753 }
754 }
755 }
756 },
757 "S1m": {
758 "type": "structure",
759 "required": [
760 "inputName",
761 "inputArn",
762 "creationTime",
763 "lastUpdateTime",
764 "status"
765 ],
766 "members": {
767 "inputName": {},
768 "inputDescription": {},
769 "inputArn": {},
770 "creationTime": {
771 "type": "timestamp"
772 },
773 "lastUpdateTime": {
774 "type": "timestamp"
775 },
776 "status": {}
777 }
778 },
779 "S21": {
780 "type": "structure",
781 "required": [
782 "roleArn",
783 "level",
784 "enabled"
785 ],
786 "members": {
787 "roleArn": {},
788 "level": {},
789 "enabled": {
790 "type": "boolean"
791 },
792 "detectorDebugOptions": {
793 "type": "list",
794 "member": {
795 "type": "structure",
796 "required": [
797 "detectorModelName"
798 ],
799 "members": {
800 "detectorModelName": {},
801 "keyValue": {}
802 }
803 }
804 }
805 }
806 }
807 }
808}
\No newline at end of file