apigateway.d.ts
197 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class APIGateway extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: APIGateway.Types.ClientConfiguration)
config: Config & APIGateway.Types.ClientConfiguration;
/**
* Create an ApiKey resource. AWS CLI
*/
createApiKey(params: APIGateway.Types.CreateApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
/**
* Create an ApiKey resource. AWS CLI
*/
createApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
/**
* Adds a new Authorizer resource to an existing RestApi resource. AWS CLI
*/
createAuthorizer(params: APIGateway.Types.CreateAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
/**
* Adds a new Authorizer resource to an existing RestApi resource. AWS CLI
*/
createAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
/**
* Creates a new BasePathMapping resource.
*/
createBasePathMapping(params: APIGateway.Types.CreateBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
/**
* Creates a new BasePathMapping resource.
*/
createBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
/**
* Creates a Deployment resource, which makes a specified RestApi callable over the internet.
*/
createDeployment(params: APIGateway.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
/**
* Creates a Deployment resource, which makes a specified RestApi callable over the internet.
*/
createDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
/**
*
*/
createDocumentationPart(params: APIGateway.Types.CreateDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
/**
*
*/
createDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
/**
*
*/
createDocumentationVersion(params: APIGateway.Types.CreateDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
/**
*
*/
createDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
/**
* Creates a new domain name.
*/
createDomainName(params: APIGateway.Types.CreateDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
/**
* Creates a new domain name.
*/
createDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
/**
* Adds a new Model resource to an existing RestApi resource.
*/
createModel(params: APIGateway.Types.CreateModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
/**
* Adds a new Model resource to an existing RestApi resource.
*/
createModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
/**
* Creates a ReqeustValidator of a given RestApi.
*/
createRequestValidator(params: APIGateway.Types.CreateRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
/**
* Creates a ReqeustValidator of a given RestApi.
*/
createRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
/**
* Creates a Resource resource.
*/
createResource(params: APIGateway.Types.CreateResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
/**
* Creates a Resource resource.
*/
createResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
/**
* Creates a new RestApi resource.
*/
createRestApi(params: APIGateway.Types.CreateRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* Creates a new RestApi resource.
*/
createRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* Creates a new Stage resource that references a pre-existing Deployment for the API.
*/
createStage(params: APIGateway.Types.CreateStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
/**
* Creates a new Stage resource that references a pre-existing Deployment for the API.
*/
createStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
/**
* Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
*/
createUsagePlan(params: APIGateway.Types.CreateUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
/**
* Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
*/
createUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
/**
* Creates a usage plan key for adding an existing API key to a usage plan.
*/
createUsagePlanKey(params: APIGateway.Types.CreateUsagePlanKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request<APIGateway.Types.UsagePlanKey, AWSError>;
/**
* Creates a usage plan key for adding an existing API key to a usage plan.
*/
createUsagePlanKey(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request<APIGateway.Types.UsagePlanKey, AWSError>;
/**
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
*/
createVpcLink(params: APIGateway.Types.CreateVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
/**
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
*/
createVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
/**
* Deletes the ApiKey resource.
*/
deleteApiKey(params: APIGateway.Types.DeleteApiKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the ApiKey resource.
*/
deleteApiKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing Authorizer resource. AWS CLI
*/
deleteAuthorizer(params: APIGateway.Types.DeleteAuthorizerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing Authorizer resource. AWS CLI
*/
deleteAuthorizer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the BasePathMapping resource.
*/
deleteBasePathMapping(params: APIGateway.Types.DeleteBasePathMappingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the BasePathMapping resource.
*/
deleteBasePathMapping(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the ClientCertificate resource.
*/
deleteClientCertificate(params: APIGateway.Types.DeleteClientCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the ClientCertificate resource.
*/
deleteClientCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
*/
deleteDeployment(params: APIGateway.Types.DeleteDeploymentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
*/
deleteDeployment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
*/
deleteDocumentationPart(params: APIGateway.Types.DeleteDocumentationPartRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
*/
deleteDocumentationPart(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
*/
deleteDocumentationVersion(params: APIGateway.Types.DeleteDocumentationVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
*/
deleteDocumentationVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the DomainName resource.
*/
deleteDomainName(params: APIGateway.Types.DeleteDomainNameRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the DomainName resource.
*/
deleteDomainName(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
*/
deleteGatewayResponse(params: APIGateway.Types.DeleteGatewayResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
*/
deleteGatewayResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents a delete integration.
*/
deleteIntegration(params: APIGateway.Types.DeleteIntegrationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents a delete integration.
*/
deleteIntegration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents a delete integration response.
*/
deleteIntegrationResponse(params: APIGateway.Types.DeleteIntegrationResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents a delete integration response.
*/
deleteIntegrationResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing Method resource.
*/
deleteMethod(params: APIGateway.Types.DeleteMethodRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing Method resource.
*/
deleteMethod(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing MethodResponse resource.
*/
deleteMethodResponse(params: APIGateway.Types.DeleteMethodResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing MethodResponse resource.
*/
deleteMethodResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a model.
*/
deleteModel(params: APIGateway.Types.DeleteModelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a model.
*/
deleteModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a RequestValidator of a given RestApi.
*/
deleteRequestValidator(params: APIGateway.Types.DeleteRequestValidatorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a RequestValidator of a given RestApi.
*/
deleteRequestValidator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a Resource resource.
*/
deleteResource(params: APIGateway.Types.DeleteResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a Resource resource.
*/
deleteResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified API.
*/
deleteRestApi(params: APIGateway.Types.DeleteRestApiRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified API.
*/
deleteRestApi(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a Stage resource.
*/
deleteStage(params: APIGateway.Types.DeleteStageRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a Stage resource.
*/
deleteStage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a usage plan of a given plan Id.
*/
deleteUsagePlan(params: APIGateway.Types.DeleteUsagePlanRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a usage plan of a given plan Id.
*/
deleteUsagePlan(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a usage plan key and remove the underlying API key from the associated usage plan.
*/
deleteUsagePlanKey(params: APIGateway.Types.DeleteUsagePlanKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a usage plan key and remove the underlying API key from the associated usage plan.
*/
deleteUsagePlanKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing VpcLink of a specified identifier.
*/
deleteVpcLink(params: APIGateway.Types.DeleteVpcLinkRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing VpcLink of a specified identifier.
*/
deleteVpcLink(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Flushes all authorizer cache entries on a stage.
*/
flushStageAuthorizersCache(params: APIGateway.Types.FlushStageAuthorizersCacheRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Flushes all authorizer cache entries on a stage.
*/
flushStageAuthorizersCache(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Flushes a stage's cache.
*/
flushStageCache(params: APIGateway.Types.FlushStageCacheRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Flushes a stage's cache.
*/
flushStageCache(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Generates a ClientCertificate resource.
*/
generateClientCertificate(params: APIGateway.Types.GenerateClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
/**
* Generates a ClientCertificate resource.
*/
generateClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
/**
* Gets information about the current Account resource.
*/
getAccount(params: APIGateway.Types.GetAccountRequest, callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request<APIGateway.Types.Account, AWSError>;
/**
* Gets information about the current Account resource.
*/
getAccount(callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request<APIGateway.Types.Account, AWSError>;
/**
* Gets information about the current ApiKey resource.
*/
getApiKey(params: APIGateway.Types.GetApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
/**
* Gets information about the current ApiKey resource.
*/
getApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
/**
* Gets information about the current ApiKeys resource.
*/
getApiKeys(params: APIGateway.Types.GetApiKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKeys) => void): Request<APIGateway.Types.ApiKeys, AWSError>;
/**
* Gets information about the current ApiKeys resource.
*/
getApiKeys(callback?: (err: AWSError, data: APIGateway.Types.ApiKeys) => void): Request<APIGateway.Types.ApiKeys, AWSError>;
/**
* Describe an existing Authorizer resource. AWS CLI
*/
getAuthorizer(params: APIGateway.Types.GetAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
/**
* Describe an existing Authorizer resource. AWS CLI
*/
getAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
/**
* Describe an existing Authorizers resource. AWS CLI
*/
getAuthorizers(params: APIGateway.Types.GetAuthorizersRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizers) => void): Request<APIGateway.Types.Authorizers, AWSError>;
/**
* Describe an existing Authorizers resource. AWS CLI
*/
getAuthorizers(callback?: (err: AWSError, data: APIGateway.Types.Authorizers) => void): Request<APIGateway.Types.Authorizers, AWSError>;
/**
* Describe a BasePathMapping resource.
*/
getBasePathMapping(params: APIGateway.Types.GetBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
/**
* Describe a BasePathMapping resource.
*/
getBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
/**
* Represents a collection of BasePathMapping resources.
*/
getBasePathMappings(params: APIGateway.Types.GetBasePathMappingsRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMappings) => void): Request<APIGateway.Types.BasePathMappings, AWSError>;
/**
* Represents a collection of BasePathMapping resources.
*/
getBasePathMappings(callback?: (err: AWSError, data: APIGateway.Types.BasePathMappings) => void): Request<APIGateway.Types.BasePathMappings, AWSError>;
/**
* Gets information about the current ClientCertificate resource.
*/
getClientCertificate(params: APIGateway.Types.GetClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
/**
* Gets information about the current ClientCertificate resource.
*/
getClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
/**
* Gets a collection of ClientCertificate resources.
*/
getClientCertificates(params: APIGateway.Types.GetClientCertificatesRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificates) => void): Request<APIGateway.Types.ClientCertificates, AWSError>;
/**
* Gets a collection of ClientCertificate resources.
*/
getClientCertificates(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificates) => void): Request<APIGateway.Types.ClientCertificates, AWSError>;
/**
* Gets information about a Deployment resource.
*/
getDeployment(params: APIGateway.Types.GetDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
/**
* Gets information about a Deployment resource.
*/
getDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
/**
* Gets information about a Deployments collection.
*/
getDeployments(params: APIGateway.Types.GetDeploymentsRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployments) => void): Request<APIGateway.Types.Deployments, AWSError>;
/**
* Gets information about a Deployments collection.
*/
getDeployments(callback?: (err: AWSError, data: APIGateway.Types.Deployments) => void): Request<APIGateway.Types.Deployments, AWSError>;
/**
*
*/
getDocumentationPart(params: APIGateway.Types.GetDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
/**
*
*/
getDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
/**
*
*/
getDocumentationParts(params: APIGateway.Types.GetDocumentationPartsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationParts) => void): Request<APIGateway.Types.DocumentationParts, AWSError>;
/**
*
*/
getDocumentationParts(callback?: (err: AWSError, data: APIGateway.Types.DocumentationParts) => void): Request<APIGateway.Types.DocumentationParts, AWSError>;
/**
*
*/
getDocumentationVersion(params: APIGateway.Types.GetDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
/**
*
*/
getDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
/**
*
*/
getDocumentationVersions(params: APIGateway.Types.GetDocumentationVersionsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersions) => void): Request<APIGateway.Types.DocumentationVersions, AWSError>;
/**
*
*/
getDocumentationVersions(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersions) => void): Request<APIGateway.Types.DocumentationVersions, AWSError>;
/**
* Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
*/
getDomainName(params: APIGateway.Types.GetDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
/**
* Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
*/
getDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
/**
* Represents a collection of DomainName resources.
*/
getDomainNames(params: APIGateway.Types.GetDomainNamesRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainNames) => void): Request<APIGateway.Types.DomainNames, AWSError>;
/**
* Represents a collection of DomainName resources.
*/
getDomainNames(callback?: (err: AWSError, data: APIGateway.Types.DomainNames) => void): Request<APIGateway.Types.DomainNames, AWSError>;
/**
* Exports a deployed version of a RestApi in a specified format.
*/
getExport(params: APIGateway.Types.GetExportRequest, callback?: (err: AWSError, data: APIGateway.Types.ExportResponse) => void): Request<APIGateway.Types.ExportResponse, AWSError>;
/**
* Exports a deployed version of a RestApi in a specified format.
*/
getExport(callback?: (err: AWSError, data: APIGateway.Types.ExportResponse) => void): Request<APIGateway.Types.ExportResponse, AWSError>;
/**
* Gets a GatewayResponse of a specified response type on the given RestApi.
*/
getGatewayResponse(params: APIGateway.Types.GetGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
/**
* Gets a GatewayResponse of a specified response type on the given RestApi.
*/
getGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
/**
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
*/
getGatewayResponses(params: APIGateway.Types.GetGatewayResponsesRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponses) => void): Request<APIGateway.Types.GatewayResponses, AWSError>;
/**
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
*/
getGatewayResponses(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponses) => void): Request<APIGateway.Types.GatewayResponses, AWSError>;
/**
* Get the integration settings.
*/
getIntegration(params: APIGateway.Types.GetIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
/**
* Get the integration settings.
*/
getIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
/**
* Represents a get integration response.
*/
getIntegrationResponse(params: APIGateway.Types.GetIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
/**
* Represents a get integration response.
*/
getIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
/**
* Describe an existing Method resource.
*/
getMethod(params: APIGateway.Types.GetMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
/**
* Describe an existing Method resource.
*/
getMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
/**
* Describes a MethodResponse resource.
*/
getMethodResponse(params: APIGateway.Types.GetMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
/**
* Describes a MethodResponse resource.
*/
getMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
/**
* Describes an existing model defined for a RestApi resource.
*/
getModel(params: APIGateway.Types.GetModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
/**
* Describes an existing model defined for a RestApi resource.
*/
getModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
/**
* Generates a sample mapping template that can be used to transform a payload into the structure of a model.
*/
getModelTemplate(params: APIGateway.Types.GetModelTemplateRequest, callback?: (err: AWSError, data: APIGateway.Types.Template) => void): Request<APIGateway.Types.Template, AWSError>;
/**
* Generates a sample mapping template that can be used to transform a payload into the structure of a model.
*/
getModelTemplate(callback?: (err: AWSError, data: APIGateway.Types.Template) => void): Request<APIGateway.Types.Template, AWSError>;
/**
* Describes existing Models defined for a RestApi resource.
*/
getModels(params: APIGateway.Types.GetModelsRequest, callback?: (err: AWSError, data: APIGateway.Types.Models) => void): Request<APIGateway.Types.Models, AWSError>;
/**
* Describes existing Models defined for a RestApi resource.
*/
getModels(callback?: (err: AWSError, data: APIGateway.Types.Models) => void): Request<APIGateway.Types.Models, AWSError>;
/**
* Gets a RequestValidator of a given RestApi.
*/
getRequestValidator(params: APIGateway.Types.GetRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
/**
* Gets a RequestValidator of a given RestApi.
*/
getRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
/**
* Gets the RequestValidators collection of a given RestApi.
*/
getRequestValidators(params: APIGateway.Types.GetRequestValidatorsRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidators) => void): Request<APIGateway.Types.RequestValidators, AWSError>;
/**
* Gets the RequestValidators collection of a given RestApi.
*/
getRequestValidators(callback?: (err: AWSError, data: APIGateway.Types.RequestValidators) => void): Request<APIGateway.Types.RequestValidators, AWSError>;
/**
* Lists information about a resource.
*/
getResource(params: APIGateway.Types.GetResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
/**
* Lists information about a resource.
*/
getResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
/**
* Lists information about a collection of Resource resources.
*/
getResources(params: APIGateway.Types.GetResourcesRequest, callback?: (err: AWSError, data: APIGateway.Types.Resources) => void): Request<APIGateway.Types.Resources, AWSError>;
/**
* Lists information about a collection of Resource resources.
*/
getResources(callback?: (err: AWSError, data: APIGateway.Types.Resources) => void): Request<APIGateway.Types.Resources, AWSError>;
/**
* Lists the RestApi resource in the collection.
*/
getRestApi(params: APIGateway.Types.GetRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* Lists the RestApi resource in the collection.
*/
getRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* Lists the RestApis resources for your collection.
*/
getRestApis(params: APIGateway.Types.GetRestApisRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApis) => void): Request<APIGateway.Types.RestApis, AWSError>;
/**
* Lists the RestApis resources for your collection.
*/
getRestApis(callback?: (err: AWSError, data: APIGateway.Types.RestApis) => void): Request<APIGateway.Types.RestApis, AWSError>;
/**
* Generates a client SDK for a RestApi and Stage.
*/
getSdk(params: APIGateway.Types.GetSdkRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkResponse) => void): Request<APIGateway.Types.SdkResponse, AWSError>;
/**
* Generates a client SDK for a RestApi and Stage.
*/
getSdk(callback?: (err: AWSError, data: APIGateway.Types.SdkResponse) => void): Request<APIGateway.Types.SdkResponse, AWSError>;
/**
*
*/
getSdkType(params: APIGateway.Types.GetSdkTypeRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkType) => void): Request<APIGateway.Types.SdkType, AWSError>;
/**
*
*/
getSdkType(callback?: (err: AWSError, data: APIGateway.Types.SdkType) => void): Request<APIGateway.Types.SdkType, AWSError>;
/**
*
*/
getSdkTypes(params: APIGateway.Types.GetSdkTypesRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkTypes) => void): Request<APIGateway.Types.SdkTypes, AWSError>;
/**
*
*/
getSdkTypes(callback?: (err: AWSError, data: APIGateway.Types.SdkTypes) => void): Request<APIGateway.Types.SdkTypes, AWSError>;
/**
* Gets information about a Stage resource.
*/
getStage(params: APIGateway.Types.GetStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
/**
* Gets information about a Stage resource.
*/
getStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
/**
* Gets information about one or more Stage resources.
*/
getStages(params: APIGateway.Types.GetStagesRequest, callback?: (err: AWSError, data: APIGateway.Types.Stages) => void): Request<APIGateway.Types.Stages, AWSError>;
/**
* Gets information about one or more Stage resources.
*/
getStages(callback?: (err: AWSError, data: APIGateway.Types.Stages) => void): Request<APIGateway.Types.Stages, AWSError>;
/**
* Gets the Tags collection for a given resource.
*/
getTags(params: APIGateway.Types.GetTagsRequest, callback?: (err: AWSError, data: APIGateway.Types.Tags) => void): Request<APIGateway.Types.Tags, AWSError>;
/**
* Gets the Tags collection for a given resource.
*/
getTags(callback?: (err: AWSError, data: APIGateway.Types.Tags) => void): Request<APIGateway.Types.Tags, AWSError>;
/**
* Gets the usage data of a usage plan in a specified time interval.
*/
getUsage(params: APIGateway.Types.GetUsageRequest, callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request<APIGateway.Types.Usage, AWSError>;
/**
* Gets the usage data of a usage plan in a specified time interval.
*/
getUsage(callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request<APIGateway.Types.Usage, AWSError>;
/**
* Gets a usage plan of a given plan identifier.
*/
getUsagePlan(params: APIGateway.Types.GetUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
/**
* Gets a usage plan of a given plan identifier.
*/
getUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
/**
* Gets a usage plan key of a given key identifier.
*/
getUsagePlanKey(params: APIGateway.Types.GetUsagePlanKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request<APIGateway.Types.UsagePlanKey, AWSError>;
/**
* Gets a usage plan key of a given key identifier.
*/
getUsagePlanKey(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request<APIGateway.Types.UsagePlanKey, AWSError>;
/**
* Gets all the usage plan keys representing the API keys added to a specified usage plan.
*/
getUsagePlanKeys(params: APIGateway.Types.GetUsagePlanKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKeys) => void): Request<APIGateway.Types.UsagePlanKeys, AWSError>;
/**
* Gets all the usage plan keys representing the API keys added to a specified usage plan.
*/
getUsagePlanKeys(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKeys) => void): Request<APIGateway.Types.UsagePlanKeys, AWSError>;
/**
* Gets all the usage plans of the caller's account.
*/
getUsagePlans(params: APIGateway.Types.GetUsagePlansRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlans) => void): Request<APIGateway.Types.UsagePlans, AWSError>;
/**
* Gets all the usage plans of the caller's account.
*/
getUsagePlans(callback?: (err: AWSError, data: APIGateway.Types.UsagePlans) => void): Request<APIGateway.Types.UsagePlans, AWSError>;
/**
* Gets a specified VPC link under the caller's account in a region.
*/
getVpcLink(params: APIGateway.Types.GetVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
/**
* Gets a specified VPC link under the caller's account in a region.
*/
getVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
/**
* Gets the VpcLinks collection under the caller's account in a selected region.
*/
getVpcLinks(params: APIGateway.Types.GetVpcLinksRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLinks) => void): Request<APIGateway.Types.VpcLinks, AWSError>;
/**
* Gets the VpcLinks collection under the caller's account in a selected region.
*/
getVpcLinks(callback?: (err: AWSError, data: APIGateway.Types.VpcLinks) => void): Request<APIGateway.Types.VpcLinks, AWSError>;
/**
* Import API keys from an external source, such as a CSV-formatted file.
*/
importApiKeys(params: APIGateway.Types.ImportApiKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKeyIds) => void): Request<APIGateway.Types.ApiKeyIds, AWSError>;
/**
* Import API keys from an external source, such as a CSV-formatted file.
*/
importApiKeys(callback?: (err: AWSError, data: APIGateway.Types.ApiKeyIds) => void): Request<APIGateway.Types.ApiKeyIds, AWSError>;
/**
*
*/
importDocumentationParts(params: APIGateway.Types.ImportDocumentationPartsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPartIds) => void): Request<APIGateway.Types.DocumentationPartIds, AWSError>;
/**
*
*/
importDocumentationParts(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPartIds) => void): Request<APIGateway.Types.DocumentationPartIds, AWSError>;
/**
* A feature of the API Gateway control service for creating a new API from an external API definition file.
*/
importRestApi(params: APIGateway.Types.ImportRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* A feature of the API Gateway control service for creating a new API from an external API definition file.
*/
importRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
*/
putGatewayResponse(params: APIGateway.Types.PutGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
/**
* Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
*/
putGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
/**
* Sets up a method's integration.
*/
putIntegration(params: APIGateway.Types.PutIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
/**
* Sets up a method's integration.
*/
putIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
/**
* Represents a put integration.
*/
putIntegrationResponse(params: APIGateway.Types.PutIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
/**
* Represents a put integration.
*/
putIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
/**
* Add a method to an existing Resource resource.
*/
putMethod(params: APIGateway.Types.PutMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
/**
* Add a method to an existing Resource resource.
*/
putMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
/**
* Adds a MethodResponse to an existing Method resource.
*/
putMethodResponse(params: APIGateway.Types.PutMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
/**
* Adds a MethodResponse to an existing Method resource.
*/
putMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
/**
* A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
*/
putRestApi(params: APIGateway.Types.PutRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
*/
putRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* Adds or updates a tag on a given resource.
*/
tagResource(params: APIGateway.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds or updates a tag on a given resource.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
*/
testInvokeAuthorizer(params: APIGateway.Types.TestInvokeAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.TestInvokeAuthorizerResponse) => void): Request<APIGateway.Types.TestInvokeAuthorizerResponse, AWSError>;
/**
* Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
*/
testInvokeAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.TestInvokeAuthorizerResponse) => void): Request<APIGateway.Types.TestInvokeAuthorizerResponse, AWSError>;
/**
* Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
*/
testInvokeMethod(params: APIGateway.Types.TestInvokeMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.TestInvokeMethodResponse) => void): Request<APIGateway.Types.TestInvokeMethodResponse, AWSError>;
/**
* Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
*/
testInvokeMethod(callback?: (err: AWSError, data: APIGateway.Types.TestInvokeMethodResponse) => void): Request<APIGateway.Types.TestInvokeMethodResponse, AWSError>;
/**
* Removes a tag from a given resource.
*/
untagResource(params: APIGateway.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a tag from a given resource.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Changes information about the current Account resource.
*/
updateAccount(params: APIGateway.Types.UpdateAccountRequest, callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request<APIGateway.Types.Account, AWSError>;
/**
* Changes information about the current Account resource.
*/
updateAccount(callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request<APIGateway.Types.Account, AWSError>;
/**
* Changes information about an ApiKey resource.
*/
updateApiKey(params: APIGateway.Types.UpdateApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
/**
* Changes information about an ApiKey resource.
*/
updateApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
/**
* Updates an existing Authorizer resource. AWS CLI
*/
updateAuthorizer(params: APIGateway.Types.UpdateAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
/**
* Updates an existing Authorizer resource. AWS CLI
*/
updateAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
/**
* Changes information about the BasePathMapping resource.
*/
updateBasePathMapping(params: APIGateway.Types.UpdateBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
/**
* Changes information about the BasePathMapping resource.
*/
updateBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
/**
* Changes information about an ClientCertificate resource.
*/
updateClientCertificate(params: APIGateway.Types.UpdateClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
/**
* Changes information about an ClientCertificate resource.
*/
updateClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
/**
* Changes information about a Deployment resource.
*/
updateDeployment(params: APIGateway.Types.UpdateDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
/**
* Changes information about a Deployment resource.
*/
updateDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
/**
*
*/
updateDocumentationPart(params: APIGateway.Types.UpdateDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
/**
*
*/
updateDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
/**
*
*/
updateDocumentationVersion(params: APIGateway.Types.UpdateDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
/**
*
*/
updateDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
/**
* Changes information about the DomainName resource.
*/
updateDomainName(params: APIGateway.Types.UpdateDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
/**
* Changes information about the DomainName resource.
*/
updateDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
/**
* Updates a GatewayResponse of a specified response type on the given RestApi.
*/
updateGatewayResponse(params: APIGateway.Types.UpdateGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
/**
* Updates a GatewayResponse of a specified response type on the given RestApi.
*/
updateGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
/**
* Represents an update integration.
*/
updateIntegration(params: APIGateway.Types.UpdateIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
/**
* Represents an update integration.
*/
updateIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
/**
* Represents an update integration response.
*/
updateIntegrationResponse(params: APIGateway.Types.UpdateIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
/**
* Represents an update integration response.
*/
updateIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
/**
* Updates an existing Method resource.
*/
updateMethod(params: APIGateway.Types.UpdateMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
/**
* Updates an existing Method resource.
*/
updateMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
/**
* Updates an existing MethodResponse resource.
*/
updateMethodResponse(params: APIGateway.Types.UpdateMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
/**
* Updates an existing MethodResponse resource.
*/
updateMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
/**
* Changes information about a model.
*/
updateModel(params: APIGateway.Types.UpdateModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
/**
* Changes information about a model.
*/
updateModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
/**
* Updates a RequestValidator of a given RestApi.
*/
updateRequestValidator(params: APIGateway.Types.UpdateRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
/**
* Updates a RequestValidator of a given RestApi.
*/
updateRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
/**
* Changes information about a Resource resource.
*/
updateResource(params: APIGateway.Types.UpdateResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
/**
* Changes information about a Resource resource.
*/
updateResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
/**
* Changes information about the specified API.
*/
updateRestApi(params: APIGateway.Types.UpdateRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* Changes information about the specified API.
*/
updateRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
/**
* Changes information about a Stage resource.
*/
updateStage(params: APIGateway.Types.UpdateStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
/**
* Changes information about a Stage resource.
*/
updateStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
/**
* Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
*/
updateUsage(params: APIGateway.Types.UpdateUsageRequest, callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request<APIGateway.Types.Usage, AWSError>;
/**
* Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
*/
updateUsage(callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request<APIGateway.Types.Usage, AWSError>;
/**
* Updates a usage plan of a given plan Id.
*/
updateUsagePlan(params: APIGateway.Types.UpdateUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
/**
* Updates a usage plan of a given plan Id.
*/
updateUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
/**
* Updates an existing VpcLink of a specified identifier.
*/
updateVpcLink(params: APIGateway.Types.UpdateVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
/**
* Updates an existing VpcLink of a specified identifier.
*/
updateVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
}
declare namespace APIGateway {
export interface AccessLogSettings {
/**
* A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
*/
format?: String;
/**
* The ARN of the CloudWatch Logs log group to receive access logs.
*/
destinationArn?: String;
}
export interface Account {
/**
* The ARN of an Amazon CloudWatch role for the current Account.
*/
cloudwatchRoleArn?: String;
/**
* Specifies the API request limits configured for the current Account.
*/
throttleSettings?: ThrottleSettings;
/**
* A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".
*/
features?: ListOfString;
/**
* The version of the API keys used for the account.
*/
apiKeyVersion?: String;
}
export interface ApiKey {
/**
* The identifier of the API Key.
*/
id?: String;
/**
* The value of the API Key.
*/
value?: String;
/**
* The name of the API Key.
*/
name?: String;
/**
* An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
*/
customerId?: String;
/**
* The description of the API Key.
*/
description?: String;
/**
* Specifies whether the API Key can be used by callers.
*/
enabled?: Boolean;
/**
* The timestamp when the API Key was created.
*/
createdDate?: Timestamp;
/**
* The timestamp when the API Key was last updated.
*/
lastUpdatedDate?: Timestamp;
/**
* A list of Stage resources that are associated with the ApiKey resource.
*/
stageKeys?: ListOfString;
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
tags?: MapOfStringToString;
}
export interface ApiKeyIds {
/**
* A list of all the ApiKey identifiers.
*/
ids?: ListOfString;
/**
* A list of warning messages.
*/
warnings?: ListOfString;
}
export type ApiKeySourceType = "HEADER"|"AUTHORIZER"|string;
export interface ApiKeys {
/**
* A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.
*/
warnings?: ListOfString;
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfApiKey;
}
export type ApiKeysFormat = "csv"|string;
export interface ApiStage {
/**
* API Id of the associated API stage in a usage plan.
*/
apiId?: String;
/**
* API stage name of the associated API stage in a usage plan.
*/
stage?: String;
/**
* Map containing method level throttling information for API stage in a usage plan.
*/
throttle?: MapOfApiStageThrottleSettings;
}
export interface Authorizer {
/**
* The identifier for the authorizer resource.
*/
id?: String;
/**
* [Required] The name of the authorizer.
*/
name?: String;
/**
* The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
*/
type?: AuthorizerType;
/**
* A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
*/
providerARNs?: ListOfARNs;
/**
* Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
*/
authType?: String;
/**
* Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
*/
authorizerUri?: String;
/**
* Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
*/
authorizerCredentials?: String;
/**
* The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
*/
identitySource?: String;
/**
* A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
*/
identityValidationExpression?: String;
/**
* The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
*/
authorizerResultTtlInSeconds?: NullableInteger;
}
export type AuthorizerType = "TOKEN"|"REQUEST"|"COGNITO_USER_POOLS"|string;
export interface Authorizers {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfAuthorizer;
}
export interface BasePathMapping {
/**
* The base path name that callers of the API must provide as part of the URL after the domain name.
*/
basePath?: String;
/**
* The string identifier of the associated RestApi.
*/
restApiId?: String;
/**
* The name of the associated stage.
*/
stage?: String;
}
export interface BasePathMappings {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfBasePathMapping;
}
export type _Blob = Buffer|Uint8Array|Blob|string;
export type Boolean = boolean;
export type CacheClusterSize = "0.5"|"1.6"|"6.1"|"13.5"|"28.4"|"58.2"|"118"|"237"|string;
export type CacheClusterStatus = "CREATE_IN_PROGRESS"|"AVAILABLE"|"DELETE_IN_PROGRESS"|"NOT_AVAILABLE"|"FLUSH_IN_PROGRESS"|string;
export interface CanarySettings {
/**
* The percent (0-100) of traffic diverted to a canary deployment.
*/
percentTraffic?: Double;
/**
* The ID of the canary deployment.
*/
deploymentId?: String;
/**
* Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
*/
stageVariableOverrides?: MapOfStringToString;
/**
* A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
*/
useStageCache?: Boolean;
}
export interface ClientCertificate {
/**
* The identifier of the client certificate.
*/
clientCertificateId?: String;
/**
* The description of the client certificate.
*/
description?: String;
/**
* The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
*/
pemEncodedCertificate?: String;
/**
* The timestamp when the client certificate was created.
*/
createdDate?: Timestamp;
/**
* The timestamp when the client certificate will expire.
*/
expirationDate?: Timestamp;
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
tags?: MapOfStringToString;
}
export interface ClientCertificates {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfClientCertificate;
}
export type ConnectionType = "INTERNET"|"VPC_LINK"|string;
export type ContentHandlingStrategy = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"|string;
export interface CreateApiKeyRequest {
/**
* The name of the ApiKey.
*/
name?: String;
/**
* The description of the ApiKey.
*/
description?: String;
/**
* Specifies whether the ApiKey can be used by callers.
*/
enabled?: Boolean;
/**
* Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
*/
generateDistinctId?: Boolean;
/**
* Specifies a value of the API key.
*/
value?: String;
/**
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
*/
stageKeys?: ListOfStageKeys;
/**
* An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
*/
customerId?: String;
/**
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
*/
tags?: MapOfStringToString;
}
export interface CreateAuthorizerRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the authorizer.
*/
name: String;
/**
* [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
*/
type: AuthorizerType;
/**
* A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
*/
providerARNs?: ListOfARNs;
/**
* Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
*/
authType?: String;
/**
* Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
*/
authorizerUri?: String;
/**
* Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
*/
authorizerCredentials?: String;
/**
* The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
*/
identitySource?: String;
/**
* A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
*/
identityValidationExpression?: String;
/**
* The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
*/
authorizerResultTtlInSeconds?: NullableInteger;
}
export interface CreateBasePathMappingRequest {
/**
* [Required] The domain name of the BasePathMapping resource to create.
*/
domainName: String;
/**
* The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
*/
basePath?: String;
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The name of the API's stage that you want to use for this mapping. Specify '(none)' if you do not want callers to explicitly specify the stage name after any base path name.
*/
stage?: String;
}
export interface CreateDeploymentRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The name of the Stage resource for the Deployment resource to create.
*/
stageName?: String;
/**
* The description of the Stage resource for the Deployment resource to create.
*/
stageDescription?: String;
/**
* The description for the Deployment resource to create.
*/
description?: String;
/**
* Enables a cache cluster for the Stage resource specified in the input.
*/
cacheClusterEnabled?: NullableBoolean;
/**
* Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
*/
cacheClusterSize?: CacheClusterSize;
/**
* A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
*/
variables?: MapOfStringToString;
/**
* The input configuration for the canary deployment when the deployment is a canary release deployment.
*/
canarySettings?: DeploymentCanarySettings;
/**
* Specifies whether active tracing with X-ray is enabled for the Stage.
*/
tracingEnabled?: NullableBoolean;
}
export interface CreateDocumentationPartRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The location of the targeted API entity of the to-be-created documentation part.
*/
location: DocumentationPartLocation;
/**
* [Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
*/
properties: String;
}
export interface CreateDocumentationVersionRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The version identifier of the new snapshot.
*/
documentationVersion: String;
/**
* The stage name to be associated with the new documentation snapshot.
*/
stageName?: String;
/**
* A description about the new documentation snapshot.
*/
description?: String;
}
export interface CreateDomainNameRequest {
/**
* [Required] The name of the DomainName resource.
*/
domainName: String;
/**
* The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
*/
certificateName?: String;
/**
* [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
*/
certificateBody?: String;
/**
* [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
*/
certificatePrivateKey?: String;
/**
* [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
*/
certificateChain?: String;
/**
* The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
*/
certificateArn?: String;
/**
* The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
*/
regionalCertificateName?: String;
/**
* The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.
*/
regionalCertificateArn?: String;
/**
* The endpoint configuration of this DomainName showing the endpoint types of the domain name.
*/
endpointConfiguration?: EndpointConfiguration;
/**
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
*/
tags?: MapOfStringToString;
/**
* The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
*/
securityPolicy?: SecurityPolicy;
}
export interface CreateModelRequest {
/**
* [Required] The RestApi identifier under which the Model will be created.
*/
restApiId: String;
/**
* [Required] The name of the model. Must be alphanumeric.
*/
name: String;
/**
* The description of the model.
*/
description?: String;
/**
* The schema for the model. For application/json models, this should be JSON schema draft 4 model.
*/
schema?: String;
/**
* [Required] The content-type for the model.
*/
contentType: String;
}
export interface CreateRequestValidatorRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The name of the to-be-created RequestValidator.
*/
name?: String;
/**
* A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).
*/
validateRequestBody?: Boolean;
/**
* A Boolean flag to indicate whether to validate request parameters, true, or not false.
*/
validateRequestParameters?: Boolean;
}
export interface CreateResourceRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The parent resource's identifier.
*/
parentId: String;
/**
* The last path segment for this resource.
*/
pathPart: String;
}
export interface CreateRestApiRequest {
/**
* [Required] The name of the RestApi.
*/
name: String;
/**
* The description of the RestApi.
*/
description?: String;
/**
* A version identifier for the API.
*/
version?: String;
/**
* The ID of the RestApi that you want to clone from.
*/
cloneFrom?: String;
/**
* The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
*/
binaryMediaTypes?: ListOfString;
/**
* A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
*/
minimumCompressionSize?: NullableInteger;
/**
* The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
*/
apiKeySource?: ApiKeySourceType;
/**
* The endpoint configuration of this RestApi showing the endpoint types of the API.
*/
endpointConfiguration?: EndpointConfiguration;
/**
* A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
*/
policy?: String;
/**
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
*/
tags?: MapOfStringToString;
}
export interface CreateStageRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
*/
stageName: String;
/**
* [Required] The identifier of the Deployment resource for the Stage resource.
*/
deploymentId: String;
/**
* The description of the Stage resource.
*/
description?: String;
/**
* Whether cache clustering is enabled for the stage.
*/
cacheClusterEnabled?: Boolean;
/**
* The stage's cache cluster size.
*/
cacheClusterSize?: CacheClusterSize;
/**
* A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
*/
variables?: MapOfStringToString;
/**
* The version of the associated API documentation.
*/
documentationVersion?: String;
/**
* The canary deployment settings of this stage.
*/
canarySettings?: CanarySettings;
/**
* Specifies whether active tracing with X-ray is enabled for the Stage.
*/
tracingEnabled?: Boolean;
/**
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
*/
tags?: MapOfStringToString;
}
export interface CreateUsagePlanKeyRequest {
/**
* [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
*/
usagePlanId: String;
/**
* [Required] The identifier of a UsagePlanKey resource for a plan customer.
*/
keyId: String;
/**
* [Required] The type of a UsagePlanKey resource for a plan customer.
*/
keyType: String;
}
export interface CreateUsagePlanRequest {
/**
* [Required] The name of the usage plan.
*/
name: String;
/**
* The description of the usage plan.
*/
description?: String;
/**
* The associated API stages of the usage plan.
*/
apiStages?: ListOfApiStage;
/**
* The throttling limits of the usage plan.
*/
throttle?: ThrottleSettings;
/**
* The quota of the usage plan.
*/
quota?: QuotaSettings;
/**
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
*/
tags?: MapOfStringToString;
}
export interface CreateVpcLinkRequest {
/**
* [Required] The name used to label and identify the VPC link.
*/
name: String;
/**
* The description of the VPC link.
*/
description?: String;
/**
* [Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
*/
targetArns: ListOfString;
/**
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
*/
tags?: MapOfStringToString;
}
export interface DeleteApiKeyRequest {
/**
* [Required] The identifier of the ApiKey resource to be deleted.
*/
apiKey: String;
}
export interface DeleteAuthorizerRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the Authorizer resource.
*/
authorizerId: String;
}
export interface DeleteBasePathMappingRequest {
/**
* [Required] The domain name of the BasePathMapping resource to delete.
*/
domainName: String;
/**
* [Required] The base path name of the BasePathMapping resource to delete. To specify an empty base path, set this parameter to '(none)'.
*/
basePath: String;
}
export interface DeleteClientCertificateRequest {
/**
* [Required] The identifier of the ClientCertificate resource to be deleted.
*/
clientCertificateId: String;
}
export interface DeleteDeploymentRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the Deployment resource to delete.
*/
deploymentId: String;
}
export interface DeleteDocumentationPartRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the to-be-deleted documentation part.
*/
documentationPartId: String;
}
export interface DeleteDocumentationVersionRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The version identifier of a to-be-deleted documentation snapshot.
*/
documentationVersion: String;
}
export interface DeleteDomainNameRequest {
/**
* [Required] The name of the DomainName resource to be deleted.
*/
domainName: String;
}
export interface DeleteGatewayResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
*/
responseType: GatewayResponseType;
}
export interface DeleteIntegrationRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies a delete integration request's resource identifier.
*/
resourceId: String;
/**
* [Required] Specifies a delete integration request's HTTP method.
*/
httpMethod: String;
}
export interface DeleteIntegrationResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies a delete integration response request's resource identifier.
*/
resourceId: String;
/**
* [Required] Specifies a delete integration response request's HTTP method.
*/
httpMethod: String;
/**
* [Required] Specifies a delete integration response request's status code.
*/
statusCode: StatusCode;
}
export interface DeleteMethodRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The Resource identifier for the Method resource.
*/
resourceId: String;
/**
* [Required] The HTTP verb of the Method resource.
*/
httpMethod: String;
}
export interface DeleteMethodResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The Resource identifier for the MethodResponse resource.
*/
resourceId: String;
/**
* [Required] The HTTP verb of the Method resource.
*/
httpMethod: String;
/**
* [Required] The status code identifier for the MethodResponse resource.
*/
statusCode: StatusCode;
}
export interface DeleteModelRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the model to delete.
*/
modelName: String;
}
export interface DeleteRequestValidatorRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the RequestValidator to be deleted.
*/
requestValidatorId: String;
}
export interface DeleteResourceRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the Resource resource.
*/
resourceId: String;
}
export interface DeleteRestApiRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
}
export interface DeleteStageRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the Stage resource to delete.
*/
stageName: String;
}
export interface DeleteUsagePlanKeyRequest {
/**
* [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
*/
usagePlanId: String;
/**
* [Required] The Id of the UsagePlanKey resource to be deleted.
*/
keyId: String;
}
export interface DeleteUsagePlanRequest {
/**
* [Required] The Id of the to-be-deleted usage plan.
*/
usagePlanId: String;
}
export interface DeleteVpcLinkRequest {
/**
* [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*/
vpcLinkId: String;
}
export interface Deployment {
/**
* The identifier for the deployment resource.
*/
id?: String;
/**
* The description for the deployment resource.
*/
description?: String;
/**
* The date and time that the deployment resource was created.
*/
createdDate?: Timestamp;
/**
* A summary of the RestApi at the date and time that the deployment resource was created.
*/
apiSummary?: PathToMapOfMethodSnapshot;
}
export interface DeploymentCanarySettings {
/**
* The percentage (0.0-100.0) of traffic routed to the canary deployment.
*/
percentTraffic?: Double;
/**
* A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
*/
stageVariableOverrides?: MapOfStringToString;
/**
* A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
*/
useStageCache?: Boolean;
}
export interface Deployments {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfDeployment;
}
export interface DocumentationPart {
/**
* The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
*/
id?: String;
/**
* The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
*/
location?: DocumentationPartLocation;
/**
* A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.
*/
properties?: String;
}
export interface DocumentationPartIds {
/**
* A list of the returned documentation part identifiers.
*/
ids?: ListOfString;
/**
* A list of warning messages reported during import of documentation parts.
*/
warnings?: ListOfString;
}
export interface DocumentationPartLocation {
/**
* [Required] The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.
*/
type: DocumentationPartType;
/**
* The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.
*/
path?: String;
/**
* The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.
*/
method?: String;
/**
* The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.
*/
statusCode?: DocumentationPartLocationStatusCode;
/**
* The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.
*/
name?: String;
}
export type DocumentationPartLocationStatusCode = string;
export type DocumentationPartType = "API"|"AUTHORIZER"|"MODEL"|"RESOURCE"|"METHOD"|"PATH_PARAMETER"|"QUERY_PARAMETER"|"REQUEST_HEADER"|"REQUEST_BODY"|"RESPONSE"|"RESPONSE_HEADER"|"RESPONSE_BODY"|string;
export interface DocumentationParts {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfDocumentationPart;
}
export interface DocumentationVersion {
/**
* The version identifier of the API documentation snapshot.
*/
version?: String;
/**
* The date when the API documentation snapshot is created.
*/
createdDate?: Timestamp;
/**
* The description of the API documentation snapshot.
*/
description?: String;
}
export interface DocumentationVersions {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfDocumentationVersion;
}
export interface DomainName {
/**
* The custom domain name as an API host name, for example, my-api.example.com.
*/
domainName?: String;
/**
* The name of the certificate that will be used by edge-optimized endpoint for this domain name.
*/
certificateName?: String;
/**
* The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
*/
certificateArn?: String;
/**
* The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
*/
certificateUploadDate?: Timestamp;
/**
* The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
*/
regionalDomainName?: String;
/**
* The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
*/
regionalHostedZoneId?: String;
/**
* The name of the certificate that will be used for validating the regional domain name.
*/
regionalCertificateName?: String;
/**
* The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
*/
regionalCertificateArn?: String;
/**
* The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
*/
distributionDomainName?: String;
/**
* The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
*/
distributionHostedZoneId?: String;
/**
* The endpoint configuration of this DomainName showing the endpoint types of the domain name.
*/
endpointConfiguration?: EndpointConfiguration;
/**
* The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
*/
domainNameStatus?: DomainNameStatus;
/**
* An optional text message containing detailed information about status of the DomainName migration.
*/
domainNameStatusMessage?: String;
/**
* The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
*/
securityPolicy?: SecurityPolicy;
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
tags?: MapOfStringToString;
}
export type DomainNameStatus = "AVAILABLE"|"UPDATING"|"PENDING"|string;
export interface DomainNames {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfDomainName;
}
export type Double = number;
export interface EndpointConfiguration {
/**
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
*/
types?: ListOfEndpointType;
/**
* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.
*/
vpcEndpointIds?: ListOfString;
}
export type EndpointType = "REGIONAL"|"EDGE"|"PRIVATE"|string;
export interface ExportResponse {
/**
* The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
*/
contentType?: String;
/**
* The content-disposition header value in the HTTP response.
*/
contentDisposition?: String;
/**
* The binary blob response to GetExport, which contains the export.
*/
body?: _Blob;
}
export interface FlushStageAuthorizersCacheRequest {
/**
* The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The name of the stage to flush.
*/
stageName: String;
}
export interface FlushStageCacheRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the stage to flush its cache.
*/
stageName: String;
}
export interface GatewayResponse {
/**
* The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
*/
responseType?: GatewayResponseType;
/**
* The HTTP status code for this GatewayResponse.
*/
statusCode?: StatusCode;
/**
* Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
*/
responseParameters?: MapOfStringToString;
/**
* Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
*/
responseTemplates?: MapOfStringToString;
/**
* A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.
*/
defaultResponse?: Boolean;
}
export type GatewayResponseType = "DEFAULT_4XX"|"DEFAULT_5XX"|"RESOURCE_NOT_FOUND"|"UNAUTHORIZED"|"INVALID_API_KEY"|"ACCESS_DENIED"|"AUTHORIZER_FAILURE"|"AUTHORIZER_CONFIGURATION_ERROR"|"INVALID_SIGNATURE"|"EXPIRED_TOKEN"|"MISSING_AUTHENTICATION_TOKEN"|"INTEGRATION_FAILURE"|"INTEGRATION_TIMEOUT"|"API_CONFIGURATION_ERROR"|"UNSUPPORTED_MEDIA_TYPE"|"BAD_REQUEST_PARAMETERS"|"BAD_REQUEST_BODY"|"REQUEST_TOO_LARGE"|"THROTTLED"|"QUOTA_EXCEEDED"|string;
export interface GatewayResponses {
position?: String;
/**
* Returns the entire collection, because of no pagination support.
*/
items?: ListOfGatewayResponse;
}
export interface GenerateClientCertificateRequest {
/**
* The description of the ClientCertificate.
*/
description?: String;
/**
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
*/
tags?: MapOfStringToString;
}
export interface GetAccountRequest {
}
export interface GetApiKeyRequest {
/**
* [Required] The identifier of the ApiKey resource.
*/
apiKey: String;
/**
* A boolean flag to specify whether (true) or not (false) the result contains the key value.
*/
includeValue?: NullableBoolean;
}
export interface GetApiKeysRequest {
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
/**
* The name of queried API keys.
*/
nameQuery?: String;
/**
* The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
*/
customerId?: String;
/**
* A boolean flag to specify whether (true) or not (false) the result contains key values.
*/
includeValues?: NullableBoolean;
}
export interface GetAuthorizerRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the Authorizer resource.
*/
authorizerId: String;
}
export interface GetAuthorizersRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetBasePathMappingRequest {
/**
* [Required] The domain name of the BasePathMapping resource to be described.
*/
domainName: String;
/**
* [Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.
*/
basePath: String;
}
export interface GetBasePathMappingsRequest {
/**
* [Required] The domain name of a BasePathMapping resource.
*/
domainName: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetClientCertificateRequest {
/**
* [Required] The identifier of the ClientCertificate resource to be described.
*/
clientCertificateId: String;
}
export interface GetClientCertificatesRequest {
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetDeploymentRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the Deployment resource to get information about.
*/
deploymentId: String;
/**
* A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
*/
embed?: ListOfString;
}
export interface GetDeploymentsRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetDocumentationPartRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The string identifier of the associated RestApi.
*/
documentationPartId: String;
}
export interface GetDocumentationPartsRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The type of API entities of the to-be-retrieved documentation parts.
*/
type?: DocumentationPartType;
/**
* The name of API entities of the to-be-retrieved documentation parts.
*/
nameQuery?: String;
/**
* The path of API entities of the to-be-retrieved documentation parts.
*/
path?: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
/**
* The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
*/
locationStatus?: LocationStatusType;
}
export interface GetDocumentationVersionRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The version identifier of the to-be-retrieved documentation snapshot.
*/
documentationVersion: String;
}
export interface GetDocumentationVersionsRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetDomainNameRequest {
/**
* [Required] The name of the DomainName resource.
*/
domainName: String;
}
export interface GetDomainNamesRequest {
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetExportRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the Stage that will be exported.
*/
stageName: String;
/**
* [Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
*/
exportType: String;
/**
* A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool
*/
parameters?: MapOfStringToString;
/**
* The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.
*/
accepts?: String;
}
export interface GetGatewayResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
*/
responseType: GatewayResponseType;
}
export interface GetGatewayResponsesRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.
*/
limit?: NullableInteger;
}
export interface GetIntegrationRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies a get integration request's resource identifier
*/
resourceId: String;
/**
* [Required] Specifies a get integration request's HTTP method.
*/
httpMethod: String;
}
export interface GetIntegrationResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies a get integration response request's resource identifier.
*/
resourceId: String;
/**
* [Required] Specifies a get integration response request's HTTP method.
*/
httpMethod: String;
/**
* [Required] Specifies a get integration response request's status code.
*/
statusCode: StatusCode;
}
export interface GetMethodRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The Resource identifier for the Method resource.
*/
resourceId: String;
/**
* [Required] Specifies the method request's HTTP method type.
*/
httpMethod: String;
}
export interface GetMethodResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The Resource identifier for the MethodResponse resource.
*/
resourceId: String;
/**
* [Required] The HTTP verb of the Method resource.
*/
httpMethod: String;
/**
* [Required] The status code for the MethodResponse resource.
*/
statusCode: StatusCode;
}
export interface GetModelRequest {
/**
* [Required] The RestApi identifier under which the Model exists.
*/
restApiId: String;
/**
* [Required] The name of the model as an identifier.
*/
modelName: String;
/**
* A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.
*/
flatten?: Boolean;
}
export interface GetModelTemplateRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the model for which to generate a template.
*/
modelName: String;
}
export interface GetModelsRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetRequestValidatorRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the RequestValidator to be retrieved.
*/
requestValidatorId: String;
}
export interface GetRequestValidatorsRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetResourceRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier for the Resource resource.
*/
resourceId: String;
/**
* A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.
*/
embed?: ListOfString;
}
export interface GetResourcesRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
/**
* A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.
*/
embed?: ListOfString;
}
export interface GetRestApiRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
}
export interface GetRestApisRequest {
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetSdkRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the Stage that the SDK will use.
*/
stageName: String;
/**
* [Required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
*/
sdkType: String;
/**
* A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.
*/
parameters?: MapOfStringToString;
}
export interface GetSdkTypeRequest {
/**
* [Required] The identifier of the queried SdkType instance.
*/
id: String;
}
export interface GetSdkTypesRequest {
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetStageRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the Stage resource to get information about.
*/
stageName: String;
}
export interface GetStagesRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The stages' deployment identifiers.
*/
deploymentId?: String;
}
export interface GetTagsRequest {
/**
* [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
*/
resourceArn: String;
/**
* (Not currently supported) The current pagination position in the paged result set.
*/
position?: String;
/**
* (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetUsagePlanKeyRequest {
/**
* [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
*/
usagePlanId: String;
/**
* [Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
*/
keyId: String;
}
export interface GetUsagePlanKeysRequest {
/**
* [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
*/
usagePlanId: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
/**
* A query parameter specifying the name of the to-be-returned usage plan keys.
*/
nameQuery?: String;
}
export interface GetUsagePlanRequest {
/**
* [Required] The identifier of the UsagePlan resource to be retrieved.
*/
usagePlanId: String;
}
export interface GetUsagePlansRequest {
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The identifier of the API key associated with the usage plans.
*/
keyId?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetUsageRequest {
/**
* [Required] The Id of the usage plan associated with the usage data.
*/
usagePlanId: String;
/**
* The Id of the API key associated with the resultant usage data.
*/
keyId?: String;
/**
* [Required] The starting date (e.g., 2016-01-01) of the usage data.
*/
startDate: String;
/**
* [Required] The ending date (e.g., 2016-12-31) of the usage data.
*/
endDate: String;
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface GetVpcLinkRequest {
/**
* [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*/
vpcLinkId: String;
}
export interface GetVpcLinksRequest {
/**
* The current pagination position in the paged result set.
*/
position?: String;
/**
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
*/
limit?: NullableInteger;
}
export interface ImportApiKeysRequest {
/**
* The payload of the POST request to import API keys. For the payload format, see API Key File Format.
*/
body: _Blob;
/**
* A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.
*/
format: ApiKeysFormat;
/**
* A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.
*/
failOnWarnings?: Boolean;
}
export interface ImportDocumentationPartsRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.
*/
mode?: PutMode;
/**
* A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.
*/
failOnWarnings?: Boolean;
/**
* [Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
*/
body: _Blob;
}
export interface ImportRestApiRequest {
/**
* A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
*/
failOnWarnings?: Boolean;
/**
* A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values. To exclude DocumentationParts from the import, set parameters as ignore=documentation. To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE. To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split. For example, the AWS CLI command to exclude documentation from the imported API is: aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' The AWS CLI command to set the regional endpoint on the imported API is: aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
*/
parameters?: MapOfStringToString;
/**
* [Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.
*/
body: _Blob;
}
export type Integer = number;
export interface Integration {
/**
* Specifies an API method integration type. The valid value is one of the following: AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration. HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration. HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration. MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend. For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
*/
type?: IntegrationType;
/**
* Specifies the integration's HTTP method type.
*/
httpMethod?: String;
/**
* Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
*/
uri?: String;
/**
* The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
*/
connectionType?: ConnectionType;
/**
* The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
*/
connectionId?: String;
/**
* Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
*/
credentials?: String;
/**
* A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
*/
requestParameters?: MapOfStringToString;
/**
* Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
*/
requestTemplates?: MapOfStringToString;
/**
* Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
*/
passthroughBehavior?: String;
/**
* Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
*/
contentHandling?: ContentHandlingStrategy;
/**
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
*/
timeoutInMillis?: Integer;
/**
* An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
*/
cacheNamespace?: String;
/**
* A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
*/
cacheKeyParameters?: ListOfString;
/**
* Specifies the integration's responses. Example: Get integration responses of a method Request GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns 200 OK status and a payload as follows: { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } Creating an API
*/
integrationResponses?: MapOfIntegrationResponse;
}
export interface IntegrationResponse {
/**
* Specifies the status code that is used to map the integration response to an existing MethodResponse.
*/
statusCode?: StatusCode;
/**
* Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
*/
selectionPattern?: String;
/**
* A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
*/
responseParameters?: MapOfStringToString;
/**
* Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
*/
responseTemplates?: MapOfStringToString;
/**
* Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
*/
contentHandling?: ContentHandlingStrategy;
}
export type IntegrationType = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY"|string;
export type ListOfARNs = ProviderARN[];
export type ListOfApiKey = ApiKey[];
export type ListOfApiStage = ApiStage[];
export type ListOfAuthorizer = Authorizer[];
export type ListOfBasePathMapping = BasePathMapping[];
export type ListOfClientCertificate = ClientCertificate[];
export type ListOfDeployment = Deployment[];
export type ListOfDocumentationPart = DocumentationPart[];
export type ListOfDocumentationVersion = DocumentationVersion[];
export type ListOfDomainName = DomainName[];
export type ListOfEndpointType = EndpointType[];
export type ListOfGatewayResponse = GatewayResponse[];
export type ListOfLong = Long[];
export type ListOfModel = Model[];
export type ListOfPatchOperation = PatchOperation[];
export type ListOfRequestValidator = RequestValidator[];
export type ListOfResource = Resource[];
export type ListOfRestApi = RestApi[];
export type ListOfSdkConfigurationProperty = SdkConfigurationProperty[];
export type ListOfSdkType = SdkType[];
export type ListOfStage = Stage[];
export type ListOfStageKeys = StageKey[];
export type ListOfString = String[];
export type ListOfUsage = ListOfLong[];
export type ListOfUsagePlan = UsagePlan[];
export type ListOfUsagePlanKey = UsagePlanKey[];
export type ListOfVpcLink = VpcLink[];
export type LocationStatusType = "DOCUMENTED"|"UNDOCUMENTED"|string;
export type Long = number;
export type MapOfApiStageThrottleSettings = {[key: string]: ThrottleSettings};
export type MapOfIntegrationResponse = {[key: string]: IntegrationResponse};
export type MapOfKeyUsages = {[key: string]: ListOfUsage};
export type MapOfMethod = {[key: string]: Method};
export type MapOfMethodResponse = {[key: string]: MethodResponse};
export type MapOfMethodSettings = {[key: string]: MethodSetting};
export type MapOfMethodSnapshot = {[key: string]: MethodSnapshot};
export type MapOfStringToBoolean = {[key: string]: NullableBoolean};
export type MapOfStringToList = {[key: string]: ListOfString};
export type MapOfStringToString = {[key: string]: String};
export interface Method {
/**
* The method's HTTP verb.
*/
httpMethod?: String;
/**
* The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
*/
authorizationType?: String;
/**
* The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
*/
authorizerId?: String;
/**
* A boolean flag specifying whether a valid ApiKey is required to invoke this method.
*/
apiKeyRequired?: NullableBoolean;
/**
* The identifier of a RequestValidator for request validation.
*/
requestValidatorId?: String;
/**
* A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
*/
operationName?: String;
/**
* A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
*/
requestParameters?: MapOfStringToBoolean;
/**
* A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
*/
requestModels?: MapOfStringToString;
/**
* Gets a method response associated with a given HTTP status code. The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response. Example: Get a 200 OK response of a GET method Request GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK status code and a payload similar to the following: { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" } AWS CLI
*/
methodResponses?: MapOfMethodResponse;
/**
* Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end. Example: Request GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK status code and a payload similar to the following: { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } } AWS CLI
*/
methodIntegration?: Integration;
/**
* A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
*/
authorizationScopes?: ListOfString;
}
export interface MethodResponse {
/**
* The method response's status code.
*/
statusCode?: StatusCode;
/**
* A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
*/
responseParameters?: MapOfStringToBoolean;
/**
* Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
*/
responseModels?: MapOfStringToString;
}
export interface MethodSetting {
/**
* Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.
*/
metricsEnabled?: Boolean;
/**
* Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.
*/
loggingLevel?: String;
/**
* Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.
*/
dataTraceEnabled?: Boolean;
/**
* Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.
*/
throttlingBurstLimit?: Integer;
/**
* Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.
*/
throttlingRateLimit?: Double;
/**
* Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.
*/
cachingEnabled?: Boolean;
/**
* Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.
*/
cacheTtlInSeconds?: Integer;
/**
* Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.
*/
cacheDataEncrypted?: Boolean;
/**
* Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.
*/
requireAuthorizationForCacheControl?: Boolean;
/**
* Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.
*/
unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy;
}
export interface MethodSnapshot {
/**
* The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
*/
authorizationType?: String;
/**
* Specifies whether the method requires a valid ApiKey.
*/
apiKeyRequired?: Boolean;
}
export interface Model {
/**
* The identifier for the model resource.
*/
id?: String;
/**
* The name of the model. Must be an alphanumeric string.
*/
name?: String;
/**
* The description of the model.
*/
description?: String;
/**
* The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*" characters in the description of any properties because such "\*" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
*/
schema?: String;
/**
* The content-type for the model.
*/
contentType?: String;
}
export interface Models {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfModel;
}
export type NullableBoolean = boolean;
export type NullableInteger = number;
export type Op = "add"|"remove"|"replace"|"move"|"copy"|"test"|string;
export interface PatchOperation {
/**
* An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.
*/
op?: Op;
/**
* The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.
*/
path?: String;
/**
* The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters.
*/
value?: String;
/**
* The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".
*/
from?: String;
}
export type PathToMapOfMethodSnapshot = {[key: string]: MapOfMethodSnapshot};
export type ProviderARN = string;
export interface PutGatewayResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
*/
responseType: GatewayResponseType;
/**
* The HTTP status code of the GatewayResponse.
*/
statusCode?: StatusCode;
/**
* Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
*/
responseParameters?: MapOfStringToString;
/**
* Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
*/
responseTemplates?: MapOfStringToString;
}
export interface PutIntegrationRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies a put integration request's resource ID.
*/
resourceId: String;
/**
* [Required] Specifies a put integration request's HTTP method.
*/
httpMethod: String;
/**
* [Required] Specifies a put integration input's type.
*/
type: IntegrationType;
/**
* Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
*/
integrationHttpMethod?: String;
/**
* Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
*/
uri?: String;
/**
* The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
*/
connectionType?: ConnectionType;
/**
* The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
*/
connectionId?: String;
/**
* Specifies whether credentials are required for a put integration.
*/
credentials?: String;
/**
* A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
*/
requestParameters?: MapOfStringToString;
/**
* Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
*/
requestTemplates?: MapOfStringToString;
/**
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation. NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response. WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.
*/
passthroughBehavior?: String;
/**
* A list of request parameters whose values are to be cached.
*/
cacheNamespace?: String;
/**
* An API-specific tag group of related cached parameters.
*/
cacheKeyParameters?: ListOfString;
/**
* Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
*/
contentHandling?: ContentHandlingStrategy;
/**
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
*/
timeoutInMillis?: NullableInteger;
}
export interface PutIntegrationResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies a put integration response request's resource identifier.
*/
resourceId: String;
/**
* [Required] Specifies a put integration response request's HTTP method.
*/
httpMethod: String;
/**
* [Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.
*/
statusCode: StatusCode;
/**
* Specifies the selection pattern of a put integration response.
*/
selectionPattern?: String;
/**
* A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.
*/
responseParameters?: MapOfStringToString;
/**
* Specifies a put integration response's templates.
*/
responseTemplates?: MapOfStringToString;
/**
* Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
*/
contentHandling?: ContentHandlingStrategy;
}
export interface PutMethodRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The Resource identifier for the new Method resource.
*/
resourceId: String;
/**
* [Required] Specifies the method request's HTTP method type.
*/
httpMethod: String;
/**
* [Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
*/
authorizationType: String;
/**
* Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
*/
authorizerId?: String;
/**
* Specifies whether the method required a valid ApiKey.
*/
apiKeyRequired?: Boolean;
/**
* A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
*/
operationName?: String;
/**
* A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.
*/
requestParameters?: MapOfStringToBoolean;
/**
* Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
*/
requestModels?: MapOfStringToString;
/**
* The identifier of a RequestValidator for validating the method request.
*/
requestValidatorId?: String;
/**
* A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
*/
authorizationScopes?: ListOfString;
}
export interface PutMethodResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The Resource identifier for the Method resource.
*/
resourceId: String;
/**
* [Required] The HTTP verb of the Method resource.
*/
httpMethod: String;
/**
* [Required] The method response's status code.
*/
statusCode: StatusCode;
/**
* A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
*/
responseParameters?: MapOfStringToBoolean;
/**
* Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
*/
responseModels?: MapOfStringToString;
}
export type PutMode = "merge"|"overwrite"|string;
export interface PutRestApiRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
*/
mode?: PutMode;
/**
* A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
*/
failOnWarnings?: Boolean;
/**
* Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
*/
parameters?: MapOfStringToString;
/**
* [Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.
*/
body: _Blob;
}
export type QuotaPeriodType = "DAY"|"WEEK"|"MONTH"|string;
export interface QuotaSettings {
/**
* The maximum number of requests that can be made in a given time period.
*/
limit?: Integer;
/**
* The number of requests subtracted from the given limit in the initial time period.
*/
offset?: Integer;
/**
* The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
*/
period?: QuotaPeriodType;
}
export interface RequestValidator {
/**
* The identifier of this RequestValidator.
*/
id?: String;
/**
* The name of this RequestValidator
*/
name?: String;
/**
* A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
*/
validateRequestBody?: Boolean;
/**
* A Boolean flag to indicate whether to validate request parameters (true) or not (false).
*/
validateRequestParameters?: Boolean;
}
export interface RequestValidators {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfRequestValidator;
}
export interface Resource {
/**
* The resource's identifier.
*/
id?: String;
/**
* The parent resource's identifier.
*/
parentId?: String;
/**
* The last path segment for this resource.
*/
pathPart?: String;
/**
* The full path for this resource.
*/
path?: String;
/**
* Gets an API resource's method of a given HTTP verb. The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request. Example: Get the GET method of an API resource Request GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } } If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.
*/
resourceMethods?: MapOfMethod;
}
export interface Resources {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfResource;
}
export interface RestApi {
/**
* The API's identifier. This identifier is unique across all of your APIs in API Gateway.
*/
id?: String;
/**
* The API's name.
*/
name?: String;
/**
* The API's description.
*/
description?: String;
/**
* The timestamp when the API was created.
*/
createdDate?: Timestamp;
/**
* A version identifier for the API.
*/
version?: String;
/**
* The warning messages reported when failonwarnings is turned on during API import.
*/
warnings?: ListOfString;
/**
* The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
*/
binaryMediaTypes?: ListOfString;
/**
* A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
*/
minimumCompressionSize?: NullableInteger;
/**
* The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
*/
apiKeySource?: ApiKeySourceType;
/**
* The endpoint configuration of this RestApi showing the endpoint types of the API.
*/
endpointConfiguration?: EndpointConfiguration;
/**
* A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
*/
policy?: String;
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
tags?: MapOfStringToString;
}
export interface RestApis {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfRestApi;
}
export interface SdkConfigurationProperty {
/**
* The name of a an SdkType configuration property.
*/
name?: String;
/**
* The user-friendly name of an SdkType configuration property.
*/
friendlyName?: String;
/**
* The description of an SdkType configuration property.
*/
description?: String;
/**
* A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).
*/
required?: Boolean;
/**
* The default value of an SdkType configuration property.
*/
defaultValue?: String;
}
export interface SdkResponse {
/**
* The content-type header value in the HTTP response.
*/
contentType?: String;
/**
* The content-disposition header value in the HTTP response.
*/
contentDisposition?: String;
/**
* The binary blob response to GetSdk, which contains the generated SDK.
*/
body?: _Blob;
}
export interface SdkType {
/**
* The identifier of an SdkType instance.
*/
id?: String;
/**
* The user-friendly name of an SdkType instance.
*/
friendlyName?: String;
/**
* The description of an SdkType.
*/
description?: String;
/**
* A list of configuration properties of an SdkType.
*/
configurationProperties?: ListOfSdkConfigurationProperty;
}
export interface SdkTypes {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfSdkType;
}
export type SecurityPolicy = "TLS_1_0"|"TLS_1_2"|string;
export interface Stage {
/**
* The identifier of the Deployment that the stage points to.
*/
deploymentId?: String;
/**
* The identifier of a client certificate for an API stage.
*/
clientCertificateId?: String;
/**
* The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
*/
stageName?: String;
/**
* The stage's description.
*/
description?: String;
/**
* Specifies whether a cache cluster is enabled for the stage.
*/
cacheClusterEnabled?: Boolean;
/**
* The size of the cache cluster for the stage, if enabled.
*/
cacheClusterSize?: CacheClusterSize;
/**
* The status of the cache cluster for the stage, if enabled.
*/
cacheClusterStatus?: CacheClusterStatus;
/**
* A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*\* for overriding all methods in the stage.
*/
methodSettings?: MapOfMethodSettings;
/**
* A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
*/
variables?: MapOfStringToString;
/**
* The version of the associated API documentation.
*/
documentationVersion?: String;
/**
* Settings for logging access in this stage.
*/
accessLogSettings?: AccessLogSettings;
/**
* Settings for the canary deployment in this stage.
*/
canarySettings?: CanarySettings;
/**
* Specifies whether active tracing with X-ray is enabled for the Stage.
*/
tracingEnabled?: Boolean;
/**
* The ARN of the WebAcl associated with the Stage.
*/
webAclArn?: String;
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
tags?: MapOfStringToString;
/**
* The timestamp when the stage was created.
*/
createdDate?: Timestamp;
/**
* The timestamp when the stage last updated.
*/
lastUpdatedDate?: Timestamp;
}
export interface StageKey {
/**
* The string identifier of the associated RestApi.
*/
restApiId?: String;
/**
* The stage name associated with the stage key.
*/
stageName?: String;
}
export interface Stages {
/**
* The current page of elements from this collection.
*/
item?: ListOfStage;
}
export type StatusCode = string;
export type String = string;
export interface TagResourceRequest {
/**
* [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
*/
resourceArn: String;
/**
* [Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
*/
tags: MapOfStringToString;
}
export interface Tags {
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
tags?: MapOfStringToString;
}
export interface Template {
/**
* The Apache Velocity Template Language (VTL) template content used for the template resource.
*/
value?: String;
}
export interface TestInvokeAuthorizerRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies a test invoke authorizer request's Authorizer ID.
*/
authorizerId: String;
/**
* [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
*/
headers?: MapOfStringToString;
/**
* [Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
*/
multiValueHeaders?: MapOfStringToList;
/**
* [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
*/
pathWithQueryString?: String;
/**
* [Optional] The simulated request body of an incoming invocation request.
*/
body?: String;
/**
* A key-value map of stage variables to simulate an invocation on a deployed Stage.
*/
stageVariables?: MapOfStringToString;
/**
* [Optional] A key-value map of additional context variables.
*/
additionalContext?: MapOfStringToString;
}
export interface TestInvokeAuthorizerResponse {
/**
* The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
*/
clientStatus?: Integer;
/**
* The API Gateway execution log for the test authorizer request.
*/
log?: String;
/**
* The execution latency of the test authorizer request.
*/
latency?: Long;
/**
* The principal identity returned by the Authorizer
*/
principalId?: String;
/**
* The JSON policy document returned by the Authorizer
*/
policy?: String;
authorization?: MapOfStringToList;
/**
* The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
*/
claims?: MapOfStringToString;
}
export interface TestInvokeMethodRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies a test invoke method request's resource ID.
*/
resourceId: String;
/**
* [Required] Specifies a test invoke method request's HTTP method.
*/
httpMethod: String;
/**
* The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
*/
pathWithQueryString?: String;
/**
* The simulated request body of an incoming invocation request.
*/
body?: String;
/**
* A key-value map of headers to simulate an incoming invocation request.
*/
headers?: MapOfStringToString;
/**
* The headers as a map from string to list of values to simulate an incoming invocation request.
*/
multiValueHeaders?: MapOfStringToList;
/**
* A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
*/
clientCertificateId?: String;
/**
* A key-value map of stage variables to simulate an invocation on a deployed Stage.
*/
stageVariables?: MapOfStringToString;
}
export interface TestInvokeMethodResponse {
/**
* The HTTP status code.
*/
status?: Integer;
/**
* The body of the HTTP response.
*/
body?: String;
/**
* The headers of the HTTP response.
*/
headers?: MapOfStringToString;
/**
* The headers of the HTTP response as a map from string to list of values.
*/
multiValueHeaders?: MapOfStringToList;
/**
* The API Gateway execution log for the test invoke request.
*/
log?: String;
/**
* The execution latency of the test invoke request.
*/
latency?: Long;
}
export interface ThrottleSettings {
/**
* The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
*/
burstLimit?: Integer;
/**
* The API request steady-state rate limit.
*/
rateLimit?: Double;
}
export type Timestamp = Date;
export type UnauthorizedCacheControlHeaderStrategy = "FAIL_WITH_403"|"SUCCEED_WITH_RESPONSE_HEADER"|"SUCCEED_WITHOUT_RESPONSE_HEADER"|string;
export interface UntagResourceRequest {
/**
* [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
*/
resourceArn: String;
/**
* [Required] The Tag keys to delete.
*/
tagKeys: ListOfString;
}
export interface UpdateAccountRequest {
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateApiKeyRequest {
/**
* [Required] The identifier of the ApiKey resource to be updated.
*/
apiKey: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateAuthorizerRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the Authorizer resource.
*/
authorizerId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateBasePathMappingRequest {
/**
* [Required] The domain name of the BasePathMapping resource to change.
*/
domainName: String;
/**
* [Required] The base path of the BasePathMapping resource to change. To specify an empty base path, set this parameter to '(none)'.
*/
basePath: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateClientCertificateRequest {
/**
* [Required] The identifier of the ClientCertificate resource to be updated.
*/
clientCertificateId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateDeploymentRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* The replacement identifier for the Deployment resource to change information about.
*/
deploymentId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateDocumentationPartRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the to-be-updated documentation part.
*/
documentationPartId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateDocumentationVersionRequest {
/**
* [Required] The string identifier of the associated RestApi..
*/
restApiId: String;
/**
* [Required] The version identifier of the to-be-updated documentation version.
*/
documentationVersion: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateDomainNameRequest {
/**
* [Required] The name of the DomainName resource to be changed.
*/
domainName: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateGatewayResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
*/
responseType: GatewayResponseType;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateIntegrationRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Represents an update integration request's resource identifier.
*/
resourceId: String;
/**
* [Required] Represents an update integration request's HTTP method.
*/
httpMethod: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateIntegrationResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] Specifies an update integration response request's resource identifier.
*/
resourceId: String;
/**
* [Required] Specifies an update integration response request's HTTP method.
*/
httpMethod: String;
/**
* [Required] Specifies an update integration response request's status code.
*/
statusCode: StatusCode;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateMethodRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The Resource identifier for the Method resource.
*/
resourceId: String;
/**
* [Required] The HTTP verb of the Method resource.
*/
httpMethod: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateMethodResponseRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The Resource identifier for the MethodResponse resource.
*/
resourceId: String;
/**
* [Required] The HTTP verb of the Method resource.
*/
httpMethod: String;
/**
* [Required] The status code for the MethodResponse resource.
*/
statusCode: StatusCode;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateModelRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the model to update.
*/
modelName: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateRequestValidatorRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of RequestValidator to be updated.
*/
requestValidatorId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateResourceRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The identifier of the Resource resource.
*/
resourceId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateRestApiRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateStageRequest {
/**
* [Required] The string identifier of the associated RestApi.
*/
restApiId: String;
/**
* [Required] The name of the Stage resource to change information about.
*/
stageName: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateUsagePlanRequest {
/**
* [Required] The Id of the to-be-updated usage plan.
*/
usagePlanId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateUsageRequest {
/**
* [Required] The Id of the usage plan associated with the usage data.
*/
usagePlanId: String;
/**
* [Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
*/
keyId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface UpdateVpcLinkRequest {
/**
* [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*/
vpcLinkId: String;
/**
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*/
patchOperations?: ListOfPatchOperation;
}
export interface Usage {
/**
* The plan Id associated with this usage data.
*/
usagePlanId?: String;
/**
* The starting date of the usage data.
*/
startDate?: String;
/**
* The ending date of the usage data.
*/
endDate?: String;
position?: String;
/**
* The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].
*/
items?: MapOfKeyUsages;
}
export interface UsagePlan {
/**
* The identifier of a UsagePlan resource.
*/
id?: String;
/**
* The name of a usage plan.
*/
name?: String;
/**
* The description of a usage plan.
*/
description?: String;
/**
* The associated API stages of a usage plan.
*/
apiStages?: ListOfApiStage;
/**
* The request throttle limits of a usage plan.
*/
throttle?: ThrottleSettings;
/**
* The maximum number of permitted requests per a given unit time interval.
*/
quota?: QuotaSettings;
/**
* The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
*/
productCode?: String;
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
tags?: MapOfStringToString;
}
export interface UsagePlanKey {
/**
* The Id of a usage plan key.
*/
id?: String;
/**
* The type of a usage plan key. Currently, the valid key type is API_KEY.
*/
type?: String;
/**
* The value of a usage plan key.
*/
value?: String;
/**
* The name of a usage plan key.
*/
name?: String;
}
export interface UsagePlanKeys {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfUsagePlanKey;
}
export interface UsagePlans {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfUsagePlan;
}
export interface VpcLink {
/**
* The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*/
id?: String;
/**
* The name used to label and identify the VPC link.
*/
name?: String;
/**
* The description of the VPC link.
*/
description?: String;
/**
* The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
*/
targetArns?: ListOfString;
/**
* The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
*/
status?: VpcLinkStatus;
/**
* A description about the VPC link status.
*/
statusMessage?: String;
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
tags?: MapOfStringToString;
}
export type VpcLinkStatus = "AVAILABLE"|"PENDING"|"DELETING"|"FAILED"|string;
export interface VpcLinks {
position?: String;
/**
* The current page of elements from this collection.
*/
items?: ListOfVpcLink;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2015-07-09"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the APIGateway client.
*/
export import Types = APIGateway;
}
export = APIGateway;