· 6 years ago · Apr 07, 2020, 11:12 PM
1components:
2 schemas:
3 AccessLogSettings:
4 properties:
5 destinationArn:
6 type: string
7 format:
8 type: string
9 type: object
10 Account:
11 properties:
12 apiKeyVersion:
13 type: string
14 cloudwatchRoleArn:
15 type: string
16 features:
17 items:
18 type: string
19 type: array
20 throttleSettings:
21 $ref: '#/components/schemas/ThrottleSettings'
22 type: object
23 ApiKey:
24 properties:
25 createdDate:
26 format: date-time
27 type: string
28 customerId:
29 type: string
30 description:
31 type: string
32 enabled:
33 type: boolean
34 id:
35 type: string
36 lastUpdatedDate:
37 format: date-time
38 type: string
39 name:
40 type: string
41 stageKeys:
42 items:
43 type: string
44 type: array
45 tags:
46 additionalProperties: true
47 type: object
48 value:
49 type: string
50 type: object
51 ApiKeyIds:
52 properties:
53 ids:
54 items:
55 type: string
56 type: array
57 warnings:
58 items:
59 type: string
60 type: array
61 type: object
62 ApiKeySourceType:
63 enum:
64 - HEADER
65 - AUTHORIZER
66 type: string
67 ApiKeys:
68 properties:
69 items:
70 items:
71 properties:
72 createdDate:
73 format: date-time
74 type: string
75 customerId:
76 type: string
77 description:
78 type: string
79 enabled:
80 type: boolean
81 id:
82 type: string
83 lastUpdatedDate:
84 format: date-time
85 type: string
86 name:
87 type: string
88 stageKeys:
89 items:
90 type: string
91 type: array
92 tags:
93 additionalProperties: true
94 type: object
95 value:
96 type: string
97 type: object
98 type: array
99 position:
100 type: string
101 warnings:
102 items:
103 type: string
104 type: array
105 type: object
106 ApiKeysFormat:
107 enum:
108 - csv
109 type: string
110 ApiStage:
111 properties:
112 apiId:
113 type: string
114 stage:
115 type: string
116 throttle:
117 additionalProperties: true
118 type: object
119 type: object
120 Authorizer:
121 properties:
122 authType:
123 type: string
124 authorizerCredentials:
125 type: string
126 authorizerResultTtlInSeconds:
127 format: int64
128 type: integer
129 authorizerUri:
130 type: string
131 id:
132 type: string
133 identitySource:
134 type: string
135 identityValidationExpression:
136 type: string
137 name:
138 type: string
139 providerARNs:
140 items:
141 type: string
142 type: array
143 type:
144 enum:
145 - TOKEN
146 - REQUEST
147 - COGNITO_USER_POOLS
148 type: string
149 type: object
150 AuthorizerType:
151 enum:
152 - TOKEN
153 - REQUEST
154 - COGNITO_USER_POOLS
155 type: string
156 Authorizers:
157 properties:
158 items:
159 items:
160 properties:
161 authType:
162 type: string
163 authorizerCredentials:
164 type: string
165 authorizerResultTtlInSeconds:
166 format: int64
167 type: integer
168 authorizerUri:
169 type: string
170 id:
171 type: string
172 identitySource:
173 type: string
174 identityValidationExpression:
175 type: string
176 name:
177 type: string
178 providerARNs:
179 items:
180 type: string
181 type: array
182 type:
183 enum:
184 - TOKEN
185 - REQUEST
186 - COGNITO_USER_POOLS
187 type: string
188 type: object
189 type: array
190 position:
191 type: string
192 type: object
193 BadRequestException:
194 properties:
195 message:
196 type: string
197 type: object
198 BasePathMapping:
199 properties:
200 basePath:
201 type: string
202 restApiId:
203 type: string
204 stage:
205 type: string
206 type: object
207 BasePathMappings:
208 properties:
209 items:
210 items:
211 properties:
212 basePath:
213 type: string
214 restApiId:
215 type: string
216 stage:
217 type: string
218 type: object
219 type: array
220 position:
221 type: string
222 type: object
223 Blob:
224 format: byte
225 type: string
226 Boolean:
227 type: boolean
228 CacheClusterSize:
229 enum:
230 - "0.5"
231 - "1.6"
232 - "6.1"
233 - "13.5"
234 - "28.4"
235 - "58.2"
236 - "118"
237 - "237"
238 type: string
239 CacheClusterStatus:
240 enum:
241 - CREATE_IN_PROGRESS
242 - AVAILABLE
243 - DELETE_IN_PROGRESS
244 - NOT_AVAILABLE
245 - FLUSH_IN_PROGRESS
246 type: string
247 CanarySettings:
248 properties:
249 deploymentId:
250 type: string
251 percentTraffic:
252 type: number
253 stageVariableOverrides:
254 additionalProperties: true
255 type: object
256 useStageCache:
257 type: boolean
258 type: object
259 ClientCertificate:
260 properties:
261 clientCertificateId:
262 type: string
263 createdDate:
264 format: date-time
265 type: string
266 description:
267 type: string
268 expirationDate:
269 format: date-time
270 type: string
271 pemEncodedCertificate:
272 type: string
273 tags:
274 additionalProperties: true
275 type: object
276 type: object
277 ClientCertificates:
278 properties:
279 items:
280 items:
281 properties:
282 clientCertificateId:
283 type: string
284 createdDate:
285 format: date-time
286 type: string
287 description:
288 type: string
289 expirationDate:
290 format: date-time
291 type: string
292 pemEncodedCertificate:
293 type: string
294 tags:
295 additionalProperties: true
296 type: object
297 type: object
298 type: array
299 position:
300 type: string
301 type: object
302 ConflictException:
303 properties:
304 message:
305 type: string
306 type: object
307 ConnectionType:
308 enum:
309 - INTERNET
310 - VPC_LINK
311 type: string
312 ContentHandlingStrategy:
313 enum:
314 - CONVERT_TO_BINARY
315 - CONVERT_TO_TEXT
316 type: string
317 CreateApiKeyRequest:
318 properties:
319 customerId:
320 type: string
321 description:
322 type: string
323 enabled:
324 type: boolean
325 generateDistinctId:
326 type: boolean
327 name:
328 type: string
329 stageKeys:
330 items:
331 properties:
332 restApiId:
333 type: string
334 stageName:
335 type: string
336 type: object
337 type: array
338 tags:
339 additionalProperties: true
340 type: object
341 value:
342 type: string
343 type: object
344 CreateAuthorizerRequest:
345 properties:
346 authType:
347 type: string
348 authorizerCredentials:
349 type: string
350 authorizerResultTtlInSeconds:
351 format: int64
352 type: integer
353 authorizerUri:
354 type: string
355 identitySource:
356 type: string
357 identityValidationExpression:
358 type: string
359 name:
360 type: string
361 providerARNs:
362 items:
363 type: string
364 type: array
365 restApiId:
366 type: string
367 type:
368 enum:
369 - TOKEN
370 - REQUEST
371 - COGNITO_USER_POOLS
372 type: string
373 required:
374 - restApiId
375 - name
376 - type
377 type: object
378 CreateBasePathMappingRequest:
379 properties:
380 basePath:
381 type: string
382 domainName:
383 type: string
384 restApiId:
385 type: string
386 stage:
387 type: string
388 required:
389 - domainName
390 - restApiId
391 type: object
392 CreateDeploymentRequest:
393 properties:
394 cacheClusterEnabled:
395 type: boolean
396 cacheClusterSize:
397 enum:
398 - "0.5"
399 - "1.6"
400 - "6.1"
401 - "13.5"
402 - "28.4"
403 - "58.2"
404 - "118"
405 - "237"
406 type: string
407 canarySettings:
408 $ref: '#/components/schemas/DeploymentCanarySettings'
409 description:
410 type: string
411 restApiId:
412 type: string
413 stageDescription:
414 type: string
415 stageName:
416 type: string
417 tracingEnabled:
418 type: boolean
419 variables:
420 additionalProperties: true
421 type: object
422 required:
423 - restApiId
424 type: object
425 CreateDocumentationPartRequest:
426 properties:
427 location:
428 $ref: '#/components/schemas/DocumentationPartLocation'
429 properties:
430 type: string
431 restApiId:
432 type: string
433 required:
434 - restApiId
435 - location
436 - properties
437 type: object
438 CreateDocumentationVersionRequest:
439 properties:
440 description:
441 type: string
442 documentationVersion:
443 type: string
444 restApiId:
445 type: string
446 stageName:
447 type: string
448 required:
449 - restApiId
450 - documentationVersion
451 type: object
452 CreateDomainNameRequest:
453 properties:
454 certificateArn:
455 type: string
456 certificateBody:
457 type: string
458 certificateChain:
459 type: string
460 certificateName:
461 type: string
462 certificatePrivateKey:
463 type: string
464 domainName:
465 type: string
466 endpointConfiguration:
467 $ref: '#/components/schemas/EndpointConfiguration'
468 regionalCertificateArn:
469 type: string
470 regionalCertificateName:
471 type: string
472 securityPolicy:
473 enum:
474 - TLS_1_0
475 - TLS_1_2
476 type: string
477 tags:
478 additionalProperties: true
479 type: object
480 required:
481 - domainName
482 type: object
483 CreateModelRequest:
484 properties:
485 contentType:
486 type: string
487 description:
488 type: string
489 name:
490 type: string
491 restApiId:
492 type: string
493 schema:
494 type: string
495 required:
496 - restApiId
497 - name
498 - contentType
499 type: object
500 CreateRequestValidatorRequest:
501 properties:
502 name:
503 type: string
504 restApiId:
505 type: string
506 validateRequestBody:
507 type: boolean
508 validateRequestParameters:
509 type: boolean
510 required:
511 - restApiId
512 type: object
513 CreateResourceRequest:
514 properties:
515 parentId:
516 type: string
517 pathPart:
518 type: string
519 restApiId:
520 type: string
521 required:
522 - restApiId
523 - parentId
524 - pathPart
525 type: object
526 CreateRestApiRequest:
527 properties:
528 apiKeySource:
529 enum:
530 - HEADER
531 - AUTHORIZER
532 type: string
533 binaryMediaTypes:
534 items:
535 type: string
536 type: array
537 cloneFrom:
538 type: string
539 description:
540 type: string
541 endpointConfiguration:
542 $ref: '#/components/schemas/EndpointConfiguration'
543 minimumCompressionSize:
544 format: int64
545 type: integer
546 name:
547 type: string
548 policy:
549 type: string
550 tags:
551 additionalProperties: true
552 type: object
553 version:
554 type: string
555 required:
556 - name
557 type: object
558 CreateStageRequest:
559 properties:
560 cacheClusterEnabled:
561 type: boolean
562 cacheClusterSize:
563 enum:
564 - "0.5"
565 - "1.6"
566 - "6.1"
567 - "13.5"
568 - "28.4"
569 - "58.2"
570 - "118"
571 - "237"
572 type: string
573 canarySettings:
574 $ref: '#/components/schemas/CanarySettings'
575 deploymentId:
576 type: string
577 description:
578 type: string
579 documentationVersion:
580 type: string
581 restApiId:
582 type: string
583 stageName:
584 type: string
585 tags:
586 additionalProperties: true
587 type: object
588 tracingEnabled:
589 type: boolean
590 variables:
591 additionalProperties: true
592 type: object
593 required:
594 - restApiId
595 - stageName
596 - deploymentId
597 type: object
598 CreateUsagePlanKeyRequest:
599 properties:
600 keyId:
601 type: string
602 keyType:
603 type: string
604 usagePlanId:
605 type: string
606 required:
607 - usagePlanId
608 - keyId
609 - keyType
610 type: object
611 CreateUsagePlanRequest:
612 properties:
613 apiStages:
614 items:
615 properties:
616 apiId:
617 type: string
618 stage:
619 type: string
620 throttle:
621 additionalProperties: true
622 type: object
623 type: object
624 type: array
625 description:
626 type: string
627 name:
628 type: string
629 quota:
630 $ref: '#/components/schemas/QuotaSettings'
631 tags:
632 additionalProperties: true
633 type: object
634 throttle:
635 $ref: '#/components/schemas/ThrottleSettings'
636 required:
637 - name
638 type: object
639 CreateVpcLinkRequest:
640 properties:
641 description:
642 type: string
643 name:
644 type: string
645 tags:
646 additionalProperties: true
647 type: object
648 targetArns:
649 items:
650 type: string
651 type: array
652 required:
653 - name
654 - targetArns
655 type: object
656 DeleteApiKeyRequest:
657 properties:
658 apiKey:
659 type: string
660 required:
661 - apiKey
662 type: object
663 DeleteAuthorizerRequest:
664 properties:
665 authorizerId:
666 type: string
667 restApiId:
668 type: string
669 required:
670 - restApiId
671 - authorizerId
672 type: object
673 DeleteBasePathMappingRequest:
674 properties:
675 basePath:
676 type: string
677 domainName:
678 type: string
679 required:
680 - domainName
681 - basePath
682 type: object
683 DeleteClientCertificateRequest:
684 properties:
685 clientCertificateId:
686 type: string
687 required:
688 - clientCertificateId
689 type: object
690 DeleteDeploymentRequest:
691 properties:
692 deploymentId:
693 type: string
694 restApiId:
695 type: string
696 required:
697 - restApiId
698 - deploymentId
699 type: object
700 DeleteDocumentationPartRequest:
701 properties:
702 documentationPartId:
703 type: string
704 restApiId:
705 type: string
706 required:
707 - restApiId
708 - documentationPartId
709 type: object
710 DeleteDocumentationVersionRequest:
711 properties:
712 documentationVersion:
713 type: string
714 restApiId:
715 type: string
716 required:
717 - restApiId
718 - documentationVersion
719 type: object
720 DeleteDomainNameRequest:
721 properties:
722 domainName:
723 type: string
724 required:
725 - domainName
726 type: object
727 DeleteGatewayResponseRequest:
728 properties:
729 responseType:
730 enum:
731 - DEFAULT_4XX
732 - DEFAULT_5XX
733 - RESOURCE_NOT_FOUND
734 - UNAUTHORIZED
735 - INVALID_API_KEY
736 - ACCESS_DENIED
737 - AUTHORIZER_FAILURE
738 - AUTHORIZER_CONFIGURATION_ERROR
739 - INVALID_SIGNATURE
740 - EXPIRED_TOKEN
741 - MISSING_AUTHENTICATION_TOKEN
742 - INTEGRATION_FAILURE
743 - INTEGRATION_TIMEOUT
744 - API_CONFIGURATION_ERROR
745 - UNSUPPORTED_MEDIA_TYPE
746 - BAD_REQUEST_PARAMETERS
747 - BAD_REQUEST_BODY
748 - REQUEST_TOO_LARGE
749 - THROTTLED
750 - QUOTA_EXCEEDED
751 type: string
752 restApiId:
753 type: string
754 required:
755 - restApiId
756 - responseType
757 type: object
758 DeleteIntegrationRequest:
759 properties:
760 httpMethod:
761 type: string
762 resourceId:
763 type: string
764 restApiId:
765 type: string
766 required:
767 - restApiId
768 - resourceId
769 - httpMethod
770 type: object
771 DeleteIntegrationResponseRequest:
772 properties:
773 httpMethod:
774 type: string
775 resourceId:
776 type: string
777 restApiId:
778 type: string
779 statusCode:
780 pattern: '[1-5]\d\d'
781 type: string
782 required:
783 - restApiId
784 - resourceId
785 - httpMethod
786 - statusCode
787 type: object
788 DeleteMethodRequest:
789 properties:
790 httpMethod:
791 type: string
792 resourceId:
793 type: string
794 restApiId:
795 type: string
796 required:
797 - restApiId
798 - resourceId
799 - httpMethod
800 type: object
801 DeleteMethodResponseRequest:
802 properties:
803 httpMethod:
804 type: string
805 resourceId:
806 type: string
807 restApiId:
808 type: string
809 statusCode:
810 pattern: '[1-5]\d\d'
811 type: string
812 required:
813 - restApiId
814 - resourceId
815 - httpMethod
816 - statusCode
817 type: object
818 DeleteModelRequest:
819 properties:
820 modelName:
821 type: string
822 restApiId:
823 type: string
824 required:
825 - restApiId
826 - modelName
827 type: object
828 DeleteRequestValidatorRequest:
829 properties:
830 requestValidatorId:
831 type: string
832 restApiId:
833 type: string
834 required:
835 - restApiId
836 - requestValidatorId
837 type: object
838 DeleteResourceRequest:
839 properties:
840 resourceId:
841 type: string
842 restApiId:
843 type: string
844 required:
845 - restApiId
846 - resourceId
847 type: object
848 DeleteRestApiRequest:
849 properties:
850 restApiId:
851 type: string
852 required:
853 - restApiId
854 type: object
855 DeleteStageRequest:
856 properties:
857 restApiId:
858 type: string
859 stageName:
860 type: string
861 required:
862 - restApiId
863 - stageName
864 type: object
865 DeleteUsagePlanKeyRequest:
866 properties:
867 keyId:
868 type: string
869 usagePlanId:
870 type: string
871 required:
872 - usagePlanId
873 - keyId
874 type: object
875 DeleteUsagePlanRequest:
876 properties:
877 usagePlanId:
878 type: string
879 required:
880 - usagePlanId
881 type: object
882 DeleteVpcLinkRequest:
883 properties:
884 vpcLinkId:
885 type: string
886 required:
887 - vpcLinkId
888 type: object
889 Deployment:
890 properties:
891 apiSummary:
892 additionalProperties: true
893 type: object
894 createdDate:
895 format: date-time
896 type: string
897 description:
898 type: string
899 id:
900 type: string
901 type: object
902 DeploymentCanarySettings:
903 properties:
904 percentTraffic:
905 type: number
906 stageVariableOverrides:
907 additionalProperties: true
908 type: object
909 useStageCache:
910 type: boolean
911 type: object
912 Deployments:
913 properties:
914 items:
915 items:
916 properties:
917 apiSummary:
918 additionalProperties: true
919 type: object
920 createdDate:
921 format: date-time
922 type: string
923 description:
924 type: string
925 id:
926 type: string
927 type: object
928 type: array
929 position:
930 type: string
931 type: object
932 DocumentationPart:
933 properties:
934 id:
935 type: string
936 location:
937 $ref: '#/components/schemas/DocumentationPartLocation'
938 properties:
939 type: string
940 type: object
941 DocumentationPartIds:
942 properties:
943 ids:
944 items:
945 type: string
946 type: array
947 warnings:
948 items:
949 type: string
950 type: array
951 type: object
952 DocumentationPartLocation:
953 properties:
954 method:
955 type: string
956 name:
957 type: string
958 path:
959 type: string
960 statusCode:
961 pattern: ^([1-5]\d\d|\*|\s*)$
962 type: string
963 type:
964 enum:
965 - API
966 - AUTHORIZER
967 - MODEL
968 - RESOURCE
969 - METHOD
970 - PATH_PARAMETER
971 - QUERY_PARAMETER
972 - REQUEST_HEADER
973 - REQUEST_BODY
974 - RESPONSE
975 - RESPONSE_HEADER
976 - RESPONSE_BODY
977 type: string
978 required:
979 - type
980 type: object
981 DocumentationPartLocationStatusCode:
982 pattern: ^([1-5]\d\d|\*|\s*)$
983 type: string
984 DocumentationPartType:
985 enum:
986 - API
987 - AUTHORIZER
988 - MODEL
989 - RESOURCE
990 - METHOD
991 - PATH_PARAMETER
992 - QUERY_PARAMETER
993 - REQUEST_HEADER
994 - REQUEST_BODY
995 - RESPONSE
996 - RESPONSE_HEADER
997 - RESPONSE_BODY
998 type: string
999 DocumentationParts:
1000 properties:
1001 items:
1002 items:
1003 properties:
1004 id:
1005 type: string
1006 location:
1007 $ref: '#/components/schemas/DocumentationPartLocation'
1008 properties:
1009 type: string
1010 type: object
1011 type: array
1012 position:
1013 type: string
1014 type: object
1015 DocumentationVersion:
1016 properties:
1017 createdDate:
1018 format: date-time
1019 type: string
1020 description:
1021 type: string
1022 version:
1023 type: string
1024 type: object
1025 DocumentationVersions:
1026 properties:
1027 items:
1028 items:
1029 properties:
1030 createdDate:
1031 format: date-time
1032 type: string
1033 description:
1034 type: string
1035 version:
1036 type: string
1037 type: object
1038 type: array
1039 position:
1040 type: string
1041 type: object
1042 DomainName:
1043 properties:
1044 certificateArn:
1045 type: string
1046 certificateName:
1047 type: string
1048 certificateUploadDate:
1049 format: date-time
1050 type: string
1051 distributionDomainName:
1052 type: string
1053 distributionHostedZoneId:
1054 type: string
1055 domainName:
1056 type: string
1057 domainNameStatus:
1058 enum:
1059 - AVAILABLE
1060 - UPDATING
1061 - PENDING
1062 type: string
1063 domainNameStatusMessage:
1064 type: string
1065 endpointConfiguration:
1066 $ref: '#/components/schemas/EndpointConfiguration'
1067 regionalCertificateArn:
1068 type: string
1069 regionalCertificateName:
1070 type: string
1071 regionalDomainName:
1072 type: string
1073 regionalHostedZoneId:
1074 type: string
1075 securityPolicy:
1076 enum:
1077 - TLS_1_0
1078 - TLS_1_2
1079 type: string
1080 tags:
1081 additionalProperties: true
1082 type: object
1083 type: object
1084 DomainNameStatus:
1085 enum:
1086 - AVAILABLE
1087 - UPDATING
1088 - PENDING
1089 type: string
1090 DomainNames:
1091 properties:
1092 items:
1093 items:
1094 properties:
1095 certificateArn:
1096 type: string
1097 certificateName:
1098 type: string
1099 certificateUploadDate:
1100 format: date-time
1101 type: string
1102 distributionDomainName:
1103 type: string
1104 distributionHostedZoneId:
1105 type: string
1106 domainName:
1107 type: string
1108 domainNameStatus:
1109 enum:
1110 - AVAILABLE
1111 - UPDATING
1112 - PENDING
1113 type: string
1114 domainNameStatusMessage:
1115 type: string
1116 endpointConfiguration:
1117 $ref: '#/components/schemas/EndpointConfiguration'
1118 regionalCertificateArn:
1119 type: string
1120 regionalCertificateName:
1121 type: string
1122 regionalDomainName:
1123 type: string
1124 regionalHostedZoneId:
1125 type: string
1126 securityPolicy:
1127 enum:
1128 - TLS_1_0
1129 - TLS_1_2
1130 type: string
1131 tags:
1132 additionalProperties: true
1133 type: object
1134 type: object
1135 type: array
1136 position:
1137 type: string
1138 type: object
1139 Double:
1140 type: number
1141 EndpointConfiguration:
1142 properties:
1143 types:
1144 items:
1145 enum:
1146 - REGIONAL
1147 - EDGE
1148 - PRIVATE
1149 type: string
1150 type: array
1151 vpcEndpointIds:
1152 items:
1153 type: string
1154 type: array
1155 type: object
1156 EndpointType:
1157 enum:
1158 - REGIONAL
1159 - EDGE
1160 - PRIVATE
1161 type: string
1162 ExportResponse:
1163 properties:
1164 body:
1165 format: byte
1166 type: string
1167 contentDisposition:
1168 type: string
1169 contentType:
1170 type: string
1171 type: object
1172 FlushStageAuthorizersCacheRequest:
1173 properties:
1174 restApiId:
1175 type: string
1176 stageName:
1177 type: string
1178 required:
1179 - restApiId
1180 - stageName
1181 type: object
1182 FlushStageCacheRequest:
1183 properties:
1184 restApiId:
1185 type: string
1186 stageName:
1187 type: string
1188 required:
1189 - restApiId
1190 - stageName
1191 type: object
1192 GatewayResponse:
1193 properties:
1194 defaultResponse:
1195 type: boolean
1196 responseParameters:
1197 additionalProperties: true
1198 type: object
1199 responseTemplates:
1200 additionalProperties: true
1201 type: object
1202 responseType:
1203 enum:
1204 - DEFAULT_4XX
1205 - DEFAULT_5XX
1206 - RESOURCE_NOT_FOUND
1207 - UNAUTHORIZED
1208 - INVALID_API_KEY
1209 - ACCESS_DENIED
1210 - AUTHORIZER_FAILURE
1211 - AUTHORIZER_CONFIGURATION_ERROR
1212 - INVALID_SIGNATURE
1213 - EXPIRED_TOKEN
1214 - MISSING_AUTHENTICATION_TOKEN
1215 - INTEGRATION_FAILURE
1216 - INTEGRATION_TIMEOUT
1217 - API_CONFIGURATION_ERROR
1218 - UNSUPPORTED_MEDIA_TYPE
1219 - BAD_REQUEST_PARAMETERS
1220 - BAD_REQUEST_BODY
1221 - REQUEST_TOO_LARGE
1222 - THROTTLED
1223 - QUOTA_EXCEEDED
1224 type: string
1225 statusCode:
1226 pattern: '[1-5]\d\d'
1227 type: string
1228 type: object
1229 GatewayResponseType:
1230 enum:
1231 - DEFAULT_4XX
1232 - DEFAULT_5XX
1233 - RESOURCE_NOT_FOUND
1234 - UNAUTHORIZED
1235 - INVALID_API_KEY
1236 - ACCESS_DENIED
1237 - AUTHORIZER_FAILURE
1238 - AUTHORIZER_CONFIGURATION_ERROR
1239 - INVALID_SIGNATURE
1240 - EXPIRED_TOKEN
1241 - MISSING_AUTHENTICATION_TOKEN
1242 - INTEGRATION_FAILURE
1243 - INTEGRATION_TIMEOUT
1244 - API_CONFIGURATION_ERROR
1245 - UNSUPPORTED_MEDIA_TYPE
1246 - BAD_REQUEST_PARAMETERS
1247 - BAD_REQUEST_BODY
1248 - REQUEST_TOO_LARGE
1249 - THROTTLED
1250 - QUOTA_EXCEEDED
1251 type: string
1252 GatewayResponses:
1253 properties:
1254 items:
1255 items:
1256 properties:
1257 defaultResponse:
1258 type: boolean
1259 responseParameters:
1260 additionalProperties: true
1261 type: object
1262 responseTemplates:
1263 additionalProperties: true
1264 type: object
1265 responseType:
1266 enum:
1267 - DEFAULT_4XX
1268 - DEFAULT_5XX
1269 - RESOURCE_NOT_FOUND
1270 - UNAUTHORIZED
1271 - INVALID_API_KEY
1272 - ACCESS_DENIED
1273 - AUTHORIZER_FAILURE
1274 - AUTHORIZER_CONFIGURATION_ERROR
1275 - INVALID_SIGNATURE
1276 - EXPIRED_TOKEN
1277 - MISSING_AUTHENTICATION_TOKEN
1278 - INTEGRATION_FAILURE
1279 - INTEGRATION_TIMEOUT
1280 - API_CONFIGURATION_ERROR
1281 - UNSUPPORTED_MEDIA_TYPE
1282 - BAD_REQUEST_PARAMETERS
1283 - BAD_REQUEST_BODY
1284 - REQUEST_TOO_LARGE
1285 - THROTTLED
1286 - QUOTA_EXCEEDED
1287 type: string
1288 statusCode:
1289 pattern: '[1-5]\d\d'
1290 type: string
1291 type: object
1292 type: array
1293 position:
1294 type: string
1295 type: object
1296 GenerateClientCertificateRequest:
1297 properties:
1298 description:
1299 type: string
1300 tags:
1301 additionalProperties: true
1302 type: object
1303 type: object
1304 GetAccountRequest:
1305 type: object
1306 GetApiKeyRequest:
1307 properties:
1308 apiKey:
1309 type: string
1310 includeValue:
1311 type: boolean
1312 required:
1313 - apiKey
1314 type: object
1315 GetApiKeysRequest:
1316 properties:
1317 customerId:
1318 type: string
1319 includeValues:
1320 type: boolean
1321 limit:
1322 format: int64
1323 type: integer
1324 nameQuery:
1325 type: string
1326 position:
1327 type: string
1328 type: object
1329 GetAuthorizerRequest:
1330 properties:
1331 authorizerId:
1332 type: string
1333 restApiId:
1334 type: string
1335 required:
1336 - restApiId
1337 - authorizerId
1338 type: object
1339 GetAuthorizersRequest:
1340 properties:
1341 limit:
1342 format: int64
1343 type: integer
1344 position:
1345 type: string
1346 restApiId:
1347 type: string
1348 required:
1349 - restApiId
1350 type: object
1351 GetBasePathMappingRequest:
1352 properties:
1353 basePath:
1354 type: string
1355 domainName:
1356 type: string
1357 required:
1358 - domainName
1359 - basePath
1360 type: object
1361 GetBasePathMappingsRequest:
1362 properties:
1363 domainName:
1364 type: string
1365 limit:
1366 format: int64
1367 type: integer
1368 position:
1369 type: string
1370 required:
1371 - domainName
1372 type: object
1373 GetClientCertificateRequest:
1374 properties:
1375 clientCertificateId:
1376 type: string
1377 required:
1378 - clientCertificateId
1379 type: object
1380 GetClientCertificatesRequest:
1381 properties:
1382 limit:
1383 format: int64
1384 type: integer
1385 position:
1386 type: string
1387 type: object
1388 GetDeploymentRequest:
1389 properties:
1390 deploymentId:
1391 type: string
1392 embed:
1393 items:
1394 type: string
1395 type: array
1396 restApiId:
1397 type: string
1398 required:
1399 - restApiId
1400 - deploymentId
1401 type: object
1402 GetDeploymentsRequest:
1403 properties:
1404 limit:
1405 format: int64
1406 type: integer
1407 position:
1408 type: string
1409 restApiId:
1410 type: string
1411 required:
1412 - restApiId
1413 type: object
1414 GetDocumentationPartRequest:
1415 properties:
1416 documentationPartId:
1417 type: string
1418 restApiId:
1419 type: string
1420 required:
1421 - restApiId
1422 - documentationPartId
1423 type: object
1424 GetDocumentationPartsRequest:
1425 properties:
1426 limit:
1427 format: int64
1428 type: integer
1429 locationStatus:
1430 enum:
1431 - DOCUMENTED
1432 - UNDOCUMENTED
1433 type: string
1434 nameQuery:
1435 type: string
1436 path:
1437 type: string
1438 position:
1439 type: string
1440 restApiId:
1441 type: string
1442 type:
1443 enum:
1444 - API
1445 - AUTHORIZER
1446 - MODEL
1447 - RESOURCE
1448 - METHOD
1449 - PATH_PARAMETER
1450 - QUERY_PARAMETER
1451 - REQUEST_HEADER
1452 - REQUEST_BODY
1453 - RESPONSE
1454 - RESPONSE_HEADER
1455 - RESPONSE_BODY
1456 type: string
1457 required:
1458 - restApiId
1459 type: object
1460 GetDocumentationVersionRequest:
1461 properties:
1462 documentationVersion:
1463 type: string
1464 restApiId:
1465 type: string
1466 required:
1467 - restApiId
1468 - documentationVersion
1469 type: object
1470 GetDocumentationVersionsRequest:
1471 properties:
1472 limit:
1473 format: int64
1474 type: integer
1475 position:
1476 type: string
1477 restApiId:
1478 type: string
1479 required:
1480 - restApiId
1481 type: object
1482 GetDomainNameRequest:
1483 properties:
1484 domainName:
1485 type: string
1486 required:
1487 - domainName
1488 type: object
1489 GetDomainNamesRequest:
1490 properties:
1491 limit:
1492 format: int64
1493 type: integer
1494 position:
1495 type: string
1496 type: object
1497 GetExportRequest:
1498 properties:
1499 accepts:
1500 type: string
1501 exportType:
1502 type: string
1503 parameters:
1504 additionalProperties: true
1505 type: object
1506 restApiId:
1507 type: string
1508 stageName:
1509 type: string
1510 required:
1511 - restApiId
1512 - stageName
1513 - exportType
1514 type: object
1515 GetGatewayResponseRequest:
1516 properties:
1517 responseType:
1518 enum:
1519 - DEFAULT_4XX
1520 - DEFAULT_5XX
1521 - RESOURCE_NOT_FOUND
1522 - UNAUTHORIZED
1523 - INVALID_API_KEY
1524 - ACCESS_DENIED
1525 - AUTHORIZER_FAILURE
1526 - AUTHORIZER_CONFIGURATION_ERROR
1527 - INVALID_SIGNATURE
1528 - EXPIRED_TOKEN
1529 - MISSING_AUTHENTICATION_TOKEN
1530 - INTEGRATION_FAILURE
1531 - INTEGRATION_TIMEOUT
1532 - API_CONFIGURATION_ERROR
1533 - UNSUPPORTED_MEDIA_TYPE
1534 - BAD_REQUEST_PARAMETERS
1535 - BAD_REQUEST_BODY
1536 - REQUEST_TOO_LARGE
1537 - THROTTLED
1538 - QUOTA_EXCEEDED
1539 type: string
1540 restApiId:
1541 type: string
1542 required:
1543 - restApiId
1544 - responseType
1545 type: object
1546 GetGatewayResponsesRequest:
1547 properties:
1548 limit:
1549 format: int64
1550 type: integer
1551 position:
1552 type: string
1553 restApiId:
1554 type: string
1555 required:
1556 - restApiId
1557 type: object
1558 GetIntegrationRequest:
1559 properties:
1560 httpMethod:
1561 type: string
1562 resourceId:
1563 type: string
1564 restApiId:
1565 type: string
1566 required:
1567 - restApiId
1568 - resourceId
1569 - httpMethod
1570 type: object
1571 GetIntegrationResponseRequest:
1572 properties:
1573 httpMethod:
1574 type: string
1575 resourceId:
1576 type: string
1577 restApiId:
1578 type: string
1579 statusCode:
1580 pattern: '[1-5]\d\d'
1581 type: string
1582 required:
1583 - restApiId
1584 - resourceId
1585 - httpMethod
1586 - statusCode
1587 type: object
1588 GetMethodRequest:
1589 properties:
1590 httpMethod:
1591 type: string
1592 resourceId:
1593 type: string
1594 restApiId:
1595 type: string
1596 required:
1597 - restApiId
1598 - resourceId
1599 - httpMethod
1600 type: object
1601 GetMethodResponseRequest:
1602 properties:
1603 httpMethod:
1604 type: string
1605 resourceId:
1606 type: string
1607 restApiId:
1608 type: string
1609 statusCode:
1610 pattern: '[1-5]\d\d'
1611 type: string
1612 required:
1613 - restApiId
1614 - resourceId
1615 - httpMethod
1616 - statusCode
1617 type: object
1618 GetModelRequest:
1619 properties:
1620 flatten:
1621 type: boolean
1622 modelName:
1623 type: string
1624 restApiId:
1625 type: string
1626 required:
1627 - restApiId
1628 - modelName
1629 type: object
1630 GetModelTemplateRequest:
1631 properties:
1632 modelName:
1633 type: string
1634 restApiId:
1635 type: string
1636 required:
1637 - restApiId
1638 - modelName
1639 type: object
1640 GetModelsRequest:
1641 properties:
1642 limit:
1643 format: int64
1644 type: integer
1645 position:
1646 type: string
1647 restApiId:
1648 type: string
1649 required:
1650 - restApiId
1651 type: object
1652 GetRequestValidatorRequest:
1653 properties:
1654 requestValidatorId:
1655 type: string
1656 restApiId:
1657 type: string
1658 required:
1659 - restApiId
1660 - requestValidatorId
1661 type: object
1662 GetRequestValidatorsRequest:
1663 properties:
1664 limit:
1665 format: int64
1666 type: integer
1667 position:
1668 type: string
1669 restApiId:
1670 type: string
1671 required:
1672 - restApiId
1673 type: object
1674 GetResourceRequest:
1675 properties:
1676 embed:
1677 items:
1678 type: string
1679 type: array
1680 resourceId:
1681 type: string
1682 restApiId:
1683 type: string
1684 required:
1685 - restApiId
1686 - resourceId
1687 type: object
1688 GetResourcesRequest:
1689 properties:
1690 embed:
1691 items:
1692 type: string
1693 type: array
1694 limit:
1695 format: int64
1696 type: integer
1697 position:
1698 type: string
1699 restApiId:
1700 type: string
1701 required:
1702 - restApiId
1703 type: object
1704 GetRestApiRequest:
1705 properties:
1706 restApiId:
1707 type: string
1708 required:
1709 - restApiId
1710 type: object
1711 GetRestApisRequest:
1712 properties:
1713 limit:
1714 format: int64
1715 type: integer
1716 position:
1717 type: string
1718 type: object
1719 GetSdkRequest:
1720 properties:
1721 parameters:
1722 additionalProperties: true
1723 type: object
1724 restApiId:
1725 type: string
1726 sdkType:
1727 type: string
1728 stageName:
1729 type: string
1730 required:
1731 - restApiId
1732 - stageName
1733 - sdkType
1734 type: object
1735 GetSdkTypeRequest:
1736 properties:
1737 id:
1738 type: string
1739 required:
1740 - id
1741 type: object
1742 GetSdkTypesRequest:
1743 properties:
1744 limit:
1745 format: int64
1746 type: integer
1747 position:
1748 type: string
1749 type: object
1750 GetStageRequest:
1751 properties:
1752 restApiId:
1753 type: string
1754 stageName:
1755 type: string
1756 required:
1757 - restApiId
1758 - stageName
1759 type: object
1760 GetStagesRequest:
1761 properties:
1762 deploymentId:
1763 type: string
1764 restApiId:
1765 type: string
1766 required:
1767 - restApiId
1768 type: object
1769 GetTagsRequest:
1770 properties:
1771 limit:
1772 format: int64
1773 type: integer
1774 position:
1775 type: string
1776 resourceArn:
1777 type: string
1778 required:
1779 - resourceArn
1780 type: object
1781 GetUsagePlanKeyRequest:
1782 properties:
1783 keyId:
1784 type: string
1785 usagePlanId:
1786 type: string
1787 required:
1788 - usagePlanId
1789 - keyId
1790 type: object
1791 GetUsagePlanKeysRequest:
1792 properties:
1793 limit:
1794 format: int64
1795 type: integer
1796 nameQuery:
1797 type: string
1798 position:
1799 type: string
1800 usagePlanId:
1801 type: string
1802 required:
1803 - usagePlanId
1804 type: object
1805 GetUsagePlanRequest:
1806 properties:
1807 usagePlanId:
1808 type: string
1809 required:
1810 - usagePlanId
1811 type: object
1812 GetUsagePlansRequest:
1813 properties:
1814 keyId:
1815 type: string
1816 limit:
1817 format: int64
1818 type: integer
1819 position:
1820 type: string
1821 type: object
1822 GetUsageRequest:
1823 properties:
1824 endDate:
1825 type: string
1826 keyId:
1827 type: string
1828 limit:
1829 format: int64
1830 type: integer
1831 position:
1832 type: string
1833 startDate:
1834 type: string
1835 usagePlanId:
1836 type: string
1837 required:
1838 - usagePlanId
1839 - startDate
1840 - endDate
1841 type: object
1842 GetVpcLinkRequest:
1843 properties:
1844 vpcLinkId:
1845 type: string
1846 required:
1847 - vpcLinkId
1848 type: object
1849 GetVpcLinksRequest:
1850 properties:
1851 limit:
1852 format: int64
1853 type: integer
1854 position:
1855 type: string
1856 type: object
1857 ImportApiKeysRequest:
1858 properties:
1859 body:
1860 format: byte
1861 type: string
1862 failOnWarnings:
1863 type: boolean
1864 format:
1865 enum:
1866 - csv
1867 type: string
1868 required:
1869 - body
1870 - format
1871 type: object
1872 ImportDocumentationPartsRequest:
1873 properties:
1874 body:
1875 format: byte
1876 type: string
1877 failOnWarnings:
1878 type: boolean
1879 mode:
1880 enum:
1881 - merge
1882 - overwrite
1883 type: string
1884 restApiId:
1885 type: string
1886 required:
1887 - restApiId
1888 - body
1889 type: object
1890 ImportRestApiRequest:
1891 properties:
1892 body:
1893 format: byte
1894 type: string
1895 failOnWarnings:
1896 type: boolean
1897 parameters:
1898 additionalProperties: true
1899 type: object
1900 required:
1901 - body
1902 type: object
1903 Integer:
1904 format: int64
1905 type: integer
1906 Integration:
1907 properties:
1908 cacheKeyParameters:
1909 items:
1910 type: string
1911 type: array
1912 cacheNamespace:
1913 type: string
1914 connectionId:
1915 type: string
1916 connectionType:
1917 enum:
1918 - INTERNET
1919 - VPC_LINK
1920 type: string
1921 contentHandling:
1922 enum:
1923 - CONVERT_TO_BINARY
1924 - CONVERT_TO_TEXT
1925 type: string
1926 credentials:
1927 type: string
1928 httpMethod:
1929 type: string
1930 integrationResponses:
1931 additionalProperties: true
1932 type: object
1933 passthroughBehavior:
1934 type: string
1935 requestParameters:
1936 additionalProperties: true
1937 type: object
1938 requestTemplates:
1939 additionalProperties: true
1940 type: object
1941 timeoutInMillis:
1942 format: int64
1943 type: integer
1944 type:
1945 enum:
1946 - HTTP
1947 - AWS
1948 - MOCK
1949 - HTTP_PROXY
1950 - AWS_PROXY
1951 type: string
1952 uri:
1953 type: string
1954 type: object
1955 IntegrationResponse:
1956 properties:
1957 contentHandling:
1958 enum:
1959 - CONVERT_TO_BINARY
1960 - CONVERT_TO_TEXT
1961 type: string
1962 responseParameters:
1963 additionalProperties: true
1964 type: object
1965 responseTemplates:
1966 additionalProperties: true
1967 type: object
1968 selectionPattern:
1969 type: string
1970 statusCode:
1971 pattern: '[1-5]\d\d'
1972 type: string
1973 type: object
1974 IntegrationType:
1975 enum:
1976 - HTTP
1977 - AWS
1978 - MOCK
1979 - HTTP_PROXY
1980 - AWS_PROXY
1981 type: string
1982 LimitExceededException:
1983 properties:
1984 message:
1985 type: string
1986 retryAfterSeconds:
1987 type: string
1988 type: object
1989 ListOfARNs:
1990 items:
1991 type: string
1992 type: array
1993 ListOfApiKey:
1994 items:
1995 properties:
1996 createdDate:
1997 format: date-time
1998 type: string
1999 customerId:
2000 type: string
2001 description:
2002 type: string
2003 enabled:
2004 type: boolean
2005 id:
2006 type: string
2007 lastUpdatedDate:
2008 format: date-time
2009 type: string
2010 name:
2011 type: string
2012 stageKeys:
2013 items:
2014 type: string
2015 type: array
2016 tags:
2017 additionalProperties: true
2018 type: object
2019 value:
2020 type: string
2021 type: object
2022 type: array
2023 ListOfApiStage:
2024 items:
2025 properties:
2026 apiId:
2027 type: string
2028 stage:
2029 type: string
2030 throttle:
2031 additionalProperties: true
2032 type: object
2033 type: object
2034 type: array
2035 ListOfAuthorizer:
2036 items:
2037 properties:
2038 authType:
2039 type: string
2040 authorizerCredentials:
2041 type: string
2042 authorizerResultTtlInSeconds:
2043 format: int64
2044 type: integer
2045 authorizerUri:
2046 type: string
2047 id:
2048 type: string
2049 identitySource:
2050 type: string
2051 identityValidationExpression:
2052 type: string
2053 name:
2054 type: string
2055 providerARNs:
2056 items:
2057 type: string
2058 type: array
2059 type:
2060 enum:
2061 - TOKEN
2062 - REQUEST
2063 - COGNITO_USER_POOLS
2064 type: string
2065 type: object
2066 type: array
2067 ListOfBasePathMapping:
2068 items:
2069 properties:
2070 basePath:
2071 type: string
2072 restApiId:
2073 type: string
2074 stage:
2075 type: string
2076 type: object
2077 type: array
2078 ListOfClientCertificate:
2079 items:
2080 properties:
2081 clientCertificateId:
2082 type: string
2083 createdDate:
2084 format: date-time
2085 type: string
2086 description:
2087 type: string
2088 expirationDate:
2089 format: date-time
2090 type: string
2091 pemEncodedCertificate:
2092 type: string
2093 tags:
2094 additionalProperties: true
2095 type: object
2096 type: object
2097 type: array
2098 ListOfDeployment:
2099 items:
2100 properties:
2101 apiSummary:
2102 additionalProperties: true
2103 type: object
2104 createdDate:
2105 format: date-time
2106 type: string
2107 description:
2108 type: string
2109 id:
2110 type: string
2111 type: object
2112 type: array
2113 ListOfDocumentationPart:
2114 items:
2115 properties:
2116 id:
2117 type: string
2118 location:
2119 $ref: '#/components/schemas/DocumentationPartLocation'
2120 properties:
2121 type: string
2122 type: object
2123 type: array
2124 ListOfDocumentationVersion:
2125 items:
2126 properties:
2127 createdDate:
2128 format: date-time
2129 type: string
2130 description:
2131 type: string
2132 version:
2133 type: string
2134 type: object
2135 type: array
2136 ListOfDomainName:
2137 items:
2138 properties:
2139 certificateArn:
2140 type: string
2141 certificateName:
2142 type: string
2143 certificateUploadDate:
2144 format: date-time
2145 type: string
2146 distributionDomainName:
2147 type: string
2148 distributionHostedZoneId:
2149 type: string
2150 domainName:
2151 type: string
2152 domainNameStatus:
2153 enum:
2154 - AVAILABLE
2155 - UPDATING
2156 - PENDING
2157 type: string
2158 domainNameStatusMessage:
2159 type: string
2160 endpointConfiguration:
2161 $ref: '#/components/schemas/EndpointConfiguration'
2162 regionalCertificateArn:
2163 type: string
2164 regionalCertificateName:
2165 type: string
2166 regionalDomainName:
2167 type: string
2168 regionalHostedZoneId:
2169 type: string
2170 securityPolicy:
2171 enum:
2172 - TLS_1_0
2173 - TLS_1_2
2174 type: string
2175 tags:
2176 additionalProperties: true
2177 type: object
2178 type: object
2179 type: array
2180 ListOfEndpointType:
2181 items:
2182 enum:
2183 - REGIONAL
2184 - EDGE
2185 - PRIVATE
2186 type: string
2187 type: array
2188 ListOfGatewayResponse:
2189 items:
2190 properties:
2191 defaultResponse:
2192 type: boolean
2193 responseParameters:
2194 additionalProperties: true
2195 type: object
2196 responseTemplates:
2197 additionalProperties: true
2198 type: object
2199 responseType:
2200 enum:
2201 - DEFAULT_4XX
2202 - DEFAULT_5XX
2203 - RESOURCE_NOT_FOUND
2204 - UNAUTHORIZED
2205 - INVALID_API_KEY
2206 - ACCESS_DENIED
2207 - AUTHORIZER_FAILURE
2208 - AUTHORIZER_CONFIGURATION_ERROR
2209 - INVALID_SIGNATURE
2210 - EXPIRED_TOKEN
2211 - MISSING_AUTHENTICATION_TOKEN
2212 - INTEGRATION_FAILURE
2213 - INTEGRATION_TIMEOUT
2214 - API_CONFIGURATION_ERROR
2215 - UNSUPPORTED_MEDIA_TYPE
2216 - BAD_REQUEST_PARAMETERS
2217 - BAD_REQUEST_BODY
2218 - REQUEST_TOO_LARGE
2219 - THROTTLED
2220 - QUOTA_EXCEEDED
2221 type: string
2222 statusCode:
2223 pattern: '[1-5]\d\d'
2224 type: string
2225 type: object
2226 type: array
2227 ListOfLong:
2228 items:
2229 format: int64
2230 type: integer
2231 type: array
2232 ListOfModel:
2233 items:
2234 properties:
2235 contentType:
2236 type: string
2237 description:
2238 type: string
2239 id:
2240 type: string
2241 name:
2242 type: string
2243 schema:
2244 type: string
2245 type: object
2246 type: array
2247 ListOfPatchOperation:
2248 items:
2249 properties:
2250 from:
2251 type: string
2252 op:
2253 enum:
2254 - add
2255 - remove
2256 - replace
2257 - move
2258 - copy
2259 - test
2260 type: string
2261 path:
2262 type: string
2263 value:
2264 type: string
2265 type: object
2266 type: array
2267 ListOfRequestValidator:
2268 items:
2269 properties:
2270 id:
2271 type: string
2272 name:
2273 type: string
2274 validateRequestBody:
2275 type: boolean
2276 validateRequestParameters:
2277 type: boolean
2278 type: object
2279 type: array
2280 ListOfResource:
2281 items:
2282 properties:
2283 id:
2284 type: string
2285 parentId:
2286 type: string
2287 path:
2288 type: string
2289 pathPart:
2290 type: string
2291 resourceMethods:
2292 additionalProperties: true
2293 type: object
2294 type: object
2295 type: array
2296 ListOfRestApi:
2297 items:
2298 properties:
2299 apiKeySource:
2300 enum:
2301 - HEADER
2302 - AUTHORIZER
2303 type: string
2304 binaryMediaTypes:
2305 items:
2306 type: string
2307 type: array
2308 createdDate:
2309 format: date-time
2310 type: string
2311 description:
2312 type: string
2313 endpointConfiguration:
2314 $ref: '#/components/schemas/EndpointConfiguration'
2315 id:
2316 type: string
2317 minimumCompressionSize:
2318 format: int64
2319 type: integer
2320 name:
2321 type: string
2322 policy:
2323 type: string
2324 tags:
2325 additionalProperties: true
2326 type: object
2327 version:
2328 type: string
2329 warnings:
2330 items:
2331 type: string
2332 type: array
2333 type: object
2334 type: array
2335 ListOfSdkConfigurationProperty:
2336 items:
2337 properties:
2338 defaultValue:
2339 type: string
2340 description:
2341 type: string
2342 friendlyName:
2343 type: string
2344 name:
2345 type: string
2346 required:
2347 type: boolean
2348 type: object
2349 type: array
2350 ListOfSdkType:
2351 items:
2352 properties:
2353 configurationProperties:
2354 items:
2355 properties:
2356 defaultValue:
2357 type: string
2358 description:
2359 type: string
2360 friendlyName:
2361 type: string
2362 name:
2363 type: string
2364 required:
2365 type: boolean
2366 type: object
2367 type: array
2368 description:
2369 type: string
2370 friendlyName:
2371 type: string
2372 id:
2373 type: string
2374 type: object
2375 type: array
2376 ListOfStage:
2377 items:
2378 properties:
2379 accessLogSettings:
2380 $ref: '#/components/schemas/AccessLogSettings'
2381 cacheClusterEnabled:
2382 type: boolean
2383 cacheClusterSize:
2384 enum:
2385 - "0.5"
2386 - "1.6"
2387 - "6.1"
2388 - "13.5"
2389 - "28.4"
2390 - "58.2"
2391 - "118"
2392 - "237"
2393 type: string
2394 cacheClusterStatus:
2395 enum:
2396 - CREATE_IN_PROGRESS
2397 - AVAILABLE
2398 - DELETE_IN_PROGRESS
2399 - NOT_AVAILABLE
2400 - FLUSH_IN_PROGRESS
2401 type: string
2402 canarySettings:
2403 $ref: '#/components/schemas/CanarySettings'
2404 clientCertificateId:
2405 type: string
2406 createdDate:
2407 format: date-time
2408 type: string
2409 deploymentId:
2410 type: string
2411 description:
2412 type: string
2413 documentationVersion:
2414 type: string
2415 lastUpdatedDate:
2416 format: date-time
2417 type: string
2418 methodSettings:
2419 additionalProperties: true
2420 type: object
2421 stageName:
2422 type: string
2423 tags:
2424 additionalProperties: true
2425 type: object
2426 tracingEnabled:
2427 type: boolean
2428 variables:
2429 additionalProperties: true
2430 type: object
2431 webAclArn:
2432 type: string
2433 type: object
2434 type: array
2435 ListOfStageKeys:
2436 items:
2437 properties:
2438 restApiId:
2439 type: string
2440 stageName:
2441 type: string
2442 type: object
2443 type: array
2444 ListOfString:
2445 items:
2446 type: string
2447 type: array
2448 ListOfUsage:
2449 items:
2450 items:
2451 format: int64
2452 type: integer
2453 type: array
2454 type: array
2455 ListOfUsagePlan:
2456 items:
2457 properties:
2458 apiStages:
2459 items:
2460 properties:
2461 apiId:
2462 type: string
2463 stage:
2464 type: string
2465 throttle:
2466 additionalProperties: true
2467 type: object
2468 type: object
2469 type: array
2470 description:
2471 type: string
2472 id:
2473 type: string
2474 name:
2475 type: string
2476 productCode:
2477 type: string
2478 quota:
2479 $ref: '#/components/schemas/QuotaSettings'
2480 tags:
2481 additionalProperties: true
2482 type: object
2483 throttle:
2484 $ref: '#/components/schemas/ThrottleSettings'
2485 type: object
2486 type: array
2487 ListOfUsagePlanKey:
2488 items:
2489 properties:
2490 id:
2491 type: string
2492 name:
2493 type: string
2494 type:
2495 type: string
2496 value:
2497 type: string
2498 type: object
2499 type: array
2500 ListOfVpcLink:
2501 items:
2502 properties:
2503 description:
2504 type: string
2505 id:
2506 type: string
2507 name:
2508 type: string
2509 status:
2510 enum:
2511 - AVAILABLE
2512 - PENDING
2513 - DELETING
2514 - FAILED
2515 type: string
2516 statusMessage:
2517 type: string
2518 tags:
2519 additionalProperties: true
2520 type: object
2521 targetArns:
2522 items:
2523 type: string
2524 type: array
2525 type: object
2526 type: array
2527 LocationStatusType:
2528 enum:
2529 - DOCUMENTED
2530 - UNDOCUMENTED
2531 type: string
2532 Long:
2533 format: int64
2534 type: integer
2535 MapOfApiStageThrottleSettings:
2536 additionalProperties: true
2537 type: object
2538 MapOfIntegrationResponse:
2539 additionalProperties: true
2540 type: object
2541 MapOfKeyUsages:
2542 additionalProperties: true
2543 type: object
2544 MapOfMethod:
2545 additionalProperties: true
2546 type: object
2547 MapOfMethodResponse:
2548 additionalProperties: true
2549 type: object
2550 MapOfMethodSettings:
2551 additionalProperties: true
2552 type: object
2553 MapOfMethodSnapshot:
2554 additionalProperties: true
2555 type: object
2556 MapOfStringToBoolean:
2557 additionalProperties: true
2558 type: object
2559 MapOfStringToList:
2560 additionalProperties: true
2561 type: object
2562 MapOfStringToString:
2563 additionalProperties: true
2564 type: object
2565 Method:
2566 properties:
2567 apiKeyRequired:
2568 type: boolean
2569 authorizationScopes:
2570 items:
2571 type: string
2572 type: array
2573 authorizationType:
2574 type: string
2575 authorizerId:
2576 type: string
2577 httpMethod:
2578 type: string
2579 methodIntegration:
2580 $ref: '#/components/schemas/Integration'
2581 methodResponses:
2582 additionalProperties: true
2583 type: object
2584 operationName:
2585 type: string
2586 requestModels:
2587 additionalProperties: true
2588 type: object
2589 requestParameters:
2590 additionalProperties: true
2591 type: object
2592 requestValidatorId:
2593 type: string
2594 type: object
2595 MethodResponse:
2596 properties:
2597 responseModels:
2598 additionalProperties: true
2599 type: object
2600 responseParameters:
2601 additionalProperties: true
2602 type: object
2603 statusCode:
2604 pattern: '[1-5]\d\d'
2605 type: string
2606 type: object
2607 MethodSetting:
2608 properties:
2609 cacheDataEncrypted:
2610 type: boolean
2611 cacheTtlInSeconds:
2612 format: int64
2613 type: integer
2614 cachingEnabled:
2615 type: boolean
2616 dataTraceEnabled:
2617 type: boolean
2618 loggingLevel:
2619 type: string
2620 metricsEnabled:
2621 type: boolean
2622 requireAuthorizationForCacheControl:
2623 type: boolean
2624 throttlingBurstLimit:
2625 format: int64
2626 type: integer
2627 throttlingRateLimit:
2628 type: number
2629 unauthorizedCacheControlHeaderStrategy:
2630 enum:
2631 - FAIL_WITH_403
2632 - SUCCEED_WITH_RESPONSE_HEADER
2633 - SUCCEED_WITHOUT_RESPONSE_HEADER
2634 type: string
2635 type: object
2636 MethodSnapshot:
2637 properties:
2638 apiKeyRequired:
2639 type: boolean
2640 authorizationType:
2641 type: string
2642 type: object
2643 Model:
2644 properties:
2645 contentType:
2646 type: string
2647 description:
2648 type: string
2649 id:
2650 type: string
2651 name:
2652 type: string
2653 schema:
2654 type: string
2655 type: object
2656 Models:
2657 properties:
2658 items:
2659 items:
2660 properties:
2661 contentType:
2662 type: string
2663 description:
2664 type: string
2665 id:
2666 type: string
2667 name:
2668 type: string
2669 schema:
2670 type: string
2671 type: object
2672 type: array
2673 position:
2674 type: string
2675 type: object
2676 NotFoundException:
2677 properties:
2678 message:
2679 type: string
2680 type: object
2681 NullableBoolean:
2682 type: boolean
2683 NullableInteger:
2684 format: int64
2685 type: integer
2686 Op:
2687 enum:
2688 - add
2689 - remove
2690 - replace
2691 - move
2692 - copy
2693 - test
2694 type: string
2695 PatchOperation:
2696 properties:
2697 from:
2698 type: string
2699 op:
2700 enum:
2701 - add
2702 - remove
2703 - replace
2704 - move
2705 - copy
2706 - test
2707 type: string
2708 path:
2709 type: string
2710 value:
2711 type: string
2712 type: object
2713 PathToMapOfMethodSnapshot:
2714 additionalProperties: true
2715 type: object
2716 ProviderARN:
2717 type: string
2718 PutGatewayResponseRequest:
2719 properties:
2720 responseParameters:
2721 additionalProperties: true
2722 type: object
2723 responseTemplates:
2724 additionalProperties: true
2725 type: object
2726 responseType:
2727 enum:
2728 - DEFAULT_4XX
2729 - DEFAULT_5XX
2730 - RESOURCE_NOT_FOUND
2731 - UNAUTHORIZED
2732 - INVALID_API_KEY
2733 - ACCESS_DENIED
2734 - AUTHORIZER_FAILURE
2735 - AUTHORIZER_CONFIGURATION_ERROR
2736 - INVALID_SIGNATURE
2737 - EXPIRED_TOKEN
2738 - MISSING_AUTHENTICATION_TOKEN
2739 - INTEGRATION_FAILURE
2740 - INTEGRATION_TIMEOUT
2741 - API_CONFIGURATION_ERROR
2742 - UNSUPPORTED_MEDIA_TYPE
2743 - BAD_REQUEST_PARAMETERS
2744 - BAD_REQUEST_BODY
2745 - REQUEST_TOO_LARGE
2746 - THROTTLED
2747 - QUOTA_EXCEEDED
2748 type: string
2749 restApiId:
2750 type: string
2751 statusCode:
2752 pattern: '[1-5]\d\d'
2753 type: string
2754 required:
2755 - restApiId
2756 - responseType
2757 type: object
2758 PutIntegrationRequest:
2759 properties:
2760 cacheKeyParameters:
2761 items:
2762 type: string
2763 type: array
2764 cacheNamespace:
2765 type: string
2766 connectionId:
2767 type: string
2768 connectionType:
2769 enum:
2770 - INTERNET
2771 - VPC_LINK
2772 type: string
2773 contentHandling:
2774 enum:
2775 - CONVERT_TO_BINARY
2776 - CONVERT_TO_TEXT
2777 type: string
2778 credentials:
2779 type: string
2780 httpMethod:
2781 type: string
2782 integrationHttpMethod:
2783 type: string
2784 passthroughBehavior:
2785 type: string
2786 requestParameters:
2787 additionalProperties: true
2788 type: object
2789 requestTemplates:
2790 additionalProperties: true
2791 type: object
2792 resourceId:
2793 type: string
2794 restApiId:
2795 type: string
2796 timeoutInMillis:
2797 format: int64
2798 type: integer
2799 type:
2800 enum:
2801 - HTTP
2802 - AWS
2803 - MOCK
2804 - HTTP_PROXY
2805 - AWS_PROXY
2806 type: string
2807 uri:
2808 type: string
2809 required:
2810 - restApiId
2811 - resourceId
2812 - httpMethod
2813 - type
2814 type: object
2815 PutIntegrationResponseRequest:
2816 properties:
2817 contentHandling:
2818 enum:
2819 - CONVERT_TO_BINARY
2820 - CONVERT_TO_TEXT
2821 type: string
2822 httpMethod:
2823 type: string
2824 resourceId:
2825 type: string
2826 responseParameters:
2827 additionalProperties: true
2828 type: object
2829 responseTemplates:
2830 additionalProperties: true
2831 type: object
2832 restApiId:
2833 type: string
2834 selectionPattern:
2835 type: string
2836 statusCode:
2837 pattern: '[1-5]\d\d'
2838 type: string
2839 required:
2840 - restApiId
2841 - resourceId
2842 - httpMethod
2843 - statusCode
2844 type: object
2845 PutMethodRequest:
2846 properties:
2847 apiKeyRequired:
2848 type: boolean
2849 authorizationScopes:
2850 items:
2851 type: string
2852 type: array
2853 authorizationType:
2854 type: string
2855 authorizerId:
2856 type: string
2857 httpMethod:
2858 type: string
2859 operationName:
2860 type: string
2861 requestModels:
2862 additionalProperties: true
2863 type: object
2864 requestParameters:
2865 additionalProperties: true
2866 type: object
2867 requestValidatorId:
2868 type: string
2869 resourceId:
2870 type: string
2871 restApiId:
2872 type: string
2873 required:
2874 - restApiId
2875 - resourceId
2876 - httpMethod
2877 - authorizationType
2878 type: object
2879 PutMethodResponseRequest:
2880 properties:
2881 httpMethod:
2882 type: string
2883 resourceId:
2884 type: string
2885 responseModels:
2886 additionalProperties: true
2887 type: object
2888 responseParameters:
2889 additionalProperties: true
2890 type: object
2891 restApiId:
2892 type: string
2893 statusCode:
2894 pattern: '[1-5]\d\d'
2895 type: string
2896 required:
2897 - restApiId
2898 - resourceId
2899 - httpMethod
2900 - statusCode
2901 type: object
2902 PutMode:
2903 enum:
2904 - merge
2905 - overwrite
2906 type: string
2907 PutRestApiRequest:
2908 properties:
2909 body:
2910 format: byte
2911 type: string
2912 failOnWarnings:
2913 type: boolean
2914 mode:
2915 enum:
2916 - merge
2917 - overwrite
2918 type: string
2919 parameters:
2920 additionalProperties: true
2921 type: object
2922 restApiId:
2923 type: string
2924 required:
2925 - restApiId
2926 - body
2927 type: object
2928 QuotaPeriodType:
2929 enum:
2930 - DAY
2931 - WEEK
2932 - MONTH
2933 type: string
2934 QuotaSettings:
2935 properties:
2936 limit:
2937 format: int64
2938 type: integer
2939 offset:
2940 format: int64
2941 type: integer
2942 period:
2943 enum:
2944 - DAY
2945 - WEEK
2946 - MONTH
2947 type: string
2948 type: object
2949 RequestValidator:
2950 properties:
2951 id:
2952 type: string
2953 name:
2954 type: string
2955 validateRequestBody:
2956 type: boolean
2957 validateRequestParameters:
2958 type: boolean
2959 type: object
2960 RequestValidators:
2961 properties:
2962 items:
2963 items:
2964 properties:
2965 id:
2966 type: string
2967 name:
2968 type: string
2969 validateRequestBody:
2970 type: boolean
2971 validateRequestParameters:
2972 type: boolean
2973 type: object
2974 type: array
2975 position:
2976 type: string
2977 type: object
2978 Resource:
2979 properties:
2980 id:
2981 type: string
2982 parentId:
2983 type: string
2984 path:
2985 type: string
2986 pathPart:
2987 type: string
2988 resourceMethods:
2989 additionalProperties: true
2990 type: object
2991 type: object
2992 Resources:
2993 properties:
2994 items:
2995 items:
2996 properties:
2997 id:
2998 type: string
2999 parentId:
3000 type: string
3001 path:
3002 type: string
3003 pathPart:
3004 type: string
3005 resourceMethods:
3006 additionalProperties: true
3007 type: object
3008 type: object
3009 type: array
3010 position:
3011 type: string
3012 type: object
3013 RestApi:
3014 properties:
3015 apiKeySource:
3016 enum:
3017 - HEADER
3018 - AUTHORIZER
3019 type: string
3020 binaryMediaTypes:
3021 items:
3022 type: string
3023 type: array
3024 createdDate:
3025 format: date-time
3026 type: string
3027 description:
3028 type: string
3029 endpointConfiguration:
3030 $ref: '#/components/schemas/EndpointConfiguration'
3031 id:
3032 type: string
3033 minimumCompressionSize:
3034 format: int64
3035 type: integer
3036 name:
3037 type: string
3038 policy:
3039 type: string
3040 tags:
3041 additionalProperties: true
3042 type: object
3043 version:
3044 type: string
3045 warnings:
3046 items:
3047 type: string
3048 type: array
3049 type: object
3050 RestApis:
3051 properties:
3052 items:
3053 items:
3054 properties:
3055 apiKeySource:
3056 enum:
3057 - HEADER
3058 - AUTHORIZER
3059 type: string
3060 binaryMediaTypes:
3061 items:
3062 type: string
3063 type: array
3064 createdDate:
3065 format: date-time
3066 type: string
3067 description:
3068 type: string
3069 endpointConfiguration:
3070 $ref: '#/components/schemas/EndpointConfiguration'
3071 id:
3072 type: string
3073 minimumCompressionSize:
3074 format: int64
3075 type: integer
3076 name:
3077 type: string
3078 policy:
3079 type: string
3080 tags:
3081 additionalProperties: true
3082 type: object
3083 version:
3084 type: string
3085 warnings:
3086 items:
3087 type: string
3088 type: array
3089 type: object
3090 type: array
3091 position:
3092 type: string
3093 type: object
3094 SdkConfigurationProperty:
3095 properties:
3096 defaultValue:
3097 type: string
3098 description:
3099 type: string
3100 friendlyName:
3101 type: string
3102 name:
3103 type: string
3104 required:
3105 type: boolean
3106 type: object
3107 SdkResponse:
3108 properties:
3109 body:
3110 format: byte
3111 type: string
3112 contentDisposition:
3113 type: string
3114 contentType:
3115 type: string
3116 type: object
3117 SdkType:
3118 properties:
3119 configurationProperties:
3120 items:
3121 properties:
3122 defaultValue:
3123 type: string
3124 description:
3125 type: string
3126 friendlyName:
3127 type: string
3128 name:
3129 type: string
3130 required:
3131 type: boolean
3132 type: object
3133 type: array
3134 description:
3135 type: string
3136 friendlyName:
3137 type: string
3138 id:
3139 type: string
3140 type: object
3141 SdkTypes:
3142 properties:
3143 items:
3144 items:
3145 properties:
3146 configurationProperties:
3147 items:
3148 properties:
3149 defaultValue:
3150 type: string
3151 description:
3152 type: string
3153 friendlyName:
3154 type: string
3155 name:
3156 type: string
3157 required:
3158 type: boolean
3159 type: object
3160 type: array
3161 description:
3162 type: string
3163 friendlyName:
3164 type: string
3165 id:
3166 type: string
3167 type: object
3168 type: array
3169 position:
3170 type: string
3171 type: object
3172 SecurityPolicy:
3173 enum:
3174 - TLS_1_0
3175 - TLS_1_2
3176 type: string
3177 ServiceUnavailableException:
3178 properties:
3179 message:
3180 type: string
3181 retryAfterSeconds:
3182 type: string
3183 type: object
3184 Stage:
3185 properties:
3186 accessLogSettings:
3187 $ref: '#/components/schemas/AccessLogSettings'
3188 cacheClusterEnabled:
3189 type: boolean
3190 cacheClusterSize:
3191 enum:
3192 - "0.5"
3193 - "1.6"
3194 - "6.1"
3195 - "13.5"
3196 - "28.4"
3197 - "58.2"
3198 - "118"
3199 - "237"
3200 type: string
3201 cacheClusterStatus:
3202 enum:
3203 - CREATE_IN_PROGRESS
3204 - AVAILABLE
3205 - DELETE_IN_PROGRESS
3206 - NOT_AVAILABLE
3207 - FLUSH_IN_PROGRESS
3208 type: string
3209 canarySettings:
3210 $ref: '#/components/schemas/CanarySettings'
3211 clientCertificateId:
3212 type: string
3213 createdDate:
3214 format: date-time
3215 type: string
3216 deploymentId:
3217 type: string
3218 description:
3219 type: string
3220 documentationVersion:
3221 type: string
3222 lastUpdatedDate:
3223 format: date-time
3224 type: string
3225 methodSettings:
3226 additionalProperties: true
3227 type: object
3228 stageName:
3229 type: string
3230 tags:
3231 additionalProperties: true
3232 type: object
3233 tracingEnabled:
3234 type: boolean
3235 variables:
3236 additionalProperties: true
3237 type: object
3238 webAclArn:
3239 type: string
3240 type: object
3241 StageKey:
3242 properties:
3243 restApiId:
3244 type: string
3245 stageName:
3246 type: string
3247 type: object
3248 Stages:
3249 properties:
3250 item:
3251 items:
3252 properties:
3253 accessLogSettings:
3254 $ref: '#/components/schemas/AccessLogSettings'
3255 cacheClusterEnabled:
3256 type: boolean
3257 cacheClusterSize:
3258 enum:
3259 - "0.5"
3260 - "1.6"
3261 - "6.1"
3262 - "13.5"
3263 - "28.4"
3264 - "58.2"
3265 - "118"
3266 - "237"
3267 type: string
3268 cacheClusterStatus:
3269 enum:
3270 - CREATE_IN_PROGRESS
3271 - AVAILABLE
3272 - DELETE_IN_PROGRESS
3273 - NOT_AVAILABLE
3274 - FLUSH_IN_PROGRESS
3275 type: string
3276 canarySettings:
3277 $ref: '#/components/schemas/CanarySettings'
3278 clientCertificateId:
3279 type: string
3280 createdDate:
3281 format: date-time
3282 type: string
3283 deploymentId:
3284 type: string
3285 description:
3286 type: string
3287 documentationVersion:
3288 type: string
3289 lastUpdatedDate:
3290 format: date-time
3291 type: string
3292 methodSettings:
3293 additionalProperties: true
3294 type: object
3295 stageName:
3296 type: string
3297 tags:
3298 additionalProperties: true
3299 type: object
3300 tracingEnabled:
3301 type: boolean
3302 variables:
3303 additionalProperties: true
3304 type: object
3305 webAclArn:
3306 type: string
3307 type: object
3308 type: array
3309 type: object
3310 StatusCode:
3311 pattern: '[1-5]\d\d'
3312 type: string
3313 String:
3314 type: string
3315 TagResourceRequest:
3316 properties:
3317 resourceArn:
3318 type: string
3319 tags:
3320 additionalProperties: true
3321 type: object
3322 required:
3323 - resourceArn
3324 - tags
3325 type: object
3326 Tags:
3327 properties:
3328 tags:
3329 additionalProperties: true
3330 type: object
3331 type: object
3332 Template:
3333 properties:
3334 value:
3335 type: string
3336 type: object
3337 TestInvokeAuthorizerRequest:
3338 properties:
3339 additionalContext:
3340 additionalProperties: true
3341 type: object
3342 authorizerId:
3343 type: string
3344 body:
3345 type: string
3346 headers:
3347 additionalProperties: true
3348 type: object
3349 multiValueHeaders:
3350 additionalProperties: true
3351 type: object
3352 pathWithQueryString:
3353 type: string
3354 restApiId:
3355 type: string
3356 stageVariables:
3357 additionalProperties: true
3358 type: object
3359 required:
3360 - restApiId
3361 - authorizerId
3362 type: object
3363 TestInvokeAuthorizerResponse:
3364 properties:
3365 authorization:
3366 additionalProperties: true
3367 type: object
3368 claims:
3369 additionalProperties: true
3370 type: object
3371 clientStatus:
3372 format: int64
3373 type: integer
3374 latency:
3375 format: int64
3376 type: integer
3377 log:
3378 type: string
3379 policy:
3380 type: string
3381 principalId:
3382 type: string
3383 type: object
3384 TestInvokeMethodRequest:
3385 properties:
3386 body:
3387 type: string
3388 clientCertificateId:
3389 type: string
3390 headers:
3391 additionalProperties: true
3392 type: object
3393 httpMethod:
3394 type: string
3395 multiValueHeaders:
3396 additionalProperties: true
3397 type: object
3398 pathWithQueryString:
3399 type: string
3400 resourceId:
3401 type: string
3402 restApiId:
3403 type: string
3404 stageVariables:
3405 additionalProperties: true
3406 type: object
3407 required:
3408 - restApiId
3409 - resourceId
3410 - httpMethod
3411 type: object
3412 TestInvokeMethodResponse:
3413 properties:
3414 body:
3415 type: string
3416 headers:
3417 additionalProperties: true
3418 type: object
3419 latency:
3420 format: int64
3421 type: integer
3422 log:
3423 type: string
3424 multiValueHeaders:
3425 additionalProperties: true
3426 type: object
3427 status:
3428 format: int64
3429 type: integer
3430 type: object
3431 ThrottleSettings:
3432 properties:
3433 burstLimit:
3434 format: int64
3435 type: integer
3436 rateLimit:
3437 type: number
3438 type: object
3439 Timestamp:
3440 format: date-time
3441 type: string
3442 TooManyRequestsException:
3443 properties:
3444 message:
3445 type: string
3446 retryAfterSeconds:
3447 type: string
3448 type: object
3449 UnauthorizedCacheControlHeaderStrategy:
3450 enum:
3451 - FAIL_WITH_403
3452 - SUCCEED_WITH_RESPONSE_HEADER
3453 - SUCCEED_WITHOUT_RESPONSE_HEADER
3454 type: string
3455 UnauthorizedException:
3456 properties:
3457 message:
3458 type: string
3459 type: object
3460 UntagResourceRequest:
3461 properties:
3462 resourceArn:
3463 type: string
3464 tagKeys:
3465 items:
3466 type: string
3467 type: array
3468 required:
3469 - resourceArn
3470 - tagKeys
3471 type: object
3472 UpdateAccountRequest:
3473 properties:
3474 patchOperations:
3475 items:
3476 properties:
3477 from:
3478 type: string
3479 op:
3480 enum:
3481 - add
3482 - remove
3483 - replace
3484 - move
3485 - copy
3486 - test
3487 type: string
3488 path:
3489 type: string
3490 value:
3491 type: string
3492 type: object
3493 type: array
3494 type: object
3495 UpdateApiKeyRequest:
3496 properties:
3497 apiKey:
3498 type: string
3499 patchOperations:
3500 items:
3501 properties:
3502 from:
3503 type: string
3504 op:
3505 enum:
3506 - add
3507 - remove
3508 - replace
3509 - move
3510 - copy
3511 - test
3512 type: string
3513 path:
3514 type: string
3515 value:
3516 type: string
3517 type: object
3518 type: array
3519 required:
3520 - apiKey
3521 type: object
3522 UpdateAuthorizerRequest:
3523 properties:
3524 authorizerId:
3525 type: string
3526 patchOperations:
3527 items:
3528 properties:
3529 from:
3530 type: string
3531 op:
3532 enum:
3533 - add
3534 - remove
3535 - replace
3536 - move
3537 - copy
3538 - test
3539 type: string
3540 path:
3541 type: string
3542 value:
3543 type: string
3544 type: object
3545 type: array
3546 restApiId:
3547 type: string
3548 required:
3549 - restApiId
3550 - authorizerId
3551 type: object
3552 UpdateBasePathMappingRequest:
3553 properties:
3554 basePath:
3555 type: string
3556 domainName:
3557 type: string
3558 patchOperations:
3559 items:
3560 properties:
3561 from:
3562 type: string
3563 op:
3564 enum:
3565 - add
3566 - remove
3567 - replace
3568 - move
3569 - copy
3570 - test
3571 type: string
3572 path:
3573 type: string
3574 value:
3575 type: string
3576 type: object
3577 type: array
3578 required:
3579 - domainName
3580 - basePath
3581 type: object
3582 UpdateClientCertificateRequest:
3583 properties:
3584 clientCertificateId:
3585 type: string
3586 patchOperations:
3587 items:
3588 properties:
3589 from:
3590 type: string
3591 op:
3592 enum:
3593 - add
3594 - remove
3595 - replace
3596 - move
3597 - copy
3598 - test
3599 type: string
3600 path:
3601 type: string
3602 value:
3603 type: string
3604 type: object
3605 type: array
3606 required:
3607 - clientCertificateId
3608 type: object
3609 UpdateDeploymentRequest:
3610 properties:
3611 deploymentId:
3612 type: string
3613 patchOperations:
3614 items:
3615 properties:
3616 from:
3617 type: string
3618 op:
3619 enum:
3620 - add
3621 - remove
3622 - replace
3623 - move
3624 - copy
3625 - test
3626 type: string
3627 path:
3628 type: string
3629 value:
3630 type: string
3631 type: object
3632 type: array
3633 restApiId:
3634 type: string
3635 required:
3636 - restApiId
3637 - deploymentId
3638 type: object
3639 UpdateDocumentationPartRequest:
3640 properties:
3641 documentationPartId:
3642 type: string
3643 patchOperations:
3644 items:
3645 properties:
3646 from:
3647 type: string
3648 op:
3649 enum:
3650 - add
3651 - remove
3652 - replace
3653 - move
3654 - copy
3655 - test
3656 type: string
3657 path:
3658 type: string
3659 value:
3660 type: string
3661 type: object
3662 type: array
3663 restApiId:
3664 type: string
3665 required:
3666 - restApiId
3667 - documentationPartId
3668 type: object
3669 UpdateDocumentationVersionRequest:
3670 properties:
3671 documentationVersion:
3672 type: string
3673 patchOperations:
3674 items:
3675 properties:
3676 from:
3677 type: string
3678 op:
3679 enum:
3680 - add
3681 - remove
3682 - replace
3683 - move
3684 - copy
3685 - test
3686 type: string
3687 path:
3688 type: string
3689 value:
3690 type: string
3691 type: object
3692 type: array
3693 restApiId:
3694 type: string
3695 required:
3696 - restApiId
3697 - documentationVersion
3698 type: object
3699 UpdateDomainNameRequest:
3700 properties:
3701 domainName:
3702 type: string
3703 patchOperations:
3704 items:
3705 properties:
3706 from:
3707 type: string
3708 op:
3709 enum:
3710 - add
3711 - remove
3712 - replace
3713 - move
3714 - copy
3715 - test
3716 type: string
3717 path:
3718 type: string
3719 value:
3720 type: string
3721 type: object
3722 type: array
3723 required:
3724 - domainName
3725 type: object
3726 UpdateGatewayResponseRequest:
3727 properties:
3728 patchOperations:
3729 items:
3730 properties:
3731 from:
3732 type: string
3733 op:
3734 enum:
3735 - add
3736 - remove
3737 - replace
3738 - move
3739 - copy
3740 - test
3741 type: string
3742 path:
3743 type: string
3744 value:
3745 type: string
3746 type: object
3747 type: array
3748 responseType:
3749 enum:
3750 - DEFAULT_4XX
3751 - DEFAULT_5XX
3752 - RESOURCE_NOT_FOUND
3753 - UNAUTHORIZED
3754 - INVALID_API_KEY
3755 - ACCESS_DENIED
3756 - AUTHORIZER_FAILURE
3757 - AUTHORIZER_CONFIGURATION_ERROR
3758 - INVALID_SIGNATURE
3759 - EXPIRED_TOKEN
3760 - MISSING_AUTHENTICATION_TOKEN
3761 - INTEGRATION_FAILURE
3762 - INTEGRATION_TIMEOUT
3763 - API_CONFIGURATION_ERROR
3764 - UNSUPPORTED_MEDIA_TYPE
3765 - BAD_REQUEST_PARAMETERS
3766 - BAD_REQUEST_BODY
3767 - REQUEST_TOO_LARGE
3768 - THROTTLED
3769 - QUOTA_EXCEEDED
3770 type: string
3771 restApiId:
3772 type: string
3773 required:
3774 - restApiId
3775 - responseType
3776 type: object
3777 UpdateIntegrationRequest:
3778 properties:
3779 httpMethod:
3780 type: string
3781 patchOperations:
3782 items:
3783 properties:
3784 from:
3785 type: string
3786 op:
3787 enum:
3788 - add
3789 - remove
3790 - replace
3791 - move
3792 - copy
3793 - test
3794 type: string
3795 path:
3796 type: string
3797 value:
3798 type: string
3799 type: object
3800 type: array
3801 resourceId:
3802 type: string
3803 restApiId:
3804 type: string
3805 required:
3806 - restApiId
3807 - resourceId
3808 - httpMethod
3809 type: object
3810 UpdateIntegrationResponseRequest:
3811 properties:
3812 httpMethod:
3813 type: string
3814 patchOperations:
3815 items:
3816 properties:
3817 from:
3818 type: string
3819 op:
3820 enum:
3821 - add
3822 - remove
3823 - replace
3824 - move
3825 - copy
3826 - test
3827 type: string
3828 path:
3829 type: string
3830 value:
3831 type: string
3832 type: object
3833 type: array
3834 resourceId:
3835 type: string
3836 restApiId:
3837 type: string
3838 statusCode:
3839 pattern: '[1-5]\d\d'
3840 type: string
3841 required:
3842 - restApiId
3843 - resourceId
3844 - httpMethod
3845 - statusCode
3846 type: object
3847 UpdateMethodRequest:
3848 properties:
3849 httpMethod:
3850 type: string
3851 patchOperations:
3852 items:
3853 properties:
3854 from:
3855 type: string
3856 op:
3857 enum:
3858 - add
3859 - remove
3860 - replace
3861 - move
3862 - copy
3863 - test
3864 type: string
3865 path:
3866 type: string
3867 value:
3868 type: string
3869 type: object
3870 type: array
3871 resourceId:
3872 type: string
3873 restApiId:
3874 type: string
3875 required:
3876 - restApiId
3877 - resourceId
3878 - httpMethod
3879 type: object
3880 UpdateMethodResponseRequest:
3881 properties:
3882 httpMethod:
3883 type: string
3884 patchOperations:
3885 items:
3886 properties:
3887 from:
3888 type: string
3889 op:
3890 enum:
3891 - add
3892 - remove
3893 - replace
3894 - move
3895 - copy
3896 - test
3897 type: string
3898 path:
3899 type: string
3900 value:
3901 type: string
3902 type: object
3903 type: array
3904 resourceId:
3905 type: string
3906 restApiId:
3907 type: string
3908 statusCode:
3909 pattern: '[1-5]\d\d'
3910 type: string
3911 required:
3912 - restApiId
3913 - resourceId
3914 - httpMethod
3915 - statusCode
3916 type: object
3917 UpdateModelRequest:
3918 properties:
3919 modelName:
3920 type: string
3921 patchOperations:
3922 items:
3923 properties:
3924 from:
3925 type: string
3926 op:
3927 enum:
3928 - add
3929 - remove
3930 - replace
3931 - move
3932 - copy
3933 - test
3934 type: string
3935 path:
3936 type: string
3937 value:
3938 type: string
3939 type: object
3940 type: array
3941 restApiId:
3942 type: string
3943 required:
3944 - restApiId
3945 - modelName
3946 type: object
3947 UpdateRequestValidatorRequest:
3948 properties:
3949 patchOperations:
3950 items:
3951 properties:
3952 from:
3953 type: string
3954 op:
3955 enum:
3956 - add
3957 - remove
3958 - replace
3959 - move
3960 - copy
3961 - test
3962 type: string
3963 path:
3964 type: string
3965 value:
3966 type: string
3967 type: object
3968 type: array
3969 requestValidatorId:
3970 type: string
3971 restApiId:
3972 type: string
3973 required:
3974 - restApiId
3975 - requestValidatorId
3976 type: object
3977 UpdateResourceRequest:
3978 properties:
3979 patchOperations:
3980 items:
3981 properties:
3982 from:
3983 type: string
3984 op:
3985 enum:
3986 - add
3987 - remove
3988 - replace
3989 - move
3990 - copy
3991 - test
3992 type: string
3993 path:
3994 type: string
3995 value:
3996 type: string
3997 type: object
3998 type: array
3999 resourceId:
4000 type: string
4001 restApiId:
4002 type: string
4003 required:
4004 - restApiId
4005 - resourceId
4006 type: object
4007 UpdateRestApiRequest:
4008 properties:
4009 patchOperations:
4010 items:
4011 properties:
4012 from:
4013 type: string
4014 op:
4015 enum:
4016 - add
4017 - remove
4018 - replace
4019 - move
4020 - copy
4021 - test
4022 type: string
4023 path:
4024 type: string
4025 value:
4026 type: string
4027 type: object
4028 type: array
4029 restApiId:
4030 type: string
4031 required:
4032 - restApiId
4033 type: object
4034 UpdateStageRequest:
4035 properties:
4036 patchOperations:
4037 items:
4038 properties:
4039 from:
4040 type: string
4041 op:
4042 enum:
4043 - add
4044 - remove
4045 - replace
4046 - move
4047 - copy
4048 - test
4049 type: string
4050 path:
4051 type: string
4052 value:
4053 type: string
4054 type: object
4055 type: array
4056 restApiId:
4057 type: string
4058 stageName:
4059 type: string
4060 required:
4061 - restApiId
4062 - stageName
4063 type: object
4064 UpdateUsagePlanRequest:
4065 properties:
4066 patchOperations:
4067 items:
4068 properties:
4069 from:
4070 type: string
4071 op:
4072 enum:
4073 - add
4074 - remove
4075 - replace
4076 - move
4077 - copy
4078 - test
4079 type: string
4080 path:
4081 type: string
4082 value:
4083 type: string
4084 type: object
4085 type: array
4086 usagePlanId:
4087 type: string
4088 required:
4089 - usagePlanId
4090 type: object
4091 UpdateUsageRequest:
4092 properties:
4093 keyId:
4094 type: string
4095 patchOperations:
4096 items:
4097 properties:
4098 from:
4099 type: string
4100 op:
4101 enum:
4102 - add
4103 - remove
4104 - replace
4105 - move
4106 - copy
4107 - test
4108 type: string
4109 path:
4110 type: string
4111 value:
4112 type: string
4113 type: object
4114 type: array
4115 usagePlanId:
4116 type: string
4117 required:
4118 - usagePlanId
4119 - keyId
4120 type: object
4121 UpdateVpcLinkRequest:
4122 properties:
4123 patchOperations:
4124 items:
4125 properties:
4126 from:
4127 type: string
4128 op:
4129 enum:
4130 - add
4131 - remove
4132 - replace
4133 - move
4134 - copy
4135 - test
4136 type: string
4137 path:
4138 type: string
4139 value:
4140 type: string
4141 type: object
4142 type: array
4143 vpcLinkId:
4144 type: string
4145 required:
4146 - vpcLinkId
4147 type: object
4148 Usage:
4149 properties:
4150 endDate:
4151 type: string
4152 items:
4153 additionalProperties: true
4154 type: object
4155 position:
4156 type: string
4157 startDate:
4158 type: string
4159 usagePlanId:
4160 type: string
4161 type: object
4162 UsagePlan:
4163 properties:
4164 apiStages:
4165 items:
4166 properties:
4167 apiId:
4168 type: string
4169 stage:
4170 type: string
4171 throttle:
4172 additionalProperties: true
4173 type: object
4174 type: object
4175 type: array
4176 description:
4177 type: string
4178 id:
4179 type: string
4180 name:
4181 type: string
4182 productCode:
4183 type: string
4184 quota:
4185 $ref: '#/components/schemas/QuotaSettings'
4186 tags:
4187 additionalProperties: true
4188 type: object
4189 throttle:
4190 $ref: '#/components/schemas/ThrottleSettings'
4191 type: object
4192 UsagePlanKey:
4193 properties:
4194 id:
4195 type: string
4196 name:
4197 type: string
4198 type:
4199 type: string
4200 value:
4201 type: string
4202 type: object
4203 UsagePlanKeys:
4204 properties:
4205 items:
4206 items:
4207 properties:
4208 id:
4209 type: string
4210 name:
4211 type: string
4212 type:
4213 type: string
4214 value:
4215 type: string
4216 type: object
4217 type: array
4218 position:
4219 type: string
4220 type: object
4221 UsagePlans:
4222 properties:
4223 items:
4224 items:
4225 properties:
4226 apiStages:
4227 items:
4228 properties:
4229 apiId:
4230 type: string
4231 stage:
4232 type: string
4233 throttle:
4234 additionalProperties: true
4235 type: object
4236 type: object
4237 type: array
4238 description:
4239 type: string
4240 id:
4241 type: string
4242 name:
4243 type: string
4244 productCode:
4245 type: string
4246 quota:
4247 $ref: '#/components/schemas/QuotaSettings'
4248 tags:
4249 additionalProperties: true
4250 type: object
4251 throttle:
4252 $ref: '#/components/schemas/ThrottleSettings'
4253 type: object
4254 type: array
4255 position:
4256 type: string
4257 type: object
4258 VpcLink:
4259 properties:
4260 description:
4261 type: string
4262 id:
4263 type: string
4264 name:
4265 type: string
4266 status:
4267 enum:
4268 - AVAILABLE
4269 - PENDING
4270 - DELETING
4271 - FAILED
4272 type: string
4273 statusMessage:
4274 type: string
4275 tags:
4276 additionalProperties: true
4277 type: object
4278 targetArns:
4279 items:
4280 type: string
4281 type: array
4282 type: object
4283 VpcLinkStatus:
4284 enum:
4285 - AVAILABLE
4286 - PENDING
4287 - DELETING
4288 - FAILED
4289 type: string
4290 VpcLinks:
4291 properties:
4292 items:
4293 items:
4294 properties:
4295 description:
4296 type: string
4297 id:
4298 type: string
4299 name:
4300 type: string
4301 status:
4302 enum:
4303 - AVAILABLE
4304 - PENDING
4305 - DELETING
4306 - FAILED
4307 type: string
4308 statusMessage:
4309 type: string
4310 tags:
4311 additionalProperties: true
4312 type: object
4313 targetArns:
4314 items:
4315 type: string
4316 type: array
4317 type: object
4318 type: array
4319 position:
4320 type: string
4321 type: object
4322info:
4323 description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps
4324 developers deliver robust, secure, and scalable mobile and web application back
4325 ends. API Gateway allows developers to securely connect mobile and web applications
4326 to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web
4327 services that are hosted outside of AWS.</p>
4328 title: Amazon API Gateway
4329 version: "2015-07-09"
4330 x-aws-api-alias: apigateway
4331 x-aws-api-protocol: rest-json
4332openapi: 3.0.0
4333paths:
4334 /account:
4335 get:
4336 description: <p>Gets information about the current <a>Account</a> resource.</p>
4337 operationId: GetAccount
4338 requestBody:
4339 content:
4340 application/json:
4341 schema:
4342 $ref: '#/components/schemas/GetAccountRequest'
4343 responses:
4344 "200":
4345 content:
4346 application/json:
4347 schema:
4348 $ref: '#/components/schemas/Account'
4349 patch:
4350 description: <p>Changes information about the current <a>Account</a> resource.</p>
4351 operationId: UpdateAccount
4352 requestBody:
4353 content:
4354 application/json:
4355 schema:
4356 $ref: '#/components/schemas/UpdateAccountRequest'
4357 responses:
4358 "200":
4359 content:
4360 application/json:
4361 schema:
4362 $ref: '#/components/schemas/Account'
4363 /apikeys:
4364 get:
4365 description: <p>Gets information about the current <a>ApiKeys</a> resource.</p>
4366 operationId: GetApiKeys
4367 requestBody:
4368 content:
4369 application/json:
4370 schema:
4371 $ref: '#/components/schemas/GetApiKeysRequest'
4372 responses:
4373 "200":
4374 content:
4375 application/json:
4376 schema:
4377 $ref: '#/components/schemas/ApiKeys'
4378 post:
4379 description: <p>Create an <a>ApiKey</a> resource. </p> <div class="seeAlso"><a
4380 href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html">AWS
4381 CLI</a></div>
4382 operationId: CreateApiKey
4383 requestBody:
4384 content:
4385 application/json:
4386 schema:
4387 $ref: '#/components/schemas/CreateApiKeyRequest'
4388 responses:
4389 "201":
4390 content:
4391 application/json:
4392 schema:
4393 $ref: '#/components/schemas/ApiKey'
4394 /apikeys/{api_Key}:
4395 delete:
4396 description: <p>Deletes the <a>ApiKey</a> resource.</p>
4397 operationId: DeleteApiKey
4398 requestBody:
4399 content:
4400 application/json:
4401 schema:
4402 $ref: '#/components/schemas/DeleteApiKeyRequest'
4403 responses: null
4404 get:
4405 description: <p>Gets information about the current <a>ApiKey</a> resource.</p>
4406 operationId: GetApiKey
4407 requestBody:
4408 content:
4409 application/json:
4410 schema:
4411 $ref: '#/components/schemas/GetApiKeyRequest'
4412 responses:
4413 "200":
4414 content:
4415 application/json:
4416 schema:
4417 $ref: '#/components/schemas/ApiKey'
4418 patch:
4419 description: <p>Changes information about an <a>ApiKey</a> resource.</p>
4420 operationId: UpdateApiKey
4421 requestBody:
4422 content:
4423 application/json:
4424 schema:
4425 $ref: '#/components/schemas/UpdateApiKeyRequest'
4426 responses:
4427 "200":
4428 content:
4429 application/json:
4430 schema:
4431 $ref: '#/components/schemas/ApiKey'
4432 /apikeys?mode=import:
4433 post:
4434 description: <p>Import API keys from an external source, such as a CSV-formatted
4435 file.</p>
4436 operationId: ImportApiKeys
4437 requestBody:
4438 content:
4439 application/json:
4440 schema:
4441 $ref: '#/components/schemas/ImportApiKeysRequest'
4442 responses:
4443 "201":
4444 content:
4445 application/json:
4446 schema:
4447 $ref: '#/components/schemas/ApiKeyIds'
4448 /clientcertificates:
4449 get:
4450 description: <p>Gets a collection of <a>ClientCertificate</a> resources.</p>
4451 operationId: GetClientCertificates
4452 requestBody:
4453 content:
4454 application/json:
4455 schema:
4456 $ref: '#/components/schemas/GetClientCertificatesRequest'
4457 responses:
4458 "200":
4459 content:
4460 application/json:
4461 schema:
4462 $ref: '#/components/schemas/ClientCertificates'
4463 post:
4464 description: <p>Generates a <a>ClientCertificate</a> resource.</p>
4465 operationId: GenerateClientCertificate
4466 requestBody:
4467 content:
4468 application/json:
4469 schema:
4470 $ref: '#/components/schemas/GenerateClientCertificateRequest'
4471 responses:
4472 "201":
4473 content:
4474 application/json:
4475 schema:
4476 $ref: '#/components/schemas/ClientCertificate'
4477 /clientcertificates/{clientcertificate_id}:
4478 delete:
4479 description: <p>Deletes the <a>ClientCertificate</a> resource.</p>
4480 operationId: DeleteClientCertificate
4481 requestBody:
4482 content:
4483 application/json:
4484 schema:
4485 $ref: '#/components/schemas/DeleteClientCertificateRequest'
4486 responses: null
4487 get:
4488 description: <p>Gets information about the current <a>ClientCertificate</a>
4489 resource.</p>
4490 operationId: GetClientCertificate
4491 requestBody:
4492 content:
4493 application/json:
4494 schema:
4495 $ref: '#/components/schemas/GetClientCertificateRequest'
4496 responses:
4497 "200":
4498 content:
4499 application/json:
4500 schema:
4501 $ref: '#/components/schemas/ClientCertificate'
4502 patch:
4503 description: <p>Changes information about an <a>ClientCertificate</a> resource.</p>
4504 operationId: UpdateClientCertificate
4505 requestBody:
4506 content:
4507 application/json:
4508 schema:
4509 $ref: '#/components/schemas/UpdateClientCertificateRequest'
4510 responses:
4511 "200":
4512 content:
4513 application/json:
4514 schema:
4515 $ref: '#/components/schemas/ClientCertificate'
4516 /domainnames:
4517 get:
4518 description: <p>Represents a collection of <a>DomainName</a> resources.</p>
4519 operationId: GetDomainNames
4520 requestBody:
4521 content:
4522 application/json:
4523 schema:
4524 $ref: '#/components/schemas/GetDomainNamesRequest'
4525 responses:
4526 "200":
4527 content:
4528 application/json:
4529 schema:
4530 $ref: '#/components/schemas/DomainNames'
4531 post:
4532 description: <p>Creates a new domain name.</p>
4533 operationId: CreateDomainName
4534 requestBody:
4535 content:
4536 application/json:
4537 schema:
4538 $ref: '#/components/schemas/CreateDomainNameRequest'
4539 responses:
4540 "201":
4541 content:
4542 application/json:
4543 schema:
4544 $ref: '#/components/schemas/DomainName'
4545 /domainnames/{domain_name}:
4546 delete:
4547 description: <p>Deletes the <a>DomainName</a> resource.</p>
4548 operationId: DeleteDomainName
4549 requestBody:
4550 content:
4551 application/json:
4552 schema:
4553 $ref: '#/components/schemas/DeleteDomainNameRequest'
4554 responses: null
4555 get:
4556 description: <p>Represents a domain name that is contained in a simpler, more
4557 intuitive URL that can be called.</p>
4558 operationId: GetDomainName
4559 requestBody:
4560 content:
4561 application/json:
4562 schema:
4563 $ref: '#/components/schemas/GetDomainNameRequest'
4564 responses:
4565 "200":
4566 content:
4567 application/json:
4568 schema:
4569 $ref: '#/components/schemas/DomainName'
4570 patch:
4571 description: <p>Changes information about the <a>DomainName</a> resource.</p>
4572 operationId: UpdateDomainName
4573 requestBody:
4574 content:
4575 application/json:
4576 schema:
4577 $ref: '#/components/schemas/UpdateDomainNameRequest'
4578 responses:
4579 "200":
4580 content:
4581 application/json:
4582 schema:
4583 $ref: '#/components/schemas/DomainName'
4584 /domainnames/{domain_name}/basepathmappings:
4585 get:
4586 description: <p>Represents a collection of <a>BasePathMapping</a> resources.</p>
4587 operationId: GetBasePathMappings
4588 requestBody:
4589 content:
4590 application/json:
4591 schema:
4592 $ref: '#/components/schemas/GetBasePathMappingsRequest'
4593 responses:
4594 "200":
4595 content:
4596 application/json:
4597 schema:
4598 $ref: '#/components/schemas/BasePathMappings'
4599 post:
4600 description: <p>Creates a new <a>BasePathMapping</a> resource.</p>
4601 operationId: CreateBasePathMapping
4602 requestBody:
4603 content:
4604 application/json:
4605 schema:
4606 $ref: '#/components/schemas/CreateBasePathMappingRequest'
4607 responses:
4608 "201":
4609 content:
4610 application/json:
4611 schema:
4612 $ref: '#/components/schemas/BasePathMapping'
4613 /domainnames/{domain_name}/basepathmappings/{base_path}:
4614 delete:
4615 description: <p>Deletes the <a>BasePathMapping</a> resource.</p>
4616 operationId: DeleteBasePathMapping
4617 requestBody:
4618 content:
4619 application/json:
4620 schema:
4621 $ref: '#/components/schemas/DeleteBasePathMappingRequest'
4622 responses: null
4623 get:
4624 description: <p>Describe a <a>BasePathMapping</a> resource.</p>
4625 operationId: GetBasePathMapping
4626 requestBody:
4627 content:
4628 application/json:
4629 schema:
4630 $ref: '#/components/schemas/GetBasePathMappingRequest'
4631 responses:
4632 "200":
4633 content:
4634 application/json:
4635 schema:
4636 $ref: '#/components/schemas/BasePathMapping'
4637 patch:
4638 description: <p>Changes information about the <a>BasePathMapping</a> resource.</p>
4639 operationId: UpdateBasePathMapping
4640 requestBody:
4641 content:
4642 application/json:
4643 schema:
4644 $ref: '#/components/schemas/UpdateBasePathMappingRequest'
4645 responses:
4646 "200":
4647 content:
4648 application/json:
4649 schema:
4650 $ref: '#/components/schemas/BasePathMapping'
4651 /restapis:
4652 get:
4653 description: <p>Lists the <a>RestApis</a> resources for your collection.</p>
4654 operationId: GetRestApis
4655 requestBody:
4656 content:
4657 application/json:
4658 schema:
4659 $ref: '#/components/schemas/GetRestApisRequest'
4660 responses:
4661 "200":
4662 content:
4663 application/json:
4664 schema:
4665 $ref: '#/components/schemas/RestApis'
4666 post:
4667 description: <p>Creates a new <a>RestApi</a> resource.</p>
4668 operationId: CreateRestApi
4669 requestBody:
4670 content:
4671 application/json:
4672 schema:
4673 $ref: '#/components/schemas/CreateRestApiRequest'
4674 responses:
4675 "201":
4676 content:
4677 application/json:
4678 schema:
4679 $ref: '#/components/schemas/RestApi'
4680 /restapis/{restapi_id}:
4681 delete:
4682 description: <p>Deletes the specified API.</p>
4683 operationId: DeleteRestApi
4684 requestBody:
4685 content:
4686 application/json:
4687 schema:
4688 $ref: '#/components/schemas/DeleteRestApiRequest'
4689 responses: null
4690 get:
4691 description: <p>Lists the <a>RestApi</a> resource in the collection.</p>
4692 operationId: GetRestApi
4693 requestBody:
4694 content:
4695 application/json:
4696 schema:
4697 $ref: '#/components/schemas/GetRestApiRequest'
4698 responses:
4699 "200":
4700 content:
4701 application/json:
4702 schema:
4703 $ref: '#/components/schemas/RestApi'
4704 patch:
4705 description: <p>Changes information about the specified API.</p>
4706 operationId: UpdateRestApi
4707 requestBody:
4708 content:
4709 application/json:
4710 schema:
4711 $ref: '#/components/schemas/UpdateRestApiRequest'
4712 responses:
4713 "200":
4714 content:
4715 application/json:
4716 schema:
4717 $ref: '#/components/schemas/RestApi'
4718 put:
4719 description: <p>A feature of the API Gateway control service for updating an
4720 existing API with an input of external API definitions. The update can take
4721 the form of merging the supplied definition into the existing API or overwriting
4722 the existing API.</p>
4723 operationId: PutRestApi
4724 requestBody:
4725 content:
4726 application/json:
4727 schema:
4728 $ref: '#/components/schemas/PutRestApiRequest'
4729 responses:
4730 "200":
4731 content:
4732 application/json:
4733 schema:
4734 $ref: '#/components/schemas/RestApi'
4735 /restapis/{restapi_id}/authorizers:
4736 get:
4737 description: <p>Describe an existing <a>Authorizers</a> resource.</p> <div class="seeAlso"><a
4738 href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html">AWS
4739 CLI</a></div>
4740 operationId: GetAuthorizers
4741 requestBody:
4742 content:
4743 application/json:
4744 schema:
4745 $ref: '#/components/schemas/GetAuthorizersRequest'
4746 responses:
4747 "200":
4748 content:
4749 application/json:
4750 schema:
4751 $ref: '#/components/schemas/Authorizers'
4752 post:
4753 description: <p>Adds a new <a>Authorizer</a> resource to an existing <a>RestApi</a>
4754 resource.</p> <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html">AWS
4755 CLI</a></div>
4756 operationId: CreateAuthorizer
4757 requestBody:
4758 content:
4759 application/json:
4760 schema:
4761 $ref: '#/components/schemas/CreateAuthorizerRequest'
4762 responses:
4763 "201":
4764 content:
4765 application/json:
4766 schema:
4767 $ref: '#/components/schemas/Authorizer'
4768 /restapis/{restapi_id}/authorizers/{authorizer_id}:
4769 delete:
4770 description: <p>Deletes an existing <a>Authorizer</a> resource.</p> <div class="seeAlso"><a
4771 href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html">AWS
4772 CLI</a></div>
4773 operationId: DeleteAuthorizer
4774 requestBody:
4775 content:
4776 application/json:
4777 schema:
4778 $ref: '#/components/schemas/DeleteAuthorizerRequest'
4779 responses: null
4780 get:
4781 description: <p>Describe an existing <a>Authorizer</a> resource.</p> <div class="seeAlso"><a
4782 href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html">AWS
4783 CLI</a></div>
4784 operationId: GetAuthorizer
4785 requestBody:
4786 content:
4787 application/json:
4788 schema:
4789 $ref: '#/components/schemas/GetAuthorizerRequest'
4790 responses:
4791 "200":
4792 content:
4793 application/json:
4794 schema:
4795 $ref: '#/components/schemas/Authorizer'
4796 patch:
4797 description: <p>Updates an existing <a>Authorizer</a> resource.</p> <div class="seeAlso"><a
4798 href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html">AWS
4799 CLI</a></div>
4800 operationId: UpdateAuthorizer
4801 requestBody:
4802 content:
4803 application/json:
4804 schema:
4805 $ref: '#/components/schemas/UpdateAuthorizerRequest'
4806 responses:
4807 "200":
4808 content:
4809 application/json:
4810 schema:
4811 $ref: '#/components/schemas/Authorizer'
4812 post:
4813 description: <p>Simulate the execution of an <a>Authorizer</a> in your <a>RestApi</a>
4814 with headers, parameters, and an incoming request body.</p> <div class="seeAlso">
4815 <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html">Use
4816 Lambda Function as Authorizer</a> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html">Use
4817 Cognito User Pool as Authorizer</a> </div>
4818 operationId: TestInvokeAuthorizer
4819 requestBody:
4820 content:
4821 application/json:
4822 schema:
4823 $ref: '#/components/schemas/TestInvokeAuthorizerRequest'
4824 responses:
4825 "200":
4826 content:
4827 application/json:
4828 schema:
4829 $ref: '#/components/schemas/TestInvokeAuthorizerResponse'
4830 /restapis/{restapi_id}/deployments:
4831 get:
4832 description: <p>Gets information about a <a>Deployments</a> collection.</p>
4833 operationId: GetDeployments
4834 requestBody:
4835 content:
4836 application/json:
4837 schema:
4838 $ref: '#/components/schemas/GetDeploymentsRequest'
4839 responses:
4840 "200":
4841 content:
4842 application/json:
4843 schema:
4844 $ref: '#/components/schemas/Deployments'
4845 post:
4846 description: <p>Creates a <a>Deployment</a> resource, which makes a specified
4847 <a>RestApi</a> callable over the internet.</p>
4848 operationId: CreateDeployment
4849 requestBody:
4850 content:
4851 application/json:
4852 schema:
4853 $ref: '#/components/schemas/CreateDeploymentRequest'
4854 responses:
4855 "201":
4856 content:
4857 application/json:
4858 schema:
4859 $ref: '#/components/schemas/Deployment'
4860 /restapis/{restapi_id}/deployments/{deployment_id}:
4861 delete:
4862 description: <p>Deletes a <a>Deployment</a> resource. Deleting a deployment
4863 will only succeed if there are no <a>Stage</a> resources associated with it.</p>
4864 operationId: DeleteDeployment
4865 requestBody:
4866 content:
4867 application/json:
4868 schema:
4869 $ref: '#/components/schemas/DeleteDeploymentRequest'
4870 responses: null
4871 get:
4872 description: <p>Gets information about a <a>Deployment</a> resource.</p>
4873 operationId: GetDeployment
4874 requestBody:
4875 content:
4876 application/json:
4877 schema:
4878 $ref: '#/components/schemas/GetDeploymentRequest'
4879 responses:
4880 "200":
4881 content:
4882 application/json:
4883 schema:
4884 $ref: '#/components/schemas/Deployment'
4885 patch:
4886 description: <p>Changes information about a <a>Deployment</a> resource.</p>
4887 operationId: UpdateDeployment
4888 requestBody:
4889 content:
4890 application/json:
4891 schema:
4892 $ref: '#/components/schemas/UpdateDeploymentRequest'
4893 responses:
4894 "200":
4895 content:
4896 application/json:
4897 schema:
4898 $ref: '#/components/schemas/Deployment'
4899 /restapis/{restapi_id}/documentation/parts:
4900 get:
4901 operationId: GetDocumentationParts
4902 requestBody:
4903 content:
4904 application/json:
4905 schema:
4906 $ref: '#/components/schemas/GetDocumentationPartsRequest'
4907 responses:
4908 "200":
4909 content:
4910 application/json:
4911 schema:
4912 $ref: '#/components/schemas/DocumentationParts'
4913 post:
4914 operationId: CreateDocumentationPart
4915 requestBody:
4916 content:
4917 application/json:
4918 schema:
4919 $ref: '#/components/schemas/CreateDocumentationPartRequest'
4920 responses:
4921 "201":
4922 content:
4923 application/json:
4924 schema:
4925 $ref: '#/components/schemas/DocumentationPart'
4926 put:
4927 operationId: ImportDocumentationParts
4928 requestBody:
4929 content:
4930 application/json:
4931 schema:
4932 $ref: '#/components/schemas/ImportDocumentationPartsRequest'
4933 responses:
4934 "200":
4935 content:
4936 application/json:
4937 schema:
4938 $ref: '#/components/schemas/DocumentationPartIds'
4939 /restapis/{restapi_id}/documentation/parts/{part_id}:
4940 delete:
4941 operationId: DeleteDocumentationPart
4942 requestBody:
4943 content:
4944 application/json:
4945 schema:
4946 $ref: '#/components/schemas/DeleteDocumentationPartRequest'
4947 responses: null
4948 get:
4949 operationId: GetDocumentationPart
4950 requestBody:
4951 content:
4952 application/json:
4953 schema:
4954 $ref: '#/components/schemas/GetDocumentationPartRequest'
4955 responses:
4956 "200":
4957 content:
4958 application/json:
4959 schema:
4960 $ref: '#/components/schemas/DocumentationPart'
4961 patch:
4962 operationId: UpdateDocumentationPart
4963 requestBody:
4964 content:
4965 application/json:
4966 schema:
4967 $ref: '#/components/schemas/UpdateDocumentationPartRequest'
4968 responses:
4969 "200":
4970 content:
4971 application/json:
4972 schema:
4973 $ref: '#/components/schemas/DocumentationPart'
4974 /restapis/{restapi_id}/documentation/versions:
4975 get:
4976 operationId: GetDocumentationVersions
4977 requestBody:
4978 content:
4979 application/json:
4980 schema:
4981 $ref: '#/components/schemas/GetDocumentationVersionsRequest'
4982 responses:
4983 "200":
4984 content:
4985 application/json:
4986 schema:
4987 $ref: '#/components/schemas/DocumentationVersions'
4988 post:
4989 operationId: CreateDocumentationVersion
4990 requestBody:
4991 content:
4992 application/json:
4993 schema:
4994 $ref: '#/components/schemas/CreateDocumentationVersionRequest'
4995 responses:
4996 "201":
4997 content:
4998 application/json:
4999 schema:
5000 $ref: '#/components/schemas/DocumentationVersion'
5001 /restapis/{restapi_id}/documentation/versions/{doc_version}:
5002 delete:
5003 operationId: DeleteDocumentationVersion
5004 requestBody:
5005 content:
5006 application/json:
5007 schema:
5008 $ref: '#/components/schemas/DeleteDocumentationVersionRequest'
5009 responses: null
5010 get:
5011 operationId: GetDocumentationVersion
5012 requestBody:
5013 content:
5014 application/json:
5015 schema:
5016 $ref: '#/components/schemas/GetDocumentationVersionRequest'
5017 responses:
5018 "200":
5019 content:
5020 application/json:
5021 schema:
5022 $ref: '#/components/schemas/DocumentationVersion'
5023 patch:
5024 operationId: UpdateDocumentationVersion
5025 requestBody:
5026 content:
5027 application/json:
5028 schema:
5029 $ref: '#/components/schemas/UpdateDocumentationVersionRequest'
5030 responses:
5031 "200":
5032 content:
5033 application/json:
5034 schema:
5035 $ref: '#/components/schemas/DocumentationVersion'
5036 /restapis/{restapi_id}/gatewayresponses:
5037 get:
5038 description: <p>Gets the <a>GatewayResponses</a> collection on the given <a>RestApi</a>.
5039 If an API developer has not added any definitions for gateway responses, the
5040 result will be the API Gateway-generated default <a>GatewayResponses</a> collection
5041 for the supported response types.</p>
5042 operationId: GetGatewayResponses
5043 requestBody:
5044 content:
5045 application/json:
5046 schema:
5047 $ref: '#/components/schemas/GetGatewayResponsesRequest'
5048 responses:
5049 "200":
5050 content:
5051 application/json:
5052 schema:
5053 $ref: '#/components/schemas/GatewayResponses'
5054 /restapis/{restapi_id}/gatewayresponses/{response_type}:
5055 delete:
5056 description: <p>Clears any customization of a <a>GatewayResponse</a> of a specified
5057 response type on the given <a>RestApi</a> and resets it with the default settings.</p>
5058 operationId: DeleteGatewayResponse
5059 requestBody:
5060 content:
5061 application/json:
5062 schema:
5063 $ref: '#/components/schemas/DeleteGatewayResponseRequest'
5064 responses: null
5065 get:
5066 description: <p>Gets a <a>GatewayResponse</a> of a specified response type on
5067 the given <a>RestApi</a>.</p>
5068 operationId: GetGatewayResponse
5069 requestBody:
5070 content:
5071 application/json:
5072 schema:
5073 $ref: '#/components/schemas/GetGatewayResponseRequest'
5074 responses:
5075 "200":
5076 content:
5077 application/json:
5078 schema:
5079 $ref: '#/components/schemas/GatewayResponse'
5080 patch:
5081 description: <p>Updates a <a>GatewayResponse</a> of a specified response type
5082 on the given <a>RestApi</a>.</p>
5083 operationId: UpdateGatewayResponse
5084 requestBody:
5085 content:
5086 application/json:
5087 schema:
5088 $ref: '#/components/schemas/UpdateGatewayResponseRequest'
5089 responses:
5090 "200":
5091 content:
5092 application/json:
5093 schema:
5094 $ref: '#/components/schemas/GatewayResponse'
5095 put:
5096 description: <p>Creates a customization of a <a>GatewayResponse</a> of a specified
5097 response type and status code on the given <a>RestApi</a>.</p>
5098 operationId: PutGatewayResponse
5099 requestBody:
5100 content:
5101 application/json:
5102 schema:
5103 $ref: '#/components/schemas/PutGatewayResponseRequest'
5104 responses:
5105 "201":
5106 content:
5107 application/json:
5108 schema:
5109 $ref: '#/components/schemas/GatewayResponse'
5110 /restapis/{restapi_id}/models:
5111 get:
5112 description: <p>Describes existing <a>Models</a> defined for a <a>RestApi</a>
5113 resource.</p>
5114 operationId: GetModels
5115 requestBody:
5116 content:
5117 application/json:
5118 schema:
5119 $ref: '#/components/schemas/GetModelsRequest'
5120 responses:
5121 "200":
5122 content:
5123 application/json:
5124 schema:
5125 $ref: '#/components/schemas/Models'
5126 post:
5127 description: <p>Adds a new <a>Model</a> resource to an existing <a>RestApi</a>
5128 resource.</p>
5129 operationId: CreateModel
5130 requestBody:
5131 content:
5132 application/json:
5133 schema:
5134 $ref: '#/components/schemas/CreateModelRequest'
5135 responses:
5136 "201":
5137 content:
5138 application/json:
5139 schema:
5140 $ref: '#/components/schemas/Model'
5141 /restapis/{restapi_id}/models/{model_name}:
5142 delete:
5143 description: <p>Deletes a model.</p>
5144 operationId: DeleteModel
5145 requestBody:
5146 content:
5147 application/json:
5148 schema:
5149 $ref: '#/components/schemas/DeleteModelRequest'
5150 responses: null
5151 get:
5152 description: <p>Describes an existing model defined for a <a>RestApi</a> resource.</p>
5153 operationId: GetModel
5154 requestBody:
5155 content:
5156 application/json:
5157 schema:
5158 $ref: '#/components/schemas/GetModelRequest'
5159 responses:
5160 "200":
5161 content:
5162 application/json:
5163 schema:
5164 $ref: '#/components/schemas/Model'
5165 patch:
5166 description: <p>Changes information about a model.</p>
5167 operationId: UpdateModel
5168 requestBody:
5169 content:
5170 application/json:
5171 schema:
5172 $ref: '#/components/schemas/UpdateModelRequest'
5173 responses:
5174 "200":
5175 content:
5176 application/json:
5177 schema:
5178 $ref: '#/components/schemas/Model'
5179 /restapis/{restapi_id}/models/{model_name}/default_template:
5180 get:
5181 description: <p>Generates a sample mapping template that can be used to transform
5182 a payload into the structure of a model.</p>
5183 operationId: GetModelTemplate
5184 requestBody:
5185 content:
5186 application/json:
5187 schema:
5188 $ref: '#/components/schemas/GetModelTemplateRequest'
5189 responses:
5190 "200":
5191 content:
5192 application/json:
5193 schema:
5194 $ref: '#/components/schemas/Template'
5195 /restapis/{restapi_id}/requestvalidators:
5196 get:
5197 description: <p>Gets the <a>RequestValidators</a> collection of a given <a>RestApi</a>.</p>
5198 operationId: GetRequestValidators
5199 requestBody:
5200 content:
5201 application/json:
5202 schema:
5203 $ref: '#/components/schemas/GetRequestValidatorsRequest'
5204 responses:
5205 "200":
5206 content:
5207 application/json:
5208 schema:
5209 $ref: '#/components/schemas/RequestValidators'
5210 post:
5211 description: <p>Creates a <a>ReqeustValidator</a> of a given <a>RestApi</a>.</p>
5212 operationId: CreateRequestValidator
5213 requestBody:
5214 content:
5215 application/json:
5216 schema:
5217 $ref: '#/components/schemas/CreateRequestValidatorRequest'
5218 responses:
5219 "201":
5220 content:
5221 application/json:
5222 schema:
5223 $ref: '#/components/schemas/RequestValidator'
5224 /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}:
5225 delete:
5226 description: <p>Deletes a <a>RequestValidator</a> of a given <a>RestApi</a>.</p>
5227 operationId: DeleteRequestValidator
5228 requestBody:
5229 content:
5230 application/json:
5231 schema:
5232 $ref: '#/components/schemas/DeleteRequestValidatorRequest'
5233 responses: null
5234 get:
5235 description: <p>Gets a <a>RequestValidator</a> of a given <a>RestApi</a>.</p>
5236 operationId: GetRequestValidator
5237 requestBody:
5238 content:
5239 application/json:
5240 schema:
5241 $ref: '#/components/schemas/GetRequestValidatorRequest'
5242 responses:
5243 "200":
5244 content:
5245 application/json:
5246 schema:
5247 $ref: '#/components/schemas/RequestValidator'
5248 patch:
5249 description: <p>Updates a <a>RequestValidator</a> of a given <a>RestApi</a>.</p>
5250 operationId: UpdateRequestValidator
5251 requestBody:
5252 content:
5253 application/json:
5254 schema:
5255 $ref: '#/components/schemas/UpdateRequestValidatorRequest'
5256 responses:
5257 "200":
5258 content:
5259 application/json:
5260 schema:
5261 $ref: '#/components/schemas/RequestValidator'
5262 /restapis/{restapi_id}/resources:
5263 get:
5264 description: <p>Lists information about a collection of <a>Resource</a> resources.</p>
5265 operationId: GetResources
5266 requestBody:
5267 content:
5268 application/json:
5269 schema:
5270 $ref: '#/components/schemas/GetResourcesRequest'
5271 responses:
5272 "200":
5273 content:
5274 application/json:
5275 schema:
5276 $ref: '#/components/schemas/Resources'
5277 /restapis/{restapi_id}/resources/{parent_id}:
5278 post:
5279 description: <p>Creates a <a>Resource</a> resource.</p>
5280 operationId: CreateResource
5281 requestBody:
5282 content:
5283 application/json:
5284 schema:
5285 $ref: '#/components/schemas/CreateResourceRequest'
5286 responses:
5287 "201":
5288 content:
5289 application/json:
5290 schema:
5291 $ref: '#/components/schemas/Resource'
5292 /restapis/{restapi_id}/resources/{resource_id}:
5293 delete:
5294 description: <p>Deletes a <a>Resource</a> resource.</p>
5295 operationId: DeleteResource
5296 requestBody:
5297 content:
5298 application/json:
5299 schema:
5300 $ref: '#/components/schemas/DeleteResourceRequest'
5301 responses: null
5302 get:
5303 description: <p>Lists information about a resource.</p>
5304 operationId: GetResource
5305 requestBody:
5306 content:
5307 application/json:
5308 schema:
5309 $ref: '#/components/schemas/GetResourceRequest'
5310 responses:
5311 "200":
5312 content:
5313 application/json:
5314 schema:
5315 $ref: '#/components/schemas/Resource'
5316 patch:
5317 description: <p>Changes information about a <a>Resource</a> resource.</p>
5318 operationId: UpdateResource
5319 requestBody:
5320 content:
5321 application/json:
5322 schema:
5323 $ref: '#/components/schemas/UpdateResourceRequest'
5324 responses:
5325 "200":
5326 content:
5327 application/json:
5328 schema:
5329 $ref: '#/components/schemas/Resource'
5330 /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}:
5331 delete:
5332 description: <p>Deletes an existing <a>Method</a> resource.</p>
5333 operationId: DeleteMethod
5334 requestBody:
5335 content:
5336 application/json:
5337 schema:
5338 $ref: '#/components/schemas/DeleteMethodRequest'
5339 responses: null
5340 get:
5341 description: <p>Describe an existing <a>Method</a> resource.</p>
5342 operationId: GetMethod
5343 requestBody:
5344 content:
5345 application/json:
5346 schema:
5347 $ref: '#/components/schemas/GetMethodRequest'
5348 responses:
5349 "200":
5350 content:
5351 application/json:
5352 schema:
5353 $ref: '#/components/schemas/Method'
5354 patch:
5355 description: <p>Updates an existing <a>Method</a> resource.</p>
5356 operationId: UpdateMethod
5357 requestBody:
5358 content:
5359 application/json:
5360 schema:
5361 $ref: '#/components/schemas/UpdateMethodRequest'
5362 responses:
5363 "200":
5364 content:
5365 application/json:
5366 schema:
5367 $ref: '#/components/schemas/Method'
5368 post:
5369 description: <p>Simulate the execution of a <a>Method</a> in your <a>RestApi</a>
5370 with headers, parameters, and an incoming request body.</p>
5371 operationId: TestInvokeMethod
5372 requestBody:
5373 content:
5374 application/json:
5375 schema:
5376 $ref: '#/components/schemas/TestInvokeMethodRequest'
5377 responses:
5378 "200":
5379 content:
5380 application/json:
5381 schema:
5382 $ref: '#/components/schemas/TestInvokeMethodResponse'
5383 put:
5384 description: <p>Add a method to an existing <a>Resource</a> resource.</p>
5385 operationId: PutMethod
5386 requestBody:
5387 content:
5388 application/json:
5389 schema:
5390 $ref: '#/components/schemas/PutMethodRequest'
5391 responses:
5392 "201":
5393 content:
5394 application/json:
5395 schema:
5396 $ref: '#/components/schemas/Method'
5397 /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration:
5398 delete:
5399 description: <p>Represents a delete integration.</p>
5400 operationId: DeleteIntegration
5401 requestBody:
5402 content:
5403 application/json:
5404 schema:
5405 $ref: '#/components/schemas/DeleteIntegrationRequest'
5406 responses: null
5407 get:
5408 description: <p>Get the integration settings.</p>
5409 operationId: GetIntegration
5410 requestBody:
5411 content:
5412 application/json:
5413 schema:
5414 $ref: '#/components/schemas/GetIntegrationRequest'
5415 responses:
5416 "200":
5417 content:
5418 application/json:
5419 schema:
5420 $ref: '#/components/schemas/Integration'
5421 patch:
5422 description: <p>Represents an update integration.</p>
5423 operationId: UpdateIntegration
5424 requestBody:
5425 content:
5426 application/json:
5427 schema:
5428 $ref: '#/components/schemas/UpdateIntegrationRequest'
5429 responses:
5430 "200":
5431 content:
5432 application/json:
5433 schema:
5434 $ref: '#/components/schemas/Integration'
5435 put:
5436 description: <p>Sets up a method's integration.</p>
5437 operationId: PutIntegration
5438 requestBody:
5439 content:
5440 application/json:
5441 schema:
5442 $ref: '#/components/schemas/PutIntegrationRequest'
5443 responses:
5444 "201":
5445 content:
5446 application/json:
5447 schema:
5448 $ref: '#/components/schemas/Integration'
5449 /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}:
5450 delete:
5451 description: <p>Represents a delete integration response.</p>
5452 operationId: DeleteIntegrationResponse
5453 requestBody:
5454 content:
5455 application/json:
5456 schema:
5457 $ref: '#/components/schemas/DeleteIntegrationResponseRequest'
5458 responses: null
5459 get:
5460 description: <p>Represents a get integration response.</p>
5461 operationId: GetIntegrationResponse
5462 requestBody:
5463 content:
5464 application/json:
5465 schema:
5466 $ref: '#/components/schemas/GetIntegrationResponseRequest'
5467 responses:
5468 "200":
5469 content:
5470 application/json:
5471 schema:
5472 $ref: '#/components/schemas/IntegrationResponse'
5473 patch:
5474 description: <p>Represents an update integration response.</p>
5475 operationId: UpdateIntegrationResponse
5476 requestBody:
5477 content:
5478 application/json:
5479 schema:
5480 $ref: '#/components/schemas/UpdateIntegrationResponseRequest'
5481 responses:
5482 "200":
5483 content:
5484 application/json:
5485 schema:
5486 $ref: '#/components/schemas/IntegrationResponse'
5487 put:
5488 description: <p>Represents a put integration.</p>
5489 operationId: PutIntegrationResponse
5490 requestBody:
5491 content:
5492 application/json:
5493 schema:
5494 $ref: '#/components/schemas/PutIntegrationResponseRequest'
5495 responses:
5496 "201":
5497 content:
5498 application/json:
5499 schema:
5500 $ref: '#/components/schemas/IntegrationResponse'
5501 /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}:
5502 delete:
5503 description: <p>Deletes an existing <a>MethodResponse</a> resource.</p>
5504 operationId: DeleteMethodResponse
5505 requestBody:
5506 content:
5507 application/json:
5508 schema:
5509 $ref: '#/components/schemas/DeleteMethodResponseRequest'
5510 responses: null
5511 get:
5512 description: <p>Describes a <a>MethodResponse</a> resource.</p>
5513 operationId: GetMethodResponse
5514 requestBody:
5515 content:
5516 application/json:
5517 schema:
5518 $ref: '#/components/schemas/GetMethodResponseRequest'
5519 responses:
5520 "200":
5521 content:
5522 application/json:
5523 schema:
5524 $ref: '#/components/schemas/MethodResponse'
5525 patch:
5526 description: <p>Updates an existing <a>MethodResponse</a> resource.</p>
5527 operationId: UpdateMethodResponse
5528 requestBody:
5529 content:
5530 application/json:
5531 schema:
5532 $ref: '#/components/schemas/UpdateMethodResponseRequest'
5533 responses:
5534 "201":
5535 content:
5536 application/json:
5537 schema:
5538 $ref: '#/components/schemas/MethodResponse'
5539 put:
5540 description: <p>Adds a <a>MethodResponse</a> to an existing <a>Method</a> resource.</p>
5541 operationId: PutMethodResponse
5542 requestBody:
5543 content:
5544 application/json:
5545 schema:
5546 $ref: '#/components/schemas/PutMethodResponseRequest'
5547 responses:
5548 "201":
5549 content:
5550 application/json:
5551 schema:
5552 $ref: '#/components/schemas/MethodResponse'
5553 /restapis/{restapi_id}/stages:
5554 get:
5555 description: <p>Gets information about one or more <a>Stage</a> resources.</p>
5556 operationId: GetStages
5557 requestBody:
5558 content:
5559 application/json:
5560 schema:
5561 $ref: '#/components/schemas/GetStagesRequest'
5562 responses:
5563 "200":
5564 content:
5565 application/json:
5566 schema:
5567 $ref: '#/components/schemas/Stages'
5568 post:
5569 description: <p>Creates a new <a>Stage</a> resource that references a pre-existing
5570 <a>Deployment</a> for the API. </p>
5571 operationId: CreateStage
5572 requestBody:
5573 content:
5574 application/json:
5575 schema:
5576 $ref: '#/components/schemas/CreateStageRequest'
5577 responses:
5578 "201":
5579 content:
5580 application/json:
5581 schema:
5582 $ref: '#/components/schemas/Stage'
5583 /restapis/{restapi_id}/stages/{stage_name}:
5584 delete:
5585 description: <p>Deletes a <a>Stage</a> resource.</p>
5586 operationId: DeleteStage
5587 requestBody:
5588 content:
5589 application/json:
5590 schema:
5591 $ref: '#/components/schemas/DeleteStageRequest'
5592 responses: null
5593 get:
5594 description: <p>Gets information about a <a>Stage</a> resource.</p>
5595 operationId: GetStage
5596 requestBody:
5597 content:
5598 application/json:
5599 schema:
5600 $ref: '#/components/schemas/GetStageRequest'
5601 responses:
5602 "200":
5603 content:
5604 application/json:
5605 schema:
5606 $ref: '#/components/schemas/Stage'
5607 patch:
5608 description: <p>Changes information about a <a>Stage</a> resource.</p>
5609 operationId: UpdateStage
5610 requestBody:
5611 content:
5612 application/json:
5613 schema:
5614 $ref: '#/components/schemas/UpdateStageRequest'
5615 responses:
5616 "200":
5617 content:
5618 application/json:
5619 schema:
5620 $ref: '#/components/schemas/Stage'
5621 /restapis/{restapi_id}/stages/{stage_name}/cache/authorizers:
5622 delete:
5623 description: <p>Flushes all authorizer cache entries on a stage.</p>
5624 operationId: FlushStageAuthorizersCache
5625 requestBody:
5626 content:
5627 application/json:
5628 schema:
5629 $ref: '#/components/schemas/FlushStageAuthorizersCacheRequest'
5630 responses: null
5631 /restapis/{restapi_id}/stages/{stage_name}/cache/data:
5632 delete:
5633 description: <p>Flushes a stage's cache.</p>
5634 operationId: FlushStageCache
5635 requestBody:
5636 content:
5637 application/json:
5638 schema:
5639 $ref: '#/components/schemas/FlushStageCacheRequest'
5640 responses: null
5641 /restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}:
5642 get:
5643 description: <p>Exports a deployed version of a <a>RestApi</a> in a specified
5644 format.</p>
5645 operationId: GetExport
5646 requestBody:
5647 content:
5648 application/json:
5649 schema:
5650 $ref: '#/components/schemas/GetExportRequest'
5651 responses:
5652 "200":
5653 content:
5654 application/json:
5655 schema:
5656 $ref: '#/components/schemas/ExportResponse'
5657 /restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}:
5658 get:
5659 description: <p>Generates a client SDK for a <a>RestApi</a> and <a>Stage</a>.</p>
5660 operationId: GetSdk
5661 requestBody:
5662 content:
5663 application/json:
5664 schema:
5665 $ref: '#/components/schemas/GetSdkRequest'
5666 responses:
5667 "200":
5668 content:
5669 application/json:
5670 schema:
5671 $ref: '#/components/schemas/SdkResponse'
5672 /restapis?mode=import:
5673 post:
5674 description: <p>A feature of the API Gateway control service for creating a
5675 new API from an external API definition file.</p>
5676 operationId: ImportRestApi
5677 requestBody:
5678 content:
5679 application/json:
5680 schema:
5681 $ref: '#/components/schemas/ImportRestApiRequest'
5682 responses:
5683 "201":
5684 content:
5685 application/json:
5686 schema:
5687 $ref: '#/components/schemas/RestApi'
5688 /sdktypes:
5689 get:
5690 operationId: GetSdkTypes
5691 requestBody:
5692 content:
5693 application/json:
5694 schema:
5695 $ref: '#/components/schemas/GetSdkTypesRequest'
5696 responses:
5697 "200":
5698 content:
5699 application/json:
5700 schema:
5701 $ref: '#/components/schemas/SdkTypes'
5702 /sdktypes/{sdktype_id}:
5703 get:
5704 operationId: GetSdkType
5705 requestBody:
5706 content:
5707 application/json:
5708 schema:
5709 $ref: '#/components/schemas/GetSdkTypeRequest'
5710 responses:
5711 "200":
5712 content:
5713 application/json:
5714 schema:
5715 $ref: '#/components/schemas/SdkType'
5716 /tags/{resource_arn}:
5717 delete:
5718 description: <p>Removes a tag from a given resource.</p>
5719 operationId: UntagResource
5720 requestBody:
5721 content:
5722 application/json:
5723 schema:
5724 $ref: '#/components/schemas/UntagResourceRequest'
5725 responses: null
5726 get:
5727 description: <p>Gets the <a>Tags</a> collection for a given resource.</p>
5728 operationId: GetTags
5729 requestBody:
5730 content:
5731 application/json:
5732 schema:
5733 $ref: '#/components/schemas/GetTagsRequest'
5734 responses:
5735 "200":
5736 content:
5737 application/json:
5738 schema:
5739 $ref: '#/components/schemas/Tags'
5740 put:
5741 description: <p>Adds or updates a tag on a given resource.</p>
5742 operationId: TagResource
5743 requestBody:
5744 content:
5745 application/json:
5746 schema:
5747 $ref: '#/components/schemas/TagResourceRequest'
5748 responses: null
5749 /usageplans:
5750 get:
5751 description: <p>Gets all the usage plans of the caller's account.</p>
5752 operationId: GetUsagePlans
5753 requestBody:
5754 content:
5755 application/json:
5756 schema:
5757 $ref: '#/components/schemas/GetUsagePlansRequest'
5758 responses:
5759 "200":
5760 content:
5761 application/json:
5762 schema:
5763 $ref: '#/components/schemas/UsagePlans'
5764 post:
5765 description: <p>Creates a usage plan with the throttle and quota limits, as
5766 well as the associated API stages, specified in the payload. </p>
5767 operationId: CreateUsagePlan
5768 requestBody:
5769 content:
5770 application/json:
5771 schema:
5772 $ref: '#/components/schemas/CreateUsagePlanRequest'
5773 responses:
5774 "201":
5775 content:
5776 application/json:
5777 schema:
5778 $ref: '#/components/schemas/UsagePlan'
5779 /usageplans/{usageplanId}:
5780 delete:
5781 description: <p>Deletes a usage plan of a given plan Id.</p>
5782 operationId: DeleteUsagePlan
5783 requestBody:
5784 content:
5785 application/json:
5786 schema:
5787 $ref: '#/components/schemas/DeleteUsagePlanRequest'
5788 responses: null
5789 get:
5790 description: <p>Gets a usage plan of a given plan identifier.</p>
5791 operationId: GetUsagePlan
5792 requestBody:
5793 content:
5794 application/json:
5795 schema:
5796 $ref: '#/components/schemas/GetUsagePlanRequest'
5797 responses:
5798 "200":
5799 content:
5800 application/json:
5801 schema:
5802 $ref: '#/components/schemas/UsagePlan'
5803 patch:
5804 description: <p>Updates a usage plan of a given plan Id.</p>
5805 operationId: UpdateUsagePlan
5806 requestBody:
5807 content:
5808 application/json:
5809 schema:
5810 $ref: '#/components/schemas/UpdateUsagePlanRequest'
5811 responses:
5812 "200":
5813 content:
5814 application/json:
5815 schema:
5816 $ref: '#/components/schemas/UsagePlan'
5817 /usageplans/{usageplanId}/keys:
5818 get:
5819 description: <p>Gets all the usage plan keys representing the API keys added
5820 to a specified usage plan.</p>
5821 operationId: GetUsagePlanKeys
5822 requestBody:
5823 content:
5824 application/json:
5825 schema:
5826 $ref: '#/components/schemas/GetUsagePlanKeysRequest'
5827 responses:
5828 "200":
5829 content:
5830 application/json:
5831 schema:
5832 $ref: '#/components/schemas/UsagePlanKeys'
5833 post:
5834 description: <p>Creates a usage plan key for adding an existing API key to a
5835 usage plan.</p>
5836 operationId: CreateUsagePlanKey
5837 requestBody:
5838 content:
5839 application/json:
5840 schema:
5841 $ref: '#/components/schemas/CreateUsagePlanKeyRequest'
5842 responses:
5843 "201":
5844 content:
5845 application/json:
5846 schema:
5847 $ref: '#/components/schemas/UsagePlanKey'
5848 /usageplans/{usageplanId}/keys/{keyId}:
5849 delete:
5850 description: <p>Deletes a usage plan key and remove the underlying API key from
5851 the associated usage plan.</p>
5852 operationId: DeleteUsagePlanKey
5853 requestBody:
5854 content:
5855 application/json:
5856 schema:
5857 $ref: '#/components/schemas/DeleteUsagePlanKeyRequest'
5858 responses: null
5859 get:
5860 description: <p>Gets a usage plan key of a given key identifier.</p>
5861 operationId: GetUsagePlanKey
5862 requestBody:
5863 content:
5864 application/json:
5865 schema:
5866 $ref: '#/components/schemas/GetUsagePlanKeyRequest'
5867 responses:
5868 "200":
5869 content:
5870 application/json:
5871 schema:
5872 $ref: '#/components/schemas/UsagePlanKey'
5873 /usageplans/{usageplanId}/keys/{keyId}/usage:
5874 patch:
5875 description: <p>Grants a temporary extension to the remaining quota of a usage
5876 plan associated with a specified API key.</p>
5877 operationId: UpdateUsage
5878 requestBody:
5879 content:
5880 application/json:
5881 schema:
5882 $ref: '#/components/schemas/UpdateUsageRequest'
5883 responses:
5884 "200":
5885 content:
5886 application/json:
5887 schema:
5888 $ref: '#/components/schemas/Usage'
5889 /usageplans/{usageplanId}/usage:
5890 get:
5891 description: <p>Gets the usage data of a usage plan in a specified time interval.</p>
5892 operationId: GetUsage
5893 requestBody:
5894 content:
5895 application/json:
5896 schema:
5897 $ref: '#/components/schemas/GetUsageRequest'
5898 responses:
5899 "200":
5900 content:
5901 application/json:
5902 schema:
5903 $ref: '#/components/schemas/Usage'
5904 /vpclinks:
5905 get:
5906 description: <p>Gets the <a>VpcLinks</a> collection under the caller's account
5907 in a selected region.</p>
5908 operationId: GetVpcLinks
5909 requestBody:
5910 content:
5911 application/json:
5912 schema:
5913 $ref: '#/components/schemas/GetVpcLinksRequest'
5914 responses:
5915 "200":
5916 content:
5917 application/json:
5918 schema:
5919 $ref: '#/components/schemas/VpcLinks'
5920 post:
5921 description: <p>Creates a VPC link, under the caller's account in a selected
5922 region, in an asynchronous operation that typically takes 2-4 minutes to complete
5923 and become operational. The caller must have permissions to create and update
5924 VPC Endpoint services.</p>
5925 operationId: CreateVpcLink
5926 requestBody:
5927 content:
5928 application/json:
5929 schema:
5930 $ref: '#/components/schemas/CreateVpcLinkRequest'
5931 responses:
5932 "202":
5933 content:
5934 application/json:
5935 schema:
5936 $ref: '#/components/schemas/VpcLink'
5937 /vpclinks/{vpclink_id}:
5938 delete:
5939 description: <p>Deletes an existing <a>VpcLink</a> of a specified identifier.</p>
5940 operationId: DeleteVpcLink
5941 requestBody:
5942 content:
5943 application/json:
5944 schema:
5945 $ref: '#/components/schemas/DeleteVpcLinkRequest'
5946 responses: null
5947 get:
5948 description: <p>Gets a specified VPC link under the caller's account in a region.</p>
5949 operationId: GetVpcLink
5950 requestBody:
5951 content:
5952 application/json:
5953 schema:
5954 $ref: '#/components/schemas/GetVpcLinkRequest'
5955 responses:
5956 "200":
5957 content:
5958 application/json:
5959 schema:
5960 $ref: '#/components/schemas/VpcLink'
5961 patch:
5962 description: <p>Updates an existing <a>VpcLink</a> of a specified identifier.</p>
5963 operationId: UpdateVpcLink
5964 requestBody:
5965 content:
5966 application/json:
5967 schema:
5968 $ref: '#/components/schemas/UpdateVpcLinkRequest'
5969 responses:
5970 "200":
5971 content:
5972 application/json:
5973 schema:
5974 $ref: '#/components/schemas/VpcLink'