package smaws-clients

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file types.ml

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
open Smaws_Lib
let service =
  Service.{
    namespace = "wafv2";
    endpointPrefix = "wafv2";
    version = "2019-07-29";
    protocol = AwsJson_1_1
  };
type single_header = {
  name: string
}

type single_query_argument = {
  name: string
}

type all_query_arguments = unit

type uri_path = unit

type query_string = unit

type oversize_handling = | NO_MATCH
  | MATCH
  | CONTINUE

type body = {
  oversize_handling: oversize_handling option
}

type method_ = unit

type all = unit

type json_match_pattern = {
  included_paths: string list option;
  all: all option
}

type json_match_scope = | VALUE
  | KEY
  | ALL

type body_parsing_fallback_behavior = | EVALUATE_AS_STRING
  | NO_MATCH
  | MATCH

type json_body = {
  oversize_handling: oversize_handling option;
  invalid_fallback_behavior: body_parsing_fallback_behavior option;
  match_scope: json_match_scope;
  match_pattern: json_match_pattern
}

type header_match_pattern = {
  excluded_headers: string list option;
  included_headers: string list option;
  all: all option
}

type map_match_scope = | VALUE
  | KEY
  | ALL

type headers = {
  oversize_handling: oversize_handling;
  match_scope: map_match_scope;
  match_pattern: header_match_pattern
}

type cookie_match_pattern = {
  excluded_cookies: string list option;
  included_cookies: string list option;
  all: all option
}

type cookies = {
  oversize_handling: oversize_handling;
  match_scope: map_match_scope;
  match_pattern: cookie_match_pattern
}

type header_order = {
  oversize_handling: oversize_handling
}

type fallback_behavior = | NO_MATCH
  | MATCH

type ja3_fingerprint = {
  fallback_behavior: fallback_behavior
}

type field_to_match = {
  ja3_fingerprint: ja3_fingerprint option;
  header_order: header_order option;
  cookies: cookies option;
  headers: headers option;
  json_body: json_body option;
  method_: method_ option;
  body: body option;
  query_string: query_string option;
  uri_path: uri_path option;
  all_query_arguments: all_query_arguments option;
  single_query_argument: single_query_argument option;
  single_header: single_header option
}

type text_transformation_type = | UTF8_TO_UNICODE
  | URL_DECODE_UNI
  | BASE64_DECODE_EXT
  | REPLACE_NULLS
  | REMOVE_NULLS
  | NORMALIZE_PATH_WIN
  | NORMALIZE_PATH
  | JS_DECODE
  | CSS_DECODE
  | SQL_HEX_DECODE
  | ESCAPE_SEQ_DECODE
  | REPLACE_COMMENTS
  | MD5
  | HEX_DECODE
  | BASE64_DECODE
  | URL_DECODE
  | CMD_LINE
  | LOWERCASE
  | HTML_ENTITY_DECODE
  | COMPRESS_WHITE_SPACE
  | NONE

type text_transformation = {
  type_: text_transformation_type;
  priority: int
}

type xss_match_statement = {
  text_transformations: text_transformation list;
  field_to_match: field_to_match
}

type web_acl_summary = {
  ar_n: string option;
  lock_token: string option;
  description: string option;
  id: string option;
  name: string option
}

type custom_http_header = {
  value: string;
  name: string
}

type custom_response = {
  response_headers: custom_http_header list option;
  custom_response_body_key: string option;
  response_code: int
}

type block_action = {
  custom_response: custom_response option
}

type custom_request_handling = {
  insert_headers: custom_http_header list
}

type allow_action = {
  custom_request_handling: custom_request_handling option
}

type default_action = {
  allow: allow_action option;
  block: block_action option
}

type positional_constraint = | CONTAINS_WORD
  | CONTAINS
  | ENDS_WITH
  | STARTS_WITH
  | EXACTLY

type byte_match_statement = {
  positional_constraint: positional_constraint;
  text_transformations: text_transformation list;
  field_to_match: field_to_match;
  search_string: bytes
}

type sensitivity_level = | HIGH
  | LOW

type sqli_match_statement = {
  sensitivity_level: sensitivity_level option;
  text_transformations: text_transformation list;
  field_to_match: field_to_match
}

type comparison_operator = | GT
  | GE
  | LT
  | LE
  | NE
  | EQ

type size_constraint_statement = {
  text_transformations: text_transformation list;
  size: int;
  comparison_operator: comparison_operator;
  field_to_match: field_to_match
}

