guardduty.d.ts
84.4 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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class GuardDuty extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: GuardDuty.Types.ClientConfiguration)
config: Config & GuardDuty.Types.ClientConfiguration;
/**
* Accepts the invitation to be monitored by a master GuardDuty account.
*/
acceptInvitation(params: GuardDuty.Types.AcceptInvitationRequest, callback?: (err: AWSError, data: GuardDuty.Types.AcceptInvitationResponse) => void): Request<GuardDuty.Types.AcceptInvitationResponse, AWSError>;
/**
* Accepts the invitation to be monitored by a master GuardDuty account.
*/
acceptInvitation(callback?: (err: AWSError, data: GuardDuty.Types.AcceptInvitationResponse) => void): Request<GuardDuty.Types.AcceptInvitationResponse, AWSError>;
/**
* Archives GuardDuty findings specified by the list of finding IDs. Only the master account can archive findings. Member accounts do not have permission to archive findings from their accounts.
*/
archiveFindings(params: GuardDuty.Types.ArchiveFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ArchiveFindingsResponse) => void): Request<GuardDuty.Types.ArchiveFindingsResponse, AWSError>;
/**
* Archives GuardDuty findings specified by the list of finding IDs. Only the master account can archive findings. Member accounts do not have permission to archive findings from their accounts.
*/
archiveFindings(callback?: (err: AWSError, data: GuardDuty.Types.ArchiveFindingsResponse) => void): Request<GuardDuty.Types.ArchiveFindingsResponse, AWSError>;
/**
* Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each region that you enable the service. You can have only one detector per account per region.
*/
createDetector(params: GuardDuty.Types.CreateDetectorRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateDetectorResponse) => void): Request<GuardDuty.Types.CreateDetectorResponse, AWSError>;
/**
* Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each region that you enable the service. You can have only one detector per account per region.
*/
createDetector(callback?: (err: AWSError, data: GuardDuty.Types.CreateDetectorResponse) => void): Request<GuardDuty.Types.CreateDetectorResponse, AWSError>;
/**
* Creates a filter using the specified finding criteria.
*/
createFilter(params: GuardDuty.Types.CreateFilterRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateFilterResponse) => void): Request<GuardDuty.Types.CreateFilterResponse, AWSError>;
/**
* Creates a filter using the specified finding criteria.
*/
createFilter(callback?: (err: AWSError, data: GuardDuty.Types.CreateFilterResponse) => void): Request<GuardDuty.Types.CreateFilterResponse, AWSError>;
/**
* Creates a new IPSet, called Trusted IP list in the consoler user interface. An IPSet is a list IP addresses trusted for secure communication with AWS infrastructure and applications. GuardDuty does not generate findings for IP addresses included in IPSets. Only users from the master account can use this operation.
*/
createIPSet(params: GuardDuty.Types.CreateIPSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateIPSetResponse) => void): Request<GuardDuty.Types.CreateIPSetResponse, AWSError>;
/**
* Creates a new IPSet, called Trusted IP list in the consoler user interface. An IPSet is a list IP addresses trusted for secure communication with AWS infrastructure and applications. GuardDuty does not generate findings for IP addresses included in IPSets. Only users from the master account can use this operation.
*/
createIPSet(callback?: (err: AWSError, data: GuardDuty.Types.CreateIPSetResponse) => void): Request<GuardDuty.Types.CreateIPSetResponse, AWSError>;
/**
* Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts.
*/
createMembers(params: GuardDuty.Types.CreateMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateMembersResponse) => void): Request<GuardDuty.Types.CreateMembersResponse, AWSError>;
/**
* Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts.
*/
createMembers(callback?: (err: AWSError, data: GuardDuty.Types.CreateMembersResponse) => void): Request<GuardDuty.Types.CreateMembersResponse, AWSError>;
/**
* Creates a publishing destination to send findings to. The resource to send findings to must exist before you use this operation.
*/
createPublishingDestination(params: GuardDuty.Types.CreatePublishingDestinationRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreatePublishingDestinationResponse) => void): Request<GuardDuty.Types.CreatePublishingDestinationResponse, AWSError>;
/**
* Creates a publishing destination to send findings to. The resource to send findings to must exist before you use this operation.
*/
createPublishingDestination(callback?: (err: AWSError, data: GuardDuty.Types.CreatePublishingDestinationResponse) => void): Request<GuardDuty.Types.CreatePublishingDestinationResponse, AWSError>;
/**
* Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types.
*/
createSampleFindings(params: GuardDuty.Types.CreateSampleFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateSampleFindingsResponse) => void): Request<GuardDuty.Types.CreateSampleFindingsResponse, AWSError>;
/**
* Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types.
*/
createSampleFindings(callback?: (err: AWSError, data: GuardDuty.Types.CreateSampleFindingsResponse) => void): Request<GuardDuty.Types.CreateSampleFindingsResponse, AWSError>;
/**
* Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.
*/
createThreatIntelSet(params: GuardDuty.Types.CreateThreatIntelSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateThreatIntelSetResponse) => void): Request<GuardDuty.Types.CreateThreatIntelSetResponse, AWSError>;
/**
* Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.
*/
createThreatIntelSet(callback?: (err: AWSError, data: GuardDuty.Types.CreateThreatIntelSetResponse) => void): Request<GuardDuty.Types.CreateThreatIntelSetResponse, AWSError>;
/**
* Declines invitations sent to the current member account by AWS account specified by their account IDs.
*/
declineInvitations(params: GuardDuty.Types.DeclineInvitationsRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeclineInvitationsResponse) => void): Request<GuardDuty.Types.DeclineInvitationsResponse, AWSError>;
/**
* Declines invitations sent to the current member account by AWS account specified by their account IDs.
*/
declineInvitations(callback?: (err: AWSError, data: GuardDuty.Types.DeclineInvitationsResponse) => void): Request<GuardDuty.Types.DeclineInvitationsResponse, AWSError>;
/**
* Deletes a Amazon GuardDuty detector specified by the detector ID.
*/
deleteDetector(params: GuardDuty.Types.DeleteDetectorRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteDetectorResponse) => void): Request<GuardDuty.Types.DeleteDetectorResponse, AWSError>;
/**
* Deletes a Amazon GuardDuty detector specified by the detector ID.
*/
deleteDetector(callback?: (err: AWSError, data: GuardDuty.Types.DeleteDetectorResponse) => void): Request<GuardDuty.Types.DeleteDetectorResponse, AWSError>;
/**
* Deletes the filter specified by the filter name.
*/
deleteFilter(params: GuardDuty.Types.DeleteFilterRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteFilterResponse) => void): Request<GuardDuty.Types.DeleteFilterResponse, AWSError>;
/**
* Deletes the filter specified by the filter name.
*/
deleteFilter(callback?: (err: AWSError, data: GuardDuty.Types.DeleteFilterResponse) => void): Request<GuardDuty.Types.DeleteFilterResponse, AWSError>;
/**
* Deletes the IPSet specified by the ipSetId. IPSets are called Trusted IP lists in the console user interface.
*/
deleteIPSet(params: GuardDuty.Types.DeleteIPSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteIPSetResponse) => void): Request<GuardDuty.Types.DeleteIPSetResponse, AWSError>;
/**
* Deletes the IPSet specified by the ipSetId. IPSets are called Trusted IP lists in the console user interface.
*/
deleteIPSet(callback?: (err: AWSError, data: GuardDuty.Types.DeleteIPSetResponse) => void): Request<GuardDuty.Types.DeleteIPSetResponse, AWSError>;
/**
* Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.
*/
deleteInvitations(params: GuardDuty.Types.DeleteInvitationsRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteInvitationsResponse) => void): Request<GuardDuty.Types.DeleteInvitationsResponse, AWSError>;
/**
* Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.
*/
deleteInvitations(callback?: (err: AWSError, data: GuardDuty.Types.DeleteInvitationsResponse) => void): Request<GuardDuty.Types.DeleteInvitationsResponse, AWSError>;
/**
* Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
*/
deleteMembers(params: GuardDuty.Types.DeleteMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteMembersResponse) => void): Request<GuardDuty.Types.DeleteMembersResponse, AWSError>;
/**
* Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
*/
deleteMembers(callback?: (err: AWSError, data: GuardDuty.Types.DeleteMembersResponse) => void): Request<GuardDuty.Types.DeleteMembersResponse, AWSError>;
/**
* Deletes the publishing definition with the specified destinationId.
*/
deletePublishingDestination(params: GuardDuty.Types.DeletePublishingDestinationRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeletePublishingDestinationResponse) => void): Request<GuardDuty.Types.DeletePublishingDestinationResponse, AWSError>;
/**
* Deletes the publishing definition with the specified destinationId.
*/
deletePublishingDestination(callback?: (err: AWSError, data: GuardDuty.Types.DeletePublishingDestinationResponse) => void): Request<GuardDuty.Types.DeletePublishingDestinationResponse, AWSError>;
/**
* Deletes ThreatIntelSet specified by the ThreatIntelSet ID.
*/
deleteThreatIntelSet(params: GuardDuty.Types.DeleteThreatIntelSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteThreatIntelSetResponse) => void): Request<GuardDuty.Types.DeleteThreatIntelSetResponse, AWSError>;
/**
* Deletes ThreatIntelSet specified by the ThreatIntelSet ID.
*/
deleteThreatIntelSet(callback?: (err: AWSError, data: GuardDuty.Types.DeleteThreatIntelSetResponse) => void): Request<GuardDuty.Types.DeleteThreatIntelSetResponse, AWSError>;
/**
* Returns information about the publishing destination specified by the provided destinationId.
*/
describePublishingDestination(params: GuardDuty.Types.DescribePublishingDestinationRequest, callback?: (err: AWSError, data: GuardDuty.Types.DescribePublishingDestinationResponse) => void): Request<GuardDuty.Types.DescribePublishingDestinationResponse, AWSError>;
/**
* Returns information about the publishing destination specified by the provided destinationId.
*/
describePublishingDestination(callback?: (err: AWSError, data: GuardDuty.Types.DescribePublishingDestinationResponse) => void): Request<GuardDuty.Types.DescribePublishingDestinationResponse, AWSError>;
/**
* Disassociates the current GuardDuty member account from its master account.
*/
disassociateFromMasterAccount(params: GuardDuty.Types.DisassociateFromMasterAccountRequest, callback?: (err: AWSError, data: GuardDuty.Types.DisassociateFromMasterAccountResponse) => void): Request<GuardDuty.Types.DisassociateFromMasterAccountResponse, AWSError>;
/**
* Disassociates the current GuardDuty member account from its master account.
*/
disassociateFromMasterAccount(callback?: (err: AWSError, data: GuardDuty.Types.DisassociateFromMasterAccountResponse) => void): Request<GuardDuty.Types.DisassociateFromMasterAccountResponse, AWSError>;
/**
* Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
*/
disassociateMembers(params: GuardDuty.Types.DisassociateMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.DisassociateMembersResponse) => void): Request<GuardDuty.Types.DisassociateMembersResponse, AWSError>;
/**
* Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
*/
disassociateMembers(callback?: (err: AWSError, data: GuardDuty.Types.DisassociateMembersResponse) => void): Request<GuardDuty.Types.DisassociateMembersResponse, AWSError>;
/**
* Retrieves an Amazon GuardDuty detector specified by the detectorId.
*/
getDetector(params: GuardDuty.Types.GetDetectorRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetDetectorResponse) => void): Request<GuardDuty.Types.GetDetectorResponse, AWSError>;
/**
* Retrieves an Amazon GuardDuty detector specified by the detectorId.
*/
getDetector(callback?: (err: AWSError, data: GuardDuty.Types.GetDetectorResponse) => void): Request<GuardDuty.Types.GetDetectorResponse, AWSError>;
/**
* Returns the details of the filter specified by the filter name.
*/
getFilter(params: GuardDuty.Types.GetFilterRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetFilterResponse) => void): Request<GuardDuty.Types.GetFilterResponse, AWSError>;
/**
* Returns the details of the filter specified by the filter name.
*/
getFilter(callback?: (err: AWSError, data: GuardDuty.Types.GetFilterResponse) => void): Request<GuardDuty.Types.GetFilterResponse, AWSError>;
/**
* Describes Amazon GuardDuty findings specified by finding IDs.
*/
getFindings(params: GuardDuty.Types.GetFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetFindingsResponse) => void): Request<GuardDuty.Types.GetFindingsResponse, AWSError>;
/**
* Describes Amazon GuardDuty findings specified by finding IDs.
*/
getFindings(callback?: (err: AWSError, data: GuardDuty.Types.GetFindingsResponse) => void): Request<GuardDuty.Types.GetFindingsResponse, AWSError>;
/**
* Lists Amazon GuardDuty findings' statistics for the specified detector ID.
*/
getFindingsStatistics(params: GuardDuty.Types.GetFindingsStatisticsRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetFindingsStatisticsResponse) => void): Request<GuardDuty.Types.GetFindingsStatisticsResponse, AWSError>;
/**
* Lists Amazon GuardDuty findings' statistics for the specified detector ID.
*/
getFindingsStatistics(callback?: (err: AWSError, data: GuardDuty.Types.GetFindingsStatisticsResponse) => void): Request<GuardDuty.Types.GetFindingsStatisticsResponse, AWSError>;
/**
* Retrieves the IPSet specified by the ipSetId.
*/
getIPSet(params: GuardDuty.Types.GetIPSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetIPSetResponse) => void): Request<GuardDuty.Types.GetIPSetResponse, AWSError>;
/**
* Retrieves the IPSet specified by the ipSetId.
*/
getIPSet(callback?: (err: AWSError, data: GuardDuty.Types.GetIPSetResponse) => void): Request<GuardDuty.Types.GetIPSetResponse, AWSError>;
/**
* Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
*/
getInvitationsCount(params: GuardDuty.Types.GetInvitationsCountRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetInvitationsCountResponse) => void): Request<GuardDuty.Types.GetInvitationsCountResponse, AWSError>;
/**
* Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
*/
getInvitationsCount(callback?: (err: AWSError, data: GuardDuty.Types.GetInvitationsCountResponse) => void): Request<GuardDuty.Types.GetInvitationsCountResponse, AWSError>;
/**
* Provides the details for the GuardDuty master account associated with the current GuardDuty member account.
*/
getMasterAccount(params: GuardDuty.Types.GetMasterAccountRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetMasterAccountResponse) => void): Request<GuardDuty.Types.GetMasterAccountResponse, AWSError>;
/**
* Provides the details for the GuardDuty master account associated with the current GuardDuty member account.
*/
getMasterAccount(callback?: (err: AWSError, data: GuardDuty.Types.GetMasterAccountResponse) => void): Request<GuardDuty.Types.GetMasterAccountResponse, AWSError>;
/**
* Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
*/
getMembers(params: GuardDuty.Types.GetMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetMembersResponse) => void): Request<GuardDuty.Types.GetMembersResponse, AWSError>;
/**
* Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
*/
getMembers(callback?: (err: AWSError, data: GuardDuty.Types.GetMembersResponse) => void): Request<GuardDuty.Types.GetMembersResponse, AWSError>;
/**
* Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
*/
getThreatIntelSet(params: GuardDuty.Types.GetThreatIntelSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetThreatIntelSetResponse) => void): Request<GuardDuty.Types.GetThreatIntelSetResponse, AWSError>;
/**
* Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
*/
getThreatIntelSet(callback?: (err: AWSError, data: GuardDuty.Types.GetThreatIntelSetResponse) => void): Request<GuardDuty.Types.GetThreatIntelSetResponse, AWSError>;
/**
* Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.
*/
inviteMembers(params: GuardDuty.Types.InviteMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.InviteMembersResponse) => void): Request<GuardDuty.Types.InviteMembersResponse, AWSError>;
/**
* Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.
*/
inviteMembers(callback?: (err: AWSError, data: GuardDuty.Types.InviteMembersResponse) => void): Request<GuardDuty.Types.InviteMembersResponse, AWSError>;
/**
* Lists detectorIds of all the existing Amazon GuardDuty detector resources.
*/
listDetectors(params: GuardDuty.Types.ListDetectorsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListDetectorsResponse) => void): Request<GuardDuty.Types.ListDetectorsResponse, AWSError>;
/**
* Lists detectorIds of all the existing Amazon GuardDuty detector resources.
*/
listDetectors(callback?: (err: AWSError, data: GuardDuty.Types.ListDetectorsResponse) => void): Request<GuardDuty.Types.ListDetectorsResponse, AWSError>;
/**
* Returns a paginated list of the current filters.
*/
listFilters(params: GuardDuty.Types.ListFiltersRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListFiltersResponse) => void): Request<GuardDuty.Types.ListFiltersResponse, AWSError>;
/**
* Returns a paginated list of the current filters.
*/
listFilters(callback?: (err: AWSError, data: GuardDuty.Types.ListFiltersResponse) => void): Request<GuardDuty.Types.ListFiltersResponse, AWSError>;
/**
* Lists Amazon GuardDuty findings for the specified detector ID.
*/
listFindings(params: GuardDuty.Types.ListFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListFindingsResponse) => void): Request<GuardDuty.Types.ListFindingsResponse, AWSError>;
/**
* Lists Amazon GuardDuty findings for the specified detector ID.
*/
listFindings(callback?: (err: AWSError, data: GuardDuty.Types.ListFindingsResponse) => void): Request<GuardDuty.Types.ListFindingsResponse, AWSError>;
/**
* Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated master account.
*/
listIPSets(params: GuardDuty.Types.ListIPSetsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListIPSetsResponse) => void): Request<GuardDuty.Types.ListIPSetsResponse, AWSError>;
/**
* Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated master account.
*/
listIPSets(callback?: (err: AWSError, data: GuardDuty.Types.ListIPSetsResponse) => void): Request<GuardDuty.Types.ListIPSetsResponse, AWSError>;
/**
* Lists all GuardDuty membership invitations that were sent to the current AWS account.
*/
listInvitations(params: GuardDuty.Types.ListInvitationsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListInvitationsResponse) => void): Request<GuardDuty.Types.ListInvitationsResponse, AWSError>;
/**
* Lists all GuardDuty membership invitations that were sent to the current AWS account.
*/
listInvitations(callback?: (err: AWSError, data: GuardDuty.Types.ListInvitationsResponse) => void): Request<GuardDuty.Types.ListInvitationsResponse, AWSError>;
/**
* Lists details about all member accounts for the current GuardDuty master account.
*/
listMembers(params: GuardDuty.Types.ListMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListMembersResponse) => void): Request<GuardDuty.Types.ListMembersResponse, AWSError>;
/**
* Lists details about all member accounts for the current GuardDuty master account.
*/
listMembers(callback?: (err: AWSError, data: GuardDuty.Types.ListMembersResponse) => void): Request<GuardDuty.Types.ListMembersResponse, AWSError>;
/**
* Returns a list of publishing destinations associated with the specified dectectorId.
*/
listPublishingDestinations(params: GuardDuty.Types.ListPublishingDestinationsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListPublishingDestinationsResponse) => void): Request<GuardDuty.Types.ListPublishingDestinationsResponse, AWSError>;
/**
* Returns a list of publishing destinations associated with the specified dectectorId.
*/
listPublishingDestinations(callback?: (err: AWSError, data: GuardDuty.Types.ListPublishingDestinationsResponse) => void): Request<GuardDuty.Types.ListPublishingDestinationsResponse, AWSError>;
/**
* Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and Threat Intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource..
*/
listTagsForResource(params: GuardDuty.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListTagsForResourceResponse) => void): Request<GuardDuty.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and Threat Intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource..
*/
listTagsForResource(callback?: (err: AWSError, data: GuardDuty.Types.ListTagsForResourceResponse) => void): Request<GuardDuty.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated with the master account are returned.
*/
listThreatIntelSets(params: GuardDuty.Types.ListThreatIntelSetsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListThreatIntelSetsResponse) => void): Request<GuardDuty.Types.ListThreatIntelSetsResponse, AWSError>;
/**
* Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated with the master account are returned.
*/
listThreatIntelSets(callback?: (err: AWSError, data: GuardDuty.Types.ListThreatIntelSetsResponse) => void): Request<GuardDuty.Types.ListThreatIntelSetsResponse, AWSError>;
/**
* Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.
*/
startMonitoringMembers(params: GuardDuty.Types.StartMonitoringMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.StartMonitoringMembersResponse) => void): Request<GuardDuty.Types.StartMonitoringMembersResponse, AWSError>;
/**
* Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.
*/
startMonitoringMembers(callback?: (err: AWSError, data: GuardDuty.Types.StartMonitoringMembersResponse) => void): Request<GuardDuty.Types.StartMonitoringMembersResponse, AWSError>;
/**
* Stops GuardDuty monitoring for the specified member accounnts. Use the StartMonitoringMembers to restart monitoring for those accounts.
*/
stopMonitoringMembers(params: GuardDuty.Types.StopMonitoringMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.StopMonitoringMembersResponse) => void): Request<GuardDuty.Types.StopMonitoringMembersResponse, AWSError>;
/**
* Stops GuardDuty monitoring for the specified member accounnts. Use the StartMonitoringMembers to restart monitoring for those accounts.
*/
stopMonitoringMembers(callback?: (err: AWSError, data: GuardDuty.Types.StopMonitoringMembersResponse) => void): Request<GuardDuty.Types.StopMonitoringMembersResponse, AWSError>;
/**
* Adds tags to a resource.
*/
tagResource(params: GuardDuty.Types.TagResourceRequest, callback?: (err: AWSError, data: GuardDuty.Types.TagResourceResponse) => void): Request<GuardDuty.Types.TagResourceResponse, AWSError>;
/**
* Adds tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: GuardDuty.Types.TagResourceResponse) => void): Request<GuardDuty.Types.TagResourceResponse, AWSError>;
/**
* Unarchives GuardDuty findings specified by the findingIds.
*/
unarchiveFindings(params: GuardDuty.Types.UnarchiveFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.UnarchiveFindingsResponse) => void): Request<GuardDuty.Types.UnarchiveFindingsResponse, AWSError>;
/**
* Unarchives GuardDuty findings specified by the findingIds.
*/
unarchiveFindings(callback?: (err: AWSError, data: GuardDuty.Types.UnarchiveFindingsResponse) => void): Request<GuardDuty.Types.UnarchiveFindingsResponse, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(params: GuardDuty.Types.UntagResourceRequest, callback?: (err: AWSError, data: GuardDuty.Types.UntagResourceResponse) => void): Request<GuardDuty.Types.UntagResourceResponse, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: GuardDuty.Types.UntagResourceResponse) => void): Request<GuardDuty.Types.UntagResourceResponse, AWSError>;
/**
* Updates the Amazon GuardDuty detector specified by the detectorId.
*/
updateDetector(params: GuardDuty.Types.UpdateDetectorRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateDetectorResponse) => void): Request<GuardDuty.Types.UpdateDetectorResponse, AWSError>;
/**
* Updates the Amazon GuardDuty detector specified by the detectorId.
*/
updateDetector(callback?: (err: AWSError, data: GuardDuty.Types.UpdateDetectorResponse) => void): Request<GuardDuty.Types.UpdateDetectorResponse, AWSError>;
/**
* Updates the filter specified by the filter name.
*/
updateFilter(params: GuardDuty.Types.UpdateFilterRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateFilterResponse) => void): Request<GuardDuty.Types.UpdateFilterResponse, AWSError>;
/**
* Updates the filter specified by the filter name.
*/
updateFilter(callback?: (err: AWSError, data: GuardDuty.Types.UpdateFilterResponse) => void): Request<GuardDuty.Types.UpdateFilterResponse, AWSError>;
/**
* Marks the specified GuardDuty findings as useful or not useful.
*/
updateFindingsFeedback(params: GuardDuty.Types.UpdateFindingsFeedbackRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateFindingsFeedbackResponse) => void): Request<GuardDuty.Types.UpdateFindingsFeedbackResponse, AWSError>;
/**
* Marks the specified GuardDuty findings as useful or not useful.
*/
updateFindingsFeedback(callback?: (err: AWSError, data: GuardDuty.Types.UpdateFindingsFeedbackResponse) => void): Request<GuardDuty.Types.UpdateFindingsFeedbackResponse, AWSError>;
/**
* Updates the IPSet specified by the IPSet ID.
*/
updateIPSet(params: GuardDuty.Types.UpdateIPSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateIPSetResponse) => void): Request<GuardDuty.Types.UpdateIPSetResponse, AWSError>;
/**
* Updates the IPSet specified by the IPSet ID.
*/
updateIPSet(callback?: (err: AWSError, data: GuardDuty.Types.UpdateIPSetResponse) => void): Request<GuardDuty.Types.UpdateIPSetResponse, AWSError>;
/**
* Updates information about the publishing destination specified by the destinationId.
*/
updatePublishingDestination(params: GuardDuty.Types.UpdatePublishingDestinationRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdatePublishingDestinationResponse) => void): Request<GuardDuty.Types.UpdatePublishingDestinationResponse, AWSError>;
/**
* Updates information about the publishing destination specified by the destinationId.
*/
updatePublishingDestination(callback?: (err: AWSError, data: GuardDuty.Types.UpdatePublishingDestinationResponse) => void): Request<GuardDuty.Types.UpdatePublishingDestinationResponse, AWSError>;
/**
* Updates the ThreatIntelSet specified by ThreatIntelSet ID.
*/
updateThreatIntelSet(params: GuardDuty.Types.UpdateThreatIntelSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateThreatIntelSetResponse) => void): Request<GuardDuty.Types.UpdateThreatIntelSetResponse, AWSError>;
/**
* Updates the ThreatIntelSet specified by ThreatIntelSet ID.
*/
updateThreatIntelSet(callback?: (err: AWSError, data: GuardDuty.Types.UpdateThreatIntelSetResponse) => void): Request<GuardDuty.Types.UpdateThreatIntelSetResponse, AWSError>;
}
declare namespace GuardDuty {
export interface AcceptInvitationRequest {
/**
* The unique ID of the detector of the GuardDuty member account.
*/
DetectorId: DetectorId;
/**
* The account ID of the master GuardDuty account whose invitation you're accepting.
*/
MasterId: String;
/**
* This value is used to validate the master account to the member account.
*/
InvitationId: String;
}
export interface AcceptInvitationResponse {
}
export interface AccessKeyDetails {
/**
* Access key ID of the user.
*/
AccessKeyId?: String;
/**
* The principal ID of the user.
*/
PrincipalId?: String;
/**
* The name of the user.
*/
UserName?: String;
/**
* The type of the user.
*/
UserType?: String;
}
export interface AccountDetail {
/**
* Member account ID.
*/
AccountId: AccountId;
/**
* Member account's email address.
*/
Email: Email;
}
export type AccountDetails = AccountDetail[];
export type AccountId = string;
export type AccountIds = AccountId[];
export interface Action {
/**
* GuardDuty Finding activity type.
*/
ActionType?: String;
/**
* Information about the AWS_API_CALL action described in this finding.
*/
AwsApiCallAction?: AwsApiCallAction;
/**
* Information about the DNS_REQUEST action described in this finding.
*/
DnsRequestAction?: DnsRequestAction;
/**
* Information about the NETWORK_CONNECTION action described in this finding.
*/
NetworkConnectionAction?: NetworkConnectionAction;
/**
* Information about the PORT_PROBE action described in this finding.
*/
PortProbeAction?: PortProbeAction;
}
export interface ArchiveFindingsRequest {
/**
* The ID of the detector that specifies the GuardDuty service whose findings you want to archive.
*/
DetectorId: DetectorId;
/**
* IDs of the findings that you want to archive.
*/
FindingIds: FindingIds;
}
export interface ArchiveFindingsResponse {
}
export interface AwsApiCallAction {
/**
* AWS API name.
*/
Api?: String;
/**
* AWS API caller type.
*/
CallerType?: String;
/**
* Domain information for the AWS API call.
*/
DomainDetails?: DomainDetails;
/**
* Remote IP information of the connection.
*/
RemoteIpDetails?: RemoteIpDetails;
/**
* AWS service name whose API was invoked.
*/
ServiceName?: String;
}
export type Boolean = boolean;
export interface City {
/**
* City name of the remote IP address.
*/
CityName?: String;
}
export type ClientToken = string;
export interface Condition {
/**
* Represents the equal condition to be applied to a single field when querying for findings.
*/
Eq?: Eq;
/**
* Represents the not equal condition to be applied to a single field when querying for findings.
*/
Neq?: Neq;
/**
* Represents a greater than condition to be applied to a single field when querying for findings.
*/
Gt?: Integer;
/**
* Represents a greater than equal condition to be applied to a single field when querying for findings.
*/
Gte?: Integer;
/**
* Represents a less than condition to be applied to a single field when querying for findings.
*/
Lt?: Integer;
/**
* Represents a less than equal condition to be applied to a single field when querying for findings.
*/
Lte?: Integer;
/**
* Represents an equal condition to be applied to a single field when querying for findings.
*/
Equals?: Equals;
/**
* Represents an not equal condition to be applied to a single field when querying for findings.
*/
NotEquals?: NotEquals;
/**
* Represents a greater than condition to be applied to a single field when querying for findings.
*/
GreaterThan?: Long;
/**
* Represents a greater than equal condition to be applied to a single field when querying for findings.
*/
GreaterThanOrEqual?: Long;
/**
* Represents a less than condition to be applied to a single field when querying for findings.
*/
LessThan?: Long;
/**
* Represents a less than equal condition to be applied to a single field when querying for findings.
*/
LessThanOrEqual?: Long;
}
export type CountBySeverity = {[key: string]: Integer};
export interface Country {
/**
* Country code of the remote IP address.
*/
CountryCode?: String;
/**
* Country name of the remote IP address.
*/
CountryName?: String;
}
export interface CreateDetectorRequest {
/**
* A boolean value that specifies whether the detector is to be enabled.
*/
Enable: Boolean;
/**
* The idempotency token for the create request.
*/
ClientToken?: ClientToken;
/**
* A enum value that specifies how frequently customer got Finding updates published.
*/
FindingPublishingFrequency?: FindingPublishingFrequency;
/**
* The tags to be added to a new detector resource.
*/
Tags?: TagMap;
}
export interface CreateDetectorResponse {
/**
* The unique ID of the created detector.
*/
DetectorId?: DetectorId;
}
export interface CreateFilterRequest {
/**
* The unique ID of the detector of the GuardDuty account for which you want to create a filter.
*/
DetectorId: DetectorId;
/**
* The name of the filter.
*/
Name: FilterName;
/**
* The description of the filter.
*/
Description?: FilterDescription;
/**
* Specifies the action that is to be applied to the findings that match the filter.
*/
Action?: FilterAction;
/**
* Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
*/
Rank?: FilterRank;
/**
* Represents the criteria to be used in the filter for querying findings.
*/
FindingCriteria: FindingCriteria;
/**
* The idempotency token for the create request.
*/
ClientToken?: ClientToken;
/**
* The tags to be added to a new filter resource.
*/
Tags?: TagMap;
}
export interface CreateFilterResponse {
/**
* The name of the successfully created filter.
*/
Name: FilterName;
}
export interface CreateIPSetRequest {
/**
* The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
*/
DetectorId: DetectorId;
/**
* The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.
*/
Name: Name;
/**
* The format of the file that contains the IPSet.
*/
Format: IpSetFormat;
/**
* The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
*/
Location: Location;
/**
* A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
*/
Activate: Boolean;
/**
* The idempotency token for the create request.
*/
ClientToken?: ClientToken;
/**
* The tags to be added to a new IP set resource.
*/
Tags?: TagMap;
}
export interface CreateIPSetResponse {
/**
* The ID of the IPSet resource.
*/
IpSetId: String;
}
export interface CreateMembersRequest {
/**
* The unique ID of the detector of the GuardDuty account with which you want to associate member accounts.
*/
DetectorId: DetectorId;
/**
* A list of account ID and email address pairs of the accounts that you want to associate with the master GuardDuty account.
*/
AccountDetails: AccountDetails;
}
export interface CreateMembersResponse {
/**
* A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export interface CreatePublishingDestinationRequest {
/**
* The ID of the GuardDuty detector associated with the publishing destination.
*/
DetectorId: DetectorId;
/**
* The type of resource for the publishing destination. Currently only S3 is supported.
*/
DestinationType: DestinationType;
/**
* Properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.
*/
DestinationProperties: DestinationProperties;
/**
* The idempotency token for the request.
*/
ClientToken?: ClientToken;
}
export interface CreatePublishingDestinationResponse {
/**
* The ID of the publishing destination created.
*/
DestinationId: String;
}
export interface CreateSampleFindingsRequest {
/**
* The ID of the detector to create sample findings for.
*/
DetectorId: DetectorId;
/**
* Types of sample findings to generate.
*/
FindingTypes?: FindingTypes;
}
export interface CreateSampleFindingsResponse {
}
export interface CreateThreatIntelSetRequest {
/**
* The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.
*/
DetectorId: DetectorId;
/**
* A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.
*/
Name: Name;
/**
* The format of the file that contains the ThreatIntelSet.
*/
Format: ThreatIntelSetFormat;
/**
* The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
*/
Location: Location;
/**
* A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.
*/
Activate: Boolean;
/**
* The idempotency token for the create request.
*/
ClientToken?: ClientToken;
/**
* The tags to be added to a new Threat List resource.
*/
Tags?: TagMap;
}
export interface CreateThreatIntelSetResponse {
/**
* The ID of the ThreatIntelSet resource.
*/
ThreatIntelSetId: String;
}
export type Criterion = {[key: string]: Condition};
export interface DeclineInvitationsRequest {
/**
* A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to decline invitations from.
*/
AccountIds: AccountIds;
}
export interface DeclineInvitationsResponse {
/**
* A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export interface DeleteDetectorRequest {
/**
* The unique ID of the detector that you want to delete.
*/
DetectorId: DetectorId;
}
export interface DeleteDetectorResponse {
}
export interface DeleteFilterRequest {
/**
* The unique ID of the detector the filter is associated with.
*/
DetectorId: DetectorId;
/**
* The name of the filter you want to delete.
*/
FilterName: String;
}
export interface DeleteFilterResponse {
}
export interface DeleteIPSetRequest {
/**
* The unique ID of the detector associated with the IPSet.
*/
DetectorId: DetectorId;
/**
* The unique ID of the IPSet to delete.
*/
IpSetId: String;
}
export interface DeleteIPSetResponse {
}
export interface DeleteInvitationsRequest {
/**
* A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to delete invitations from.
*/
AccountIds: AccountIds;
}
export interface DeleteInvitationsResponse {
/**
* A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export interface DeleteMembersRequest {
/**
* The unique ID of the detector of the GuardDuty account whose members you want to delete.
*/
DetectorId: DetectorId;
/**
* A list of account IDs of the GuardDuty member accounts that you want to delete.
*/
AccountIds: AccountIds;
}
export interface DeleteMembersResponse {
/**
* The accounts that could not be processed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export interface DeletePublishingDestinationRequest {
/**
* The unique ID of the detector associated with the publishing destination to delete.
*/
DetectorId: DetectorId;
/**
* The ID of the publishing destination to delete.
*/
DestinationId: String;
}
export interface DeletePublishingDestinationResponse {
}
export interface DeleteThreatIntelSetRequest {
/**
* The unique ID of the detector the threatIntelSet is associated with.
*/
DetectorId: DetectorId;
/**
* The unique ID of the threatIntelSet you want to delete.
*/
ThreatIntelSetId: String;
}
export interface DeleteThreatIntelSetResponse {
}
export interface DescribePublishingDestinationRequest {
/**
* The unique ID of the detector associated with the publishing destination to retrieve.
*/
DetectorId: DetectorId;
/**
* The ID of the publishing destination to retrieve.
*/
DestinationId: String;
}
export interface DescribePublishingDestinationResponse {
/**
* The ID of the publishing destination.
*/
DestinationId: String;
/**
* The type of the publishing destination. Currently, only S3 is supported.
*/
DestinationType: DestinationType;
/**
* The status of the publishing destination.
*/
Status: PublishingStatus;
/**
* The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.
*/
PublishingFailureStartTimestamp: Long;
/**
* A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.
*/
DestinationProperties: DestinationProperties;
}
export interface Destination {
/**
* The unique ID of the publishing destination.
*/
DestinationId: String;
/**
* The type of resource used for the publishing destination. Currently, only S3 is supported.
*/
DestinationType: DestinationType;
/**
* The status of the publishing destination.
*/
Status: PublishingStatus;
}
export interface DestinationProperties {
/**
* The ARN of the resource to publish to.
*/
DestinationArn?: String;
/**
* The ARN of the KMS key to use for encryption.
*/
KmsKeyArn?: String;
}
export type DestinationType = "S3"|string;
export type Destinations = Destination[];
export type DetectorId = string;
export type DetectorIds = DetectorId[];
export type DetectorStatus = "ENABLED"|"DISABLED"|string;
export interface DisassociateFromMasterAccountRequest {
/**
* The unique ID of the detector of the GuardDuty member account.
*/
DetectorId: DetectorId;
}
export interface DisassociateFromMasterAccountResponse {
}
export interface DisassociateMembersRequest {
/**
* The unique ID of the detector of the GuardDuty account whose members you want to disassociate from master.
*/
DetectorId: DetectorId;
/**
* A list of account IDs of the GuardDuty member accounts that you want to disassociate from master.
*/
AccountIds: AccountIds;
}
export interface DisassociateMembersResponse {
/**
* A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export interface DnsRequestAction {
/**
* Domain information for the API request.
*/
Domain?: String;
}
export interface DomainDetails {
/**
* Domain information for the AWS API call.
*/
Domain?: String;
}
export type Double = number;
export type Email = string;
export type Eq = String[];
export type Equals = String[];
export interface Evidence {
/**
* A list of threat intelligence details related to the evidence.
*/
ThreatIntelligenceDetails?: ThreatIntelligenceDetails;
}
export type Feedback = "USEFUL"|"NOT_USEFUL"|string;
export type FilterAction = "NOOP"|"ARCHIVE"|string;
export type FilterDescription = string;
export type FilterName = string;
export type FilterNames = FilterName[];
export type FilterRank = number;
export interface Finding {
/**
* The ID of the account in which the finding was generated.
*/
AccountId: String;
/**
* The ARN for the finding.
*/
Arn: String;
/**
* The confidence score for the finding.
*/
Confidence?: Double;
/**
* The time and date at which the finding was created.
*/
CreatedAt: String;
/**
* The description of the finding.
*/
Description?: String;
/**
* The ID of the finding.
*/
Id: String;
/**
* The partition associated with the finding.
*/
Partition?: String;
/**
* The Region in which the finding was generated.
*/
Region: String;
Resource: Resource;
/**
* The version of the schema used for the finding.
*/
SchemaVersion: String;
Service?: Service;
/**
* The severity of the finding.
*/
Severity: Double;
/**
* The title for the finding.
*/
Title?: String;
/**
* The type of the finding.
*/
Type: FindingType;
/**
* The time and date at which the finding was laste updated.
*/
UpdatedAt: String;
}
export interface FindingCriteria {
/**
* Represents a map of finding properties that match specified conditions and values when querying findings.
*/
Criterion?: Criterion;
}
export type FindingId = string;
export type FindingIds = FindingId[];
export type FindingPublishingFrequency = "FIFTEEN_MINUTES"|"ONE_HOUR"|"SIX_HOURS"|string;
export type FindingStatisticType = "COUNT_BY_SEVERITY"|string;
export type FindingStatisticTypes = FindingStatisticType[];
export interface FindingStatistics {
/**
* Represents a map of severity to count statistic for a set of findings
*/
CountBySeverity?: CountBySeverity;
}
export type FindingType = string;
export type FindingTypes = FindingType[];
export type Findings = Finding[];
export interface GeoLocation {
/**
* Latitude information of remote IP address.
*/
Lat?: Double;
/**
* Longitude information of remote IP address.
*/
Lon?: Double;
}
export interface GetDetectorRequest {
/**
* The unique ID of the detector that you want to get.
*/
DetectorId: DetectorId;
}
export interface GetDetectorResponse {
/**
* Detector creation timestamp.
*/
CreatedAt?: String;
/**
* Finding publishing frequency.
*/
FindingPublishingFrequency?: FindingPublishingFrequency;
/**
* The GuardDuty service role.
*/
ServiceRole: String;
/**
* The detector status.
*/
Status: DetectorStatus;
/**
* Detector last update timestamp.
*/
UpdatedAt?: String;
/**
* The tags of the detector resource.
*/
Tags?: TagMap;
}
export interface GetFilterRequest {
/**
* The unique ID of the detector the filter is associated with.
*/
DetectorId: DetectorId;
/**
* The name of the filter you want to get.
*/
FilterName: String;
}
export interface GetFilterResponse {
/**
* The name of the filter.
*/
Name: FilterName;
/**
* The description of the filter.
*/
Description?: FilterDescription;
/**
* Specifies the action that is to be applied to the findings that match the filter.
*/
Action: FilterAction;
/**
* Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
*/
Rank?: FilterRank;
/**
* Represents the criteria to be used in the filter for querying findings.
*/
FindingCriteria: FindingCriteria;
/**
* The tags of the filter resource.
*/
Tags?: TagMap;
}
export interface GetFindingsRequest {
/**
* The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.
*/
DetectorId: DetectorId;
/**
* IDs of the findings that you want to retrieve.
*/
FindingIds: FindingIds;
/**
* Represents the criteria used for sorting findings.
*/
SortCriteria?: SortCriteria;
}
export interface GetFindingsResponse {
/**
* A list of findings.
*/
Findings: Findings;
}
export interface GetFindingsStatisticsRequest {
/**
* The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.
*/
DetectorId: DetectorId;
/**
* Types of finding statistics to retrieve.
*/
FindingStatisticTypes: FindingStatisticTypes;
/**
* Represents the criteria used for querying findings.
*/
FindingCriteria?: FindingCriteria;
}
export interface GetFindingsStatisticsResponse {
/**
* Finding statistics object.
*/
FindingStatistics: FindingStatistics;
}
export interface GetIPSetRequest {
/**
* The unique ID of the detector the ipSet is associated with.
*/
DetectorId: DetectorId;
/**
* The unique ID of the IPSet to retrieve.
*/
IpSetId: String;
}
export interface GetIPSetResponse {
/**
* The user friendly name for the IPSet.
*/
Name: Name;
/**
* The format of the file that contains the IPSet.
*/
Format: IpSetFormat;
/**
* The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
*/
Location: Location;
/**
* The status of ipSet file uploaded.
*/
Status: IpSetStatus;
/**
* The tags of the IP set resource.
*/
Tags?: TagMap;
}
export interface GetInvitationsCountRequest {
}
export interface GetInvitationsCountResponse {
/**
* The number of received invitations.
*/
InvitationsCount?: Integer;
}
export interface GetMasterAccountRequest {
/**
* The unique ID of the detector of the GuardDuty member account.
*/
DetectorId: DetectorId;
}
export interface GetMasterAccountResponse {
/**
* Master account details.
*/
Master: Master;
}
export interface GetMembersRequest {
/**
* The unique ID of the detector of the GuardDuty account whose members you want to retrieve.
*/
DetectorId: DetectorId;
/**
* A list of account IDs of the GuardDuty member accounts that you want to describe.
*/
AccountIds: AccountIds;
}
export interface GetMembersResponse {
/**
* A list of members.
*/
Members: Members;
/**
* A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export interface GetThreatIntelSetRequest {
/**
* The unique ID of the detector the threatIntelSet is associated with.
*/
DetectorId: DetectorId;
/**
* The unique ID of the threatIntelSet you want to get.
*/
ThreatIntelSetId: String;
}
export interface GetThreatIntelSetResponse {
/**
* A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.
*/
Name: Name;
/**
* The format of the threatIntelSet.
*/
Format: ThreatIntelSetFormat;
/**
* The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
*/
Location: Location;
/**
* The status of threatIntelSet file uploaded.
*/
Status: ThreatIntelSetStatus;
/**
* The tags of the Threat List resource.
*/
Tags?: TagMap;
}
export type GuardDutyArn = string;
export interface IamInstanceProfile {
/**
* AWS EC2 instance profile ARN.
*/
Arn?: String;
/**
* AWS EC2 instance profile ID.
*/
Id?: String;
}
export interface InstanceDetails {
/**
* The availability zone of the EC2 instance.
*/
AvailabilityZone?: String;
/**
* The profile information of the EC2 instance.
*/
IamInstanceProfile?: IamInstanceProfile;
/**
* The image description of the EC2 instance.
*/
ImageDescription?: String;
/**
* The image ID of the EC2 instance.
*/
ImageId?: String;
/**
* The ID of the EC2 instance.
*/
InstanceId?: String;
/**
* The state of the EC2 instance.
*/
InstanceState?: String;
/**
* The type of the EC2 instance.
*/
InstanceType?: String;
/**
* The launch time of the EC2 instance.
*/
LaunchTime?: String;
/**
* The network interface information of the EC2 instance.
*/
NetworkInterfaces?: NetworkInterfaces;
/**
* The platform of the EC2 instance.
*/
Platform?: String;
/**
* The product code of the EC2 instance.
*/
ProductCodes?: ProductCodes;
/**
* The tags of the EC2 instance.
*/
Tags?: Tags;
}
export type Integer = number;
export interface Invitation {
/**
* The ID of the account from which the invitations was sent.
*/
AccountId?: AccountId;
/**
* The ID of the invitation. This value is used to validate the inviter account to the member account.
*/
InvitationId?: String;
/**
* The status of the relationship between the inviter and invitee accounts.
*/
RelationshipStatus?: String;
/**
* Timestamp at which the invitation was sent.
*/
InvitedAt?: String;
}
export type Invitations = Invitation[];
export interface InviteMembersRequest {
/**
* The unique ID of the detector of the GuardDuty account with which you want to invite members.
*/
DetectorId: DetectorId;
/**
* A list of account IDs of the accounts that you want to invite to GuardDuty as members.
*/
AccountIds: AccountIds;
/**
* A boolean value that specifies whether you want to disable email notification to the accounts that you’re inviting to GuardDuty as members.
*/
DisableEmailNotification?: Boolean;
/**
* The invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members.
*/
Message?: String;
}
export interface InviteMembersResponse {
/**
* A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export type IpSetFormat = "TXT"|"STIX"|"OTX_CSV"|"ALIEN_VAULT"|"PROOF_POINT"|"FIRE_EYE"|string;
export type IpSetIds = String[];
export type IpSetStatus = "INACTIVE"|"ACTIVATING"|"ACTIVE"|"DEACTIVATING"|"ERROR"|"DELETE_PENDING"|"DELETED"|string;
export type Ipv6Addresses = String[];
export interface ListDetectorsRequest {
/**
* You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
*/
MaxResults?: MaxResults;
/**
* You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: String;
}
export interface ListDetectorsResponse {
/**
* A list of detector Ids.
*/
DetectorIds: DetectorIds;
/**
* Pagination parameter to be used on the next list operation to retrieve more items.
*/
NextToken?: String;
}
export interface ListFiltersRequest {
/**
* The unique ID of the detector the filter is associated with.
*/
DetectorId: DetectorId;
/**
* You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
*/
MaxResults?: MaxResults;
/**
* You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: String;
}
export interface ListFiltersResponse {
/**
* A list of filter names
*/
FilterNames: FilterNames;
/**
* Pagination parameter to be used on the next list operation to retrieve more items.
*/
NextToken?: String;
}
export interface ListFindingsRequest {
/**
* The ID of the detector that specifies the GuardDuty service whose findings you want to list.
*/
DetectorId: DetectorId;
/**
* Represents the criteria used for querying findings. Valid values include: JSON field name accountId region confidence id resource.accessKeyDetails.accessKeyId resource.accessKeyDetails.principalId resource.accessKeyDetails.userName resource.accessKeyDetails.userType resource.instanceDetails.iamInstanceProfile.id resource.instanceDetails.imageId resource.instanceDetails.instanceId resource.instanceDetails.networkInterfaces.ipv6Addresses resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress resource.instanceDetails.networkInterfaces.publicDnsName resource.instanceDetails.networkInterfaces.publicIp resource.instanceDetails.networkInterfaces.securityGroups.groupId resource.instanceDetails.networkInterfaces.securityGroups.groupName resource.instanceDetails.networkInterfaces.subnetId resource.instanceDetails.networkInterfaces.vpcId resource.instanceDetails.tags.key resource.instanceDetails.tags.value resource.resourceType service.action.actionType service.action.awsApiCallAction.api service.action.awsApiCallAction.callerType service.action.awsApiCallAction.remoteIpDetails.city.cityName service.action.awsApiCallAction.remoteIpDetails.country.countryName service.action.awsApiCallAction.remoteIpDetails.ipAddressV4 service.action.awsApiCallAction.remoteIpDetails.organization.asn service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg service.action.awsApiCallAction.serviceName service.action.dnsRequestAction.domain service.action.networkConnectionAction.blocked service.action.networkConnectionAction.connectionDirection service.action.networkConnectionAction.localPortDetails.port service.action.networkConnectionAction.protocol service.action.networkConnectionAction.remoteIpDetails.city.cityName service.action.networkConnectionAction.remoteIpDetails.country.countryName service.action.networkConnectionAction.remoteIpDetails.ipAddressV4 service.action.networkConnectionAction.remoteIpDetails.organization.asn service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg service.action.networkConnectionAction.remotePortDetails.port service.additionalInfo.threatListName service.archived When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed. service.resourceRole severity type updatedAt Type: Timestamp in Unix Epoch millisecond format: 1486685375000
*/
FindingCriteria?: FindingCriteria;
/**
* Represents the criteria used for sorting findings.
*/
SortCriteria?: SortCriteria;
/**
* You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
*/
MaxResults?: MaxResults;
/**
* You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: String;
}
export interface ListFindingsResponse {
/**
* The IDs of the findings you are listing.
*/
FindingIds: FindingIds;
/**
* Pagination parameter to be used on the next list operation to retrieve more items.
*/
NextToken?: String;
}
export interface ListIPSetsRequest {
/**
* The unique ID of the detector the ipSet is associated with.
*/
DetectorId: DetectorId;
/**
* You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
*/
MaxResults?: MaxResults;
/**
* You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: String;
}
export interface ListIPSetsResponse {
/**
* The IDs of the IPSet resources.
*/
IpSetIds: IpSetIds;
/**
* Pagination parameter to be used on the next list operation to retrieve more items.
*/
NextToken?: String;
}
export interface ListInvitationsRequest {
/**
* You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
*/
MaxResults?: MaxResults;
/**
* You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: String;
}
export interface ListInvitationsResponse {
/**
* A list of invitation descriptions.
*/
Invitations?: Invitations;
/**
* Pagination parameter to be used on the next list operation to retrieve more items.
*/
NextToken?: String;
}
export interface ListMembersRequest {
/**
* The unique ID of the detector the member is associated with.
*/
DetectorId: DetectorId;
/**
* You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
*/
MaxResults?: MaxResults;
/**
* You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: String;
/**
* Specifies whether to only return associated members or to return all members (including members which haven't been invited yet or have been disassociated).
*/
OnlyAssociated?: String;
}
export interface ListMembersResponse {
/**
* A list of members.
*/
Members?: Members;
/**
* Pagination parameter to be used on the next list operation to retrieve more items.
*/
NextToken?: String;
}
export interface ListPublishingDestinationsRequest {
/**
* The ID of the detector to retrieve publishing destinations for.
*/
DetectorId: DetectorId;
/**
* The maximum number of results to return in the response.
*/
MaxResults?: MaxResults;
/**
* A token to use for paginating results returned in the repsonse. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
*/
NextToken?: String;
}
export interface ListPublishingDestinationsResponse {
/**
* A Destinations obect that includes information about each publishing destination returned.
*/
Destinations: Destinations;
/**
* A token to use for paginating results returned in the repsonse. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
*/
NextToken?: String;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) for the given GuardDuty resource
*/
ResourceArn: GuardDutyArn;
}
export interface ListTagsForResourceResponse {
/**
* The tags associated with the resource.
*/
Tags?: TagMap;
}
export interface ListThreatIntelSetsRequest {
/**
* The unique ID of the detector the threatIntelSet is associated with.
*/
DetectorId: DetectorId;
/**
* You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
*/
MaxResults?: MaxResults;
/**
* You can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: String;
}
export interface ListThreatIntelSetsResponse {
/**
* The IDs of the ThreatIntelSet resources.
*/
ThreatIntelSetIds: ThreatIntelSetIds;
/**
* Pagination parameter to be used on the next list operation to retrieve more items.
*/
NextToken?: String;
}
export interface LocalPortDetails {
/**
* Port number of the local connection.
*/
Port?: Integer;
/**
* Port name of the local connection.
*/
PortName?: String;
}
export type Location = string;
export type Long = number;
export interface Master {
/**
* The ID of the account used as the Master account.
*/
AccountId?: AccountId;
/**
* This value is used to validate the master account to the member account.
*/
InvitationId?: String;
/**
* The status of the relationship between the master and member accounts.
*/
RelationshipStatus?: String;
/**
* Timestamp at which the invitation was sent.
*/
InvitedAt?: String;
}
export type MaxResults = number;
export interface Member {
/**
* Member account ID.
*/
AccountId: AccountId;
/**
* Member account's detector ID.
*/
DetectorId?: DetectorId;
/**
* Master account ID.
*/
MasterId: String;
/**
* Member account's email address.
*/
Email: Email;
/**
* The status of the relationship between the member and the master.
*/
RelationshipStatus: String;
/**
* Timestamp at which the invitation was sent
*/
InvitedAt?: String;
/**
* Member last updated timestamp.
*/
UpdatedAt: String;
}
export type Members = Member[];
export type Name = string;
export type Neq = String[];
export interface NetworkConnectionAction {
/**
* Network connection blocked information.
*/
Blocked?: Boolean;
/**
* Network connection direction.
*/
ConnectionDirection?: String;
/**
* Local port information of the connection.
*/
LocalPortDetails?: LocalPortDetails;
/**
* Network connection protocol.
*/
Protocol?: String;
/**
* Remote IP information of the connection.
*/
RemoteIpDetails?: RemoteIpDetails;
/**
* Remote port information of the connection.
*/
RemotePortDetails?: RemotePortDetails;
}
export interface NetworkInterface {
/**
* A list of EC2 instance IPv6 address information.
*/
Ipv6Addresses?: Ipv6Addresses;
/**
* The ID of the network interface
*/
NetworkInterfaceId?: String;
/**
* Private DNS name of the EC2 instance.
*/
PrivateDnsName?: String;
/**
* Private IP address of the EC2 instance.
*/
PrivateIpAddress?: String;
/**
* Other private IP address information of the EC2 instance.
*/
PrivateIpAddresses?: PrivateIpAddresses;
/**
* Public DNS name of the EC2 instance.
*/
PublicDnsName?: String;
/**
* Public IP address of the EC2 instance.
*/
PublicIp?: String;
/**
* Security groups associated with the EC2 instance.
*/
SecurityGroups?: SecurityGroups;
/**
* The subnet ID of the EC2 instance.
*/
SubnetId?: String;
/**
* The VPC ID of the EC2 instance.
*/
VpcId?: String;
}
export type NetworkInterfaces = NetworkInterface[];
export type NotEquals = String[];
export type OrderBy = "ASC"|"DESC"|string;
export interface Organization {
/**
* Autonomous system number of the internet provider of the remote IP address.
*/
Asn?: String;
/**
* Organization that registered this ASN.
*/
AsnOrg?: String;
/**
* ISP information for the internet provider.
*/
Isp?: String;
/**
* Name of the internet provider.
*/
Org?: String;
}
export interface PortProbeAction {
/**
* Port probe blocked information.
*/
Blocked?: Boolean;
/**
* A list of port probe details objects.
*/
PortProbeDetails?: PortProbeDetails;
}
export interface PortProbeDetail {
/**
* Local port information of the connection.
*/
LocalPortDetails?: LocalPortDetails;
/**
* Remote IP information of the connection.
*/
RemoteIpDetails?: RemoteIpDetails;
}
export type PortProbeDetails = PortProbeDetail[];
export interface PrivateIpAddressDetails {
/**
* Private DNS name of the EC2 instance.
*/
PrivateDnsName?: String;
/**
* Private IP address of the EC2 instance.
*/
PrivateIpAddress?: String;
}
export type PrivateIpAddresses = PrivateIpAddressDetails[];
export interface ProductCode {
/**
* Product code information.
*/
Code?: String;
/**
* Product code type.
*/
ProductType?: String;
}
export type ProductCodes = ProductCode[];
export type PublishingStatus = "PENDING_VERIFICATION"|"PUBLISHING"|"UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY"|"STOPPED"|string;
export interface RemoteIpDetails {
/**
* City information of the remote IP address.
*/
City?: City;
/**
* Country code of the remote IP address.
*/
Country?: Country;
/**
* Location information of the remote IP address.
*/
GeoLocation?: GeoLocation;
/**
* IPV4 remote address of the connection.
*/
IpAddressV4?: String;
/**
* ISP Organization information of the remote IP address.
*/
Organization?: Organization;
}
export interface RemotePortDetails {
/**
* Port number of the remote connection.
*/
Port?: Integer;
/**
* Port name of the remote connection.
*/
PortName?: String;
}
export interface Resource {
/**
* The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding.
*/
AccessKeyDetails?: AccessKeyDetails;
/**
* The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding.
*/
InstanceDetails?: InstanceDetails;
/**
* The type of the AWS resource.
*/
ResourceType?: String;
}
export interface SecurityGroup {
/**
* EC2 instance's security group ID.
*/
GroupId?: String;
/**
* EC2 instance's security group name.
*/
GroupName?: String;
}
export type SecurityGroups = SecurityGroup[];
export interface Service {
/**
* Information about the activity described in a finding.
*/
Action?: Action;
/**
* An evidence object associated with the service.
*/
Evidence?: Evidence;
/**
* Indicates whether this finding is archived.
*/
Archived?: Boolean;
/**
* Total count of the occurrences of this finding type.
*/
Count?: Integer;
/**
* Detector ID for the GuardDuty service.
*/
DetectorId?: DetectorId;
/**
* First seen timestamp of the activity that prompted GuardDuty to generate this finding.
*/
EventFirstSeen?: String;
/**
* Last seen timestamp of the activity that prompted GuardDuty to generate this finding.
*/
EventLastSeen?: String;
/**
* Resource role information for this finding.
*/
ResourceRole?: String;
/**
* The name of the AWS service (GuardDuty) that generated a finding.
*/
ServiceName?: String;
/**
* Feedback left about the finding.
*/
UserFeedback?: String;
}
export interface SortCriteria {
/**
* Represents the finding attribute (for example, accountId) by which to sort findings.
*/
AttributeName?: String;
/**
* Order by which the sorted findings are to be displayed.
*/
OrderBy?: OrderBy;
}
export interface StartMonitoringMembersRequest {
/**
* The unique ID of the detector of the GuardDuty master account associated with the member accounts to monitor.
*/
DetectorId: DetectorId;
/**
* A list of account IDs of the GuardDuty member accounts to start monitoring.
*/
AccountIds: AccountIds;
}
export interface StartMonitoringMembersResponse {
/**
* A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export interface StopMonitoringMembersRequest {
/**
* The unique ID of the detector of the GuardDuty account that you want to stop from monitor members' findings.
*/
DetectorId: DetectorId;
/**
* A list of account IDs of the GuardDuty member accounts whose findings you want the master account to stop monitoring.
*/
AccountIds: AccountIds;
}
export interface StopMonitoringMembersResponse {
/**
* A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
*/
UnprocessedAccounts: UnprocessedAccounts;
}
export type String = string;
export interface Tag {
/**
* EC2 instance tag key.
*/
Key?: String;
/**
* EC2 instance tag value.
*/
Value?: String;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag to.
*/
ResourceArn: GuardDutyArn;
/**
* The tags to be added to a resource.
*/
Tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Tags = Tag[];
export type ThreatIntelSetFormat = "TXT"|"STIX"|"OTX_CSV"|"ALIEN_VAULT"|"PROOF_POINT"|"FIRE_EYE"|string;
export type ThreatIntelSetIds = String[];
export type ThreatIntelSetStatus = "INACTIVE"|"ACTIVATING"|"ACTIVE"|"DEACTIVATING"|"ERROR"|"DELETE_PENDING"|"DELETED"|string;
export interface ThreatIntelligenceDetail {
/**
* The name of the threat intelligence list that triggered the finding.
*/
ThreatListName?: String;
/**
* A list of names of the threats in the threat intelligence list that triggered the finding.
*/
ThreatNames?: ThreatNames;
}
export type ThreatIntelligenceDetails = ThreatIntelligenceDetail[];
export type ThreatNames = String[];
export interface UnarchiveFindingsRequest {
/**
* The ID of the detector associated with the findings to unarchive.
*/
DetectorId: DetectorId;
/**
* IDs of the findings to unarchive.
*/
FindingIds: FindingIds;
}
export interface UnarchiveFindingsResponse {
}
export interface UnprocessedAccount {
/**
* AWS Account ID.
*/
AccountId: AccountId;
/**
* A reason why the account hasn't been processed.
*/
Result: String;
}
export type UnprocessedAccounts = UnprocessedAccount[];
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) for the resource to remove tags from.
*/
ResourceArn: GuardDutyArn;
/**
* The tag keys to remove from the resource.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateDetectorRequest {
/**
* The unique ID of the detector to update.
*/
DetectorId: DetectorId;
/**
* Specifies whether the detector is enabled or not enabled.
*/
Enable?: Boolean;
/**
* A enum value that specifies how frequently findings are exported, such as to CloudWatch Events.
*/
FindingPublishingFrequency?: FindingPublishingFrequency;
}
export interface UpdateDetectorResponse {
}
export interface UpdateFilterRequest {
/**
* The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.
*/
DetectorId: DetectorId;
/**
* The name of the filter.
*/
FilterName: String;
/**
* The description of the filter.
*/
Description?: FilterDescription;
/**
* Specifies the action that is to be applied to the findings that match the filter.
*/
Action?: FilterAction;
/**
* Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
*/
Rank?: FilterRank;
/**
* Represents the criteria to be used in the filter for querying findings.
*/
FindingCriteria?: FindingCriteria;
}
export interface UpdateFilterResponse {
/**
* The name of the filter.
*/
Name: FilterName;
}
export interface UpdateFindingsFeedbackRequest {
/**
* The ID of the detector associated with the findings to update feedback for.
*/
DetectorId: DetectorId;
/**
* IDs of the findings that you want to mark as useful or not useful.
*/
FindingIds: FindingIds;
/**
* The feedback for the finding.
*/
Feedback: Feedback;
/**
* Additional feedback about the GuardDuty findings.
*/
Comments?: String;
}
export interface UpdateFindingsFeedbackResponse {
}
export interface UpdateIPSetRequest {
/**
* The detectorID that specifies the GuardDuty service whose IPSet you want to update.
*/
DetectorId: DetectorId;
/**
* The unique ID that specifies the IPSet that you want to update.
*/
IpSetId: String;
/**
* The unique ID that specifies the IPSet that you want to update.
*/
Name?: Name;
/**
* The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
*/
Location?: Location;
/**
* The updated boolean value that specifies whether the IPSet is active or not.
*/
Activate?: Boolean;
}
export interface UpdateIPSetResponse {
}
export interface UpdatePublishingDestinationRequest {
/**
* The ID of the
*/
DetectorId: DetectorId;
/**
* The ID of the detector associated with the publishing destinations to update.
*/
DestinationId: String;
/**
* A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.
*/
DestinationProperties?: DestinationProperties;
}
export interface UpdatePublishingDestinationResponse {
}
export interface UpdateThreatIntelSetRequest {
/**
* The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.
*/
DetectorId: DetectorId;
/**
* The unique ID that specifies the ThreatIntelSet that you want to update.
*/
ThreatIntelSetId: String;
/**
* The unique ID that specifies the ThreatIntelSet that you want to update.
*/
Name?: Name;
/**
* The updated URI of the file that contains the ThreateIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
*/
Location?: Location;
/**
* The updated boolean value that specifies whether the ThreateIntelSet is active or not.
*/
Activate?: Boolean;
}
export interface UpdateThreatIntelSetResponse {
}
/**
* 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 = "2017-11-28"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the GuardDuty client.
*/
export import Types = GuardDuty;
}
export = GuardDuty;