UNPKG

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