type country_code = | XK
  | ZW
  | ZM
  | YE
  | EH
  | WF
  | VI
  | VG
  | VN
  | VE
  | VU
  | UZ
  | UY
  | UM
  | US
  | GB
  | AE
  | UA
  | UG
  | TV
  | TC
  | TM
  | TR
  | TN
  | TT
  | TO
  | TK
  | TG
  | TL
  | TH
  | TZ
  | TJ
  | TW
  | SY
  | CH
  | SE
  | SZ
  | SJ
  | SR
  | SD
  | LK
  | ES
  | SS
  | GS
  | ZA
  | SO
  | SB
  | SI
  | SK
  | SX
  | SG
  | SL
  | SC
  | RS
  | SN
  | SA
  | ST
  | SM
  | WS
  | VC
  | PM
  | MF
  | LC
  | KN
  | SH
  | BL
  | RW
  | RU
  | RO
  | RE
  | QA
  | PR
  | PT
  | PL
  | PN
  | PH
  | PE
  | PY
  | PG
  | PA
  | PS
  | PW
  | PK
  | OM
  | NO
  | MP
  | NF
  | NU
  | NG
  | NE
  | NI
  | NZ
  | NC
  | NL
  | NP
  | NR
  | NA
  | MM
  | MZ
  | MA
  | MS
  | ME
  | MN
  | MC
  | MD
  | FM
  | MX
  | YT
  | MU
  | MR
  | MQ
  | MH
  | MT
  | ML
  | MV
  | MY
  | MW
  | MG
  | MK
  | MO
  | LU
  | LT
  | LI
  | LY
  | LR
  | LS
  | LB
  | LV
  | LA
  | KG
  | KW
  | KR
  | KP
  | KI
  | KE
  | KZ
  | JO
  | JE
  | JP
  | JM
  | IT
  | IL
  | IM
  | IE
  | IQ
  | IR
  | ID
  | IN
  | IS
  | HU
  | HK
  | HN
  | VA
  | HM
  | HT
  | GY
  | GW
  | GN
  | GG
  | GT
  | GU
  | GP
  | GD
  | GL
  | GR
  | GI
  | GH
  | DE
  | GE
  | GM
  | GA
  | TF
  | PF
  | GF
  | FR
  | FI
  | FJ
  | FO
  | FK
  | ET
  | EE
  | ER
  | GQ
  | SV
  | EG
  | EC
  | DO
  | DM
  | DJ
  | DK
  | CZ
  | CY
  | CW
  | CU
  | HR
  | CI
  | CR
  | CK
  | CD
  | CG
  | KM
  | CO
  | CC
  | CX
  | CN
  | CL
  | TD
  | CF
  | KY
  | CV
  | CA
  | CM
  | KH
  | BI
  | BF
  | BG
  | BN
  | IO
  | BR
  | BV
  | BW
  | BA
  | BQ
  | BO
  | BT
  | BM
  | BJ
  | BZ
  | BE
  | BY
  | BB
  | BD
  | BH
  | BS
  | AZ
  | AT
  | AU
  | AW
  | AM
  | AR
  | AG
  | AQ
  | AI
  | AO
  | AD
  | AS
  | DZ
  | AL
  | AX
  | AF

type forwarded_ip_config = {
  fallback_behavior: fallback_behavior;
  header_name: string
}

type geo_match_statement = {
  forwarded_ip_config: forwarded_ip_config option;
  country_codes: country_code list option
}

type excluded_rule = {
  name: string
}

type count_action = {
  custom_request_handling: custom_request_handling option
}

type captcha_action = {
  custom_request_handling: custom_request_handling option
}

type challenge_action = {
  custom_request_handling: custom_request_handling option
}

type rule_action = {
  challenge: challenge_action option;
  captcha: captcha_action option;
  count: count_action option;
  allow: allow_action option;
  block: block_action option
}

type rule_action_override = {
  action_to_use: rule_action;
  name: string
}

type rule_group_reference_statement = {
  rule_action_overrides: rule_action_override list option;
  excluded_rules: excluded_rule list option;
  ar_n: string
}

type forwarded_ip_position = | ANY
  | LAST
  | FIRST

type ip_set_forwarded_ip_config = {
  position: forwarded_ip_position;
  fallback_behavior: fallback_behavior;
  header_name: string
}

type ip_set_reference_statement = {
  ip_set_forwarded_ip_config: ip_set_forwarded_ip_config option;
  ar_n: string
}

type regex_pattern_set_reference_statement = {
  text_transformations: text_transformation list;
  field_to_match: field_to_match;
  ar_n: string
}

type rate_based_statement_aggregate_key_type = | CONSTANT
  | CUSTOM_KEYS
  | FORWARDED_IP
  | IP

type rate_limit_header = {
  text_transformations: text_transformation list;
  name: string
}

type rate_limit_cookie = {
  text_transformations: text_transformation list;
  name: string
}

type rate_limit_query_argument = {
  text_transformations: text_transformation list;
  name: string
}

type rate_limit_query_string = {
  text_transformations: text_transformation list
}

