UNPKG

24 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": "S1b"
249 },
250 "nodeProperties": {
251 "shape": "S1c"
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": "S1s"
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": "S1v"
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": "S1s"
437 }
438 }
439 },
440 "nodeDetails": {
441 "type": "structure",
442 "members": {
443 "nodeIndex": {
444 "type": "integer"
445 },
446 "isMainNode": {
447 "type": "boolean"
448 }
449 }
450 },
451 "nodeProperties": {
452 "shape": "S1c"
453 },
454 "arrayProperties": {
455 "type": "structure",
456 "members": {
457 "statusSummary": {
458 "type": "map",
459 "key": {},
460 "value": {
461 "type": "integer"
462 }
463 },
464 "size": {
465 "type": "integer"
466 },
467 "index": {
468 "type": "integer"
469 }
470 }
471 },
472 "timeout": {
473 "shape": "S1b"
474 }
475 }
476 }
477 }
478 }
479 }
480 },
481 "ListJobs": {
482 "http": {
483 "requestUri": "/v1/listjobs"
484 },
485 "input": {
486 "type": "structure",
487 "members": {
488 "jobQueue": {},
489 "arrayJobId": {},
490 "multiNodeJobId": {},
491 "jobStatus": {},
492 "maxResults": {
493 "type": "integer"
494 },
495 "nextToken": {}
496 }
497 },
498 "output": {
499 "type": "structure",
500 "required": [
501 "jobSummaryList"
502 ],
503 "members": {
504 "jobSummaryList": {
505 "type": "list",
506 "member": {
507 "type": "structure",
508 "required": [
509 "jobId",
510 "jobName"
511 ],
512 "members": {
513 "jobId": {},
514 "jobName": {},
515 "createdAt": {
516 "type": "long"
517 },
518 "status": {},
519 "statusReason": {},
520 "startedAt": {
521 "type": "long"
522 },
523 "stoppedAt": {
524 "type": "long"
525 },
526 "container": {
527 "type": "structure",
528 "members": {
529 "exitCode": {
530 "type": "integer"
531 },
532 "reason": {}
533 }
534 },
535 "arrayProperties": {
536 "type": "structure",
537 "members": {
538 "size": {
539 "type": "integer"
540 },
541 "index": {
542 "type": "integer"
543 }
544 }
545 },
546 "nodeProperties": {
547 "type": "structure",
548 "members": {
549 "isMainNode": {
550 "type": "boolean"
551 },
552 "numNodes": {
553 "type": "integer"
554 },
555 "nodeIndex": {
556 "type": "integer"
557 }
558 }
559 }
560 }
561 }
562 },
563 "nextToken": {}
564 }
565 }
566 },
567 "RegisterJobDefinition": {
568 "http": {
569 "requestUri": "/v1/registerjobdefinition"
570 },
571 "input": {
572 "type": "structure",
573 "required": [
574 "jobDefinitionName",
575 "type"
576 ],
577 "members": {
578 "jobDefinitionName": {},
579 "type": {},
580 "parameters": {
581 "shape": "Sy"
582 },
583 "containerProperties": {
584 "shape": "S10"
585 },
586 "nodeProperties": {
587 "shape": "S1c"
588 },
589 "retryStrategy": {
590 "shape": "Sz"
591 },
592 "timeout": {
593 "shape": "S1b"
594 }
595 }
596 },
597 "output": {
598 "type": "structure",
599 "required": [
600 "jobDefinitionName",
601 "jobDefinitionArn",
602 "revision"
603 ],
604 "members": {
605 "jobDefinitionName": {},
606 "jobDefinitionArn": {},
607 "revision": {
608 "type": "integer"
609 }
610 }
611 }
612 },
613 "SubmitJob": {
614 "http": {
615 "requestUri": "/v1/submitjob"
616 },
617 "input": {
618 "type": "structure",
619 "required": [
620 "jobName",
621 "jobQueue",
622 "jobDefinition"
623 ],
624 "members": {
625 "jobName": {},
626 "jobQueue": {},
627 "arrayProperties": {
628 "type": "structure",
629 "members": {
630 "size": {
631 "type": "integer"
632 }
633 }
634 },
635 "dependsOn": {
636 "shape": "S1v"
637 },
638 "jobDefinition": {},
639 "parameters": {
640 "shape": "Sy"
641 },
642 "containerOverrides": {
643 "shape": "S2e"
644 },
645 "nodeOverrides": {
646 "type": "structure",
647 "members": {
648 "nodePropertyOverrides": {
649 "type": "list",
650 "member": {
651 "type": "structure",
652 "required": [
653 "targetNodes"
654 ],
655 "members": {
656 "targetNodes": {},
657 "containerOverrides": {
658 "shape": "S2e"
659 }
660 }
661 }
662 }
663 }
664 },
665 "retryStrategy": {
666 "shape": "Sz"
667 },
668 "timeout": {
669 "shape": "S1b"
670 }
671 }
672 },
673 "output": {
674 "type": "structure",
675 "required": [
676 "jobName",
677 "jobId"
678 ],
679 "members": {
680 "jobName": {},
681 "jobId": {}
682 }
683 }
684 },
685 "TerminateJob": {
686 "http": {
687 "requestUri": "/v1/terminatejob"
688 },
689 "input": {
690 "type": "structure",
691 "required": [
692 "jobId",
693 "reason"
694 ],
695 "members": {
696 "jobId": {},
697 "reason": {}
698 }
699 },
700 "output": {
701 "type": "structure",
702 "members": {}
703 }
704 },
705 "UpdateComputeEnvironment": {
706 "http": {
707 "requestUri": "/v1/updatecomputeenvironment"
708 },
709 "input": {
710 "type": "structure",
711 "required": [
712 "computeEnvironment"
713 ],
714 "members": {
715 "computeEnvironment": {},
716 "state": {},
717 "computeResources": {
718 "type": "structure",
719 "members": {
720 "minvCpus": {
721 "type": "integer"
722 },
723 "maxvCpus": {
724 "type": "integer"
725 },
726 "desiredvCpus": {
727 "type": "integer"
728 }
729 }
730 },
731 "serviceRole": {}
732 }
733 },
734 "output": {
735 "type": "structure",
736 "members": {
737 "computeEnvironmentName": {},
738 "computeEnvironmentArn": {}
739 }
740 }
741 },
742 "UpdateJobQueue": {
743 "http": {
744 "requestUri": "/v1/updatejobqueue"
745 },
746 "input": {
747 "type": "structure",
748 "required": [
749 "jobQueue"
750 ],
751 "members": {
752 "jobQueue": {},
753 "state": {},
754 "priority": {
755 "type": "integer"
756 },
757 "computeEnvironmentOrder": {
758 "shape": "Sg"
759 }
760 }
761 },
762 "output": {
763 "type": "structure",
764 "members": {
765 "jobQueueName": {},
766 "jobQueueArn": {}
767 }
768 }
769 }
770 },
771 "shapes": {
772 "S7": {
773 "type": "structure",
774 "required": [
775 "type",
776 "minvCpus",
777 "maxvCpus",
778 "instanceTypes",
779 "subnets",
780 "instanceRole"
781 ],
782 "members": {
783 "type": {},
784 "minvCpus": {
785 "type": "integer"
786 },
787 "maxvCpus": {
788 "type": "integer"
789 },
790 "desiredvCpus": {
791 "type": "integer"
792 },
793 "instanceTypes": {
794 "shape": "Sa"
795 },
796 "imageId": {},
797 "subnets": {
798 "shape": "Sa"
799 },
800 "securityGroupIds": {
801 "shape": "Sa"
802 },
803 "ec2KeyPair": {},
804 "instanceRole": {},
805 "tags": {
806 "type": "map",
807 "key": {},
808 "value": {}
809 },
810 "placementGroup": {},
811 "bidPercentage": {
812 "type": "integer"
813 },
814 "spotIamFleetRole": {},
815 "launchTemplate": {
816 "type": "structure",
817 "members": {
818 "launchTemplateId": {},
819 "launchTemplateName": {},
820 "version": {}
821 }
822 }
823 }
824 },
825 "Sa": {
826 "type": "list",
827 "member": {}
828 },
829 "Sg": {
830 "type": "list",
831 "member": {
832 "type": "structure",
833 "required": [
834 "order",
835 "computeEnvironment"
836 ],
837 "members": {
838 "order": {
839 "type": "integer"
840 },
841 "computeEnvironment": {}
842 }
843 }
844 },
845 "Sy": {
846 "type": "map",
847 "key": {},
848 "value": {}
849 },
850 "Sz": {
851 "type": "structure",
852 "members": {
853 "attempts": {
854 "type": "integer"
855 }
856 }
857 },
858 "S10": {
859 "type": "structure",
860 "members": {
861 "image": {},
862 "vcpus": {
863 "type": "integer"
864 },
865 "memory": {
866 "type": "integer"
867 },
868 "command": {
869 "shape": "Sa"
870 },
871 "jobRoleArn": {},
872 "volumes": {
873 "shape": "S11"
874 },
875 "environment": {
876 "shape": "S14"
877 },
878 "mountPoints": {
879 "shape": "S16"
880 },
881 "readonlyRootFilesystem": {
882 "type": "boolean"
883 },
884 "privileged": {
885 "type": "boolean"
886 },
887 "ulimits": {
888 "shape": "S19"
889 },
890 "user": {},
891 "instanceType": {}
892 }
893 },
894 "S11": {
895 "type": "list",
896 "member": {
897 "type": "structure",
898 "members": {
899 "host": {
900 "type": "structure",
901 "members": {
902 "sourcePath": {}
903 }
904 },
905 "name": {}
906 }
907 }
908 },
909 "S14": {
910 "type": "list",
911 "member": {
912 "type": "structure",
913 "members": {
914 "name": {},
915 "value": {}
916 }
917 }
918 },
919 "S16": {
920 "type": "list",
921 "member": {
922 "type": "structure",
923 "members": {
924 "containerPath": {},
925 "readOnly": {
926 "type": "boolean"
927 },
928 "sourceVolume": {}
929 }
930 }
931 },
932 "S19": {
933 "type": "list",
934 "member": {
935 "type": "structure",
936 "required": [
937 "hardLimit",
938 "name",
939 "softLimit"
940 ],
941 "members": {
942 "hardLimit": {
943 "type": "integer"
944 },
945 "name": {},
946 "softLimit": {
947 "type": "integer"
948 }
949 }
950 }
951 },
952 "S1b": {
953 "type": "structure",
954 "members": {
955 "attemptDurationSeconds": {
956 "type": "integer"
957 }
958 }
959 },
960 "S1c": {
961 "type": "structure",
962 "required": [
963 "numNodes",
964 "mainNode",
965 "nodeRangeProperties"
966 ],
967 "members": {
968 "numNodes": {
969 "type": "integer"
970 },
971 "mainNode": {
972 "type": "integer"
973 },
974 "nodeRangeProperties": {
975 "type": "list",
976 "member": {
977 "type": "structure",
978 "required": [
979 "targetNodes"
980 ],
981 "members": {
982 "targetNodes": {},
983 "container": {
984 "shape": "S10"
985 }
986 }
987 }
988 }
989 }
990 },
991 "S1s": {
992 "type": "list",
993 "member": {
994 "type": "structure",
995 "members": {
996 "attachmentId": {},
997 "ipv6Address": {},
998 "privateIpv4Address": {}
999 }
1000 }
1001 },
1002 "S1v": {
1003 "type": "list",
1004 "member": {
1005 "type": "structure",
1006 "members": {
1007 "jobId": {},
1008 "type": {}
1009 }
1010 }
1011 },
1012 "S2e": {
1013 "type": "structure",
1014 "members": {
1015 "vcpus": {
1016 "type": "integer"
1017 },
1018 "memory": {
1019 "type": "integer"
1020 },
1021 "command": {
1022 "shape": "Sa"
1023 },
1024 "instanceType": {},
1025 "environment": {
1026 "shape": "S14"
1027 }
1028 }
1029 }
1030 }
1031}
\No newline at end of file