UNPKG

25.3 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2016-08-10",
5 "endpointPrefix": "batch",
6 "jsonVersion": "1.1",
7 "protocol": "rest-json",
8 "serviceAbbreviation": "AWS Batch",
9 "serviceFullName": "AWS Batch",
10 "serviceId": "Batch",
11 "signatureVersion": "v4",
12 "uid": "batch-2016-08-10"
13 },
14 "operations": {
15 "CancelJob": {
16 "http": {
17 "requestUri": "/v1/canceljob"
18 },
19 "input": {
20 "type": "structure",
21 "required": [
22 "jobId",
23 "reason"
24 ],
25 "members": {
26 "jobId": {},
27 "reason": {}
28 }
29 },
30 "output": {
31 "type": "structure",
32 "members": {}
33 }
34 },
35 "CreateComputeEnvironment": {
36 "http": {
37 "requestUri": "/v1/createcomputeenvironment"
38 },
39 "input": {
40 "type": "structure",
41 "required": [
42 "computeEnvironmentName",
43 "type",
44 "serviceRole"
45 ],
46 "members": {
47 "computeEnvironmentName": {},
48 "type": {},
49 "state": {},
50 "computeResources": {
51 "shape": "S7"
52 },
53 "serviceRole": {}
54 }
55 },
56 "output": {
57 "type": "structure",
58 "members": {
59 "computeEnvironmentName": {},
60 "computeEnvironmentArn": {}
61 }
62 }
63 },
64 "CreateJobQueue": {
65 "http": {
66 "requestUri": "/v1/createjobqueue"
67 },
68 "input": {
69 "type": "structure",
70 "required": [
71 "jobQueueName",
72 "priority",
73 "computeEnvironmentOrder"
74 ],
75 "members": {
76 "jobQueueName": {},
77 "state": {},
78 "priority": {
79 "type": "integer"
80 },
81 "computeEnvironmentOrder": {
82 "shape": "Sg"
83 }
84 }
85 },
86 "output": {
87 "type": "structure",
88 "required": [
89 "jobQueueName",
90 "jobQueueArn"
91 ],
92 "members": {
93 "jobQueueName": {},
94 "jobQueueArn": {}
95 }
96 }
97 },
98 "DeleteComputeEnvironment": {
99 "http": {
100 "requestUri": "/v1/deletecomputeenvironment"
101 },
102 "input": {
103 "type": "structure",
104 "required": [
105 "computeEnvironment"
106 ],
107 "members": {
108 "computeEnvironment": {}
109 }
110 },
111 "output": {
112 "type": "structure",
113 "members": {}
114 }
115 },
116 "DeleteJobQueue": {
117 "http": {
118 "requestUri": "/v1/deletejobqueue"
119 },
120 "input": {
121 "type": "structure",
122 "required": [
123 "jobQueue"
124 ],
125 "members": {
126 "jobQueue": {}
127 }
128 },
129 "output": {
130 "type": "structure",
131 "members": {}
132 }
133 },
134 "DeregisterJobDefinition": {
135 "http": {
136 "requestUri": "/v1/deregisterjobdefinition"
137 },
138 "input": {
139 "type": "structure",
140 "required": [
141 "jobDefinition"
142 ],
143 "members": {
144 "jobDefinition": {}
145 }
146 },
147 "output": {
148 "type": "structure",
149 "members": {}
150 }
151 },
152 "DescribeComputeEnvironments": {
153 "http": {
154 "requestUri": "/v1/describecomputeenvironments"
155 },
156 "input": {
157 "type": "structure",
158 "members": {
159 "computeEnvironments": {
160 "shape": "Sa"
161 },
162 "maxResults": {
163 "type": "integer"
164 },
165 "nextToken": {}
166 }
167 },
168 "output": {
169 "type": "structure",
170 "members": {
171 "computeEnvironments": {
172 "type": "list",
173 "member": {
174 "type": "structure",
175 "required": [
176 "computeEnvironmentName",
177 "computeEnvironmentArn",
178 "ecsClusterArn"
179 ],
180 "members": {
181 "computeEnvironmentName": {},
182 "computeEnvironmentArn": {},
183 "ecsClusterArn": {},
184 "type": {},
185 "state": {},
186 "status": {},
187 "statusReason": {},
188 "computeResources": {
189 "shape": "S7"
190 },
191 "serviceRole": {}
192 }
193 }
194 },
195 "nextToken": {}
196 }
197 }
198 },
199 "DescribeJobDefinitions": {
200 "http": {
201 "requestUri": "/v1/describejobdefinitions"
202 },
203 "input": {
204 "type": "structure",
205 "members": {
206 "jobDefinitions": {
207 "shape": "Sa"
208 },
209 "maxResults": {
210 "type": "integer"
211 },
212 "jobDefinitionName": {},
213 "status": {},
214 "nextToken": {}
215 }
216 },
217 "output": {
218 "type": "structure",
219 "members": {
220 "jobDefinitions": {
221 "type": "list",
222 "member": {
223 "type": "structure",
224 "required": [
225 "jobDefinitionName",
226 "jobDefinitionArn",
227 "revision",
228 "type"
229 ],
230 "members": {
231 "jobDefinitionName": {},
232 "jobDefinitionArn": {},
233 "revision": {
234 "type": "integer"
235 },
236 "status": {},
237 "type": {},
238 "parameters": {
239 "shape": "Sy"
240 },
241 "retryStrategy": {
242 "shape": "Sz"
243 },
244 "containerProperties": {
245 "shape": "S10"
246 },
247 "timeout": {
248 "shape": "S1j"
249 },
250 "nodeProperties": {
251 "shape": "S1k"
252 }
253 }
254 }
255 },
256 "nextToken": {}
257 }
258 }
259 },
260 "DescribeJobQueues": {
261 "http": {
262 "requestUri": "/v1/describejobqueues"
263 },
264 "input": {
265 "type": "structure",
266 "members": {
267 "jobQueues": {
268 "shape": "Sa"
269 },
270 "maxResults": {
271 "type": "integer"
272 },
273 "nextToken": {}
274 }
275 },
276 "output": {
277 "type": "structure",
278 "members": {
279 "jobQueues": {
280 "type": "list",
281 "member": {
282 "type": "structure",
283 "required": [
284 "jobQueueName",
285 "jobQueueArn",
286 "state",
287 "priority",
288 "computeEnvironmentOrder"
289 ],
290 "members": {
291 "jobQueueName": {},
292 "jobQueueArn": {},
293 "state": {},
294 "status": {},
295 "statusReason": {},
296 "priority": {
297 "type": "integer"
298 },
299 "computeEnvironmentOrder": {
300 "shape": "Sg"
301 }
302 }
303 }
304 },
305 "nextToken": {}
306 }
307 }
308 },
309 "DescribeJobs": {
310 "http": {
311 "requestUri": "/v1/describejobs"
312 },
313 "input": {
314 "type": "structure",
315 "required": [
316 "jobs"
317 ],
318 "members": {
319 "jobs": {
320 "shape": "Sa"
321 }
322 }
323 },
324 "output": {
325 "type": "structure",
326 "members": {
327 "jobs": {
328 "type": "list",
329 "member": {
330 "type": "structure",
331 "required": [
332 "jobName",
333 "jobId",
334 "jobQueue",
335 "status",
336 "startedAt",
337 "jobDefinition"
338 ],
339 "members": {
340 "jobName": {},
341 "jobId": {},
342 "jobQueue": {},
343 "status": {},
344 "attempts": {
345 "type": "list",
346 "member": {
347 "type": "structure",
348 "members": {
349 "container": {
350 "type": "structure",
351 "members": {
352 "containerInstanceArn": {},
353 "taskArn": {},
354 "exitCode": {
355 "type": "integer"
356 },
357 "reason": {},
358 "logStreamName": {},
359 "networkInterfaces": {
360 "shape": "S20"
361 }
362 }
363 },
364 "startedAt": {
365 "type": "long"
366 },
367 "stoppedAt": {
368 "type": "long"
369 },
370 "statusReason": {}
371 }
372 }
373 },
374 "statusReason": {},
375 "createdAt": {
376 "type": "long"
377 },
378 "retryStrategy": {
379 "shape": "Sz"
380 },
381 "startedAt": {
382 "type": "long"
383 },
384 "stoppedAt": {
385 "type": "long"
386 },
387 "dependsOn": {
388 "shape": "S23"
389 },
390 "jobDefinition": {},
391 "parameters": {
392 "shape": "Sy"
393 },
394 "container": {
395 "type": "structure",
396 "members": {
397 "image": {},
398 "vcpus": {
399 "type": "integer"
400 },
401 "memory": {
402 "type": "integer"
403 },
404 "command": {
405 "shape": "Sa"
406 },
407 "jobRoleArn": {},
408 "volumes": {
409 "shape": "S11"
410 },
411 "environment": {
412 "shape": "S14"
413 },
414 "mountPoints": {
415 "shape": "S16"
416 },
417 "readonlyRootFilesystem": {
418 "type": "boolean"
419 },
420 "ulimits": {
421 "shape": "S19"
422 },
423 "privileged": {
424 "type": "boolean"
425 },
426 "user": {},
427 "exitCode": {
428 "type": "integer"
429 },
430 "reason": {},
431 "containerInstanceArn": {},
432 "taskArn": {},
433 "logStreamName": {},
434 "instanceType": {},
435 "networkInterfaces": {
436 "shape": "S20"
437 },
438 "resourceRequirements": {
439 "shape": "S1b"
440 },
441 "linuxParameters": {
442 "shape": "S1e"
443 }
444 }
445 },
446 "nodeDetails": {
447 "type": "structure",
448 "members": {
449 "nodeIndex": {
450 "type": "integer"
451 },
452 "isMainNode": {
453 "type": "boolean"
454 }
455 }
456 },
457 "nodeProperties": {
458 "shape": "S1k"
459 },
460 "arrayProperties": {
461 "type": "structure",
462 "members": {
463 "statusSummary": {
464 "type": "map",
465 "key": {},
466 "value": {
467 "type": "integer"
468 }
469 },
470 "size": {
471 "type": "integer"
472 },
473 "index": {
474 "type": "integer"
475 }
476 }
477 },
478 "timeout": {
479 "shape": "S1j"
480 }
481 }
482 }
483 }
484 }
485 }
486 },
487 "ListJobs": {
488 "http": {
489 "requestUri": "/v1/listjobs"
490 },
491 "input": {
492 "type": "structure",
493 "members": {
494 "jobQueue": {},
495 "arrayJobId": {},
496 "multiNodeJobId": {},
497 "jobStatus": {},
498 "maxResults": {
499 "type": "integer"
500 },
501 "nextToken": {}
502 }
503 },
504 "output": {
505 "type": "structure",
506 "required": [
507 "jobSummaryList"
508 ],
509 "members": {
510 "jobSummaryList": {
511 "type": "list",
512 "member": {
513 "type": "structure",
514 "required": [
515 "jobId",
516 "jobName"
517 ],
518 "members": {
519 "jobId": {},
520 "jobName": {},
521 "createdAt": {
522 "type": "long"
523 },
524 "status": {},
525 "statusReason": {},
526 "startedAt": {
527 "type": "long"
528 },
529 "stoppedAt": {
530 "type": "long"
531 },
532 "container": {
533 "type": "structure",
534 "members": {
535 "exitCode": {
536 "type": "integer"
537 },
538 "reason": {}
539 }
540 },
541 "arrayProperties": {
542 "type": "structure",
543 "members": {
544 "size": {
545 "type": "integer"
546 },
547 "index": {
548 "type": "integer"
549 }
550 }
551 },
552 "nodeProperties": {
553 "type": "structure",
554 "members": {
555 "isMainNode": {
556 "type": "boolean"
557 },
558 "numNodes": {
559 "type": "integer"
560 },
561 "nodeIndex": {
562 "type": "integer"
563 }
564 }
565 }
566 }
567 }
568 },
569 "nextToken": {}
570 }
571 }
572 },
573 "RegisterJobDefinition": {
574 "http": {
575 "requestUri": "/v1/registerjobdefinition"
576 },
577 "input": {
578 "type": "structure",
579 "required": [
580 "jobDefinitionName",
581 "type"
582 ],
583 "members": {
584 "jobDefinitionName": {},
585 "type": {},
586 "parameters": {
587 "shape": "Sy"
588 },
589 "containerProperties": {
590 "shape": "S10"
591 },
592 "nodeProperties": {
593 "shape": "S1k"
594 },
595 "retryStrategy": {
596 "shape": "Sz"
597 },
598 "timeout": {
599 "shape": "S1j"
600 }
601 }
602 },
603 "output": {
604 "type": "structure",
605 "required": [
606 "jobDefinitionName",
607 "jobDefinitionArn",
608 "revision"
609 ],
610 "members": {
611 "jobDefinitionName": {},
612 "jobDefinitionArn": {},
613 "revision": {
614 "type": "integer"
615 }
616 }
617 }
618 },
619 "SubmitJob": {
620 "http": {
621 "requestUri": "/v1/submitjob"
622 },
623 "input": {
624 "type": "structure",
625 "required": [
626 "jobName",
627 "jobQueue",
628 "jobDefinition"
629 ],
630 "members": {
631 "jobName": {},
632 "jobQueue": {},
633 "arrayProperties": {
634 "type": "structure",
635 "members": {
636 "size": {
637 "type": "integer"
638 }
639 }
640 },
641 "dependsOn": {
642 "shape": "S23"
643 },
644 "jobDefinition": {},
645 "parameters": {
646 "shape": "Sy"
647 },
648 "containerOverrides": {
649 "shape": "S2m"
650 },
651 "nodeOverrides": {
652 "type": "structure",
653 "members": {
654 "numNodes": {
655 "type": "integer"
656 },
657 "nodePropertyOverrides": {
658 "type": "list",
659 "member": {
660 "type": "structure",
661 "required": [
662 "targetNodes"
663 ],
664 "members": {
665 "targetNodes": {},
666 "containerOverrides": {
667 "shape": "S2m"
668 }
669 }
670 }
671 }
672 }
673 },
674 "retryStrategy": {
675 "shape": "Sz"
676 },
677 "timeout": {
678 "shape": "S1j"
679 }
680 }
681 },
682 "output": {
683 "type": "structure",
684 "required": [
685 "jobName",
686 "jobId"
687 ],
688 "members": {
689 "jobName": {},
690 "jobId": {}
691 }
692 }
693 },
694 "TerminateJob": {
695 "http": {
696 "requestUri": "/v1/terminatejob"
697 },
698 "input": {
699 "type": "structure",
700 "required": [
701 "jobId",
702 "reason"
703 ],
704 "members": {
705 "jobId": {},
706 "reason": {}
707 }
708 },
709 "output": {
710 "type": "structure",
711 "members": {}
712 }
713 },
714 "UpdateComputeEnvironment": {
715 "http": {
716 "requestUri": "/v1/updatecomputeenvironment"
717 },
718 "input": {
719 "type": "structure",
720 "required": [
721 "computeEnvironment"
722 ],
723 "members": {
724 "computeEnvironment": {},
725 "state": {},
726 "computeResources": {
727 "type": "structure",
728 "members": {
729 "minvCpus": {
730 "type": "integer"
731 },
732 "maxvCpus": {
733 "type": "integer"
734 },
735 "desiredvCpus": {
736 "type": "integer"
737 }
738 }
739 },
740 "serviceRole": {}
741 }
742 },
743 "output": {
744 "type": "structure",
745 "members": {
746 "computeEnvironmentName": {},
747 "computeEnvironmentArn": {}
748 }
749 }
750 },
751 "UpdateJobQueue": {
752 "http": {
753 "requestUri": "/v1/updatejobqueue"
754 },
755 "input": {
756 "type": "structure",
757 "required": [
758 "jobQueue"
759 ],
760 "members": {
761 "jobQueue": {},
762 "state": {},
763 "priority": {
764 "type": "integer"
765 },
766 "computeEnvironmentOrder": {
767 "shape": "Sg"
768 }
769 }
770 },
771 "output": {
772 "type": "structure",
773 "members": {
774 "jobQueueName": {},
775 "jobQueueArn": {}
776 }
777 }
778 }
779 },
780 "shapes": {
781 "S7": {
782 "type": "structure",
783 "required": [
784 "type",
785 "minvCpus",
786 "maxvCpus",
787 "instanceTypes",
788 "subnets",
789 "instanceRole"
790 ],
791 "members": {
792 "type": {},
793 "minvCpus": {
794 "type": "integer"
795 },
796 "maxvCpus": {
797 "type": "integer"
798 },
799 "desiredvCpus": {
800 "type": "integer"
801 },
802 "instanceTypes": {
803 "shape": "Sa"
804 },
805 "imageId": {},
806 "subnets": {
807 "shape": "Sa"
808 },
809 "securityGroupIds": {
810 "shape": "Sa"
811 },
812 "ec2KeyPair": {},
813 "instanceRole": {},
814 "tags": {
815 "type": "map",
816 "key": {},
817 "value": {}
818 },
819 "placementGroup": {},
820 "bidPercentage": {
821 "type": "integer"
822 },
823 "spotIamFleetRole": {},
824 "launchTemplate": {
825 "type": "structure",
826 "members": {
827 "launchTemplateId": {},
828 "launchTemplateName": {},
829 "version": {}
830 }
831 }
832 }
833 },
834 "Sa": {
835 "type": "list",
836 "member": {}
837 },
838 "Sg": {
839 "type": "list",
840 "member": {
841 "type": "structure",
842 "required": [
843 "order",
844 "computeEnvironment"
845 ],
846 "members": {
847 "order": {
848 "type": "integer"
849 },
850 "computeEnvironment": {}
851 }
852 }
853 },
854 "Sy": {
855 "type": "map",
856 "key": {},
857 "value": {}
858 },
859 "Sz": {
860 "type": "structure",
861 "members": {
862 "attempts": {
863 "type": "integer"
864 }
865 }
866 },
867 "S10": {
868 "type": "structure",
869 "members": {
870 "image": {},
871 "vcpus": {
872 "type": "integer"
873 },
874 "memory": {
875 "type": "integer"
876 },
877 "command": {
878 "shape": "Sa"
879 },
880 "jobRoleArn": {},
881 "volumes": {
882 "shape": "S11"
883 },
884 "environment": {
885 "shape": "S14"
886 },
887 "mountPoints": {
888 "shape": "S16"
889 },
890 "readonlyRootFilesystem": {
891 "type": "boolean"
892 },
893 "privileged": {
894 "type": "boolean"
895 },
896 "ulimits": {
897 "shape": "S19"
898 },
899 "user": {},
900 "instanceType": {},
901 "resourceRequirements": {
902 "shape": "S1b"
903 },
904 "linuxParameters": {
905 "shape": "S1e"
906 }
907 }
908 },
909 "S11": {
910 "type": "list",
911 "member": {
912 "type": "structure",
913 "members": {
914 "host": {
915 "type": "structure",
916 "members": {
917 "sourcePath": {}
918 }
919 },
920 "name": {}
921 }
922 }
923 },
924 "S14": {
925 "type": "list",
926 "member": {
927 "type": "structure",
928 "members": {
929 "name": {},
930 "value": {}
931 }
932 }
933 },
934 "S16": {
935 "type": "list",
936 "member": {
937 "type": "structure",
938 "members": {
939 "containerPath": {},
940 "readOnly": {
941 "type": "boolean"
942 },
943 "sourceVolume": {}
944 }
945 }
946 },
947 "S19": {
948 "type": "list",
949 "member": {
950 "type": "structure",
951 "required": [
952 "hardLimit",
953 "name",
954 "softLimit"
955 ],
956 "members": {
957 "hardLimit": {
958 "type": "integer"
959 },
960 "name": {},
961 "softLimit": {
962 "type": "integer"
963 }
964 }
965 }
966 },
967 "S1b": {
968 "type": "list",
969 "member": {
970 "type": "structure",
971 "required": [
972 "value",
973 "type"
974 ],
975 "members": {
976 "value": {},
977 "type": {}
978 }
979 }
980 },
981 "S1e": {
982 "type": "structure",
983 "members": {
984 "devices": {
985 "type": "list",
986 "member": {
987 "type": "structure",
988 "required": [
989 "hostPath"
990 ],
991 "members": {
992 "hostPath": {},
993 "containerPath": {},
994 "permissions": {
995 "type": "list",
996 "member": {}
997 }
998 }
999 }
1000 }
1001 }
1002 },
1003 "S1j": {
1004 "type": "structure",
1005 "members": {
1006 "attemptDurationSeconds": {
1007 "type": "integer"
1008 }
1009 }
1010 },
1011 "S1k": {
1012 "type": "structure",
1013 "required": [
1014 "numNodes",
1015 "mainNode",
1016 "nodeRangeProperties"
1017 ],
1018 "members": {
1019 "numNodes": {
1020 "type": "integer"
1021 },
1022 "mainNode": {
1023 "type": "integer"
1024 },
1025 "nodeRangeProperties": {
1026 "type": "list",
1027 "member": {
1028 "type": "structure",
1029 "required": [
1030 "targetNodes"
1031 ],
1032 "members": {
1033 "targetNodes": {},
1034 "container": {
1035 "shape": "S10"
1036 }
1037 }
1038 }
1039 }
1040 }
1041 },
1042 "S20": {
1043 "type": "list",
1044 "member": {
1045 "type": "structure",
1046 "members": {
1047 "attachmentId": {},
1048 "ipv6Address": {},
1049 "privateIpv4Address": {}
1050 }
1051 }
1052 },
1053 "S23": {
1054 "type": "list",
1055 "member": {
1056 "type": "structure",
1057 "members": {
1058 "jobId": {},
1059 "type": {}
1060 }
1061 }
1062 },
1063 "S2m": {
1064 "type": "structure",
1065 "members": {
1066 "vcpus": {
1067 "type": "integer"
1068 },
1069 "memory": {
1070 "type": "integer"
1071 },
1072 "command": {
1073 "shape": "Sa"
1074 },
1075 "instanceType": {},
1076 "environment": {
1077 "shape": "S14"
1078 },
1079 "resourceRequirements": {
1080 "shape": "S1b"
1081 }
1082 }
1083 }
1084 }
1085}
\No newline at end of file