type rate_limit_http_method = unit

type rate_limit_forwarded_i_p = unit

type rate_limit_i_p = unit

type rate_limit_label_namespace = {
  namespace: string
}

type rate_limit_uri_path = {
  text_transformations: text_transformation list
}

type rate_based_statement_custom_key = {
  uri_path: rate_limit_uri_path option;
  label_namespace: rate_limit_label_namespace option;
  i_p: rate_limit_i_p option;
  forwarded_i_p: rate_limit_forwarded_i_p option;
  http_method: rate_limit_http_method option;
  query_string: rate_limit_query_string option;
  query_argument: rate_limit_query_argument option;
  cookie: rate_limit_cookie option;
  header: rate_limit_header option
}

type payload_type = | FORM_ENCODED
  | JSON

type username_field = {
  identifier: string
}

type password_field = {
  identifier: string
}

type inspection_level = | TARGETED
  | COMMON

type aws_managed_rules_bot_control_rule_set = {
  enable_machine_learning: bool option;
  inspection_level: inspection_level
}

type request_inspection = {
  password_field: password_field;
  username_field: username_field;
  payload_type: payload_type
}

type response_inspection_status_code = {
  failure_codes: int list;
  success_codes: int list
}

type response_inspection_header = {
  failure_values: string list;
  success_values: string list;
  name: string
}

type response_inspection_body_contains = {
  failure_strings: string list;
  success_strings: string list
}

type response_inspection_json = {
  failure_values: string list;
  success_values: string list;
  identifier: string
}

type response_inspection = {
  json: response_inspection_json option;
  body_contains: response_inspection_body_contains option;
  header: response_inspection_header option;
  status_code: response_inspection_status_code option
}

type aws_managed_rules_atp_rule_set = {
  enable_regex_in_path: bool option;
  response_inspection: response_inspection option;
  request_inspection: request_inspection option;
  login_path: string
}

type email_field = {
  identifier: string
}

type phone_number_field = {
  identifier: string
}

type address_field = {
  identifier: string
}

type request_inspection_acf_p = {
  address_fields: address_field list option;
  phone_number_fields: phone_number_field list option;
  email_field: email_field option;
  password_field: password_field option;
  username_field: username_field option;
  payload_type: payload_type
}

type aws_managed_rules_acfp_rule_set = {
  enable_regex_in_path: bool option;
  response_inspection: response_inspection option;
  request_inspection: request_inspection_acf_p;
  registration_page_path: string;
  creation_path: string
}

type managed_rule_group_config = {
  aws_managed_rules_acfp_rule_set: aws_managed_rules_acfp_rule_set option;
  aws_managed_rules_atp_rule_set: aws_managed_rules_atp_rule_set option;
  aws_managed_rules_bot_control_rule_set: aws_managed_rules_bot_control_rule_set option;
  password_field: password_field option;
  username_field: username_field option;
  payload_type: payload_type option;
  login_path: string option
}

type label_match_scope = | NAMESPACE
  | LABEL

type label_match_statement = {
  key: string;
  scope: label_match_scope
}

type regex_match_statement = {
  text_transformations: text_transformation list;
  field_to_match: field_to_match;
  regex_string: string
}

type and_statement = {
  statements: statement list
} and managed_rule_group_statement = {
  rule_action_overrides: rule_action_override list option;
  managed_rule_group_configs: managed_rule_group_config list option;
  scope_down_statement: statement option;
  excluded_rules: excluded_rule list option;
  version: string option;
  name: string;
  vendor_name: string
} and not_statement = {
  statement: statement
} and or_statement = {
  statements: statement list
} and rate_based_statement = {
  custom_keys: rate_based_statement_custom_key list option;
  forwarded_ip_config: forwarded_ip_config option;
  scope_down_statement: statement option;
  aggregate_key_type: rate_based_statement_aggregate_key_type;
  evaluation_window_sec: int option;
  limit: int
} and statement = {
  regex_match_statement: regex_match_statement option;
  label_match_statement: label_match_statement option;
  managed_rule_group_statement: managed_rule_group_statement option;
  not_statement: not_statement option;
  or_statement: or_statement option;
  and_statement: and_statement option;
  rate_based_statement: rate_based_statement option;
  regex_pattern_set_reference_statement: regex_pattern_set_reference_statement option;
  ip_set_reference_statement: ip_set_reference_statement option;
  rule_group_reference_statement: rule_group_reference_statement option;
  geo_match_statement: geo_match_statement option;
  size_constraint_statement: size_constraint_statement option;
  xss_match_statement: xss_match_statement option;
  sqli_match_statement: sqli_match_statement option;
  byte_match_statement: byte_match_statement option
}

type none_action = unit

type override_action = {
  none: none_action option;
  count: count_action option
}

