UNPKG

24.1 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2016-11-23",
5 "endpointPrefix": "states",
6 "jsonVersion": "1.0",
7 "protocol": "json",
8 "serviceAbbreviation": "AWS SFN",
9 "serviceFullName": "AWS Step Functions",
10 "serviceId": "SFN",
11 "signatureVersion": "v4",
12 "targetPrefix": "AWSStepFunctions",
13 "uid": "states-2016-11-23"
14 },
15 "operations": {
16 "CreateActivity": {
17 "input": {
18 "type": "structure",
19 "required": [
20 "name"
21 ],
22 "members": {
23 "name": {},
24 "tags": {
25 "shape": "S3"
26 }
27 }
28 },
29 "output": {
30 "type": "structure",
31 "required": [
32 "activityArn",
33 "creationDate"
34 ],
35 "members": {
36 "activityArn": {},
37 "creationDate": {
38 "type": "timestamp"
39 }
40 }
41 },
42 "idempotent": true
43 },
44 "CreateStateMachine": {
45 "input": {
46 "type": "structure",
47 "required": [
48 "name",
49 "definition",
50 "roleArn"
51 ],
52 "members": {
53 "name": {},
54 "definition": {
55 "shape": "Sb"
56 },
57 "roleArn": {},
58 "tags": {
59 "shape": "S3"
60 }
61 }
62 },
63 "output": {
64 "type": "structure",
65 "required": [
66 "stateMachineArn",
67 "creationDate"
68 ],
69 "members": {
70 "stateMachineArn": {},
71 "creationDate": {
72 "type": "timestamp"
73 }
74 }
75 },
76 "idempotent": true
77 },
78 "DeleteActivity": {
79 "input": {
80 "type": "structure",
81 "required": [
82 "activityArn"
83 ],
84 "members": {
85 "activityArn": {}
86 }
87 },
88 "output": {
89 "type": "structure",
90 "members": {}
91 }
92 },
93 "DeleteStateMachine": {
94 "input": {
95 "type": "structure",
96 "required": [
97 "stateMachineArn"
98 ],
99 "members": {
100 "stateMachineArn": {}
101 }
102 },
103 "output": {
104 "type": "structure",
105 "members": {}
106 }
107 },
108 "DescribeActivity": {
109 "input": {
110 "type": "structure",
111 "required": [
112 "activityArn"
113 ],
114 "members": {
115 "activityArn": {}
116 }
117 },
118 "output": {
119 "type": "structure",
120 "required": [
121 "activityArn",
122 "name",
123 "creationDate"
124 ],
125 "members": {
126 "activityArn": {},
127 "name": {},
128 "creationDate": {
129 "type": "timestamp"
130 }
131 }
132 }
133 },
134 "DescribeExecution": {
135 "input": {
136 "type": "structure",
137 "required": [
138 "executionArn"
139 ],
140 "members": {
141 "executionArn": {}
142 }
143 },
144 "output": {
145 "type": "structure",
146 "required": [
147 "executionArn",
148 "stateMachineArn",
149 "status",
150 "startDate",
151 "input"
152 ],
153 "members": {
154 "executionArn": {},
155 "stateMachineArn": {},
156 "name": {},
157 "status": {},
158 "startDate": {
159 "type": "timestamp"
160 },
161 "stopDate": {
162 "type": "timestamp"
163 },
164 "input": {
165 "shape": "Sm"
166 },
167 "output": {
168 "shape": "Sm"
169 }
170 }
171 }
172 },
173 "DescribeStateMachine": {
174 "input": {
175 "type": "structure",
176 "required": [
177 "stateMachineArn"
178 ],
179 "members": {
180 "stateMachineArn": {}
181 }
182 },
183 "output": {
184 "type": "structure",
185 "required": [
186 "stateMachineArn",
187 "name",
188 "definition",
189 "roleArn",
190 "creationDate"
191 ],
192 "members": {
193 "stateMachineArn": {},
194 "name": {},
195 "status": {},
196 "definition": {
197 "shape": "Sb"
198 },
199 "roleArn": {},
200 "creationDate": {
201 "type": "timestamp"
202 }
203 }
204 }
205 },
206 "DescribeStateMachineForExecution": {
207 "input": {
208 "type": "structure",
209 "required": [
210 "executionArn"
211 ],
212 "members": {
213 "executionArn": {}
214 }
215 },
216 "output": {
217 "type": "structure",
218 "required": [
219 "stateMachineArn",
220 "name",
221 "definition",
222 "roleArn",
223 "updateDate"
224 ],
225 "members": {
226 "stateMachineArn": {},
227 "name": {},
228 "definition": {
229 "shape": "Sb"
230 },
231 "roleArn": {},
232 "updateDate": {
233 "type": "timestamp"
234 }
235 }
236 }
237 },
238 "GetActivityTask": {
239 "input": {
240 "type": "structure",
241 "required": [
242 "activityArn"
243 ],
244 "members": {
245 "activityArn": {},
246 "workerName": {}
247 }
248 },
249 "output": {
250 "type": "structure",
251 "members": {
252 "taskToken": {},
253 "input": {
254 "type": "string",
255 "sensitive": true
256 }
257 }
258 }
259 },
260 "GetExecutionHistory": {
261 "input": {
262 "type": "structure",
263 "required": [
264 "executionArn"
265 ],
266 "members": {
267 "executionArn": {},
268 "maxResults": {
269 "type": "integer"
270 },
271 "reverseOrder": {
272 "type": "boolean"
273 },
274 "nextToken": {}
275 }
276 },
277 "output": {
278 "type": "structure",
279 "required": [
280 "events"
281 ],
282 "members": {
283 "events": {
284 "type": "list",
285 "member": {
286 "type": "structure",
287 "required": [
288 "timestamp",
289 "type",
290 "id"
291 ],
292 "members": {
293 "timestamp": {
294 "type": "timestamp"
295 },
296 "type": {},
297 "id": {
298 "type": "long"
299 },
300 "previousEventId": {
301 "type": "long"
302 },
303 "activityFailedEventDetails": {
304 "type": "structure",
305 "members": {
306 "error": {
307 "shape": "S16"
308 },
309 "cause": {
310 "shape": "S17"
311 }
312 }
313 },
314 "activityScheduleFailedEventDetails": {
315 "type": "structure",
316 "members": {
317 "error": {
318 "shape": "S16"
319 },
320 "cause": {
321 "shape": "S17"
322 }
323 }
324 },
325 "activityScheduledEventDetails": {
326 "type": "structure",
327 "required": [
328 "resource"
329 ],
330 "members": {
331 "resource": {},
332 "input": {
333 "shape": "Sm"
334 },
335 "timeoutInSeconds": {
336 "type": "long"
337 },
338 "heartbeatInSeconds": {
339 "type": "long"
340 }
341 }
342 },
343 "activityStartedEventDetails": {
344 "type": "structure",
345 "members": {
346 "workerName": {}
347 }
348 },
349 "activitySucceededEventDetails": {
350 "type": "structure",
351 "members": {
352 "output": {
353 "shape": "Sm"
354 }
355 }
356 },
357 "activityTimedOutEventDetails": {
358 "type": "structure",
359 "members": {
360 "error": {
361 "shape": "S16"
362 },
363 "cause": {
364 "shape": "S17"
365 }
366 }
367 },
368 "taskFailedEventDetails": {
369 "type": "structure",
370 "required": [
371 "resourceType",
372 "resource"
373 ],
374 "members": {
375 "resourceType": {},
376 "resource": {},
377 "error": {
378 "shape": "S16"
379 },
380 "cause": {
381 "shape": "S17"
382 }
383 }
384 },
385 "taskScheduledEventDetails": {
386 "type": "structure",
387 "required": [
388 "resourceType",
389 "resource",
390 "region",
391 "parameters"
392 ],
393 "members": {
394 "resourceType": {},
395 "resource": {},
396 "region": {},
397 "parameters": {
398 "type": "string",
399 "sensitive": true
400 },
401 "timeoutInSeconds": {
402 "type": "long"
403 }
404 }
405 },
406 "taskStartFailedEventDetails": {
407 "type": "structure",
408 "required": [
409 "resourceType",
410 "resource"
411 ],
412 "members": {
413 "resourceType": {},
414 "resource": {},
415 "error": {
416 "shape": "S16"
417 },
418 "cause": {
419 "shape": "S17"
420 }
421 }
422 },
423 "taskStartedEventDetails": {
424 "type": "structure",
425 "required": [
426 "resourceType",
427 "resource"
428 ],
429 "members": {
430 "resourceType": {},
431 "resource": {}
432 }
433 },
434 "taskSubmitFailedEventDetails": {
435 "type": "structure",
436 "required": [
437 "resourceType",
438 "resource"
439 ],
440 "members": {
441 "resourceType": {},
442 "resource": {},
443 "error": {
444 "shape": "S16"
445 },
446 "cause": {
447 "shape": "S17"
448 }
449 }
450 },
451 "taskSubmittedEventDetails": {
452 "type": "structure",
453 "required": [
454 "resourceType",
455 "resource"
456 ],
457 "members": {
458 "resourceType": {},
459 "resource": {},
460 "output": {
461 "shape": "Sm"
462 }
463 }
464 },
465 "taskSucceededEventDetails": {
466 "type": "structure",
467 "required": [
468 "resourceType",
469 "resource"
470 ],
471 "members": {
472 "resourceType": {},
473 "resource": {},
474 "output": {
475 "shape": "Sm"
476 }
477 }
478 },
479 "taskTimedOutEventDetails": {
480 "type": "structure",
481 "required": [
482 "resourceType",
483 "resource"
484 ],
485 "members": {
486 "resourceType": {},
487 "resource": {},
488 "error": {
489 "shape": "S16"
490 },
491 "cause": {
492 "shape": "S17"
493 }
494 }
495 },
496 "executionFailedEventDetails": {
497 "type": "structure",
498 "members": {
499 "error": {
500 "shape": "S16"
501 },
502 "cause": {
503 "shape": "S17"
504 }
505 }
506 },
507 "executionStartedEventDetails": {
508 "type": "structure",
509 "members": {
510 "input": {
511 "shape": "Sm"
512 },
513 "roleArn": {}
514 }
515 },
516 "executionSucceededEventDetails": {
517 "type": "structure",
518 "members": {
519 "output": {
520 "shape": "Sm"
521 }
522 }
523 },
524 "executionAbortedEventDetails": {
525 "type": "structure",
526 "members": {
527 "error": {
528 "shape": "S16"
529 },
530 "cause": {
531 "shape": "S17"
532 }
533 }
534 },
535 "executionTimedOutEventDetails": {
536 "type": "structure",
537 "members": {
538 "error": {
539 "shape": "S16"
540 },
541 "cause": {
542 "shape": "S17"
543 }
544 }
545 },
546 "lambdaFunctionFailedEventDetails": {
547 "type": "structure",
548 "members": {
549 "error": {
550 "shape": "S16"
551 },
552 "cause": {
553 "shape": "S17"
554 }
555 }
556 },
557 "lambdaFunctionScheduleFailedEventDetails": {
558 "type": "structure",
559 "members": {
560 "error": {
561 "shape": "S16"
562 },
563 "cause": {
564 "shape": "S17"
565 }
566 }
567 },
568 "lambdaFunctionScheduledEventDetails": {
569 "type": "structure",
570 "required": [
571 "resource"
572 ],
573 "members": {
574 "resource": {},
575 "input": {
576 "shape": "Sm"
577 },
578 "timeoutInSeconds": {
579 "type": "long"
580 }
581 }
582 },
583 "lambdaFunctionStartFailedEventDetails": {
584 "type": "structure",
585 "members": {
586 "error": {
587 "shape": "S16"
588 },
589 "cause": {
590 "shape": "S17"
591 }
592 }
593 },
594 "lambdaFunctionSucceededEventDetails": {
595 "type": "structure",
596 "members": {
597 "output": {
598 "shape": "Sm"
599 }
600 }
601 },
602 "lambdaFunctionTimedOutEventDetails": {
603 "type": "structure",
604 "members": {
605 "error": {
606 "shape": "S16"
607 },
608 "cause": {
609 "shape": "S17"
610 }
611 }
612 },
613 "stateEnteredEventDetails": {
614 "type": "structure",
615 "required": [
616 "name"
617 ],
618 "members": {
619 "name": {},
620 "input": {
621 "shape": "Sm"
622 }
623 }
624 },
625 "stateExitedEventDetails": {
626 "type": "structure",
627 "required": [
628 "name"
629 ],
630 "members": {
631 "name": {},
632 "output": {
633 "shape": "Sm"
634 }
635 }
636 }
637 }
638 }
639 },
640 "nextToken": {}
641 }
642 }
643 },
644 "ListActivities": {
645 "input": {
646 "type": "structure",
647 "members": {
648 "maxResults": {
649 "type": "integer"
650 },
651 "nextToken": {}
652 }
653 },
654 "output": {
655 "type": "structure",
656 "required": [
657 "activities"
658 ],
659 "members": {
660 "activities": {
661 "type": "list",
662 "member": {
663 "type": "structure",
664 "required": [
665 "activityArn",
666 "name",
667 "creationDate"
668 ],
669 "members": {
670 "activityArn": {},
671 "name": {},
672 "creationDate": {
673 "type": "timestamp"
674 }
675 }
676 }
677 },
678 "nextToken": {}
679 }
680 }
681 },
682 "ListExecutions": {
683 "input": {
684 "type": "structure",
685 "required": [
686 "stateMachineArn"
687 ],
688 "members": {
689 "stateMachineArn": {},
690 "statusFilter": {},
691 "maxResults": {
692 "type": "integer"
693 },
694 "nextToken": {}
695 }
696 },
697 "output": {
698 "type": "structure",
699 "required": [
700 "executions"
701 ],
702 "members": {
703 "executions": {
704 "type": "list",
705 "member": {
706 "type": "structure",
707 "required": [
708 "executionArn",
709 "stateMachineArn",
710 "name",
711 "status",
712 "startDate"
713 ],
714 "members": {
715 "executionArn": {},
716 "stateMachineArn": {},
717 "name": {},
718 "status": {},
719 "startDate": {
720 "type": "timestamp"
721 },
722 "stopDate": {
723 "type": "timestamp"
724 }
725 }
726 }
727 },
728 "nextToken": {}
729 }
730 }
731 },
732 "ListStateMachines": {
733 "input": {
734 "type": "structure",
735 "members": {
736 "maxResults": {
737 "type": "integer"
738 },
739 "nextToken": {}
740 }
741 },
742 "output": {
743 "type": "structure",
744 "required": [
745 "stateMachines"
746 ],
747 "members": {
748 "stateMachines": {
749 "type": "list",
750 "member": {
751 "type": "structure",
752 "required": [
753 "stateMachineArn",
754 "name",
755 "creationDate"
756 ],
757 "members": {
758 "stateMachineArn": {},
759 "name": {},
760 "creationDate": {
761 "type": "timestamp"
762 }
763 }
764 }
765 },
766 "nextToken": {}
767 }
768 }
769 },
770 "ListTagsForResource": {
771 "input": {
772 "type": "structure",
773 "required": [
774 "resourceArn"
775 ],
776 "members": {
777 "resourceArn": {}
778 }
779 },
780 "output": {
781 "type": "structure",
782 "members": {
783 "tags": {
784 "shape": "S3"
785 }
786 }
787 }
788 },
789 "SendTaskFailure": {
790 "input": {
791 "type": "structure",
792 "required": [
793 "taskToken"
794 ],
795 "members": {
796 "taskToken": {},
797 "error": {
798 "shape": "S16"
799 },
800 "cause": {
801 "shape": "S17"
802 }
803 }
804 },
805 "output": {
806 "type": "structure",
807 "members": {}
808 }
809 },
810 "SendTaskHeartbeat": {
811 "input": {
812 "type": "structure",
813 "required": [
814 "taskToken"
815 ],
816 "members": {
817 "taskToken": {}
818 }
819 },
820 "output": {
821 "type": "structure",
822 "members": {}
823 }
824 },
825 "SendTaskSuccess": {
826 "input": {
827 "type": "structure",
828 "required": [
829 "taskToken",
830 "output"
831 ],
832 "members": {
833 "taskToken": {},
834 "output": {
835 "shape": "Sm"
836 }
837 }
838 },
839 "output": {
840 "type": "structure",
841 "members": {}
842 }
843 },
844 "StartExecution": {
845 "input": {
846 "type": "structure",
847 "required": [
848 "stateMachineArn"
849 ],
850 "members": {
851 "stateMachineArn": {},
852 "name": {},
853 "input": {
854 "shape": "Sm"
855 }
856 }
857 },
858 "output": {
859 "type": "structure",
860 "required": [
861 "executionArn",
862 "startDate"
863 ],
864 "members": {
865 "executionArn": {},
866 "startDate": {
867 "type": "timestamp"
868 }
869 }
870 },
871 "idempotent": true
872 },
873 "StopExecution": {
874 "input": {
875 "type": "structure",
876 "required": [
877 "executionArn"
878 ],
879 "members": {
880 "executionArn": {},
881 "error": {
882 "shape": "S16"
883 },
884 "cause": {
885 "shape": "S17"
886 }
887 }
888 },
889 "output": {
890 "type": "structure",
891 "required": [
892 "stopDate"
893 ],
894 "members": {
895 "stopDate": {
896 "type": "timestamp"
897 }
898 }
899 }
900 },
901 "TagResource": {
902 "input": {
903 "type": "structure",
904 "required": [
905 "resourceArn",
906 "tags"
907 ],
908 "members": {
909 "resourceArn": {},
910 "tags": {
911 "shape": "S3"
912 }
913 }
914 },
915 "output": {
916 "type": "structure",
917 "members": {}
918 }
919 },
920 "UntagResource": {
921 "input": {
922 "type": "structure",
923 "required": [
924 "resourceArn",
925 "tagKeys"
926 ],
927 "members": {
928 "resourceArn": {},
929 "tagKeys": {
930 "type": "list",
931 "member": {}
932 }
933 }
934 },
935 "output": {
936 "type": "structure",
937 "members": {}
938 }
939 },
940 "UpdateStateMachine": {
941 "input": {
942 "type": "structure",
943 "required": [
944 "stateMachineArn"
945 ],
946 "members": {
947 "stateMachineArn": {},
948 "definition": {
949 "shape": "Sb"
950 },
951 "roleArn": {}
952 }
953 },
954 "output": {
955 "type": "structure",
956 "required": [
957 "updateDate"
958 ],
959 "members": {
960 "updateDate": {
961 "type": "timestamp"
962 }
963 }
964 },
965 "idempotent": true
966 }
967 },
968 "shapes": {
969 "S3": {
970 "type": "list",
971 "member": {
972 "type": "structure",
973 "members": {
974 "key": {},
975 "value": {}
976 }
977 }
978 },
979 "Sb": {
980 "type": "string",
981 "sensitive": true
982 },
983 "Sm": {
984 "type": "string",
985 "sensitive": true
986 },
987 "S16": {
988 "type": "string",
989 "sensitive": true
990 },
991 "S17": {
992 "type": "string",
993 "sensitive": true
994 }
995 }
996}
\No newline at end of file