wafregional.d.ts
249 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
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 WAFRegional extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: WAFRegional.Types.ClientConfiguration)
config: Config & WAFRegional.Types.ClientConfiguration;
/**
* Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.
*/
associateWebACL(params: WAFRegional.Types.AssociateWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.AssociateWebACLResponse) => void): Request<WAFRegional.Types.AssociateWebACLResponse, AWSError>;
/**
* Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.
*/
associateWebACL(callback?: (err: AWSError, data: WAFRegional.Types.AssociateWebACLResponse) => void): Request<WAFRegional.Types.AssociateWebACLResponse, AWSError>;
/**
* Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createByteMatchSet(params: WAFRegional.Types.CreateByteMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateByteMatchSetResponse) => void): Request<WAFRegional.Types.CreateByteMatchSetResponse, AWSError>;
/**
* Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createByteMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateByteMatchSetResponse) => void): Request<WAFRegional.Types.CreateByteMatchSetResponse, AWSError>;
/**
* Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createGeoMatchSet(params: WAFRegional.Types.CreateGeoMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateGeoMatchSetResponse) => void): Request<WAFRegional.Types.CreateGeoMatchSetResponse, AWSError>;
/**
* Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createGeoMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateGeoMatchSetResponse) => void): Request<WAFRegional.Types.CreateGeoMatchSetResponse, AWSError>;
/**
* Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createIPSet(params: WAFRegional.Types.CreateIPSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateIPSetResponse) => void): Request<WAFRegional.Types.CreateIPSetResponse, AWSError>;
/**
* Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createIPSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateIPSetResponse) => void): Request<WAFRegional.Types.CreateIPSetResponse, AWSError>;
/**
* Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRateBasedRule(params: WAFRegional.Types.CreateRateBasedRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRateBasedRuleResponse) => void): Request<WAFRegional.Types.CreateRateBasedRuleResponse, AWSError>;
/**
* Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRateBasedRule(callback?: (err: AWSError, data: WAFRegional.Types.CreateRateBasedRuleResponse) => void): Request<WAFRegional.Types.CreateRateBasedRuleResponse, AWSError>;
/**
* Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRegexMatchSet(params: WAFRegional.Types.CreateRegexMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRegexMatchSetResponse) => void): Request<WAFRegional.Types.CreateRegexMatchSetResponse, AWSError>;
/**
* Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRegexMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateRegexMatchSetResponse) => void): Request<WAFRegional.Types.CreateRegexMatchSetResponse, AWSError>;
/**
* Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRegexPatternSet(params: WAFRegional.Types.CreateRegexPatternSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRegexPatternSetResponse) => void): Request<WAFRegional.Types.CreateRegexPatternSetResponse, AWSError>;
/**
* Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRegexPatternSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateRegexPatternSetResponse) => void): Request<WAFRegional.Types.CreateRegexPatternSetResponse, AWSError>;
/**
* Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRule(params: WAFRegional.Types.CreateRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRuleResponse) => void): Request<WAFRegional.Types.CreateRuleResponse, AWSError>;
/**
* Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRule(callback?: (err: AWSError, data: WAFRegional.Types.CreateRuleResponse) => void): Request<WAFRegional.Types.CreateRuleResponse, AWSError>;
/**
* Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRuleGroup(params: WAFRegional.Types.CreateRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRuleGroupResponse) => void): Request<WAFRegional.Types.CreateRuleGroupResponse, AWSError>;
/**
* Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.CreateRuleGroupResponse) => void): Request<WAFRegional.Types.CreateRuleGroupResponse, AWSError>;
/**
* Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createSizeConstraintSet(params: WAFRegional.Types.CreateSizeConstraintSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateSizeConstraintSetResponse) => void): Request<WAFRegional.Types.CreateSizeConstraintSetResponse, AWSError>;
/**
* Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createSizeConstraintSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateSizeConstraintSetResponse) => void): Request<WAFRegional.Types.CreateSizeConstraintSetResponse, AWSError>;
/**
* Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createSqlInjectionMatchSet(params: WAFRegional.Types.CreateSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateSqlInjectionMatchSetResponse) => void): Request<WAFRegional.Types.CreateSqlInjectionMatchSetResponse, AWSError>;
/**
* Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createSqlInjectionMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateSqlInjectionMatchSetResponse) => void): Request<WAFRegional.Types.CreateSqlInjectionMatchSetResponse, AWSError>;
/**
* Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
*/
createWebACL(params: WAFRegional.Types.CreateWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateWebACLResponse) => void): Request<WAFRegional.Types.CreateWebACLResponse, AWSError>;
/**
* Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
*/
createWebACL(callback?: (err: AWSError, data: WAFRegional.Types.CreateWebACLResponse) => void): Request<WAFRegional.Types.CreateWebACLResponse, AWSError>;
/**
* Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createXssMatchSet(params: WAFRegional.Types.CreateXssMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateXssMatchSetResponse) => void): Request<WAFRegional.Types.CreateXssMatchSetResponse, AWSError>;
/**
* Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
createXssMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateXssMatchSetResponse) => void): Request<WAFRegional.Types.CreateXssMatchSetResponse, AWSError>;
/**
* Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request.
*/
deleteByteMatchSet(params: WAFRegional.Types.DeleteByteMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteByteMatchSetResponse) => void): Request<WAFRegional.Types.DeleteByteMatchSetResponse, AWSError>;
/**
* Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request.
*/
deleteByteMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteByteMatchSetResponse) => void): Request<WAFRegional.Types.DeleteByteMatchSetResponse, AWSError>;
/**
* Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request.
*/
deleteGeoMatchSet(params: WAFRegional.Types.DeleteGeoMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteGeoMatchSetResponse) => void): Request<WAFRegional.Types.DeleteGeoMatchSetResponse, AWSError>;
/**
* Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request.
*/
deleteGeoMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteGeoMatchSetResponse) => void): Request<WAFRegional.Types.DeleteGeoMatchSetResponse, AWSError>;
/**
* Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request.
*/
deleteIPSet(params: WAFRegional.Types.DeleteIPSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteIPSetResponse) => void): Request<WAFRegional.Types.DeleteIPSetResponse, AWSError>;
/**
* Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request.
*/
deleteIPSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteIPSetResponse) => void): Request<WAFRegional.Types.DeleteIPSetResponse, AWSError>;
/**
* Permanently deletes the LoggingConfiguration from the specified web ACL.
*/
deleteLoggingConfiguration(params: WAFRegional.Types.DeleteLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteLoggingConfigurationResponse) => void): Request<WAFRegional.Types.DeleteLoggingConfigurationResponse, AWSError>;
/**
* Permanently deletes the LoggingConfiguration from the specified web ACL.
*/
deleteLoggingConfiguration(callback?: (err: AWSError, data: WAFRegional.Types.DeleteLoggingConfigurationResponse) => void): Request<WAFRegional.Types.DeleteLoggingConfigurationResponse, AWSError>;
/**
* Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup.
*/
deletePermissionPolicy(params: WAFRegional.Types.DeletePermissionPolicyRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeletePermissionPolicyResponse) => void): Request<WAFRegional.Types.DeletePermissionPolicyResponse, AWSError>;
/**
* Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup.
*/
deletePermissionPolicy(callback?: (err: AWSError, data: WAFRegional.Types.DeletePermissionPolicyResponse) => void): Request<WAFRegional.Types.DeletePermissionPolicyResponse, AWSError>;
/**
* Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request.
*/
deleteRateBasedRule(params: WAFRegional.Types.DeleteRateBasedRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRateBasedRuleResponse) => void): Request<WAFRegional.Types.DeleteRateBasedRuleResponse, AWSError>;
/**
* Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request.
*/
deleteRateBasedRule(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRateBasedRuleResponse) => void): Request<WAFRegional.Types.DeleteRateBasedRuleResponse, AWSError>;
/**
* Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request.
*/
deleteRegexMatchSet(params: WAFRegional.Types.DeleteRegexMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRegexMatchSetResponse) => void): Request<WAFRegional.Types.DeleteRegexMatchSetResponse, AWSError>;
/**
* Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request.
*/
deleteRegexMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRegexMatchSetResponse) => void): Request<WAFRegional.Types.DeleteRegexMatchSetResponse, AWSError>;
/**
* Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty.
*/
deleteRegexPatternSet(params: WAFRegional.Types.DeleteRegexPatternSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRegexPatternSetResponse) => void): Request<WAFRegional.Types.DeleteRegexPatternSetResponse, AWSError>;
/**
* Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty.
*/
deleteRegexPatternSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRegexPatternSetResponse) => void): Request<WAFRegional.Types.DeleteRegexPatternSetResponse, AWSError>;
/**
* Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request.
*/
deleteRule(params: WAFRegional.Types.DeleteRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRuleResponse) => void): Request<WAFRegional.Types.DeleteRuleResponse, AWSError>;
/**
* Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request.
*/
deleteRule(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRuleResponse) => void): Request<WAFRegional.Types.DeleteRuleResponse, AWSError>;
/**
* Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request.
*/
deleteRuleGroup(params: WAFRegional.Types.DeleteRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRuleGroupResponse) => void): Request<WAFRegional.Types.DeleteRuleGroupResponse, AWSError>;
/**
* Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request.
*/
deleteRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRuleGroupResponse) => void): Request<WAFRegional.Types.DeleteRuleGroupResponse, AWSError>;
/**
* Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request.
*/
deleteSizeConstraintSet(params: WAFRegional.Types.DeleteSizeConstraintSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteSizeConstraintSetResponse) => void): Request<WAFRegional.Types.DeleteSizeConstraintSetResponse, AWSError>;
/**
* Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request.
*/
deleteSizeConstraintSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteSizeConstraintSetResponse) => void): Request<WAFRegional.Types.DeleteSizeConstraintSetResponse, AWSError>;
/**
* Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request.
*/
deleteSqlInjectionMatchSet(params: WAFRegional.Types.DeleteSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteSqlInjectionMatchSetResponse) => void): Request<WAFRegional.Types.DeleteSqlInjectionMatchSetResponse, AWSError>;
/**
* Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request.
*/
deleteSqlInjectionMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteSqlInjectionMatchSetResponse) => void): Request<WAFRegional.Types.DeleteSqlInjectionMatchSetResponse, AWSError>;
/**
* Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request.
*/
deleteWebACL(params: WAFRegional.Types.DeleteWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteWebACLResponse) => void): Request<WAFRegional.Types.DeleteWebACLResponse, AWSError>;
/**
* Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request.
*/
deleteWebACL(callback?: (err: AWSError, data: WAFRegional.Types.DeleteWebACLResponse) => void): Request<WAFRegional.Types.DeleteWebACLResponse, AWSError>;
/**
* Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request.
*/
deleteXssMatchSet(params: WAFRegional.Types.DeleteXssMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteXssMatchSetResponse) => void): Request<WAFRegional.Types.DeleteXssMatchSetResponse, AWSError>;
/**
* Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request.
*/
deleteXssMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteXssMatchSetResponse) => void): Request<WAFRegional.Types.DeleteXssMatchSetResponse, AWSError>;
/**
* Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.
*/
disassociateWebACL(params: WAFRegional.Types.DisassociateWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.DisassociateWebACLResponse) => void): Request<WAFRegional.Types.DisassociateWebACLResponse, AWSError>;
/**
* Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.
*/
disassociateWebACL(callback?: (err: AWSError, data: WAFRegional.Types.DisassociateWebACLResponse) => void): Request<WAFRegional.Types.DisassociateWebACLResponse, AWSError>;
/**
* Returns the ByteMatchSet specified by ByteMatchSetId.
*/
getByteMatchSet(params: WAFRegional.Types.GetByteMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetByteMatchSetResponse) => void): Request<WAFRegional.Types.GetByteMatchSetResponse, AWSError>;
/**
* Returns the ByteMatchSet specified by ByteMatchSetId.
*/
getByteMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetByteMatchSetResponse) => void): Request<WAFRegional.Types.GetByteMatchSetResponse, AWSError>;
/**
* When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.
*/
getChangeToken(params: WAFRegional.Types.GetChangeTokenRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetChangeTokenResponse) => void): Request<WAFRegional.Types.GetChangeTokenResponse, AWSError>;
/**
* When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.
*/
getChangeToken(callback?: (err: AWSError, data: WAFRegional.Types.GetChangeTokenResponse) => void): Request<WAFRegional.Types.GetChangeTokenResponse, AWSError>;
/**
* Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete.
*/
getChangeTokenStatus(params: WAFRegional.Types.GetChangeTokenStatusRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetChangeTokenStatusResponse) => void): Request<WAFRegional.Types.GetChangeTokenStatusResponse, AWSError>;
/**
* Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete.
*/
getChangeTokenStatus(callback?: (err: AWSError, data: WAFRegional.Types.GetChangeTokenStatusResponse) => void): Request<WAFRegional.Types.GetChangeTokenStatusResponse, AWSError>;
/**
* Returns the GeoMatchSet that is specified by GeoMatchSetId.
*/
getGeoMatchSet(params: WAFRegional.Types.GetGeoMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetGeoMatchSetResponse) => void): Request<WAFRegional.Types.GetGeoMatchSetResponse, AWSError>;
/**
* Returns the GeoMatchSet that is specified by GeoMatchSetId.
*/
getGeoMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetGeoMatchSetResponse) => void): Request<WAFRegional.Types.GetGeoMatchSetResponse, AWSError>;
/**
* Returns the IPSet that is specified by IPSetId.
*/
getIPSet(params: WAFRegional.Types.GetIPSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetIPSetResponse) => void): Request<WAFRegional.Types.GetIPSetResponse, AWSError>;
/**
* Returns the IPSet that is specified by IPSetId.
*/
getIPSet(callback?: (err: AWSError, data: WAFRegional.Types.GetIPSetResponse) => void): Request<WAFRegional.Types.GetIPSetResponse, AWSError>;
/**
* Returns the LoggingConfiguration for the specified web ACL.
*/
getLoggingConfiguration(params: WAFRegional.Types.GetLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetLoggingConfigurationResponse) => void): Request<WAFRegional.Types.GetLoggingConfigurationResponse, AWSError>;
/**
* Returns the LoggingConfiguration for the specified web ACL.
*/
getLoggingConfiguration(callback?: (err: AWSError, data: WAFRegional.Types.GetLoggingConfigurationResponse) => void): Request<WAFRegional.Types.GetLoggingConfigurationResponse, AWSError>;
/**
* Returns the IAM policy attached to the RuleGroup.
*/
getPermissionPolicy(params: WAFRegional.Types.GetPermissionPolicyRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetPermissionPolicyResponse) => void): Request<WAFRegional.Types.GetPermissionPolicyResponse, AWSError>;
/**
* Returns the IAM policy attached to the RuleGroup.
*/
getPermissionPolicy(callback?: (err: AWSError, data: WAFRegional.Types.GetPermissionPolicyResponse) => void): Request<WAFRegional.Types.GetPermissionPolicyResponse, AWSError>;
/**
* Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request.
*/
getRateBasedRule(params: WAFRegional.Types.GetRateBasedRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRateBasedRuleResponse) => void): Request<WAFRegional.Types.GetRateBasedRuleResponse, AWSError>;
/**
* Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request.
*/
getRateBasedRule(callback?: (err: AWSError, data: WAFRegional.Types.GetRateBasedRuleResponse) => void): Request<WAFRegional.Types.GetRateBasedRuleResponse, AWSError>;
/**
* Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.
*/
getRateBasedRuleManagedKeys(params: WAFRegional.Types.GetRateBasedRuleManagedKeysRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRateBasedRuleManagedKeysResponse) => void): Request<WAFRegional.Types.GetRateBasedRuleManagedKeysResponse, AWSError>;
/**
* Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.
*/
getRateBasedRuleManagedKeys(callback?: (err: AWSError, data: WAFRegional.Types.GetRateBasedRuleManagedKeysResponse) => void): Request<WAFRegional.Types.GetRateBasedRuleManagedKeysResponse, AWSError>;
/**
* Returns the RegexMatchSet specified by RegexMatchSetId.
*/
getRegexMatchSet(params: WAFRegional.Types.GetRegexMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRegexMatchSetResponse) => void): Request<WAFRegional.Types.GetRegexMatchSetResponse, AWSError>;
/**
* Returns the RegexMatchSet specified by RegexMatchSetId.
*/
getRegexMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetRegexMatchSetResponse) => void): Request<WAFRegional.Types.GetRegexMatchSetResponse, AWSError>;
/**
* Returns the RegexPatternSet specified by RegexPatternSetId.
*/
getRegexPatternSet(params: WAFRegional.Types.GetRegexPatternSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRegexPatternSetResponse) => void): Request<WAFRegional.Types.GetRegexPatternSetResponse, AWSError>;
/**
* Returns the RegexPatternSet specified by RegexPatternSetId.
*/
getRegexPatternSet(callback?: (err: AWSError, data: WAFRegional.Types.GetRegexPatternSetResponse) => void): Request<WAFRegional.Types.GetRegexPatternSetResponse, AWSError>;
/**
* Returns the Rule that is specified by the RuleId that you included in the GetRule request.
*/
getRule(params: WAFRegional.Types.GetRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRuleResponse) => void): Request<WAFRegional.Types.GetRuleResponse, AWSError>;
/**
* Returns the Rule that is specified by the RuleId that you included in the GetRule request.
*/
getRule(callback?: (err: AWSError, data: WAFRegional.Types.GetRuleResponse) => void): Request<WAFRegional.Types.GetRuleResponse, AWSError>;
/**
* Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
*/
getRuleGroup(params: WAFRegional.Types.GetRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRuleGroupResponse) => void): Request<WAFRegional.Types.GetRuleGroupResponse, AWSError>;
/**
* Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
*/
getRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.GetRuleGroupResponse) => void): Request<WAFRegional.Types.GetRuleGroupResponse, AWSError>;
/**
* Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.
*/
getSampledRequests(params: WAFRegional.Types.GetSampledRequestsRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetSampledRequestsResponse) => void): Request<WAFRegional.Types.GetSampledRequestsResponse, AWSError>;
/**
* Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.
*/
getSampledRequests(callback?: (err: AWSError, data: WAFRegional.Types.GetSampledRequestsResponse) => void): Request<WAFRegional.Types.GetSampledRequestsResponse, AWSError>;
/**
* Returns the SizeConstraintSet specified by SizeConstraintSetId.
*/
getSizeConstraintSet(params: WAFRegional.Types.GetSizeConstraintSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetSizeConstraintSetResponse) => void): Request<WAFRegional.Types.GetSizeConstraintSetResponse, AWSError>;
/**
* Returns the SizeConstraintSet specified by SizeConstraintSetId.
*/
getSizeConstraintSet(callback?: (err: AWSError, data: WAFRegional.Types.GetSizeConstraintSetResponse) => void): Request<WAFRegional.Types.GetSizeConstraintSetResponse, AWSError>;
/**
* Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
*/
getSqlInjectionMatchSet(params: WAFRegional.Types.GetSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetSqlInjectionMatchSetResponse) => void): Request<WAFRegional.Types.GetSqlInjectionMatchSetResponse, AWSError>;
/**
* Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
*/
getSqlInjectionMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetSqlInjectionMatchSetResponse) => void): Request<WAFRegional.Types.GetSqlInjectionMatchSetResponse, AWSError>;
/**
* Returns the WebACL that is specified by WebACLId.
*/
getWebACL(params: WAFRegional.Types.GetWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetWebACLResponse) => void): Request<WAFRegional.Types.GetWebACLResponse, AWSError>;
/**
* Returns the WebACL that is specified by WebACLId.
*/
getWebACL(callback?: (err: AWSError, data: WAFRegional.Types.GetWebACLResponse) => void): Request<WAFRegional.Types.GetWebACLResponse, AWSError>;
/**
* Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.
*/
getWebACLForResource(params: WAFRegional.Types.GetWebACLForResourceRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetWebACLForResourceResponse) => void): Request<WAFRegional.Types.GetWebACLForResourceResponse, AWSError>;
/**
* Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.
*/
getWebACLForResource(callback?: (err: AWSError, data: WAFRegional.Types.GetWebACLForResourceResponse) => void): Request<WAFRegional.Types.GetWebACLForResourceResponse, AWSError>;
/**
* Returns the XssMatchSet that is specified by XssMatchSetId.
*/
getXssMatchSet(params: WAFRegional.Types.GetXssMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetXssMatchSetResponse) => void): Request<WAFRegional.Types.GetXssMatchSetResponse, AWSError>;
/**
* Returns the XssMatchSet that is specified by XssMatchSetId.
*/
getXssMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetXssMatchSetResponse) => void): Request<WAFRegional.Types.GetXssMatchSetResponse, AWSError>;
/**
* Returns an array of ActivatedRule objects.
*/
listActivatedRulesInRuleGroup(params: WAFRegional.Types.ListActivatedRulesInRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListActivatedRulesInRuleGroupResponse) => void): Request<WAFRegional.Types.ListActivatedRulesInRuleGroupResponse, AWSError>;
/**
* Returns an array of ActivatedRule objects.
*/
listActivatedRulesInRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.ListActivatedRulesInRuleGroupResponse) => void): Request<WAFRegional.Types.ListActivatedRulesInRuleGroupResponse, AWSError>;
/**
* Returns an array of ByteMatchSetSummary objects.
*/
listByteMatchSets(params: WAFRegional.Types.ListByteMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListByteMatchSetsResponse) => void): Request<WAFRegional.Types.ListByteMatchSetsResponse, AWSError>;
/**
* Returns an array of ByteMatchSetSummary objects.
*/
listByteMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListByteMatchSetsResponse) => void): Request<WAFRegional.Types.ListByteMatchSetsResponse, AWSError>;
/**
* Returns an array of GeoMatchSetSummary objects in the response.
*/
listGeoMatchSets(params: WAFRegional.Types.ListGeoMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListGeoMatchSetsResponse) => void): Request<WAFRegional.Types.ListGeoMatchSetsResponse, AWSError>;
/**
* Returns an array of GeoMatchSetSummary objects in the response.
*/
listGeoMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListGeoMatchSetsResponse) => void): Request<WAFRegional.Types.ListGeoMatchSetsResponse, AWSError>;
/**
* Returns an array of IPSetSummary objects in the response.
*/
listIPSets(params: WAFRegional.Types.ListIPSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListIPSetsResponse) => void): Request<WAFRegional.Types.ListIPSetsResponse, AWSError>;
/**
* Returns an array of IPSetSummary objects in the response.
*/
listIPSets(callback?: (err: AWSError, data: WAFRegional.Types.ListIPSetsResponse) => void): Request<WAFRegional.Types.ListIPSetsResponse, AWSError>;
/**
* Returns an array of LoggingConfiguration objects.
*/
listLoggingConfigurations(params: WAFRegional.Types.ListLoggingConfigurationsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListLoggingConfigurationsResponse) => void): Request<WAFRegional.Types.ListLoggingConfigurationsResponse, AWSError>;
/**
* Returns an array of LoggingConfiguration objects.
*/
listLoggingConfigurations(callback?: (err: AWSError, data: WAFRegional.Types.ListLoggingConfigurationsResponse) => void): Request<WAFRegional.Types.ListLoggingConfigurationsResponse, AWSError>;
/**
* Returns an array of RuleSummary objects.
*/
listRateBasedRules(params: WAFRegional.Types.ListRateBasedRulesRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRateBasedRulesResponse) => void): Request<WAFRegional.Types.ListRateBasedRulesResponse, AWSError>;
/**
* Returns an array of RuleSummary objects.
*/
listRateBasedRules(callback?: (err: AWSError, data: WAFRegional.Types.ListRateBasedRulesResponse) => void): Request<WAFRegional.Types.ListRateBasedRulesResponse, AWSError>;
/**
* Returns an array of RegexMatchSetSummary objects.
*/
listRegexMatchSets(params: WAFRegional.Types.ListRegexMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRegexMatchSetsResponse) => void): Request<WAFRegional.Types.ListRegexMatchSetsResponse, AWSError>;
/**
* Returns an array of RegexMatchSetSummary objects.
*/
listRegexMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListRegexMatchSetsResponse) => void): Request<WAFRegional.Types.ListRegexMatchSetsResponse, AWSError>;
/**
* Returns an array of RegexPatternSetSummary objects.
*/
listRegexPatternSets(params: WAFRegional.Types.ListRegexPatternSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRegexPatternSetsResponse) => void): Request<WAFRegional.Types.ListRegexPatternSetsResponse, AWSError>;
/**
* Returns an array of RegexPatternSetSummary objects.
*/
listRegexPatternSets(callback?: (err: AWSError, data: WAFRegional.Types.ListRegexPatternSetsResponse) => void): Request<WAFRegional.Types.ListRegexPatternSetsResponse, AWSError>;
/**
* Returns an array of resources associated with the specified web ACL.
*/
listResourcesForWebACL(params: WAFRegional.Types.ListResourcesForWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListResourcesForWebACLResponse) => void): Request<WAFRegional.Types.ListResourcesForWebACLResponse, AWSError>;
/**
* Returns an array of resources associated with the specified web ACL.
*/
listResourcesForWebACL(callback?: (err: AWSError, data: WAFRegional.Types.ListResourcesForWebACLResponse) => void): Request<WAFRegional.Types.ListResourcesForWebACLResponse, AWSError>;
/**
* Returns an array of RuleGroup objects.
*/
listRuleGroups(params: WAFRegional.Types.ListRuleGroupsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRuleGroupsResponse) => void): Request<WAFRegional.Types.ListRuleGroupsResponse, AWSError>;
/**
* Returns an array of RuleGroup objects.
*/
listRuleGroups(callback?: (err: AWSError, data: WAFRegional.Types.ListRuleGroupsResponse) => void): Request<WAFRegional.Types.ListRuleGroupsResponse, AWSError>;
/**
* Returns an array of RuleSummary objects.
*/
listRules(params: WAFRegional.Types.ListRulesRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRulesResponse) => void): Request<WAFRegional.Types.ListRulesResponse, AWSError>;
/**
* Returns an array of RuleSummary objects.
*/
listRules(callback?: (err: AWSError, data: WAFRegional.Types.ListRulesResponse) => void): Request<WAFRegional.Types.ListRulesResponse, AWSError>;
/**
* Returns an array of SizeConstraintSetSummary objects.
*/
listSizeConstraintSets(params: WAFRegional.Types.ListSizeConstraintSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListSizeConstraintSetsResponse) => void): Request<WAFRegional.Types.ListSizeConstraintSetsResponse, AWSError>;
/**
* Returns an array of SizeConstraintSetSummary objects.
*/
listSizeConstraintSets(callback?: (err: AWSError, data: WAFRegional.Types.ListSizeConstraintSetsResponse) => void): Request<WAFRegional.Types.ListSizeConstraintSetsResponse, AWSError>;
/**
* Returns an array of SqlInjectionMatchSet objects.
*/
listSqlInjectionMatchSets(params: WAFRegional.Types.ListSqlInjectionMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListSqlInjectionMatchSetsResponse) => void): Request<WAFRegional.Types.ListSqlInjectionMatchSetsResponse, AWSError>;
/**
* Returns an array of SqlInjectionMatchSet objects.
*/
listSqlInjectionMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListSqlInjectionMatchSetsResponse) => void): Request<WAFRegional.Types.ListSqlInjectionMatchSetsResponse, AWSError>;
/**
* Returns an array of RuleGroup objects that you are subscribed to.
*/
listSubscribedRuleGroups(params: WAFRegional.Types.ListSubscribedRuleGroupsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListSubscribedRuleGroupsResponse) => void): Request<WAFRegional.Types.ListSubscribedRuleGroupsResponse, AWSError>;
/**
* Returns an array of RuleGroup objects that you are subscribed to.
*/
listSubscribedRuleGroups(callback?: (err: AWSError, data: WAFRegional.Types.ListSubscribedRuleGroupsResponse) => void): Request<WAFRegional.Types.ListSubscribedRuleGroupsResponse, AWSError>;
/**
*
*/
listTagsForResource(params: WAFRegional.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListTagsForResourceResponse) => void): Request<WAFRegional.Types.ListTagsForResourceResponse, AWSError>;
/**
*
*/
listTagsForResource(callback?: (err: AWSError, data: WAFRegional.Types.ListTagsForResourceResponse) => void): Request<WAFRegional.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns an array of WebACLSummary objects in the response.
*/
listWebACLs(params: WAFRegional.Types.ListWebACLsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListWebACLsResponse) => void): Request<WAFRegional.Types.ListWebACLsResponse, AWSError>;
/**
* Returns an array of WebACLSummary objects in the response.
*/
listWebACLs(callback?: (err: AWSError, data: WAFRegional.Types.ListWebACLsResponse) => void): Request<WAFRegional.Types.ListWebACLsResponse, AWSError>;
/**
* Returns an array of XssMatchSet objects.
*/
listXssMatchSets(params: WAFRegional.Types.ListXssMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListXssMatchSetsResponse) => void): Request<WAFRegional.Types.ListXssMatchSetsResponse, AWSError>;
/**
* Returns an array of XssMatchSet objects.
*/
listXssMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListXssMatchSetsResponse) => void): Request<WAFRegional.Types.ListXssMatchSetsResponse, AWSError>;
/**
* Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Do not create the data firehose using a Kinesis stream as your source. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
*/
putLoggingConfiguration(params: WAFRegional.Types.PutLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFRegional.Types.PutLoggingConfigurationResponse) => void): Request<WAFRegional.Types.PutLoggingConfigurationResponse, AWSError>;
/**
* Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Do not create the data firehose using a Kinesis stream as your source. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
*/
putLoggingConfiguration(callback?: (err: AWSError, data: WAFRegional.Types.PutLoggingConfigurationResponse) => void): Request<WAFRegional.Types.PutLoggingConfigurationResponse, AWSError>;
/**
* Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below.
*/
putPermissionPolicy(params: WAFRegional.Types.PutPermissionPolicyRequest, callback?: (err: AWSError, data: WAFRegional.Types.PutPermissionPolicyResponse) => void): Request<WAFRegional.Types.PutPermissionPolicyResponse, AWSError>;
/**
* Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below.
*/
putPermissionPolicy(callback?: (err: AWSError, data: WAFRegional.Types.PutPermissionPolicyResponse) => void): Request<WAFRegional.Types.PutPermissionPolicyResponse, AWSError>;
/**
*
*/
tagResource(params: WAFRegional.Types.TagResourceRequest, callback?: (err: AWSError, data: WAFRegional.Types.TagResourceResponse) => void): Request<WAFRegional.Types.TagResourceResponse, AWSError>;
/**
*
*/
tagResource(callback?: (err: AWSError, data: WAFRegional.Types.TagResourceResponse) => void): Request<WAFRegional.Types.TagResourceResponse, AWSError>;
/**
*
*/
untagResource(params: WAFRegional.Types.UntagResourceRequest, callback?: (err: AWSError, data: WAFRegional.Types.UntagResourceResponse) => void): Request<WAFRegional.Types.UntagResourceResponse, AWSError>;
/**
*
*/
untagResource(callback?: (err: AWSError, data: WAFRegional.Types.UntagResourceResponse) => void): Request<WAFRegional.Types.UntagResourceResponse, AWSError>;
/**
* Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateByteMatchSet(params: WAFRegional.Types.UpdateByteMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateByteMatchSetResponse) => void): Request<WAFRegional.Types.UpdateByteMatchSetResponse, AWSError>;
/**
* Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateByteMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateByteMatchSetResponse) => void): Request<WAFRegional.Types.UpdateByteMatchSetResponse, AWSError>;
/**
* Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateGeoMatchSet(params: WAFRegional.Types.UpdateGeoMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateGeoMatchSetResponse) => void): Request<WAFRegional.Types.UpdateGeoMatchSetResponse, AWSError>;
/**
* Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateGeoMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateGeoMatchSetResponse) => void): Request<WAFRegional.Types.UpdateGeoMatchSetResponse, AWSError>;
/**
* Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateIPSet(params: WAFRegional.Types.UpdateIPSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateIPSetResponse) => void): Request<WAFRegional.Types.UpdateIPSetResponse, AWSError>;
/**
* Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateIPSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateIPSetResponse) => void): Request<WAFRegional.Types.UpdateIPSetResponse, AWSError>;
/**
* Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.
*/
updateRateBasedRule(params: WAFRegional.Types.UpdateRateBasedRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRateBasedRuleResponse) => void): Request<WAFRegional.Types.UpdateRateBasedRuleResponse, AWSError>;
/**
* Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.
*/
updateRateBasedRule(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRateBasedRuleResponse) => void): Request<WAFRegional.Types.UpdateRateBasedRuleResponse, AWSError>;
/**
* Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateRegexMatchSet(params: WAFRegional.Types.UpdateRegexMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRegexMatchSetResponse) => void): Request<WAFRegional.Types.UpdateRegexMatchSetResponse, AWSError>;
/**
* Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateRegexMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRegexMatchSetResponse) => void): Request<WAFRegional.Types.UpdateRegexMatchSetResponse, AWSError>;
/**
* Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateRegexPatternSet(params: WAFRegional.Types.UpdateRegexPatternSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRegexPatternSetResponse) => void): Request<WAFRegional.Types.UpdateRegexPatternSetResponse, AWSError>;
/**
* Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateRegexPatternSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRegexPatternSetResponse) => void): Request<WAFRegional.Types.UpdateRegexPatternSetResponse, AWSError>;
/**
* Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateRule(params: WAFRegional.Types.UpdateRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRuleResponse) => void): Request<WAFRegional.Types.UpdateRuleResponse, AWSError>;
/**
* Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateRule(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRuleResponse) => void): Request<WAFRegional.Types.UpdateRuleResponse, AWSError>;
/**
* Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateRuleGroup(params: WAFRegional.Types.UpdateRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRuleGroupResponse) => void): Request<WAFRegional.Types.UpdateRuleGroupResponse, AWSError>;
/**
* Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRuleGroupResponse) => void): Request<WAFRegional.Types.UpdateRuleGroupResponse, AWSError>;
/**
* Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateSizeConstraintSet(params: WAFRegional.Types.UpdateSizeConstraintSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateSizeConstraintSetResponse) => void): Request<WAFRegional.Types.UpdateSizeConstraintSetResponse, AWSError>;
/**
* Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateSizeConstraintSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateSizeConstraintSetResponse) => void): Request<WAFRegional.Types.UpdateSizeConstraintSetResponse, AWSError>;
/**
* Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateSqlInjectionMatchSet(params: WAFRegional.Types.UpdateSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateSqlInjectionMatchSetResponse) => void): Request<WAFRegional.Types.UpdateSqlInjectionMatchSetResponse, AWSError>;
/**
* Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateSqlInjectionMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateSqlInjectionMatchSetResponse) => void): Request<WAFRegional.Types.UpdateSqlInjectionMatchSetResponse, AWSError>;
/**
* Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateWebACL(params: WAFRegional.Types.UpdateWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateWebACLResponse) => void): Request<WAFRegional.Types.UpdateWebACLResponse, AWSError>;
/**
* Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateWebACL(callback?: (err: AWSError, data: WAFRegional.Types.UpdateWebACLResponse) => void): Request<WAFRegional.Types.UpdateWebACLResponse, AWSError>;
/**
* Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateXssMatchSet(params: WAFRegional.Types.UpdateXssMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateXssMatchSetResponse) => void): Request<WAFRegional.Types.UpdateXssMatchSetResponse, AWSError>;
/**
* Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
*/
updateXssMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateXssMatchSetResponse) => void): Request<WAFRegional.Types.UpdateXssMatchSetResponse, AWSError>;
}
declare namespace WAFRegional {
export type Action = string;
export interface ActivatedRule {
/**
* Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.
*/
Priority: RulePriority;
/**
* The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules.
*/
RuleId: ResourceId;
/**
* Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following: ALLOW: CloudFront responds with the requested object. BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code. COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
*/
Action?: WafAction;
/**
* Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
*/
OverrideAction?: WafOverrideAction;
/**
* The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.
*/
Type?: WafRuleType;
/**
* An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL. Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule. If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps: Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information. Submit an UpdateWebACL request that has two actions: The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude. The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.
*/
ExcludedRules?: ExcludedRules;
}
export type ActivatedRules = ActivatedRule[];
export interface AssociateWebACLRequest {
/**
* A unique identifier (ID) for the web ACL.
*/
WebACLId: ResourceId;
/**
* The ARN (Amazon Resource Name) of the resource to be protected, either an application load balancer or Amazon API Gateway stage. The ARN should be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
*/
ResourceArn: ResourceArn;
}
export interface AssociateWebACLResponse {
}
export interface ByteMatchSet {
/**
* The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
*/
ByteMatchSetId: ResourceId;
/**
* A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
*/
Name?: ResourceName;
/**
* Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
*/
ByteMatchTuples: ByteMatchTuples;
}
export type ByteMatchSetSummaries = ByteMatchSetSummary[];
export interface ByteMatchSetSummary {
/**
* The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
*/
ByteMatchSetId: ResourceId;
/**
* A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
*/
Name: ResourceName;
}
export interface ByteMatchSetUpdate {
/**
* Specifies whether to insert or delete a ByteMatchTuple.
*/
Action: ChangeAction;
/**
* Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.
*/
ByteMatchTuple: ByteMatchTuple;
}
export type ByteMatchSetUpdates = ByteMatchSetUpdate[];
export type ByteMatchTargetString = Buffer|Uint8Array|Blob|string;
export interface ByteMatchTuple {
/**
* The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.
*/
FieldToMatch: FieldToMatch;
/**
* The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes. Valid values depend on the values that you specified for FieldToMatch: HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header. METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character. URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg. BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString. If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. If you're using the AWS WAF API Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString. If you're using the AWS CLI or one of the AWS SDKs The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
*/
TargetString: ByteMatchTargetString;
/**
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations.
*/
TextTransformation: TextTransformation;
/**
* Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following: CONTAINS The specified part of the web request must include the value of TargetString, but the location doesn't matter. CONTAINS_WORD The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following: TargetString exactly matches the value of the specified part of the web request, such as the value of a header. TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;. TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot. TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;. EXACTLY The value of the specified part of the web request must exactly match the value of TargetString. STARTS_WITH The value of TargetString must appear at the beginning of the specified part of the web request. ENDS_WITH The value of TargetString must appear at the end of the specified part of the web request.
*/
PositionalConstraint: PositionalConstraint;
}
export type ByteMatchTuples = ByteMatchTuple[];
export type ChangeAction = "INSERT"|"DELETE"|string;
export type ChangeToken = string;
export type ChangeTokenStatus = "PROVISIONED"|"PENDING"|"INSYNC"|string;
export type ComparisonOperator = "EQ"|"NE"|"LE"|"LT"|"GE"|"GT"|string;
export type Country = string;
export interface CreateByteMatchSetRequest {
/**
* A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
*/
Name: ResourceName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface CreateByteMatchSetResponse {
/**
* A ByteMatchSet that contains no ByteMatchTuple objects.
*/
ByteMatchSet?: ByteMatchSet;
/**
* The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateGeoMatchSetRequest {
/**
* A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet.
*/
Name: ResourceName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface CreateGeoMatchSetResponse {
/**
* The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.
*/
GeoMatchSet?: GeoMatchSet;
/**
* The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateIPSetRequest {
/**
* A friendly name or description of the IPSet. You can't change Name after you create the IPSet.
*/
Name: ResourceName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface CreateIPSetResponse {
/**
* The IPSet returned in the CreateIPSet response.
*/
IPSet?: IPSet;
/**
* The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateRateBasedRuleRequest {
/**
* A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.
*/
Name: ResourceName;
/**
* A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.
*/
MetricName: MetricName;
/**
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.
*/
RateKey: RateKey;
/**
* The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
*/
RateLimit: RateLimit;
/**
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken: ChangeToken;
Tags?: TagList;
}
export interface CreateRateBasedRuleResponse {
/**
* The RateBasedRule that is returned in the CreateRateBasedRule response.
*/
Rule?: RateBasedRule;
/**
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateRegexMatchSetRequest {
/**
* A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.
*/
Name: ResourceName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface CreateRegexMatchSetResponse {
/**
* A RegexMatchSet that contains no RegexMatchTuple objects.
*/
RegexMatchSet?: RegexMatchSet;
/**
* The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateRegexPatternSetRequest {
/**
* A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
*/
Name: ResourceName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface CreateRegexPatternSetResponse {
/**
* A RegexPatternSet that contains no objects.
*/
RegexPatternSet?: RegexPatternSet;
/**
* The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateRuleGroupRequest {
/**
* A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup.
*/
Name: ResourceName;
/**
* A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
*/
MetricName: MetricName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
Tags?: TagList;
}
export interface CreateRuleGroupResponse {
/**
* An empty RuleGroup.
*/
RuleGroup?: RuleGroup;
/**
* The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateRuleRequest {
/**
* A friendly name or description of the Rule. You can't change the name of a Rule after you create it.
*/
Name: ResourceName;
/**
* A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the Rule.
*/
MetricName: MetricName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
Tags?: TagList;
}
export interface CreateRuleResponse {
/**
* The Rule returned in the CreateRule response.
*/
Rule?: Rule;
/**
* The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateSizeConstraintSetRequest {
/**
* A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.
*/
Name: ResourceName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface CreateSizeConstraintSetResponse {
/**
* A SizeConstraintSet that contains no SizeConstraint objects.
*/
SizeConstraintSet?: SizeConstraintSet;
/**
* The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateSqlInjectionMatchSetRequest {
/**
* A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.
*/
Name: ResourceName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface CreateSqlInjectionMatchSetResponse {
/**
* A SqlInjectionMatchSet.
*/
SqlInjectionMatchSet?: SqlInjectionMatchSet;
/**
* The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateWebACLRequest {
/**
* A friendly name or description of the WebACL. You can't change Name after you create the WebACL.
*/
Name: ResourceName;
/**
* A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.
*/
MetricName: MetricName;
/**
* The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.
*/
DefaultAction: WafAction;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
Tags?: TagList;
}
export interface CreateWebACLResponse {
/**
* The WebACL returned in the CreateWebACL response.
*/
WebACL?: WebACL;
/**
* The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface CreateXssMatchSetRequest {
/**
* A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.
*/
Name: ResourceName;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface CreateXssMatchSetResponse {
/**
* An XssMatchSet.
*/
XssMatchSet?: XssMatchSet;
/**
* The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteByteMatchSetRequest {
/**
* The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
*/
ByteMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteByteMatchSetResponse {
/**
* The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteGeoMatchSetRequest {
/**
* The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*/
GeoMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteGeoMatchSetResponse {
/**
* The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteIPSetRequest {
/**
* The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.
*/
IPSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteIPSetResponse {
/**
* The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteLoggingConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
*/
ResourceArn: ResourceArn;
}
export interface DeleteLoggingConfigurationResponse {
}
export interface DeletePermissionPolicyRequest {
/**
* The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy. The user making the request must be the owner of the RuleGroup.
*/
ResourceArn: ResourceArn;
}
export interface DeletePermissionPolicyResponse {
}
export interface DeleteRateBasedRuleRequest {
/**
* The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
*/
RuleId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteRateBasedRuleResponse {
/**
* The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteRegexMatchSetRequest {
/**
* The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*/
RegexMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteRegexMatchSetResponse {
/**
* The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteRegexPatternSetRequest {
/**
* The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*/
RegexPatternSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteRegexPatternSetResponse {
/**
* The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteRuleGroupRequest {
/**
* The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
*/
RuleGroupId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteRuleGroupResponse {
/**
* The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteRuleRequest {
/**
* The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.
*/
RuleId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteRuleResponse {
/**
* The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteSizeConstraintSetRequest {
/**
* The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
*/
SizeConstraintSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteSizeConstraintSetResponse {
/**
* The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteSqlInjectionMatchSetRequest {
/**
* The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
*/
SqlInjectionMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteSqlInjectionMatchSetResponse {
/**
* The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteWebACLRequest {
/**
* The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.
*/
WebACLId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteWebACLResponse {
/**
* The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DeleteXssMatchSetRequest {
/**
* The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*/
XssMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface DeleteXssMatchSetResponse {
/**
* The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface DisassociateWebACLRequest {
/**
* The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed, either an application load balancer or Amazon API Gateway stage. The ARN should be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
*/
ResourceArn: ResourceArn;
}
export interface DisassociateWebACLResponse {
}
export interface ExcludedRule {
/**
* The unique identifier for the rule to exclude from the rule group.
*/
RuleId: ResourceId;
}
export type ExcludedRules = ExcludedRule[];
export interface FieldToMatch {
/**
* The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.
*/
Type: MatchFieldType;
/**
* When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. If the value of Type is any other value, omit Data.
*/
Data?: MatchFieldData;
}
export interface GeoMatchConstraint {
/**
* The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value.
*/
Type: GeoMatchConstraintType;
/**
* The country that you want AWS WAF to search for.
*/
Value: GeoMatchConstraintValue;
}
export type GeoMatchConstraintType = "Country"|string;
export type GeoMatchConstraintValue = "AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CD"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KP"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"US"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW"|string;
export type GeoMatchConstraints = GeoMatchConstraint[];
export interface GeoMatchSet {
/**
* The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet). GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*/
GeoMatchSetId: ResourceId;
/**
* A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.
*/
Name?: ResourceName;
/**
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
*/
GeoMatchConstraints: GeoMatchConstraints;
}
export type GeoMatchSetSummaries = GeoMatchSetSummary[];
export interface GeoMatchSetSummary {
/**
* The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.
*/
GeoMatchSetId: ResourceId;
/**
* A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.
*/
Name: ResourceName;
}
export interface GeoMatchSetUpdate {
/**
* Specifies whether to insert or delete a country with UpdateGeoMatchSet.
*/
Action: ChangeAction;
/**
* The country from which web requests originate that you want AWS WAF to search for.
*/
GeoMatchConstraint: GeoMatchConstraint;
}
export type GeoMatchSetUpdates = GeoMatchSetUpdate[];
export interface GetByteMatchSetRequest {
/**
* The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
*/
ByteMatchSetId: ResourceId;
}
export interface GetByteMatchSetResponse {
/**
* Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics: ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch: Contains Data and Type
*/
ByteMatchSet?: ByteMatchSet;
}
export interface GetChangeTokenRequest {
}
export interface GetChangeTokenResponse {
/**
* The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.
*/
ChangeToken?: ChangeToken;
}
export interface GetChangeTokenStatusRequest {
/**
* The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.
*/
ChangeToken: ChangeToken;
}
export interface GetChangeTokenStatusResponse {
/**
* The status of the change token.
*/
ChangeTokenStatus?: ChangeTokenStatus;
}
export interface GetGeoMatchSetRequest {
/**
* The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*/
GeoMatchSetId: ResourceId;
}
export interface GetGeoMatchSetResponse {
/**
* Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country.
*/
GeoMatchSet?: GeoMatchSet;
}
export interface GetIPSetRequest {
/**
* The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.
*/
IPSetId: ResourceId;
}
export interface GetIPSetResponse {
/**
* Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics: IPSet: Contains IPSetDescriptors, IPSetId, and Name IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value
*/
IPSet?: IPSet;
}
export interface GetLoggingConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
*/
ResourceArn: ResourceArn;
}
export interface GetLoggingConfigurationResponse {
/**
* The LoggingConfiguration for the specified web ACL.
*/
LoggingConfiguration?: LoggingConfiguration;
}
export interface GetPermissionPolicyRequest {
/**
* The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.
*/
ResourceArn: ResourceArn;
}
export interface GetPermissionPolicyResponse {
/**
* The IAM policy attached to the specified RuleGroup.
*/
Policy?: PolicyString;
}
export interface GetRateBasedRuleManagedKeysRequest {
/**
* The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
*/
RuleId: ResourceId;
/**
* A null value and not currently used. Do not include this in your request.
*/
NextMarker?: NextMarker;
}
export interface GetRateBasedRuleManagedKeysResponse {
/**
* An array of IP addresses that currently are blocked by the specified RateBasedRule.
*/
ManagedKeys?: ManagedKeys;
/**
* A null value and not currently used.
*/
NextMarker?: NextMarker;
}
export interface GetRateBasedRuleRequest {
/**
* The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
*/
RuleId: ResourceId;
}
export interface GetRateBasedRuleResponse {
/**
* Information about the RateBasedRule that you specified in the GetRateBasedRule request.
*/
Rule?: RateBasedRule;
}
export interface GetRegexMatchSetRequest {
/**
* The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*/
RegexMatchSetId: ResourceId;
}
export interface GetRegexMatchSetResponse {
/**
* Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple.
*/
RegexMatchSet?: RegexMatchSet;
}
export interface GetRegexPatternSetRequest {
/**
* The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*/
RegexPatternSetId: ResourceId;
}
export interface GetRegexPatternSetResponse {
/**
* Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.
*/
RegexPatternSet?: RegexPatternSet;
}
export interface GetRuleGroupRequest {
/**
* The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
*/
RuleGroupId: ResourceId;
}
export interface GetRuleGroupResponse {
/**
* Information about the RuleGroup that you specified in the GetRuleGroup request.
*/
RuleGroup?: RuleGroup;
}
export interface GetRuleRequest {
/**
* The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.
*/
RuleId: ResourceId;
}
export interface GetRuleResponse {
/**
* Information about the Rule that you specified in the GetRule request. For more information, see the following topics: Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId Predicate: Each Predicate object contains DataId, Negated, and Type
*/
Rule?: Rule;
}
export type GetSampledRequestsMaxItems = number;
export interface GetSampledRequestsRequest {
/**
* The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.
*/
WebAclId: ResourceId;
/**
* RuleId is one of three values: The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests. Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.
*/
RuleId: ResourceId;
/**
* The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
*/
TimeWindow: TimeWindow;
/**
* The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.
*/
MaxItems: GetSampledRequestsMaxItems;
}
export interface GetSampledRequestsResponse {
/**
* A complex type that contains detailed information about each of the requests in the sample.
*/
SampledRequests?: SampledHTTPRequests;
/**
* The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.
*/
PopulationSize?: PopulationSize;
/**
* Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.
*/
TimeWindow?: TimeWindow;
}
export interface GetSizeConstraintSetRequest {
/**
* The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
*/
SizeConstraintSetId: ResourceId;
}
export interface GetSizeConstraintSetResponse {
/**
* Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics: SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name SizeConstraints: Contains an array of SizeConstraint objects. Each SizeConstraint object contains FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains Data and Type
*/
SizeConstraintSet?: SizeConstraintSet;
}
export interface GetSqlInjectionMatchSetRequest {
/**
* The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
*/
SqlInjectionMatchSetId: ResourceId;
}
export interface GetSqlInjectionMatchSetResponse {
/**
* Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics: SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an array of SqlInjectionMatchTuple objects SqlInjectionMatchTuple: Each SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
*/
SqlInjectionMatchSet?: SqlInjectionMatchSet;
}
export interface GetWebACLForResourceRequest {
/**
* The ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage. The ARN should be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
*/
ResourceArn: ResourceArn;
}
export interface GetWebACLForResourceResponse {
/**
* Information about the web ACL that you specified in the GetWebACLForResource request. If there is no associated resource, a null WebACLSummary is returned.
*/
WebACLSummary?: WebACLSummary;
}
export interface GetWebACLRequest {
/**
* The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.
*/
WebACLId: ResourceId;
}
export interface GetWebACLResponse {
/**
* Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics: WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId DefaultAction (Data type is WafAction): Contains Type Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId Action: Contains Type
*/
WebACL?: WebACL;
}
export interface GetXssMatchSetRequest {
/**
* The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*/
XssMatchSetId: ResourceId;
}
export interface GetXssMatchSetResponse {
/**
* Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics: XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
*/
XssMatchSet?: XssMatchSet;
}
export interface HTTPHeader {
/**
* The name of one of the headers in the sampled web request.
*/
Name?: HeaderName;
/**
* The value of one of the headers in the sampled web request.
*/
Value?: HeaderValue;
}
export type HTTPHeaders = HTTPHeader[];
export type HTTPMethod = string;
export interface HTTPRequest {
/**
* The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs: c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request
*/
ClientIP?: IPString;
/**
* The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.
*/
Country?: Country;
/**
* The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.
*/
URI?: URIString;
/**
* The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
*/
Method?: HTTPMethod;
/**
* The HTTP version specified in the sampled web request, for example, HTTP/1.1.
*/
HTTPVersion?: HTTPVersion;
/**
* A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.
*/
Headers?: HTTPHeaders;
}
export type HTTPVersion = string;
export type HeaderName = string;
export type HeaderValue = string;
export interface IPSet {
/**
* The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet). IPSetId is returned by CreateIPSet and by ListIPSets.
*/
IPSetId: ResourceId;
/**
* A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.
*/
Name?: ResourceName;
/**
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
*/
IPSetDescriptors: IPSetDescriptors;
}
export interface IPSetDescriptor {
/**
* Specify IPV4 or IPV6.
*/
Type: IPSetDescriptorType;
/**
* Specify an IPv4 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Specify an IPv6 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
*/
Value: IPSetDescriptorValue;
}
export type IPSetDescriptorType = "IPV4"|"IPV6"|string;
export type IPSetDescriptorValue = string;
export type IPSetDescriptors = IPSetDescriptor[];
export type IPSetSummaries = IPSetSummary[];
export interface IPSetSummary {
/**
* The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.
*/
IPSetId: ResourceId;
/**
* A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.
*/
Name: ResourceName;
}
export interface IPSetUpdate {
/**
* Specifies whether to insert or delete an IP address with UpdateIPSet.
*/
Action: ChangeAction;
/**
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.
*/
IPSetDescriptor: IPSetDescriptor;
}
export type IPSetUpdates = IPSetUpdate[];
export type IPString = string;
export interface ListActivatedRulesInRuleGroupRequest {
/**
* The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.
*/
RuleGroupId?: ResourceId;
/**
* If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules.
*/
Limit?: PaginationLimit;
}
export interface ListActivatedRulesInRuleGroupResponse {
/**
* If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of ActivatedRules objects.
*/
ActivatedRules?: ActivatedRules;
}
export interface ListByteMatchSetsRequest {
/**
* If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.
*/
Limit?: PaginationLimit;
}
export interface ListByteMatchSetsResponse {
/**
* If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of ByteMatchSetSummary objects.
*/
ByteMatchSets?: ByteMatchSetSummaries;
}
export interface ListGeoMatchSetsRequest {
/**
* If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects.
*/
Limit?: PaginationLimit;
}
export interface ListGeoMatchSetsResponse {
/**
* If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of GeoMatchSetSummary objects.
*/
GeoMatchSets?: GeoMatchSetSummaries;
}
export interface ListIPSetsRequest {
/**
* AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.
*/
Limit?: PaginationLimit;
}
export interface ListIPSetsResponse {
/**
* To list more IPSet objects, submit another ListIPSets request, and in the next request use the NextMarker response value as the NextMarker value.
*/
NextMarker?: NextMarker;
/**
* An array of IPSetSummary objects.
*/
IPSets?: IPSetSummaries;
}
export interface ListLoggingConfigurationsRequest {
/**
* If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations.
*/
Limit?: PaginationLimit;
}
export interface ListLoggingConfigurationsResponse {
/**
* An array of LoggingConfiguration objects.
*/
LoggingConfigurations?: LoggingConfigurations;
/**
* If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
}
export interface ListRateBasedRulesRequest {
/**
* If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
*/
Limit?: PaginationLimit;
}
export interface ListRateBasedRulesResponse {
/**
* If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of RuleSummary objects.
*/
Rules?: RuleSummaries;
}
export interface ListRegexMatchSetsRequest {
/**
* If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects.
*/
Limit?: PaginationLimit;
}
export interface ListRegexMatchSetsResponse {
/**
* If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of RegexMatchSetSummary objects.
*/
RegexMatchSets?: RegexMatchSetSummaries;
}
export interface ListRegexPatternSetsRequest {
/**
* If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects.
*/
Limit?: PaginationLimit;
}
export interface ListRegexPatternSetsResponse {
/**
* If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of RegexPatternSetSummary objects.
*/
RegexPatternSets?: RegexPatternSetSummaries;
}
export interface ListResourcesForWebACLRequest {
/**
* The unique identifier (ID) of the web ACL for which to list the associated resources.
*/
WebACLId: ResourceId;
/**
* The type of resource to list, either an application load balancer or Amazon API Gateway.
*/
ResourceType?: ResourceType;
}
export interface ListResourcesForWebACLResponse {
/**
* An array of ARNs (Amazon Resource Names) of the resources associated with the specified web ACL. An array with zero elements is returned if there are no resources associated with the web ACL.
*/
ResourceArns?: ResourceArns;
}
export interface ListRuleGroupsRequest {
/**
* If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.
*/
Limit?: PaginationLimit;
}
export interface ListRuleGroupsResponse {
/**
* If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of RuleGroup objects.
*/
RuleGroups?: RuleGroupSummaries;
}
export interface ListRulesRequest {
/**
* If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
*/
Limit?: PaginationLimit;
}
export interface ListRulesResponse {
/**
* If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of RuleSummary objects.
*/
Rules?: RuleSummaries;
}
export interface ListSizeConstraintSetsRequest {
/**
* If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.
*/
Limit?: PaginationLimit;
}
export interface ListSizeConstraintSetsResponse {
/**
* If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of SizeConstraintSetSummary objects.
*/
SizeConstraintSets?: SizeConstraintSetSummaries;
}
export interface ListSqlInjectionMatchSetsRequest {
/**
* If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
*/
Limit?: PaginationLimit;
}
export interface ListSqlInjectionMatchSetsResponse {
/**
* If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of SqlInjectionMatchSetSummary objects.
*/
SqlInjectionMatchSets?: SqlInjectionMatchSetSummaries;
}
export interface ListSubscribedRuleGroupsRequest {
/**
* If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects.
*/
Limit?: PaginationLimit;
}
export interface ListSubscribedRuleGroupsResponse {
/**
* If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of RuleGroup objects.
*/
RuleGroups?: SubscribedRuleGroupSummaries;
}
export interface ListTagsForResourceRequest {
NextMarker?: NextMarker;
Limit?: PaginationLimit;
ResourceARN: ResourceArn;
}
export interface ListTagsForResourceResponse {
NextMarker?: NextMarker;
TagInfoForResource?: TagInfoForResource;
}
export interface ListWebACLsRequest {
/**
* If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.
*/
Limit?: PaginationLimit;
}
export interface ListWebACLsResponse {
/**
* If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of WebACLSummary objects.
*/
WebACLs?: WebACLSummaries;
}
export interface ListXssMatchSetsRequest {
/**
* If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.
*/
NextMarker?: NextMarker;
/**
* Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
*/
Limit?: PaginationLimit;
}
export interface ListXssMatchSetsResponse {
/**
* If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
*/
NextMarker?: NextMarker;
/**
* An array of XssMatchSetSummary objects.
*/
XssMatchSets?: XssMatchSetSummaries;
}
export type LogDestinationConfigs = ResourceArn[];
export interface LoggingConfiguration {
/**
* The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
*/
ResourceArn: ResourceArn;
/**
* An array of Amazon Kinesis Data Firehose ARNs.
*/
LogDestinationConfigs: LogDestinationConfigs;
/**
* The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.
*/
RedactedFields?: RedactedFields;
}
export type LoggingConfigurations = LoggingConfiguration[];
export type ManagedKey = string;
export type ManagedKeys = ManagedKey[];
export type MatchFieldData = string;
export type MatchFieldType = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS"|string;
export type MetricName = string;
export type Negated = boolean;
export type NextMarker = string;
export type PaginationLimit = number;
export type PolicyString = string;
export type PopulationSize = number;
export type PositionalConstraint = "EXACTLY"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CONTAINS_WORD"|string;
export interface Predicate {
/**
* Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
*/
Negated: Negated;
/**
* The type of predicate in a Rule, such as ByteMatch or IPSet.
*/
Type: PredicateType;
/**
* A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.
*/
DataId: ResourceId;
}
export type PredicateType = "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch"|string;
export type Predicates = Predicate[];
export interface PutLoggingConfigurationRequest {
/**
* The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor. When specifying Type in RedactedFields, you must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.
*/
LoggingConfiguration: LoggingConfiguration;
}
export interface PutLoggingConfigurationResponse {
/**
* The LoggingConfiguration that you submitted in the request.
*/
LoggingConfiguration?: LoggingConfiguration;
}
export interface PutPermissionPolicyRequest {
/**
* The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
*/
ResourceArn: ResourceArn;
/**
* The policy to attach to the specified RuleGroup.
*/
Policy: PolicyString;
}
export interface PutPermissionPolicyResponse {
}
export interface RateBasedRule {
/**
* A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).
*/
RuleId: ResourceId;
/**
* A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.
*/
Name?: ResourceName;
/**
* A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.
*/
MetricName?: MetricName;
/**
* The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
*/
MatchPredicates: Predicates;
/**
* The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.
*/
RateKey: RateKey;
/**
* The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
*/
RateLimit: RateLimit;
}
export type RateKey = "IP"|string;
export type RateLimit = number;
export type RedactedFields = FieldToMatch[];
export interface RegexMatchSet {
/**
* The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet). RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*/
RegexMatchSetId?: ResourceId;
/**
* A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.
*/
Name?: ResourceName;
/**
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains: The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
*/
RegexMatchTuples?: RegexMatchTuples;
}
export type RegexMatchSetSummaries = RegexMatchSetSummary[];
export interface RegexMatchSetSummary {
/**
* The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*/
RegexMatchSetId: ResourceId;
/**
* A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.
*/
Name: ResourceName;
}
export interface RegexMatchSetUpdate {
/**
* Specifies whether to insert or delete a RegexMatchTuple.
*/
Action: ChangeAction;
/**
* Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.
*/
RegexMatchTuple: RegexMatchTuple;
}
export type RegexMatchSetUpdates = RegexMatchSetUpdate[];
export interface RegexMatchTuple {
/**
* Specifies where in a web request to look for the RegexPatternSet.
*/
FieldToMatch: FieldToMatch;
/**
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations.
*/
TextTransformation: TextTransformation;
/**
* The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*/
RegexPatternSetId: ResourceId;
}
export type RegexMatchTuples = RegexMatchTuple[];
export interface RegexPatternSet {
/**
* The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*/
RegexPatternSetId: ResourceId;
/**
* A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
*/
Name?: ResourceName;
/**
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
*/
RegexPatternStrings: RegexPatternStrings;
}
export type RegexPatternSetSummaries = RegexPatternSetSummary[];
export interface RegexPatternSetSummary {
/**
* The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*/
RegexPatternSetId: ResourceId;
/**
* A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
*/
Name: ResourceName;
}
export interface RegexPatternSetUpdate {
/**
* Specifies whether to insert or delete a RegexPatternString.
*/
Action: ChangeAction;
/**
* Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t.
*/
RegexPatternString: RegexPatternString;
}
export type RegexPatternSetUpdates = RegexPatternSetUpdate[];
export type RegexPatternString = string;
export type RegexPatternStrings = RegexPatternString[];
export type ResourceArn = string;
export type ResourceArns = ResourceArn[];
export type ResourceId = string;
export type ResourceName = string;
export type ResourceType = "APPLICATION_LOAD_BALANCER"|"API_GATEWAY"|string;
export interface Rule {
/**
* A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules.
*/
RuleId: ResourceId;
/**
* The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
*/
Name?: ResourceName;
/**
* A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
*/
MetricName?: MetricName;
/**
* The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
*/
Predicates: Predicates;
}
export interface RuleGroup {
/**
* A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
*/
RuleGroupId: ResourceId;
/**
* The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.
*/
Name?: ResourceName;
/**
* A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
*/
MetricName?: MetricName;
}
export type RuleGroupSummaries = RuleGroupSummary[];
export interface RuleGroupSummary {
/**
* A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
*/
RuleGroupId: ResourceId;
/**
* A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
*/
Name: ResourceName;
}
export interface RuleGroupUpdate {
/**
* Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup.
*/
Action: ChangeAction;
/**
* The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).
*/
ActivatedRule: ActivatedRule;
}
export type RuleGroupUpdates = RuleGroupUpdate[];
export type RulePriority = number;
export type RuleSummaries = RuleSummary[];
export interface RuleSummary {
/**
* A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules.
*/
RuleId: ResourceId;
/**
* A friendly name or description of the Rule. You can't change the name of a Rule after you create it.
*/
Name: ResourceName;
}
export interface RuleUpdate {
/**
* Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.
*/
Action: ChangeAction;
/**
* The ID of the Predicate (such as an IPSet) that you want to add to a Rule.
*/
Predicate: Predicate;
}
export type RuleUpdates = RuleUpdate[];
export type SampleWeight = number;
export interface SampledHTTPRequest {
/**
* A complex type that contains detailed information about the request.
*/
Request: HTTPRequest;
/**
* A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.
*/
Weight: SampleWeight;
/**
* The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
*/
Timestamp?: Timestamp;
/**
* The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.
*/
Action?: Action;
/**
* This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.
*/
RuleWithinRuleGroup?: ResourceId;
}
export type SampledHTTPRequests = SampledHTTPRequest[];
export type Size = number;
export interface SizeConstraint {
/**
* Specifies where in a web request to look for the size constraint.
*/
FieldToMatch: FieldToMatch;
/**
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection. NONE Specify NONE if you don't want to perform any text transformations. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value.
*/
TextTransformation: TextTransformation;
/**
* The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. EQ: Used to test if the Size is equal to the size of the FieldToMatch NE: Used to test if the Size is not equal to the size of the FieldToMatch LE: Used to test if the Size is less than or equal to the size of the FieldToMatch LT: Used to test if the Size is strictly less than the size of the FieldToMatch GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch GT: Used to test if the Size is strictly greater than the size of the FieldToMatch
*/
ComparisonOperator: ComparisonOperator;
/**
* The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
*/
Size: Size;
}
export interface SizeConstraintSet {
/**
* A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
*/
SizeConstraintSetId: ResourceId;
/**
* The name, if any, of the SizeConstraintSet.
*/
Name?: ResourceName;
/**
* Specifies the parts of web requests that you want to inspect the size of.
*/
SizeConstraints: SizeConstraints;
}
export type SizeConstraintSetSummaries = SizeConstraintSetSummary[];
export interface SizeConstraintSetSummary {
/**
* A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
*/
SizeConstraintSetId: ResourceId;
/**
* The name of the SizeConstraintSet, if any.
*/
Name: ResourceName;
}
export interface SizeConstraintSetUpdate {
/**
* Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.
*/
Action: ChangeAction;
/**
* Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
*/
SizeConstraint: SizeConstraint;
}
export type SizeConstraintSetUpdates = SizeConstraintSetUpdate[];
export type SizeConstraints = SizeConstraint[];
export interface SqlInjectionMatchSet {
/**
* A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
*/
SqlInjectionMatchSetId: ResourceId;
/**
* The name, if any, of the SqlInjectionMatchSet.
*/
Name?: ResourceName;
/**
* Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
*/
SqlInjectionMatchTuples: SqlInjectionMatchTuples;
}
export type SqlInjectionMatchSetSummaries = SqlInjectionMatchSetSummary[];
export interface SqlInjectionMatchSetSummary {
/**
* A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
*/
SqlInjectionMatchSetId: ResourceId;
/**
* The name of the SqlInjectionMatchSet, if any, specified by Id.
*/
Name: ResourceName;
}
export interface SqlInjectionMatchSetUpdate {
/**
* Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.
*/
Action: ChangeAction;
/**
* Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
*/
SqlInjectionMatchTuple: SqlInjectionMatchTuple;
}
export type SqlInjectionMatchSetUpdates = SqlInjectionMatchSetUpdate[];
export interface SqlInjectionMatchTuple {
/**
* Specifies where in a web request to look for snippets of malicious SQL code.
*/
FieldToMatch: FieldToMatch;
/**
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations.
*/
TextTransformation: TextTransformation;
}
export type SqlInjectionMatchTuples = SqlInjectionMatchTuple[];
export type SubscribedRuleGroupSummaries = SubscribedRuleGroupSummary[];
export interface SubscribedRuleGroupSummary {
/**
* A unique identifier for a RuleGroup.
*/
RuleGroupId: ResourceId;
/**
* A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
*/
Name: ResourceName;
/**
* A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
*/
MetricName: MetricName;
}
export interface Tag {
Key?: TagKey;
Value?: TagValue;
}
export interface TagInfoForResource {
ResourceARN?: ResourceArn;
TagList?: TagList;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
ResourceARN: ResourceArn;
Tags: TagList;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE"|string;
export interface TimeWindow {
/**
* The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
*/
StartTime: Timestamp;
/**
* The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
*/
EndTime: Timestamp;
}
export type Timestamp = Date;
export type URIString = string;
export interface UntagResourceRequest {
ResourceARN: ResourceArn;
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateByteMatchSetRequest {
/**
* The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
*/
ByteMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types: ByteMatchSetUpdate: Contains Action and ByteMatchTuple ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch: Contains Data and Type
*/
Updates: ByteMatchSetUpdates;
}
export interface UpdateByteMatchSetResponse {
/**
* The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateGeoMatchSetRequest {
/**
* The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*/
GeoMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types: GeoMatchSetUpdate: Contains Action and GeoMatchConstraint GeoMatchConstraint: Contains Type and Value You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request.
*/
Updates: GeoMatchSetUpdates;
}
export interface UpdateGeoMatchSetResponse {
/**
* The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateIPSetRequest {
/**
* The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.
*/
IPSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types: IPSetUpdate: Contains Action and IPSetDescriptor IPSetDescriptor: Contains Type and Value You can insert a maximum of 1000 addresses in a single request.
*/
Updates: IPSetUpdates;
}
export interface UpdateIPSetResponse {
/**
* The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateRateBasedRuleRequest {
/**
* The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
*/
RuleId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.
*/
Updates: RuleUpdates;
/**
* The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
*/
RateLimit: RateLimit;
}
export interface UpdateRateBasedRuleResponse {
/**
* The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateRegexMatchSetRequest {
/**
* The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*/
RegexMatchSetId: ResourceId;
/**
* An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.
*/
Updates: RegexMatchSetUpdates;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface UpdateRegexMatchSetResponse {
/**
* The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateRegexPatternSetRequest {
/**
* The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*/
RegexPatternSetId: ResourceId;
/**
* An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.
*/
Updates: RegexPatternSetUpdates;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface UpdateRegexPatternSetResponse {
/**
* The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateRuleGroupRequest {
/**
* The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
*/
RuleGroupId: ResourceId;
/**
* An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup. You can only insert REGULAR rules into a rule group. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
*/
Updates: RuleGroupUpdates;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
}
export interface UpdateRuleGroupResponse {
/**
* The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateRuleRequest {
/**
* The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.
*/
RuleId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types: RuleUpdate: Contains Action and Predicate Predicate: Contains DataId, Negated, and Type FieldToMatch: Contains Data and Type
*/
Updates: RuleUpdates;
}
export interface UpdateRuleResponse {
/**
* The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateSizeConstraintSetRequest {
/**
* The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
*/
SizeConstraintSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types: SizeConstraintSetUpdate: Contains Action and SizeConstraint SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains Data and Type
*/
Updates: SizeConstraintSetUpdates;
}
export interface UpdateSizeConstraintSetResponse {
/**
* The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateSqlInjectionMatchSetRequest {
/**
* The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
*/
SqlInjectionMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types: SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
*/
Updates: SqlInjectionMatchSetUpdates;
}
export interface UpdateSqlInjectionMatchSetResponse {
/**
* The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateWebACLRequest {
/**
* The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.
*/
WebACLId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of updates to make to the WebACL. An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types: WebACLUpdate: Contains Action and ActivatedRule ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. WafAction: Contains Type
*/
Updates?: WebACLUpdates;
/**
* A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.
*/
DefaultAction?: WafAction;
}
export interface UpdateWebACLResponse {
/**
* The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface UpdateXssMatchSetRequest {
/**
* The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*/
XssMatchSetId: ResourceId;
/**
* The value returned by the most recent call to GetChangeToken.
*/
ChangeToken: ChangeToken;
/**
* An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types: XssMatchSetUpdate: Contains Action and XssMatchTuple XssMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
*/
Updates: XssMatchSetUpdates;
}
export interface UpdateXssMatchSetResponse {
/**
* The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
ChangeToken?: ChangeToken;
}
export interface WafAction {
/**
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following: ALLOW: AWS WAF allows requests BLOCK: AWS WAF blocks requests COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.
*/
Type: WafActionType;
}
export type WafActionType = "BLOCK"|"ALLOW"|"COUNT"|string;
export interface WafOverrideAction {
/**
* COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.
*/
Type: WafOverrideActionType;
}
export type WafOverrideActionType = "NONE"|"COUNT"|string;
export type WafRuleType = "REGULAR"|"RATE_BASED"|"GROUP"|string;
export interface WebACL {
/**
* A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs.
*/
WebACLId: ResourceId;
/**
* A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
*/
Name?: ResourceName;
/**
* A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.
*/
MetricName?: MetricName;
/**
* The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
*/
DefaultAction: WafAction;
/**
* An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
*/
Rules: ActivatedRules;
/**
* Tha Amazon Resource Name (ARN) of the web ACL.
*/
WebACLArn?: ResourceArn;
}
export type WebACLSummaries = WebACLSummary[];
export interface WebACLSummary {
/**
* A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs.
*/
WebACLId: ResourceId;
/**
* A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
*/
Name: ResourceName;
}
export interface WebACLUpdate {
/**
* Specifies whether to insert a Rule into or delete a Rule from a WebACL.
*/
Action: ChangeAction;
/**
* The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).
*/
ActivatedRule: ActivatedRule;
}
export type WebACLUpdates = WebACLUpdate[];
export interface XssMatchSet {
/**
* A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*/
XssMatchSetId: ResourceId;
/**
* The name, if any, of the XssMatchSet.
*/
Name?: ResourceName;
/**
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
*/
XssMatchTuples: XssMatchTuples;
}
export type XssMatchSetSummaries = XssMatchSetSummary[];
export interface XssMatchSetSummary {
/**
* A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*/
XssMatchSetId: ResourceId;
/**
* The name of the XssMatchSet, if any, specified by Id.
*/
Name: ResourceName;
}
export interface XssMatchSetUpdate {
/**
* Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.
*/
Action: ChangeAction;
/**
* Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
*/
XssMatchTuple: XssMatchTuple;
}
export type XssMatchSetUpdates = XssMatchSetUpdate[];
export interface XssMatchTuple {
/**
* Specifies where in a web request to look for cross-site scripting attacks.
*/
FieldToMatch: FieldToMatch;
/**
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations.
*/
TextTransformation: TextTransformation;
}
export type XssMatchTuples = XssMatchTuple[];
/**
* 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 = "2016-11-28"|"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 WAFRegional client.
*/
export import Types = WAFRegional;
}
export = WAFRegional;