type label = {
  name: string
}

type visibility_config = {
  metric_name: string;
  cloud_watch_metrics_enabled: bool;
  sampled_requests_enabled: bool
}

type immunity_time_property = {
  immunity_time: int
}

type captcha_config = {
  immunity_time_property: immunity_time_property option
}

type challenge_config = {
  immunity_time_property: immunity_time_property option
}

type rule = {
  challenge_config: challenge_config option;
  captcha_config: captcha_config option;
  visibility_config: visibility_config;
  rule_labels: label list option;
  override_action: override_action option;
  action: rule_action option;
  statement: statement;
  priority: int;
  name: string
}

type firewall_manager_statement = {
  rule_group_reference_statement: rule_group_reference_statement option;
  managed_rule_group_statement: managed_rule_group_statement option
}

type firewall_manager_rule_group = {
  visibility_config: visibility_config;
  override_action: override_action;
  firewall_manager_statement: firewall_manager_statement;
  priority: int;
  name: string
}

type response_content_type = | APPLICATION_JSON
  | TEXT_HTML
  | TEXT_PLAIN

type custom_response_body = {
  content: string;
  content_type: response_content_type
}

type size_inspection_limit = | KB_64
  | KB_48
  | KB_32
  | KB_16

type request_body_associated_resource_type_config = {
  default_size_inspection_limit: size_inspection_limit
}

type associated_resource_type = | VERIFIED_ACCESS_INSTANCE
  | APP_RUNNER_SERVICE
  | COGNITO_USER_POOL
  | API_GATEWAY
  | CLOUDFRONT

type association_config = {
  request_body: (string * request_body_associated_resource_type_config) list option
}

type web_ac_l = {
  association_config: association_config option;
  token_domains: string list option;
  challenge_config: challenge_config option;
  captcha_config: captcha_config option;
  custom_response_bodies: (string * custom_response_body) list option;
  label_namespace: string option;
  managed_by_firewall_manager: bool option;
  post_process_firewall_manager_rule_groups: firewall_manager_rule_group list option;
  pre_process_firewall_manager_rule_groups: firewall_manager_rule_group list option;
  capacity: int option;
  visibility_config: visibility_config;
  rules: rule list option;
  description: string option;
  default_action: default_action;
  ar_n: string;
  id: string;
  name: string
}

type waf_unsupported_aggregate_key_type_exception = {
  message: string option
}

type waf_unavailable_entity_exception = {
  message: string option
}

type waf_tag_operation_internal_error_exception = {
  message: string option
}

type waf_tag_operation_exception = {
  message: string option
}

type waf_subscription_not_found_exception = {
  message: string option
}

type waf_service_linked_role_error_exception = {
  message: string option
}

type waf_optimistic_lock_exception = {
  message: string option
}

type waf_nonexistent_item_exception = {
  message: string option
}

type waf_log_destination_permission_issue_exception = {
  message: string option
}

type waf_limits_exceeded_exception = {
  source_type: string option;
  message: string option
}

type waf_invalid_resource_exception = {
  message: string option
}

type waf_invalid_permission_policy_exception = {
  message: string option
}

type parameter_exception_field = | ACP_RULE_SET_RESPONSE_INSPECTION
  | CUSTOM_KEYS
  | SCOPE_DOWN
  | ASSOCIATED_RESOURCE_TYPE
  | ATP_RULE_SET_RESPONSE_INSPECTION
  | TOKEN_DOMAIN
  | CHALLENGE_CONFIG
  | OVERSIZE_HANDLING
  | MAP_MATCH_SCOPE
  | COOKIE_MATCH_PATTERN
  | HEADER_MATCH_PATTERN
  | PAYLOAD_TYPE
  | MANAGED_RULE_GROUP_CONFIG
  | LOG_DESTINATION
  | ASSOCIABLE_RESOURCE
  | CHANGE_PROPAGATION_STATUS
  | EXPIRE_TIMESTAMP
  | FILTER_CONDITION
  | LOGGING_FILTER
  | BODY_PARSING_FALLBACK_BEHAVIOR
  | JSON_MATCH_SCOPE
  | JSON_MATCH_PATTERN
  | CUSTOM_RESPONSE_BODY
  | CUSTOM_RESPONSE
  | RESPONSE_CONTENT_TYPE
  | CUSTOM_REQUEST_HANDLING
  | HEADER_NAME
  | IP_SET_FORWARDED_IP_CONFIG
  | FORWARDED_IP_CONFIG
  | POSITION
  | FALLBACK_BEHAVIOR
  | FIREWALL_MANAGER_STATEMENT
  | METRIC_NAME
  | TAG_KEYS
  | TAGS
  | RESOURCE_TYPE
  | RESOURCE_ARN
  | SCOPE_VALUE
  | OVERRIDE_ACTION
  | ENTITY_LIMIT
  | RULE_ACTION
  | DEFAULT_ACTION
  | SINGLE_HEADER
  | SINGLE_QUERY_ARGUMENT
  | TEXT_TRANSFORMATION
  | FIELD_TO_MATCH
  | IP_ADDRESS_VERSION
  | IP_ADDRESS
  | NOT_STATEMENT
  | OR_STATEMENT
  | AND_STATEMENT
  | LABEL_MATCH_STATEMENT
  | MANAGED_RULE_SET_STATEMENT
  | IP_SET_REFERENCE_STATEMENT
  | REGEX_PATTERN_REFERENCE_STATEMENT
  | RULE_GROUP_REFERENCE_STATEMENT
  | RATE_BASED_STATEMENT
  | GEO_MATCH_STATEMENT
  | SIZE_CONSTRAINT_STATEMENT
  | XSS_MATCH_STATEMENT
  | SQLI_MATCH_STATEMENT
  | BYTE_MATCH_STATEMENT
  | STATEMENT
  | EXCLUDED_RULE
  | RULE
  | MANAGED_RULE_SET
  | IP_SET
  | REGEX_PATTERN_SET
  | RULE_GROUP
  | WEB_ACL

