frauddetector.d.ts
81.2 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
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-base';
interface Blob {}
declare class FraudDetector extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: FraudDetector.Types.ClientConfiguration)
config: Config & FraudDetector.Types.ClientConfiguration;
/**
* Creates a batch of variables.
*/
batchCreateVariable(params: FraudDetector.Types.BatchCreateVariableRequest, callback?: (err: AWSError, data: FraudDetector.Types.BatchCreateVariableResult) => void): Request<FraudDetector.Types.BatchCreateVariableResult, AWSError>;
/**
* Creates a batch of variables.
*/
batchCreateVariable(callback?: (err: AWSError, data: FraudDetector.Types.BatchCreateVariableResult) => void): Request<FraudDetector.Types.BatchCreateVariableResult, AWSError>;
/**
* Gets a batch of variables.
*/
batchGetVariable(params: FraudDetector.Types.BatchGetVariableRequest, callback?: (err: AWSError, data: FraudDetector.Types.BatchGetVariableResult) => void): Request<FraudDetector.Types.BatchGetVariableResult, AWSError>;
/**
* Gets a batch of variables.
*/
batchGetVariable(callback?: (err: AWSError, data: FraudDetector.Types.BatchGetVariableResult) => void): Request<FraudDetector.Types.BatchGetVariableResult, AWSError>;
/**
* Creates a detector version. The detector version starts in a DRAFT status.
*/
createDetectorVersion(params: FraudDetector.Types.CreateDetectorVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateDetectorVersionResult) => void): Request<FraudDetector.Types.CreateDetectorVersionResult, AWSError>;
/**
* Creates a detector version. The detector version starts in a DRAFT status.
*/
createDetectorVersion(callback?: (err: AWSError, data: FraudDetector.Types.CreateDetectorVersionResult) => void): Request<FraudDetector.Types.CreateDetectorVersionResult, AWSError>;
/**
* Creates a model using the specified model type.
*/
createModel(params: FraudDetector.Types.CreateModelRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateModelResult) => void): Request<FraudDetector.Types.CreateModelResult, AWSError>;
/**
* Creates a model using the specified model type.
*/
createModel(callback?: (err: AWSError, data: FraudDetector.Types.CreateModelResult) => void): Request<FraudDetector.Types.CreateModelResult, AWSError>;
/**
* Creates a version of the model using the specified model type and model id.
*/
createModelVersion(params: FraudDetector.Types.CreateModelVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateModelVersionResult) => void): Request<FraudDetector.Types.CreateModelVersionResult, AWSError>;
/**
* Creates a version of the model using the specified model type and model id.
*/
createModelVersion(callback?: (err: AWSError, data: FraudDetector.Types.CreateModelVersionResult) => void): Request<FraudDetector.Types.CreateModelVersionResult, AWSError>;
/**
* Creates a rule for use with the specified detector.
*/
createRule(params: FraudDetector.Types.CreateRuleRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateRuleResult) => void): Request<FraudDetector.Types.CreateRuleResult, AWSError>;
/**
* Creates a rule for use with the specified detector.
*/
createRule(callback?: (err: AWSError, data: FraudDetector.Types.CreateRuleResult) => void): Request<FraudDetector.Types.CreateRuleResult, AWSError>;
/**
* Creates a variable.
*/
createVariable(params: FraudDetector.Types.CreateVariableRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateVariableResult) => void): Request<FraudDetector.Types.CreateVariableResult, AWSError>;
/**
* Creates a variable.
*/
createVariable(callback?: (err: AWSError, data: FraudDetector.Types.CreateVariableResult) => void): Request<FraudDetector.Types.CreateVariableResult, AWSError>;
/**
* Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
*/
deleteDetector(params: FraudDetector.Types.DeleteDetectorRequest, callback?: (err: AWSError, data: FraudDetector.Types.DeleteDetectorResult) => void): Request<FraudDetector.Types.DeleteDetectorResult, AWSError>;
/**
* Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
*/
deleteDetector(callback?: (err: AWSError, data: FraudDetector.Types.DeleteDetectorResult) => void): Request<FraudDetector.Types.DeleteDetectorResult, AWSError>;
/**
* Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.
*/
deleteDetectorVersion(params: FraudDetector.Types.DeleteDetectorVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.DeleteDetectorVersionResult) => void): Request<FraudDetector.Types.DeleteDetectorVersionResult, AWSError>;
/**
* Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.
*/
deleteDetectorVersion(callback?: (err: AWSError, data: FraudDetector.Types.DeleteDetectorVersionResult) => void): Request<FraudDetector.Types.DeleteDetectorVersionResult, AWSError>;
/**
* Deletes the specified event.
*/
deleteEvent(params: FraudDetector.Types.DeleteEventRequest, callback?: (err: AWSError, data: FraudDetector.Types.DeleteEventResult) => void): Request<FraudDetector.Types.DeleteEventResult, AWSError>;
/**
* Deletes the specified event.
*/
deleteEvent(callback?: (err: AWSError, data: FraudDetector.Types.DeleteEventResult) => void): Request<FraudDetector.Types.DeleteEventResult, AWSError>;
/**
* Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.
*/
deleteRule(params: FraudDetector.Types.DeleteRuleRequest, callback?: (err: AWSError, data: FraudDetector.Types.DeleteRuleResult) => void): Request<FraudDetector.Types.DeleteRuleResult, AWSError>;
/**
* Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.
*/
deleteRule(callback?: (err: AWSError, data: FraudDetector.Types.DeleteRuleResult) => void): Request<FraudDetector.Types.DeleteRuleResult, AWSError>;
/**
* Gets all versions for a specified detector.
*/
describeDetector(params: FraudDetector.Types.DescribeDetectorRequest, callback?: (err: AWSError, data: FraudDetector.Types.DescribeDetectorResult) => void): Request<FraudDetector.Types.DescribeDetectorResult, AWSError>;
/**
* Gets all versions for a specified detector.
*/
describeDetector(callback?: (err: AWSError, data: FraudDetector.Types.DescribeDetectorResult) => void): Request<FraudDetector.Types.DescribeDetectorResult, AWSError>;
/**
* Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version.
*/
describeModelVersions(params: FraudDetector.Types.DescribeModelVersionsRequest, callback?: (err: AWSError, data: FraudDetector.Types.DescribeModelVersionsResult) => void): Request<FraudDetector.Types.DescribeModelVersionsResult, AWSError>;
/**
* Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version.
*/
describeModelVersions(callback?: (err: AWSError, data: FraudDetector.Types.DescribeModelVersionsResult) => void): Request<FraudDetector.Types.DescribeModelVersionsResult, AWSError>;
/**
* Gets a particular detector version.
*/
getDetectorVersion(params: FraudDetector.Types.GetDetectorVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetDetectorVersionResult) => void): Request<FraudDetector.Types.GetDetectorVersionResult, AWSError>;
/**
* Gets a particular detector version.
*/
getDetectorVersion(callback?: (err: AWSError, data: FraudDetector.Types.GetDetectorVersionResult) => void): Request<FraudDetector.Types.GetDetectorVersionResult, AWSError>;
/**
* Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.
*/
getDetectors(params: FraudDetector.Types.GetDetectorsRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetDetectorsResult) => void): Request<FraudDetector.Types.GetDetectorsResult, AWSError>;
/**
* Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.
*/
getDetectors(callback?: (err: AWSError, data: FraudDetector.Types.GetDetectorsResult) => void): Request<FraudDetector.Types.GetDetectorsResult, AWSError>;
/**
* Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
*/
getEntityTypes(params: FraudDetector.Types.GetEntityTypesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetEntityTypesResult) => void): Request<FraudDetector.Types.GetEntityTypesResult, AWSError>;
/**
* Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
*/
getEntityTypes(callback?: (err: AWSError, data: FraudDetector.Types.GetEntityTypesResult) => void): Request<FraudDetector.Types.GetEntityTypesResult, AWSError>;
/**
* Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.
*/
getEventPrediction(params: FraudDetector.Types.GetEventPredictionRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetEventPredictionResult) => void): Request<FraudDetector.Types.GetEventPredictionResult, AWSError>;
/**
* Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.
*/
getEventPrediction(callback?: (err: AWSError, data: FraudDetector.Types.GetEventPredictionResult) => void): Request<FraudDetector.Types.GetEventPredictionResult, AWSError>;
/**
* Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
*/
getEventTypes(params: FraudDetector.Types.GetEventTypesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetEventTypesResult) => void): Request<FraudDetector.Types.GetEventTypesResult, AWSError>;
/**
* Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
*/
getEventTypes(callback?: (err: AWSError, data: FraudDetector.Types.GetEventTypesResult) => void): Request<FraudDetector.Types.GetEventTypesResult, AWSError>;
/**
* Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.
*/
getExternalModels(params: FraudDetector.Types.GetExternalModelsRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetExternalModelsResult) => void): Request<FraudDetector.Types.GetExternalModelsResult, AWSError>;
/**
* Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.
*/
getExternalModels(callback?: (err: AWSError, data: FraudDetector.Types.GetExternalModelsResult) => void): Request<FraudDetector.Types.GetExternalModelsResult, AWSError>;
/**
* Gets the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector.
*/
getKMSEncryptionKey(callback?: (err: AWSError, data: FraudDetector.Types.GetKMSEncryptionKeyResult) => void): Request<FraudDetector.Types.GetKMSEncryptionKeyResult, AWSError>;
/**
* Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning.
*/
getLabels(params: FraudDetector.Types.GetLabelsRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetLabelsResult) => void): Request<FraudDetector.Types.GetLabelsResult, AWSError>;
/**
* Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning.
*/
getLabels(callback?: (err: AWSError, data: FraudDetector.Types.GetLabelsResult) => void): Request<FraudDetector.Types.GetLabelsResult, AWSError>;
/**
* Gets the details of the specified model version.
*/
getModelVersion(params: FraudDetector.Types.GetModelVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetModelVersionResult) => void): Request<FraudDetector.Types.GetModelVersionResult, AWSError>;
/**
* Gets the details of the specified model version.
*/
getModelVersion(callback?: (err: AWSError, data: FraudDetector.Types.GetModelVersionResult) => void): Request<FraudDetector.Types.GetModelVersionResult, AWSError>;
/**
* Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
*/
getModels(params: FraudDetector.Types.GetModelsRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetModelsResult) => void): Request<FraudDetector.Types.GetModelsResult, AWSError>;
/**
* Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
*/
getModels(callback?: (err: AWSError, data: FraudDetector.Types.GetModelsResult) => void): Request<FraudDetector.Types.GetModelsResult, AWSError>;
/**
* Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.
*/
getOutcomes(params: FraudDetector.Types.GetOutcomesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetOutcomesResult) => void): Request<FraudDetector.Types.GetOutcomesResult, AWSError>;
/**
* Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.
*/
getOutcomes(callback?: (err: AWSError, data: FraudDetector.Types.GetOutcomesResult) => void): Request<FraudDetector.Types.GetOutcomesResult, AWSError>;
/**
* Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified. This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.
*/
getRules(params: FraudDetector.Types.GetRulesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetRulesResult) => void): Request<FraudDetector.Types.GetRulesResult, AWSError>;
/**
* Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified. This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.
*/
getRules(callback?: (err: AWSError, data: FraudDetector.Types.GetRulesResult) => void): Request<FraudDetector.Types.GetRulesResult, AWSError>;
/**
* Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.
*/
getVariables(params: FraudDetector.Types.GetVariablesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetVariablesResult) => void): Request<FraudDetector.Types.GetVariablesResult, AWSError>;
/**
* Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.
*/
getVariables(callback?: (err: AWSError, data: FraudDetector.Types.GetVariablesResult) => void): Request<FraudDetector.Types.GetVariablesResult, AWSError>;
/**
* Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
*/
listTagsForResource(params: FraudDetector.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: FraudDetector.Types.ListTagsForResourceResult) => void): Request<FraudDetector.Types.ListTagsForResourceResult, AWSError>;
/**
* Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
*/
listTagsForResource(callback?: (err: AWSError, data: FraudDetector.Types.ListTagsForResourceResult) => void): Request<FraudDetector.Types.ListTagsForResourceResult, AWSError>;
/**
* Creates or updates a detector.
*/
putDetector(params: FraudDetector.Types.PutDetectorRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutDetectorResult) => void): Request<FraudDetector.Types.PutDetectorResult, AWSError>;
/**
* Creates or updates a detector.
*/
putDetector(callback?: (err: AWSError, data: FraudDetector.Types.PutDetectorResult) => void): Request<FraudDetector.Types.PutDetectorResult, AWSError>;
/**
* Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.
*/
putEntityType(params: FraudDetector.Types.PutEntityTypeRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutEntityTypeResult) => void): Request<FraudDetector.Types.PutEntityTypeResult, AWSError>;
/**
* Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.
*/
putEntityType(callback?: (err: AWSError, data: FraudDetector.Types.PutEntityTypeResult) => void): Request<FraudDetector.Types.PutEntityTypeResult, AWSError>;
/**
* Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
*/
putEventType(params: FraudDetector.Types.PutEventTypeRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutEventTypeResult) => void): Request<FraudDetector.Types.PutEventTypeResult, AWSError>;
/**
* Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
*/
putEventType(callback?: (err: AWSError, data: FraudDetector.Types.PutEventTypeResult) => void): Request<FraudDetector.Types.PutEventTypeResult, AWSError>;
/**
* Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.
*/
putExternalModel(params: FraudDetector.Types.PutExternalModelRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutExternalModelResult) => void): Request<FraudDetector.Types.PutExternalModelResult, AWSError>;
/**
* Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.
*/
putExternalModel(callback?: (err: AWSError, data: FraudDetector.Types.PutExternalModelResult) => void): Request<FraudDetector.Types.PutExternalModelResult, AWSError>;
/**
* Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.
*/
putKMSEncryptionKey(params: FraudDetector.Types.PutKMSEncryptionKeyRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutKMSEncryptionKeyResult) => void): Request<FraudDetector.Types.PutKMSEncryptionKeyResult, AWSError>;
/**
* Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.
*/
putKMSEncryptionKey(callback?: (err: AWSError, data: FraudDetector.Types.PutKMSEncryptionKeyResult) => void): Request<FraudDetector.Types.PutKMSEncryptionKeyResult, AWSError>;
/**
* Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.
*/
putLabel(params: FraudDetector.Types.PutLabelRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutLabelResult) => void): Request<FraudDetector.Types.PutLabelResult, AWSError>;
/**
* Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.
*/
putLabel(callback?: (err: AWSError, data: FraudDetector.Types.PutLabelResult) => void): Request<FraudDetector.Types.PutLabelResult, AWSError>;
/**
* Creates or updates an outcome.
*/
putOutcome(params: FraudDetector.Types.PutOutcomeRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutOutcomeResult) => void): Request<FraudDetector.Types.PutOutcomeResult, AWSError>;
/**
* Creates or updates an outcome.
*/
putOutcome(callback?: (err: AWSError, data: FraudDetector.Types.PutOutcomeResult) => void): Request<FraudDetector.Types.PutOutcomeResult, AWSError>;
/**
* Assigns tags to a resource.
*/
tagResource(params: FraudDetector.Types.TagResourceRequest, callback?: (err: AWSError, data: FraudDetector.Types.TagResourceResult) => void): Request<FraudDetector.Types.TagResourceResult, AWSError>;
/**
* Assigns tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: FraudDetector.Types.TagResourceResult) => void): Request<FraudDetector.Types.TagResourceResult, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(params: FraudDetector.Types.UntagResourceRequest, callback?: (err: AWSError, data: FraudDetector.Types.UntagResourceResult) => void): Request<FraudDetector.Types.UntagResourceResult, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: FraudDetector.Types.UntagResourceResult) => void): Request<FraudDetector.Types.UntagResourceResult, AWSError>;
/**
* Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.
*/
updateDetectorVersion(params: FraudDetector.Types.UpdateDetectorVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionResult, AWSError>;
/**
* Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.
*/
updateDetectorVersion(callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionResult, AWSError>;
/**
* Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).
*/
updateDetectorVersionMetadata(params: FraudDetector.Types.UpdateDetectorVersionMetadataRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionMetadataResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionMetadataResult, AWSError>;
/**
* Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).
*/
updateDetectorVersionMetadata(callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionMetadataResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionMetadataResult, AWSError>;
/**
* Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.
*/
updateDetectorVersionStatus(params: FraudDetector.Types.UpdateDetectorVersionStatusRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionStatusResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionStatusResult, AWSError>;
/**
* Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.
*/
updateDetectorVersionStatus(callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionStatusResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionStatusResult, AWSError>;
/**
* Updates a model. You can update the description attribute using this action.
*/
updateModel(params: FraudDetector.Types.UpdateModelRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelResult) => void): Request<FraudDetector.Types.UpdateModelResult, AWSError>;
/**
* Updates a model. You can update the description attribute using this action.
*/
updateModel(callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelResult) => void): Request<FraudDetector.Types.UpdateModelResult, AWSError>;
/**
* Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.
*/
updateModelVersion(params: FraudDetector.Types.UpdateModelVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelVersionResult) => void): Request<FraudDetector.Types.UpdateModelVersionResult, AWSError>;
/**
* Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.
*/
updateModelVersion(callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelVersionResult) => void): Request<FraudDetector.Types.UpdateModelVersionResult, AWSError>;
/**
* Updates the status of a model version. You can perform the following status updates: Change the TRAINING_COMPLETE status to ACTIVE. Change ACTIVEto INACTIVE.
*/
updateModelVersionStatus(params: FraudDetector.Types.UpdateModelVersionStatusRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelVersionStatusResult) => void): Request<FraudDetector.Types.UpdateModelVersionStatusResult, AWSError>;
/**
* Updates the status of a model version. You can perform the following status updates: Change the TRAINING_COMPLETE status to ACTIVE. Change ACTIVEto INACTIVE.
*/
updateModelVersionStatus(callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelVersionStatusResult) => void): Request<FraudDetector.Types.UpdateModelVersionStatusResult, AWSError>;
/**
* Updates a rule's metadata. The description attribute can be updated.
*/
updateRuleMetadata(params: FraudDetector.Types.UpdateRuleMetadataRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateRuleMetadataResult) => void): Request<FraudDetector.Types.UpdateRuleMetadataResult, AWSError>;
/**
* Updates a rule's metadata. The description attribute can be updated.
*/
updateRuleMetadata(callback?: (err: AWSError, data: FraudDetector.Types.UpdateRuleMetadataResult) => void): Request<FraudDetector.Types.UpdateRuleMetadataResult, AWSError>;
/**
* Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
*/
updateRuleVersion(params: FraudDetector.Types.UpdateRuleVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateRuleVersionResult) => void): Request<FraudDetector.Types.UpdateRuleVersionResult, AWSError>;
/**
* Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
*/
updateRuleVersion(callback?: (err: AWSError, data: FraudDetector.Types.UpdateRuleVersionResult) => void): Request<FraudDetector.Types.UpdateRuleVersionResult, AWSError>;
/**
* Updates a variable.
*/
updateVariable(params: FraudDetector.Types.UpdateVariableRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateVariableResult) => void): Request<FraudDetector.Types.UpdateVariableResult, AWSError>;
/**
* Updates a variable.
*/
updateVariable(callback?: (err: AWSError, data: FraudDetector.Types.UpdateVariableResult) => void): Request<FraudDetector.Types.UpdateVariableResult, AWSError>;
}
declare namespace FraudDetector {
export interface BatchCreateVariableError {
/**
* The name.
*/
name?: string;
/**
* The error code.
*/
code?: integer;
/**
* The error message.
*/
message?: string;
}
export type BatchCreateVariableErrorList = BatchCreateVariableError[];
export interface BatchCreateVariableRequest {
/**
* The list of variables for the batch create variable request.
*/
variableEntries: VariableEntryList;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface BatchCreateVariableResult {
/**
* Provides the errors for the BatchCreateVariable request.
*/
errors?: BatchCreateVariableErrorList;
}
export interface BatchGetVariableError {
/**
* The error name.
*/
name?: string;
/**
* The error code.
*/
code?: integer;
/**
* The error message.
*/
message?: string;
}
export type BatchGetVariableErrorList = BatchGetVariableError[];
export interface BatchGetVariableRequest {
/**
* The list of variable names to get.
*/
names: NameList;
}
export interface BatchGetVariableResult {
/**
* The returned variables.
*/
variables?: VariableList;
/**
* The errors from the request.
*/
errors?: BatchGetVariableErrorList;
}
export interface CreateDetectorVersionRequest {
/**
* The ID of the detector under which you want to create a new version.
*/
detectorId: identifier;
/**
* The description of the detector version.
*/
description?: description;
/**
* The Amazon Sagemaker model endpoints to include in the detector version.
*/
externalModelEndpoints?: ListOfStrings;
/**
* The rules to include in the detector version.
*/
rules: RuleList;
/**
* The model versions to include in the detector version.
*/
modelVersions?: ListOfModelVersions;
/**
* The rule execution mode for the rules included in the detector version. You can define and edit the rule mode at the detector version level, when it is in draft status. If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. The default behavior is FIRST_MATCHED.
*/
ruleExecutionMode?: RuleExecutionMode;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateDetectorVersionResult {
/**
* The ID for the created version's parent detector.
*/
detectorId?: identifier;
/**
* The ID for the created detector.
*/
detectorVersionId?: nonEmptyString;
/**
* The status of the detector version.
*/
status?: DetectorVersionStatus;
}
export interface CreateModelRequest {
/**
* The model ID.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The model description.
*/
description?: description;
/**
* The name of the event type.
*/
eventTypeName: string;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateModelResult {
}
export interface CreateModelVersionRequest {
/**
* The model ID.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The training data source location in Amazon S3.
*/
trainingDataSource: TrainingDataSourceEnum;
/**
* The training data schema.
*/
trainingDataSchema: TrainingDataSchema;
/**
* Details for the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.
*/
externalEventsDetail?: ExternalEventsDetail;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateModelVersionResult {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The model version number of the model version created.
*/
modelVersionNumber?: nonEmptyString;
/**
* The model version status.
*/
status?: string;
}
export interface CreateRuleRequest {
/**
* The rule ID.
*/
ruleId: identifier;
/**
* The detector ID for the rule's parent detector.
*/
detectorId: identifier;
/**
* The rule description.
*/
description?: description;
/**
* The rule expression.
*/
expression: ruleExpression;
/**
* The language of the rule.
*/
language: Language;
/**
* The outcome or outcomes returned when the rule expression matches.
*/
outcomes: NonEmptyListOfStrings;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateRuleResult {
/**
* The created rule.
*/
rule?: Rule;
}
export interface CreateVariableRequest {
/**
* The name of the variable.
*/
name: string;
/**
* The data type.
*/
dataType: DataType;
/**
* The source of the data.
*/
dataSource: DataSource;
/**
* The default value for the variable when no value is received.
*/
defaultValue: string;
/**
* The description.
*/
description?: string;
/**
* The variable type. For more information see Variable types. Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
*/
variableType?: string;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateVariableResult {
}
export type CsvIndexToVariableMap = {[key: string]: string};
export type DataSource = "EVENT"|"MODEL_SCORE"|"EXTERNAL_MODEL_SCORE"|string;
export type DataType = "STRING"|"INTEGER"|"FLOAT"|"BOOLEAN"|string;
export interface DataValidationMetrics {
/**
* The file-specific model training validation messages.
*/
fileLevelMessages?: fileValidationMessageList;
/**
* The field-specific model training validation messages.
*/
fieldLevelMessages?: fieldValidationMessageList;
}
export interface DeleteDetectorRequest {
/**
* The ID of the detector to delete.
*/
detectorId: identifier;
}
export interface DeleteDetectorResult {
}
export interface DeleteDetectorVersionRequest {
/**
* The ID of the parent detector for the detector version to delete.
*/
detectorId: identifier;
/**
* The ID of the detector version to delete.
*/
detectorVersionId: wholeNumberVersionString;
}
export interface DeleteDetectorVersionResult {
}
export interface DeleteEventRequest {
/**
* The ID of the event to delete.
*/
eventId: string;
/**
* The name of the event type.
*/
eventTypeName: string;
}
export interface DeleteEventResult {
}
export interface DeleteRuleRequest {
rule: Rule;
}
export interface DeleteRuleResult {
}
export interface DescribeDetectorRequest {
/**
* The detector ID.
*/
detectorId: identifier;
/**
* The next token from the previous response.
*/
nextToken?: string;
/**
* The maximum number of results to return for the request.
*/
maxResults?: DetectorVersionMaxResults;
}
export interface DescribeDetectorResult {
/**
* The detector ID.
*/
detectorId?: identifier;
/**
* The status and description for each detector version.
*/
detectorVersionSummaries?: DetectorVersionSummaryList;
/**
* The next token to be used for subsequent requests.
*/
nextToken?: string;
/**
* The detector ARN.
*/
arn?: fraudDetectorArn;
}
export interface DescribeModelVersionsRequest {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model version number.
*/
modelVersionNumber?: floatVersionString;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The next token from the previous results.
*/
nextToken?: string;
/**
* The maximum number of results to return.
*/
maxResults?: modelsMaxPageSize;
}
export interface DescribeModelVersionsResult {
/**
* The model version details.
*/
modelVersionDetails?: modelVersionDetailList;
/**
* The next token.
*/
nextToken?: string;
}
export interface Detector {
/**
* The detector ID.
*/
detectorId?: identifier;
/**
* The detector description.
*/
description?: description;
/**
* The name of the event type.
*/
eventTypeName?: identifier;
/**
* Timestamp of when the detector was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the detector was created.
*/
createdTime?: time;
/**
* The detector ARN.
*/
arn?: fraudDetectorArn;
}
export type DetectorList = Detector[];
export type DetectorVersionMaxResults = number;
export type DetectorVersionStatus = "DRAFT"|"ACTIVE"|"INACTIVE"|string;
export interface DetectorVersionSummary {
/**
* The detector version ID.
*/
detectorVersionId?: nonEmptyString;
/**
* The detector version status.
*/
status?: DetectorVersionStatus;
/**
* The detector version description.
*/
description?: description;
/**
* Timestamp of when the detector version was last updated.
*/
lastUpdatedTime?: time;
}
export type DetectorVersionSummaryList = DetectorVersionSummary[];
export type DetectorsMaxResults = number;
export interface Entity {
/**
* The entity type.
*/
entityType: string;
/**
* The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.
*/
entityId: identifier;
}
export interface EntityType {
/**
* The entity type name.
*/
name?: string;
/**
* The entity type description.
*/
description?: description;
/**
* Timestamp of when the entity type was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the entity type was created.
*/
createdTime?: time;
/**
* The entity type ARN.
*/
arn?: fraudDetectorArn;
}
export interface EventType {
/**
* The event type name.
*/
name?: string;
/**
* The event type description.
*/
description?: description;
/**
* The event type event variables.
*/
eventVariables?: ListOfStrings;
/**
* The event type labels.
*/
labels?: ListOfStrings;
/**
* The event type entity types.
*/
entityTypes?: NonEmptyListOfStrings;
/**
* Timestamp of when the event type was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the event type was created.
*/
createdTime?: time;
/**
* The entity type ARN.
*/
arn?: fraudDetectorArn;
}
export type EventVariableMap = {[key: string]: variableValue};
export interface ExternalEventsDetail {
/**
* The Amazon S3 bucket location for the data.
*/
dataLocation: s3BucketLocation;
/**
* The ARN of the role that provides Amazon Fraud Detector access to the data location.
*/
dataAccessRoleArn: iamRoleArn;
}
export interface ExternalModel {
/**
* The Amazon SageMaker model endpoints.
*/
modelEndpoint?: string;
/**
* The source of the model.
*/
modelSource?: ModelSource;
/**
* The role used to invoke the model.
*/
invokeModelEndpointRoleArn?: string;
/**
* The input configuration.
*/
inputConfiguration?: ModelInputConfiguration;
/**
* The output configuration.
*/
outputConfiguration?: ModelOutputConfiguration;
/**
* The Amazon Fraud Detector status for the external model endpoint
*/
modelEndpointStatus?: ModelEndpointStatus;
/**
* Timestamp of when the model was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the model was last created.
*/
createdTime?: time;
/**
* The model ARN.
*/
arn?: fraudDetectorArn;
}
export type ExternalModelEndpointDataBlobMap = {[key: string]: ModelEndpointDataBlob};
export type ExternalModelList = ExternalModel[];
export type ExternalModelsMaxResults = number;
export interface FieldValidationMessage {
/**
* The field name.
*/
fieldName?: string;
/**
* The message ID.
*/
identifier?: string;
/**
* The message title.
*/
title?: string;
/**
* The message content.
*/
content?: string;
/**
* The message type.
*/
type?: string;
}
export interface FileValidationMessage {
/**
* The message title.
*/
title?: string;
/**
* The message content.
*/
content?: string;
/**
* The message type.
*/
type?: string;
}
export interface GetDetectorVersionRequest {
/**
* The detector ID.
*/
detectorId: identifier;
/**
* The detector version ID.
*/
detectorVersionId: wholeNumberVersionString;
}
export interface GetDetectorVersionResult {
/**
* The detector ID.
*/
detectorId?: identifier;
/**
* The detector version ID.
*/
detectorVersionId?: wholeNumberVersionString;
/**
* The detector version description.
*/
description?: description;
/**
* The Amazon SageMaker model endpoints included in the detector version.
*/
externalModelEndpoints?: ListOfStrings;
/**
* The model versions included in the detector version.
*/
modelVersions?: ListOfModelVersions;
/**
* The rules included in the detector version.
*/
rules?: RuleList;
/**
* The status of the detector version.
*/
status?: DetectorVersionStatus;
/**
* The timestamp when the detector version was last updated.
*/
lastUpdatedTime?: time;
/**
* The timestamp when the detector version was created.
*/
createdTime?: time;
/**
* The execution mode of the rule in the dectector FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.
*/
ruleExecutionMode?: RuleExecutionMode;
/**
* The detector version ARN.
*/
arn?: fraudDetectorArn;
}
export interface GetDetectorsRequest {
/**
* The detector ID.
*/
detectorId?: identifier;
/**
* The next token for the subsequent request.
*/
nextToken?: string;
/**
* The maximum number of objects to return for the request.
*/
maxResults?: DetectorsMaxResults;
}
export interface GetDetectorsResult {
/**
* The detectors.
*/
detectors?: DetectorList;
/**
* The next page token.
*/
nextToken?: string;
}
export interface GetEntityTypesRequest {
/**
* The name.
*/
name?: identifier;
/**
* The next token for the subsequent request.
*/
nextToken?: string;
/**
* The maximum number of objects to return for the request.
*/
maxResults?: entityTypesMaxResults;
}
export interface GetEntityTypesResult {
/**
* An array of entity types.
*/
entityTypes?: entityTypeList;
/**
* The next page token.
*/
nextToken?: string;
}
export interface GetEventPredictionRequest {
/**
* The detector ID.
*/
detectorId: string;
/**
* The detector version ID.
*/
detectorVersionId?: wholeNumberVersionString;
/**
* The unique ID used to identify the event.
*/
eventId: string;
/**
* The event type associated with the detector specified for the prediction.
*/
eventTypeName: string;
/**
* The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."
*/
entities: listOfEntities;
/**
* Timestamp that defines when the event under evaluation occurred.
*/
eventTimestamp: string;
/**
* Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.
*/
eventVariables: EventVariableMap;
/**
* The Amazon SageMaker model endpoint input data blobs.
*/
externalModelEndpointDataBlobs?: ExternalModelEndpointDataBlobMap;
}
export interface GetEventPredictionResult {
/**
* The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.
*/
modelScores?: ListOfModelScores;
/**
* The results.
*/
ruleResults?: ListOfRuleResults;
}
export interface GetEventTypesRequest {
/**
* The name.
*/
name?: identifier;
/**
* The next token for the subsequent request.
*/
nextToken?: string;
/**
* The maximum number of objects to return for the request.
*/
maxResults?: eventTypesMaxResults;
}
export interface GetEventTypesResult {
/**
* An array of event types.
*/
eventTypes?: eventTypeList;
/**
* The next page token.
*/
nextToken?: string;
}
export interface GetExternalModelsRequest {
/**
* The Amazon SageMaker model endpoint.
*/
modelEndpoint?: string;
/**
* The next page token for the request.
*/
nextToken?: string;
/**
* The maximum number of objects to return for the request.
*/
maxResults?: ExternalModelsMaxResults;
}
export interface GetExternalModelsResult {
/**
* Gets the Amazon SageMaker models.
*/
externalModels?: ExternalModelList;
/**
* The next page token to be used in subsequent requests.
*/
nextToken?: string;
}
export interface GetKMSEncryptionKeyResult {
/**
* The KMS encryption key.
*/
kmsKey?: KMSKey;
}
export interface GetLabelsRequest {
/**
* The name of the label or labels to get.
*/
name?: identifier;
/**
* The next token for the subsequent request.
*/
nextToken?: string;
/**
* The maximum number of objects to return for the request.
*/
maxResults?: labelsMaxResults;
}
export interface GetLabelsResult {
/**
* An array of labels.
*/
labels?: labelList;
/**
* The next page token.
*/
nextToken?: string;
}
export interface GetModelVersionRequest {
/**
* The model ID.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The model version number.
*/
modelVersionNumber: floatVersionString;
}
export interface GetModelVersionResult {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The model version number.
*/
modelVersionNumber?: floatVersionString;
/**
* The training data source.
*/
trainingDataSource?: TrainingDataSourceEnum;
/**
* The training data schema.
*/
trainingDataSchema?: TrainingDataSchema;
/**
* The event details.
*/
externalEventsDetail?: ExternalEventsDetail;
/**
* The model version status.
*/
status?: string;
/**
* The model version ARN.
*/
arn?: fraudDetectorArn;
}
export interface GetModelsRequest {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The next token for the subsequent request.
*/
nextToken?: string;
/**
* The maximum number of objects to return for the request.
*/
maxResults?: modelsMaxPageSize;
}
export interface GetModelsResult {
/**
* The next page token to be used in subsequent requests.
*/
nextToken?: string;
/**
* The array of models.
*/
models?: modelList;
}
export interface GetOutcomesRequest {
/**
* The name of the outcome or outcomes to get.
*/
name?: identifier;
/**
* The next page token for the request.
*/
nextToken?: string;
/**
* The maximum number of objects to return for the request.
*/
maxResults?: OutcomesMaxResults;
}
export interface GetOutcomesResult {
/**
* The outcomes.
*/
outcomes?: OutcomeList;
/**
* The next page token for subsequent requests.
*/
nextToken?: string;
}
export interface GetRulesRequest {
/**
* The rule ID.
*/
ruleId?: identifier;
/**
* The detector ID.
*/
detectorId: identifier;
/**
* The rule version.
*/
ruleVersion?: wholeNumberVersionString;
/**
* The next page token.
*/
nextToken?: string;
/**
* The maximum number of rules to return for the request.
*/
maxResults?: RulesMaxResults;
}
export interface GetRulesResult {
/**
* The details of the requested rule.
*/
ruleDetails?: RuleDetailList;
/**
* The next page token to be used in subsequent requests.
*/
nextToken?: string;
}
export interface GetVariablesRequest {
/**
* The name of the variable.
*/
name?: string;
/**
* The next page token of the get variable request.
*/
nextToken?: string;
/**
* The max size per page determined for the get variable request.
*/
maxResults?: VariablesMaxResults;
}
export interface GetVariablesResult {
/**
* The names of the variables returned.
*/
variables?: VariableList;
/**
* The next page token to be used in subsequent requests.
*/
nextToken?: string;
}
export type JsonKeyToVariableMap = {[key: string]: string};
export interface KMSKey {
/**
* The encryption key ARN.
*/
kmsEncryptionKeyArn?: KmsEncryptionKeyArn;
}
export type KmsEncryptionKeyArn = string;
export interface Label {
/**
* The label name.
*/
name?: string;
/**
* The label description.
*/
description?: description;
/**
* Timestamp of when the label was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the event type was created.
*/
createdTime?: time;
/**
* The label ARN.
*/
arn?: fraudDetectorArn;
}
export interface LabelSchema {
/**
* The label mapper maps the Amazon Fraud Detector supported model classification labels (FRAUD, LEGIT) to the appropriate event type labels. For example, if "FRAUD" and "LEGIT" are Amazon Fraud Detector supported labels, this mapper could be: {"FRAUD" => ["0"], "LEGIT" => ["1"]} or {"FRAUD" => ["false"], "LEGIT" => ["true"]} or {"FRAUD" => ["fraud", "abuse"], "LEGIT" => ["legit", "safe"]}. The value part of the mapper is a list, because you may have multiple label variants from your event type for a single Amazon Fraud Detector label.
*/
labelMapper: labelMapper;
}
export type Language = "DETECTORPL"|string;
export type ListOfModelScores = ModelScores[];
export type ListOfModelVersions = ModelVersion[];
export type ListOfRuleResults = RuleResult[];
export type ListOfStrings = string[];
export interface ListTagsForResourceRequest {
/**
* The ARN that specifies the resource whose tags you want to list.
*/
resourceARN: fraudDetectorArn;
/**
* The next token from the previous results.
*/
nextToken?: string;
/**
* The maximum number of objects to return for the request.
*/
maxResults?: TagsMaxResults;
}
export interface ListTagsForResourceResult {
/**
* A collection of key and value pairs.
*/
tags?: tagList;
/**
* The next token for subsequent requests.
*/
nextToken?: string;
}
export interface MetricDataPoint {
/**
* The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
*/
fpr?: float;
/**
* The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
*/
precision?: float;
/**
* The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
*/
tpr?: float;
/**
* The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.
*/
threshold?: float;
}
export interface Model {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The model description.
*/
description?: description;
/**
* The name of the event type.
*/
eventTypeName?: string;
/**
* Timestamp of when the model was created.
*/
createdTime?: time;
/**
* Timestamp of last time the model was updated.
*/
lastUpdatedTime?: time;
/**
* The ARN of the model.
*/
arn?: fraudDetectorArn;
}
export interface ModelEndpointDataBlob {
/**
* The byte buffer of the Amazon SageMaker model endpoint input data blob.
*/
byteBuffer?: blob;
/**
* The content type of the Amazon SageMaker model endpoint input data blob.
*/
contentType?: contentType;
}
export type ModelEndpointStatus = "ASSOCIATED"|"DISSOCIATED"|string;
export interface ModelInputConfiguration {
/**
* The event type name.
*/
eventTypeName?: identifier;
/**
* The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.
*/
format?: ModelInputDataFormat;
/**
* The event variables.
*/
useEventVariables: UseEventVariables;
/**
* Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker.
*/
jsonInputTemplate?: string;
/**
* Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker.
*/
csvInputTemplate?: string;
}
export type ModelInputDataFormat = "TEXT_CSV"|"APPLICATION_JSON"|string;
export interface ModelOutputConfiguration {
/**
* The format of the model output configuration.
*/
format: ModelOutputDataFormat;
/**
* A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.
*/
jsonKeyToVariableMap?: JsonKeyToVariableMap;
/**
* A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.
*/
csvIndexToVariableMap?: CsvIndexToVariableMap;
}
export type ModelOutputDataFormat = "TEXT_CSV"|"APPLICATION_JSONLINES"|string;
export type ModelPredictionMap = {[key: string]: float};
export interface ModelScores {
/**
* The model version.
*/
modelVersion?: ModelVersion;
/**
* The model's fraud prediction scores.
*/
scores?: ModelPredictionMap;
}
export type ModelSource = "SAGEMAKER"|string;
export type ModelTypeEnum = "ONLINE_FRAUD_INSIGHTS"|string;
export interface ModelVersion {
/**
* The model ID.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The model version number.
*/
modelVersionNumber: nonEmptyString;
/**
* The model version ARN.
*/
arn?: fraudDetectorArn;
}
export interface ModelVersionDetail {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The model version number.
*/
modelVersionNumber?: floatVersionString;
/**
* The status of the model version.
*/
status?: string;
/**
* The model version training data source.
*/
trainingDataSource?: TrainingDataSourceEnum;
/**
* The training data schema.
*/
trainingDataSchema?: TrainingDataSchema;
/**
* The event details.
*/
externalEventsDetail?: ExternalEventsDetail;
/**
* The training results.
*/
trainingResult?: TrainingResult;
/**
* The timestamp when the model was last updated.
*/
lastUpdatedTime?: time;
/**
* The timestamp when the model was created.
*/
createdTime?: time;
/**
* The model version ARN.
*/
arn?: fraudDetectorArn;
}
export type ModelVersionStatus = "ACTIVE"|"INACTIVE"|string;
export type NameList = string[];
export type NonEmptyListOfStrings = string[];
export interface Outcome {
/**
* The outcome name.
*/
name?: identifier;
/**
* The outcome description.
*/
description?: description;
/**
* The timestamp when the outcome was last updated.
*/
lastUpdatedTime?: time;
/**
* The timestamp when the outcome was created.
*/
createdTime?: time;
/**
* The outcome ARN.
*/
arn?: fraudDetectorArn;
}
export type OutcomeList = Outcome[];
export type OutcomesMaxResults = number;
export interface PutDetectorRequest {
/**
* The detector ID.
*/
detectorId: identifier;
/**
* The description of the detector.
*/
description?: description;
/**
* The name of the event type.
*/
eventTypeName: identifier;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface PutDetectorResult {
}
export interface PutEntityTypeRequest {
/**
* The name of the entity type.
*/
name: identifier;
/**
* The description.
*/
description?: description;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface PutEntityTypeResult {
}
export interface PutEventTypeRequest {
/**
* The name.
*/
name: identifier;
/**
* The description of the event type.
*/
description?: description;
/**
* The event type variables.
*/
eventVariables: NonEmptyListOfStrings;
/**
* The event type labels.
*/
labels?: ListOfStrings;
/**
* The entity type for the event type. Example entity types: customer, merchant, account.
*/
entityTypes: NonEmptyListOfStrings;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface PutEventTypeResult {
}
export interface PutExternalModelRequest {
/**
* The model endpoints name.
*/
modelEndpoint: sageMakerEndpointIdentifier;
/**
* The source of the model.
*/
modelSource: ModelSource;
/**
* The IAM role used to invoke the model endpoint.
*/
invokeModelEndpointRoleArn: string;
/**
* The model endpoint input configuration.
*/
inputConfiguration: ModelInputConfiguration;
/**
* The model endpoint output configuration.
*/
outputConfiguration: ModelOutputConfiguration;
/**
* The model endpoint’s status in Amazon Fraud Detector.
*/
modelEndpointStatus: ModelEndpointStatus;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface PutExternalModelResult {
}
export interface PutKMSEncryptionKeyRequest {
/**
* The KMS encryption key ARN.
*/
kmsEncryptionKeyArn: KmsEncryptionKeyArn;
}
export interface PutKMSEncryptionKeyResult {
}
export interface PutLabelRequest {
/**
* The label name.
*/
name: identifier;
/**
* The label description.
*/
description?: description;
/**
*
*/
tags?: tagList;
}
export interface PutLabelResult {
}
export interface PutOutcomeRequest {
/**
* The name of the outcome.
*/
name: identifier;
/**
* The outcome description.
*/
description?: description;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface PutOutcomeResult {
}
export interface Rule {
/**
* The detector for which the rule is associated.
*/
detectorId: identifier;
/**
* The rule ID.
*/
ruleId: identifier;
/**
* The rule version.
*/
ruleVersion: wholeNumberVersionString;
}
export interface RuleDetail {
/**
* The rule ID.
*/
ruleId?: identifier;
/**
* The rule description.
*/
description?: description;
/**
* The detector for which the rule is associated.
*/
detectorId?: identifier;
/**
* The rule version.
*/
ruleVersion?: wholeNumberVersionString;
/**
* The rule expression.
*/
expression?: ruleExpression;
/**
* The rule language.
*/
language?: Language;
/**
* The rule outcomes.
*/
outcomes?: NonEmptyListOfStrings;
/**
* Timestamp of the last time the rule was updated.
*/
lastUpdatedTime?: time;
/**
* The timestamp of when the rule was created.
*/
createdTime?: time;
/**
* The rule ARN.
*/
arn?: fraudDetectorArn;
}
export type RuleDetailList = RuleDetail[];
export type RuleExecutionMode = "ALL_MATCHED"|"FIRST_MATCHED"|string;
export type RuleList = Rule[];
export interface RuleResult {
/**
* The rule ID that was matched, based on the rule execution mode.
*/
ruleId?: string;
/**
* The outcomes of the matched rule, based on the rule execution mode.
*/
outcomes?: ListOfStrings;
}
export type RulesMaxResults = number;
export interface Tag {
/**
* A tag key.
*/
key: tagKey;
/**
* A value assigned to a tag key.
*/
value: tagValue;
}
export interface TagResourceRequest {
/**
* The resource ARN.
*/
resourceARN: fraudDetectorArn;
/**
* The tags to assign to the resource.
*/
tags: tagList;
}
export interface TagResourceResult {
}
export type TagsMaxResults = number;
export interface TrainingDataSchema {
/**
* The training data schema variables.
*/
modelVariables: ListOfStrings;
labelSchema: LabelSchema;
}
export type TrainingDataSourceEnum = "EXTERNAL_EVENTS"|string;
export interface TrainingMetrics {
/**
* The area under the curve. This summarizes true positive rate (TPR) and false positive rate (FPR) across all possible model score thresholds. A model with no predictive power has an AUC of 0.5, whereas a perfect model has a score of 1.0.
*/
auc?: float;
/**
* The data points details.
*/
metricDataPoints?: metricDataPointsList;
}
export interface TrainingResult {
/**
* The validation metrics.
*/
dataValidationMetrics?: DataValidationMetrics;
/**
* The training metric details.
*/
trainingMetrics?: TrainingMetrics;
}
export interface UntagResourceRequest {
/**
* The ARN of the resource from which to remove the tag.
*/
resourceARN: fraudDetectorArn;
/**
* The resource ARN.
*/
tagKeys: tagKeyList;
}
export interface UntagResourceResult {
}
export interface UpdateDetectorVersionMetadataRequest {
/**
* The detector ID.
*/
detectorId: identifier;
/**
* The detector version ID.
*/
detectorVersionId: wholeNumberVersionString;
/**
* The description.
*/
description: description;
}
export interface UpdateDetectorVersionMetadataResult {
}
export interface UpdateDetectorVersionRequest {
/**
* The parent detector ID for the detector version you want to update.
*/
detectorId: identifier;
/**
* The detector version ID.
*/
detectorVersionId: wholeNumberVersionString;
/**
* The Amazon SageMaker model endpoints to include in the detector version.
*/
externalModelEndpoints: ListOfStrings;
/**
* The rules to include in the detector version.
*/
rules: RuleList;
/**
* The detector version description.
*/
description?: description;
/**
* The model versions to include in the detector version.
*/
modelVersions?: ListOfModelVersions;
/**
* The rule execution mode to add to the detector. If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status. The default behavior is FIRST_MATCHED.
*/
ruleExecutionMode?: RuleExecutionMode;
}
export interface UpdateDetectorVersionResult {
}
export interface UpdateDetectorVersionStatusRequest {
/**
* The detector ID.
*/
detectorId: identifier;
/**
* The detector version ID.
*/
detectorVersionId: wholeNumberVersionString;
/**
* The new status.
*/
status: DetectorVersionStatus;
}
export interface UpdateDetectorVersionStatusResult {
}
export interface UpdateModelRequest {
/**
* The model ID.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The new model description.
*/
description?: description;
}
export interface UpdateModelResult {
}
export interface UpdateModelVersionRequest {
/**
* The model ID.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The major version number.
*/
majorVersionNumber: wholeNumberVersionString;
/**
* The event details.
*/
externalEventsDetail?: ExternalEventsDetail;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface UpdateModelVersionResult {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The model version number of the model version updated.
*/
modelVersionNumber?: floatVersionString;
/**
* The status of the updated model version.
*/
status?: string;
}
export interface UpdateModelVersionStatusRequest {
/**
* The model ID of the model version to update.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The model version number.
*/
modelVersionNumber: floatVersionString;
/**
* The model version status.
*/
status: ModelVersionStatus;
}
export interface UpdateModelVersionStatusResult {
}
export interface UpdateRuleMetadataRequest {
/**
* The rule to update.
*/
rule: Rule;
/**
* The rule description.
*/
description: description;
}
export interface UpdateRuleMetadataResult {
}
export interface UpdateRuleVersionRequest {
/**
* The rule to update.
*/
rule: Rule;
/**
* The description.
*/
description?: description;
/**
* The rule expression.
*/
expression: ruleExpression;
/**
* The language.
*/
language: Language;
/**
* The outcomes.
*/
outcomes: NonEmptyListOfStrings;
/**
* The tags to assign to the rule version.
*/
tags?: tagList;
}
export interface UpdateRuleVersionResult {
/**
* The new rule version that was created.
*/
rule?: Rule;
}
export interface UpdateVariableRequest {
/**
* The name of the variable.
*/
name: string;
/**
* The new default value of the variable.
*/
defaultValue?: string;
/**
* The new description.
*/
description?: string;
/**
* The variable type. For more information see Variable types.
*/
variableType?: string;
}
export interface UpdateVariableResult {
}
export type UseEventVariables = boolean;
export interface Variable {
/**
* The name of the variable.
*/
name?: string;
/**
* The data type of the variable. For more information see Variable types.
*/
dataType?: DataType;
/**
* The data source of the variable.
*/
dataSource?: DataSource;
/**
* The default value of the variable.
*/
defaultValue?: string;
/**
* The description of the variable.
*/
description?: string;
/**
* The variable type of the variable. Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
*/
variableType?: string;
/**
* The time when variable was last updated.
*/
lastUpdatedTime?: time;
/**
* The time when the variable was created.
*/
createdTime?: time;
/**
* The ARN of the variable.
*/
arn?: fraudDetectorArn;
}
export interface VariableEntry {
/**
* The name of the variable.
*/
name?: string;
/**
* The data type of the variable.
*/
dataType?: string;
/**
* The data source of the variable.
*/
dataSource?: string;
/**
* The default value of the variable.
*/
defaultValue?: string;
/**
* The description of the variable.
*/
description?: string;
/**
* The type of the variable. For more information see Variable types. Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
*/
variableType?: string;
}
export type VariableEntryList = VariableEntry[];
export type VariableList = Variable[];
export type VariablesMaxResults = number;
export type blob = Buffer|Uint8Array|Blob|string;
export type contentType = string;
export type description = string;
export type entityTypeList = EntityType[];
export type entityTypesMaxResults = number;
export type eventTypeList = EventType[];
export type eventTypesMaxResults = number;
export type fieldValidationMessageList = FieldValidationMessage[];
export type fileValidationMessageList = FileValidationMessage[];
export type float = number;
export type floatVersionString = string;
export type fraudDetectorArn = string;
export type iamRoleArn = string;
export type identifier = string;
export type integer = number;
export type labelList = Label[];
export type labelMapper = {[key: string]: ListOfStrings};
export type labelsMaxResults = number;
export type listOfEntities = Entity[];
export type metricDataPointsList = MetricDataPoint[];
export type modelIdentifier = string;
export type modelList = Model[];
export type modelVersionDetailList = ModelVersionDetail[];
export type modelsMaxPageSize = number;
export type nonEmptyString = string;
export type ruleExpression = string;
export type s3BucketLocation = string;
export type sageMakerEndpointIdentifier = string;
export type tagKey = string;
export type tagKeyList = tagKey[];
export type tagList = Tag[];
export type tagValue = string;
export type time = string;
export type variableName = string;
export type variableValue = string;
export type wholeNumberVersionString = string;
/**
* 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 = "2019-11-15"|"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 FraudDetector client.
*/
export import Types = FraudDetector;
}
export = FraudDetector;