type waf_invalid_parameter_exception = {
  reason: string option;
  parameter: string option;
  field: parameter_exception_field option;
  message: string option
}

type waf_invalid_operation_exception = {
  message: string option
}

type waf_internal_error_exception = {
  message: string option
}

type waf_expired_managed_rule_group_version_exception = {
  message: string option
}

type waf_duplicate_item_exception = {
  message: string option
}

type waf_configuration_warning_exception = {
  message: string option
}

type waf_associated_item_exception = {
  message: string option
}

type version_to_publish = {
  forecasted_lifetime: int option;
  associated_rule_group_arn: string option
}

type update_web_acl_response = {
  next_lock_token: string option
}

type scope = | REGIONAL
  | CLOUDFRONT

type update_web_acl_request = {
  association_config: association_config option;
  token_domains: string list option;
  challenge_config: challenge_config option;
  captcha_config: captcha_config option;
  custom_response_bodies: (string * custom_response_body) list option;
  lock_token: string;
  visibility_config: visibility_config;
  rules: rule list option;
  description: string option;
  default_action: default_action;
  id: string;
  scope: scope;
  name: string
}

type update_rule_group_response = {
  next_lock_token: string option
}

type update_rule_group_request = {
  custom_response_bodies: (string * custom_response_body) list option;
  lock_token: string;
  visibility_config: visibility_config;
  rules: rule list option;
  description: string option;
  id: string;
  scope: scope;
  name: string
}

type update_regex_pattern_set_response = {
  next_lock_token: string option
}

type regex = {
  regex_string: string option
}

type update_regex_pattern_set_request = {
  lock_token: string;
  regular_expression_list: regex list;
  description: string option;
  id: string;
  scope: scope;
  name: string
}

type update_managed_rule_set_version_expiry_date_response = {
  next_lock_token: string option;
  expiry_timestamp: float option;
  expiring_version: string option
}

type update_managed_rule_set_version_expiry_date_request = {
  expiry_timestamp: float;
  version_to_expire: string;
  lock_token: string;
  id: string;
  scope: scope;
  name: string
}

type update_ip_set_response = {
  next_lock_token: string option
}

type update_ip_set_request = {
  lock_token: string;
  addresses: string list;
  description: string option;
  id: string;
  scope: scope;
  name: string
}

type untag_resource_response = unit

type untag_resource_request = {
  tag_keys: string list;
  resource_ar_n: string
}

type time_window = {
  end_time: float;
  start_time: float
}

type tag_resource_response = unit

type tag = {
  value: string;
  key: string
}

type tag_resource_request = {
  tags: tag list;
  resource_ar_n: string
}

type tag_info_for_resource = {
  tag_list: tag list option;
  resource_ar_n: string option
}

type http_header = {
  value: string option;
  name: string option
}

type http_request = {
  headers: http_header list option;
  http_version: string option;
  method_: string option;
  ur_i: string option;
  country: string option;
  client_i_p: string option
}

type failure_reason = | TOKEN_DOMAIN_MISMATCH
  | TOKEN_INVALID
  | TOKEN_EXPIRED
  | TOKEN_MISSING

type captcha_response = {
  failure_reason: failure_reason option;
  solve_timestamp: int option;
  response_code: int option
}

type challenge_response = {
  failure_reason: failure_reason option;
  solve_timestamp: int option;
  response_code: int option
}

type sampled_http_request = {
  overridden_action: string option;
  challenge_response: challenge_response option;
  captcha_response: captcha_response option;
  labels: label list option;
  response_code_sent: int option;
  request_headers_inserted: http_header list option;
  rule_name_within_rule_group: string option;
  action: string option;
  timestamp_: float option;
  weight: int;
  request: http_request
}

type rule_summary = {
  action: rule_action option;
  name: string option
}

type rule_group_summary = {
  ar_n: string option;
  lock_token: string option;
  description: string option;
  id: string option;
  name: string option
}

type label_summary = {
  name: string option
}

type rule_group = {
  consumed_labels: label_summary list option;
  available_labels: label_summary list option;
  custom_response_bodies: (string * custom_response_body) list option;
  label_namespace: string option;
  visibility_config: visibility_config;
  rules: rule list option;
  description: string option;
  ar_n: string;
  capacity: int;
  id: string;
  name: string
}

type resource_type = | VERIFIED_ACCESS_INSTANCE
  | APP_RUNNER_SERVICE
  | COGNITIO_USER_POOL
  | APPSYNC
  | API_GATEWAY
  | APPLICATION_LOAD_BALANCER

type release_summary = {
  timestamp_: float option;
  release_version: string option
}

type regex_pattern_set_summary = {
  ar_n: string option;
  lock_token: string option;
  description: string option;
  id: string option;
  name: string option
}

type regex_pattern_set = {
  regular_expression_list: regex list option;
  description: string option;
  ar_n: string option;
  id: string option;
  name: string option
}

type ip_address_version = | IPV6
  | IPV4

type rate_based_statement_managed_keys_ip_set = {
  addresses: string list option;
  ip_address_version: ip_address_version option
}

type put_permission_policy_response = unit

type put_permission_policy_request = {
  policy: string;
  resource_arn: string
}

type put_managed_rule_set_versions_response = {
  next_lock_token: string option
}

type put_managed_rule_set_versions_request = {
  versions_to_publish: (string * version_to_publish) list option;
  recommended_version: string option;
  lock_token: string;
  id: string;
  scope: scope;
  name: string
}

type filter_behavior = | DROP
  | KEEP

type filter_requirement = | MEETS_ANY
  | MEETS_ALL

type action_value = | EXCLUDED_AS_COUNT
  | CHALLENGE
  | CAPTCHA
  | COUNT
  | BLOCK
  | ALLOW

type action_condition = {
  action: action_value
}

type label_name_condition = {
  label_name: string
}

type condition = {
  label_name_condition: label_name_condition option;
  action_condition: action_condition option
}

type filter = {
  conditions: condition list;
  requirement: filter_requirement;
  behavior: filter_behavior
}

type logging_filter = {
  default_behavior: filter_behavior;
  filters: filter list
}

type log_type = | WAF_LOGS

type log_scope = | SECURITY_LAKE
  | CUSTOMER

type logging_configuration = {
  log_scope: log_scope option;
  log_type: log_type option;
  logging_filter: logging_filter option;
  managed_by_firewall_manager: bool option;
  redacted_fields: field_to_match list option;
  log_destination_configs: string list;
  resource_arn: string
}

type put_logging_configuration_response = {
  logging_configuration: logging_configuration option
}

type put_logging_configuration_request = {
  logging_configuration: logging_configuration
}

type managed_rule_set_version = {
  expiry_timestamp: float option;
  last_update_timestamp: float option;
  publish_timestamp: float option;
  forecasted_lifetime: int option;
  capacity: int option;
  associated_rule_group_arn: string option
}

type platform = | ANDROID
  | IOS

type mobile_sdk_release = {
  tags: tag list option;
  release_notes: string option;
  timestamp_: float option;
  release_version: string option
}

type managed_rule_set_summary = {
  label_namespace: string option;
  ar_n: string option;
  lock_token: string option;
  description: string option;
  id: string option;
  name: string option
}

type managed_rule_set = {
  label_namespace: string option;
  recommended_version: string option;
  published_versions: (string * managed_rule_set_version) list option;
  description: string option;
  ar_n: string;
  id: string;
  name: string
}

type managed_rule_group_version = {
  last_update_timestamp: float option;
  name: string option
}

type managed_rule_group_summary = {
  description: string option;
  versioning_supported: bool option;
  name: string option;
  vendor_name: string option
}

type managed_product_descriptor = {
  is_advanced_managed_rule_set: bool option;
  is_versioning_supported: bool option;
  sns_topic_arn: string option;
  product_description: string option;
  product_title: string option;
  product_link: string option;
  product_id: string option;
  managed_rule_set_name: string option;
  vendor_name: string option
}

type list_web_ac_ls_response = {
  web_ac_ls: web_acl_summary list option;
  next_marker: string option
}

type list_web_ac_ls_request = {
  limit: int option;
  next_marker: string option;
  scope: scope
}

type list_tags_for_resource_response = {
  tag_info_for_resource: tag_info_for_resource option;
  next_marker: string option
}

type list_tags_for_resource_request = {
  resource_ar_n: string;
  limit: int option;
  next_marker: string option
}

type list_rule_groups_response = {
  rule_groups: rule_group_summary list option;
  next_marker: string option
}

type list_rule_groups_request = {
  limit: int option;
  next_marker: string option;
  scope: scope
}

type list_resources_for_web_acl_response = {
  resource_arns: string list option
}

type list_resources_for_web_acl_request = {
  resource_type: resource_type option;
  web_acl_arn: string
}

type list_regex_pattern_sets_response = {
  regex_pattern_sets: regex_pattern_set_summary list option;
  next_marker: string option
}

type list_regex_pattern_sets_request = {
  limit: int option;
  next_marker: string option;
  scope: scope
}

type list_mobile_sdk_releases_response = {
  next_marker: string option;
  release_summaries: release_summary list option
}

type list_mobile_sdk_releases_request = {
  limit: int option;
  next_marker: string option;
  platform: platform
}

type list_managed_rule_sets_response = {
  managed_rule_sets: managed_rule_set_summary list option;
  next_marker: string option
}

type list_managed_rule_sets_request = {
  limit: int option;
  next_marker: string option;
  scope: scope
}

type list_logging_configurations_response = {
  next_marker: string option;
  logging_configurations: logging_configuration list option
}

type list_logging_configurations_request = {
  log_scope: log_scope option;
  limit: int option;
  next_marker: string option;
  scope: scope
}

type ip_set_summary = {
  ar_n: string option;
  lock_token: string option;
  description: string option;
  id: string option;
  name: string option
}

type list_ip_sets_response = {
  ip_sets: ip_set_summary list option;
  next_marker: string option
}

type list_ip_sets_request = {
  limit: int option;
  next_marker: string option;
  scope: scope
}

type list_available_managed_rule_groups_response = {
  managed_rule_groups: managed_rule_group_summary list option;
  next_marker: string option
}

type list_available_managed_rule_groups_request = {
  limit: int option;
  next_marker: string option;
  scope: scope
}

type list_available_managed_rule_group_versions_response = {
  current_default_version: string option;
  versions: managed_rule_group_version list option;
  next_marker: string option
}

type list_available_managed_rule_group_versions_request = {
  limit: int option;
  next_marker: string option;
  scope: scope;
  name: string;
  vendor_name: string
}

type api_key_summary = {
  version: int option;
  creation_timestamp: float option;
  api_key: string option;
  token_domains: string list option
}

type list_api_keys_response = {
  application_integration_ur_l: string option;
  api_key_summaries: api_key_summary list option;
  next_marker: string option
}

type list_api_keys_request = {
  limit: int option;
  next_marker: string option;
  scope: scope
}

type ip_set = {
  addresses: string list;
  ip_address_version: ip_address_version;
  description: string option;
  ar_n: string;
  id: string;
  name: string
}

type get_web_acl_response = {
  application_integration_ur_l: string option;
  lock_token: string option;
  web_ac_l: web_ac_l option
}

type get_web_acl_request = {
  id: string;
  scope: scope;
  name: string
}

type get_web_acl_for_resource_response = {
  web_ac_l: web_ac_l option
}

type get_web_acl_for_resource_request = {
  resource_arn: string
}

type get_sampled_requests_response = {
  time_window: time_window option;
  population_size: int option;
  sampled_requests: sampled_http_request list option
}

type get_sampled_requests_request = {
  max_items: int;
  time_window: time_window;
  scope: scope;
  rule_metric_name: string;
  web_acl_arn: string
}

type get_rule_group_response = {
  lock_token: string option;
  rule_group: rule_group option
}

type get_rule_group_request = {
  ar_n: string option;
  id: string option;
  scope: scope option;
  name: string option
}

type get_regex_pattern_set_response = {
  lock_token: string option;
  regex_pattern_set: regex_pattern_set option
}

type get_regex_pattern_set_request = {
  id: string;
  scope: scope;
  name: string
}

type get_rate_based_statement_managed_keys_response = {
  managed_keys_ip_v6: rate_based_statement_managed_keys_ip_set option;
  managed_keys_ip_v4: rate_based_statement_managed_keys_ip_set option
}

type get_rate_based_statement_managed_keys_request = {
  rule_name: string;
  rule_group_rule_name: string option;
  web_acl_id: string;
  web_acl_name: string;
  scope: scope
}

type get_permission_policy_response = {
  policy: string option
}

type get_permission_policy_request = {
  resource_arn: string
}

type get_mobile_sdk_release_response = {
  mobile_sdk_release: mobile_sdk_release option
}

type get_mobile_sdk_release_request = {
  release_version: string;
  platform: platform
}

type get_managed_rule_set_response = {
  lock_token: string option;
  managed_rule_set: managed_rule_set option
}

type get_managed_rule_set_request = {
  id: string;
  scope: scope;
  name: string
}

type get_logging_configuration_response = {
  logging_configuration: logging_configuration option
}

type get_logging_configuration_request = {
  log_scope: log_scope option;
  log_type: log_type option;
  resource_arn: string
}

type get_ip_set_response = {
  lock_token: string option;
  ip_set: ip_set option
}

type get_ip_set_request = {
  id: string;
  scope: scope;
  name: string
}

type get_decrypted_api_key_response = {
  creation_timestamp: float option;
  token_domains: string list option
}

type get_decrypted_api_key_request = {
  api_key: string;
  scope: scope
}

type generate_mobile_sdk_release_url_response = {
  url: string option
}

type generate_mobile_sdk_release_url_request = {
  release_version: string;
  platform: platform
}

type disassociate_web_acl_response = unit

type disassociate_web_acl_request = {
  resource_arn: string
}

type describe_managed_rule_group_response = {
  consumed_labels: label_summary list option;
  available_labels: label_summary list option;
  label_namespace: string option;
  rules: rule_summary list option;
  capacity: int option;
  sns_topic_arn: string option;
  version_name: string option
}

type describe_managed_rule_group_request = {
  version_name: string option;
  scope: scope;
  name: string;
  vendor_name: string
}

type describe_managed_products_by_vendor_response = {
  managed_products: managed_product_descriptor list option
}

type describe_managed_products_by_vendor_request = {
  scope: scope;
  vendor_name: string
}

type describe_all_managed_products_response = {
  managed_products: managed_product_descriptor list option
}

type describe_all_managed_products_request = {
  scope: scope
}

type delete_web_acl_response = unit

type delete_web_acl_request = {
  lock_token: string;
  id: string;
  scope: scope;
  name: string
}

type delete_rule_group_response = unit

type delete_rule_group_request = {
  lock_token: string;
  id: string;
  scope: scope;
  name: string
}

type delete_regex_pattern_set_response = unit

type delete_regex_pattern_set_request = {
  lock_token: string;
  id: string;
  scope: scope;
  name: string
}

type delete_permission_policy_response = unit

type delete_permission_policy_request = {
  resource_arn: string
}

type delete_logging_configuration_response = unit

type delete_logging_configuration_request = {
  log_scope: log_scope option;
  log_type: log_type option;
  resource_arn: string
}

type delete_ip_set_response = unit

type delete_ip_set_request = {
  lock_token: string;
  id: string;
  scope: scope;
  name: string
}

type delete_firewall_manager_rule_groups_response = {
  next_web_acl_lock_token: string option
}

type delete_firewall_manager_rule_groups_request = {
  web_acl_lock_token: string;
  web_acl_arn: string
}

type delete_api_key_response = unit

type delete_api_key_request = {
  api_key: string;
  scope: scope
}

type create_web_acl_response = {
  summary: web_acl_summary option
}

type create_web_acl_request = {
  association_config: association_config option;
  token_domains: string list option;
  challenge_config: challenge_config option;
  captcha_config: captcha_config option;
  custom_response_bodies: (string * custom_response_body) list option;
  tags: tag list option;
  visibility_config: visibility_config;
  rules: rule list option;
  description: string option;
  default_action: default_action;
  scope: scope;
  name: string
}

type create_rule_group_response = {
  summary: rule_group_summary option
}

type create_rule_group_request = {
  custom_response_bodies: (string * custom_response_body) list option;
  tags: tag list option;
  visibility_config: visibility_config;
  rules: rule list option;
  description: string option;
  capacity: int;
  scope: scope;
  name: string
}

type create_regex_pattern_set_response = {
  summary: regex_pattern_set_summary option
}

type create_regex_pattern_set_request = {
  tags: tag list option;
  regular_expression_list: regex list;
  description: string option;
  scope: scope;
  name: string
}

type create_ip_set_response = {
  summary: ip_set_summary option
}

type create_ip_set_request = {
  tags: tag list option;
  addresses: string list;
  ip_address_version: ip_address_version;
  description: string option;
  scope: scope;
  name: string
}

type create_api_key_response = {
  api_key: string option
}

type create_api_key_request = {
  token_domains: string list;
  scope: scope
}

type check_capacity_response = {
  capacity: int option
}

type check_capacity_request = {
  rules: rule list;
  scope: scope
}

type associate_web_acl_response = unit

type associate_web_acl_request = {
  resource_arn: string;
  web_acl_arn: string
}



type base_document = Json.t

OCaml

Innovation. Community. Security.