securityhub.d.ts
81.9 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
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 SecurityHub extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: SecurityHub.Types.ClientConfiguration)
config: Config & SecurityHub.Types.ClientConfiguration;
/**
* Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from. When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.
*/
acceptInvitation(params: SecurityHub.Types.AcceptInvitationRequest, callback?: (err: AWSError, data: SecurityHub.Types.AcceptInvitationResponse) => void): Request<SecurityHub.Types.AcceptInvitationResponse, AWSError>;
/**
* Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from. When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.
*/
acceptInvitation(callback?: (err: AWSError, data: SecurityHub.Types.AcceptInvitationResponse) => void): Request<SecurityHub.Types.AcceptInvitationResponse, AWSError>;
/**
* Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Standards Supported in AWS Security Hub.
*/
batchDisableStandards(params: SecurityHub.Types.BatchDisableStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchDisableStandardsResponse) => void): Request<SecurityHub.Types.BatchDisableStandardsResponse, AWSError>;
/**
* Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Standards Supported in AWS Security Hub.
*/
batchDisableStandards(callback?: (err: AWSError, data: SecurityHub.Types.BatchDisableStandardsResponse) => void): Request<SecurityHub.Types.BatchDisableStandardsResponse, AWSError>;
/**
* Enables the standards specified by the provided standardsArn. In this release, only CIS AWS Foundations standards are supported. For more information, see Standards Supported in AWS Security Hub.
*/
batchEnableStandards(params: SecurityHub.Types.BatchEnableStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchEnableStandardsResponse) => void): Request<SecurityHub.Types.BatchEnableStandardsResponse, AWSError>;
/**
* Enables the standards specified by the provided standardsArn. In this release, only CIS AWS Foundations standards are supported. For more information, see Standards Supported in AWS Security Hub.
*/
batchEnableStandards(callback?: (err: AWSError, data: SecurityHub.Types.BatchEnableStandardsResponse) => void): Request<SecurityHub.Types.BatchEnableStandardsResponse, AWSError>;
/**
* Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
*/
batchImportFindings(params: SecurityHub.Types.BatchImportFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchImportFindingsResponse) => void): Request<SecurityHub.Types.BatchImportFindingsResponse, AWSError>;
/**
* Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
*/
batchImportFindings(callback?: (err: AWSError, data: SecurityHub.Types.BatchImportFindingsResponse) => void): Request<SecurityHub.Types.BatchImportFindingsResponse, AWSError>;
/**
* Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
*/
createActionTarget(params: SecurityHub.Types.CreateActionTargetRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateActionTargetResponse) => void): Request<SecurityHub.Types.CreateActionTargetResponse, AWSError>;
/**
* Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
*/
createActionTarget(callback?: (err: AWSError, data: SecurityHub.Types.CreateActionTargetResponse) => void): Request<SecurityHub.Types.CreateActionTargetResponse, AWSError>;
/**
* Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. Use the GroupByAttribute to group the related findings in the insight.
*/
createInsight(params: SecurityHub.Types.CreateInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateInsightResponse) => void): Request<SecurityHub.Types.CreateInsightResponse, AWSError>;
/**
* Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. Use the GroupByAttribute to group the related findings in the insight.
*/
createInsight(callback?: (err: AWSError, data: SecurityHub.Types.CreateInsightResponse) => void): Request<SecurityHub.Types.CreateInsightResponse, AWSError>;
/**
* Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. You can use the EnableSecurityHub to enable Security Hub. After you use CreateMembers to create member account associations in Security Hub, you need to use the InviteMembers action, which invites the accounts to enable Security Hub and become member accounts in Security Hub. If the invitation is accepted by the account owner, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start being sent to both the member and master accounts. You can remove the association between the master and member accounts by using the DisassociateFromMasterAccount or DisassociateMembers operation.
*/
createMembers(params: SecurityHub.Types.CreateMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateMembersResponse) => void): Request<SecurityHub.Types.CreateMembersResponse, AWSError>;
/**
* Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. You can use the EnableSecurityHub to enable Security Hub. After you use CreateMembers to create member account associations in Security Hub, you need to use the InviteMembers action, which invites the accounts to enable Security Hub and become member accounts in Security Hub. If the invitation is accepted by the account owner, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start being sent to both the member and master accounts. You can remove the association between the master and member accounts by using the DisassociateFromMasterAccount or DisassociateMembers operation.
*/
createMembers(callback?: (err: AWSError, data: SecurityHub.Types.CreateMembersResponse) => void): Request<SecurityHub.Types.CreateMembersResponse, AWSError>;
/**
* Declines invitations to become a member account.
*/
declineInvitations(params: SecurityHub.Types.DeclineInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeclineInvitationsResponse) => void): Request<SecurityHub.Types.DeclineInvitationsResponse, AWSError>;
/**
* Declines invitations to become a member account.
*/
declineInvitations(callback?: (err: AWSError, data: SecurityHub.Types.DeclineInvitationsResponse) => void): Request<SecurityHub.Types.DeclineInvitationsResponse, AWSError>;
/**
* Deletes a custom action target from Security Hub. Deleting a custom action target doesn't affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.
*/
deleteActionTarget(params: SecurityHub.Types.DeleteActionTargetRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteActionTargetResponse) => void): Request<SecurityHub.Types.DeleteActionTargetResponse, AWSError>;
/**
* Deletes a custom action target from Security Hub. Deleting a custom action target doesn't affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.
*/
deleteActionTarget(callback?: (err: AWSError, data: SecurityHub.Types.DeleteActionTargetResponse) => void): Request<SecurityHub.Types.DeleteActionTargetResponse, AWSError>;
/**
* Deletes the insight specified by the InsightArn.
*/
deleteInsight(params: SecurityHub.Types.DeleteInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteInsightResponse) => void): Request<SecurityHub.Types.DeleteInsightResponse, AWSError>;
/**
* Deletes the insight specified by the InsightArn.
*/
deleteInsight(callback?: (err: AWSError, data: SecurityHub.Types.DeleteInsightResponse) => void): Request<SecurityHub.Types.DeleteInsightResponse, AWSError>;
/**
* Deletes invitations received by the AWS account to become a member account.
*/
deleteInvitations(params: SecurityHub.Types.DeleteInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteInvitationsResponse) => void): Request<SecurityHub.Types.DeleteInvitationsResponse, AWSError>;
/**
* Deletes invitations received by the AWS account to become a member account.
*/
deleteInvitations(callback?: (err: AWSError, data: SecurityHub.Types.DeleteInvitationsResponse) => void): Request<SecurityHub.Types.DeleteInvitationsResponse, AWSError>;
/**
* Deletes the specified member accounts from Security Hub.
*/
deleteMembers(params: SecurityHub.Types.DeleteMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteMembersResponse) => void): Request<SecurityHub.Types.DeleteMembersResponse, AWSError>;
/**
* Deletes the specified member accounts from Security Hub.
*/
deleteMembers(callback?: (err: AWSError, data: SecurityHub.Types.DeleteMembersResponse) => void): Request<SecurityHub.Types.DeleteMembersResponse, AWSError>;
/**
* Returns a list of the custom action targets in Security Hub in your account.
*/
describeActionTargets(params: SecurityHub.Types.DescribeActionTargetsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeActionTargetsResponse) => void): Request<SecurityHub.Types.DescribeActionTargetsResponse, AWSError>;
/**
* Returns a list of the custom action targets in Security Hub in your account.
*/
describeActionTargets(callback?: (err: AWSError, data: SecurityHub.Types.DescribeActionTargetsResponse) => void): Request<SecurityHub.Types.DescribeActionTargetsResponse, AWSError>;
/**
* Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.
*/
describeHub(params: SecurityHub.Types.DescribeHubRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeHubResponse) => void): Request<SecurityHub.Types.DescribeHubResponse, AWSError>;
/**
* Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.
*/
describeHub(callback?: (err: AWSError, data: SecurityHub.Types.DescribeHubResponse) => void): Request<SecurityHub.Types.DescribeHubResponse, AWSError>;
/**
* Returns information about the products available that you can subscribe to and integrate with Security Hub to consolidate findings.
*/
describeProducts(params: SecurityHub.Types.DescribeProductsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeProductsResponse) => void): Request<SecurityHub.Types.DescribeProductsResponse, AWSError>;
/**
* Returns information about the products available that you can subscribe to and integrate with Security Hub to consolidate findings.
*/
describeProducts(callback?: (err: AWSError, data: SecurityHub.Types.DescribeProductsResponse) => void): Request<SecurityHub.Types.DescribeProductsResponse, AWSError>;
/**
* Disables the integration of the specified product with Security Hub. Findings from that product are no longer sent to Security Hub after the integration is disabled.
*/
disableImportFindingsForProduct(params: SecurityHub.Types.DisableImportFindingsForProductRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisableImportFindingsForProductResponse) => void): Request<SecurityHub.Types.DisableImportFindingsForProductResponse, AWSError>;
/**
* Disables the integration of the specified product with Security Hub. Findings from that product are no longer sent to Security Hub after the integration is disabled.
*/
disableImportFindingsForProduct(callback?: (err: AWSError, data: SecurityHub.Types.DisableImportFindingsForProductResponse) => void): Request<SecurityHub.Types.DisableImportFindingsForProductResponse, AWSError>;
/**
* Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts. When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and can't be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.
*/
disableSecurityHub(params: SecurityHub.Types.DisableSecurityHubRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisableSecurityHubResponse) => void): Request<SecurityHub.Types.DisableSecurityHubResponse, AWSError>;
/**
* Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts. When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and can't be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.
*/
disableSecurityHub(callback?: (err: AWSError, data: SecurityHub.Types.DisableSecurityHubResponse) => void): Request<SecurityHub.Types.DisableSecurityHubResponse, AWSError>;
/**
* Disassociates the current Security Hub member account from the associated master account.
*/
disassociateFromMasterAccount(params: SecurityHub.Types.DisassociateFromMasterAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisassociateFromMasterAccountResponse) => void): Request<SecurityHub.Types.DisassociateFromMasterAccountResponse, AWSError>;
/**
* Disassociates the current Security Hub member account from the associated master account.
*/
disassociateFromMasterAccount(callback?: (err: AWSError, data: SecurityHub.Types.DisassociateFromMasterAccountResponse) => void): Request<SecurityHub.Types.DisassociateFromMasterAccountResponse, AWSError>;
/**
* Disassociates the specified member accounts from the associated master account.
*/
disassociateMembers(params: SecurityHub.Types.DisassociateMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisassociateMembersResponse) => void): Request<SecurityHub.Types.DisassociateMembersResponse, AWSError>;
/**
* Disassociates the specified member accounts from the associated master account.
*/
disassociateMembers(callback?: (err: AWSError, data: SecurityHub.Types.DisassociateMembersResponse) => void): Request<SecurityHub.Types.DisassociateMembersResponse, AWSError>;
/**
* Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permission policy that grants permission for the product to send findings to Security Hub is applied.
*/
enableImportFindingsForProduct(params: SecurityHub.Types.EnableImportFindingsForProductRequest, callback?: (err: AWSError, data: SecurityHub.Types.EnableImportFindingsForProductResponse) => void): Request<SecurityHub.Types.EnableImportFindingsForProductResponse, AWSError>;
/**
* Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permission policy that grants permission for the product to send findings to Security Hub is applied.
*/
enableImportFindingsForProduct(callback?: (err: AWSError, data: SecurityHub.Types.EnableImportFindingsForProductResponse) => void): Request<SecurityHub.Types.EnableImportFindingsForProductResponse, AWSError>;
/**
* Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie. To learn more, see Setting Up AWS Security Hub.
*/
enableSecurityHub(params: SecurityHub.Types.EnableSecurityHubRequest, callback?: (err: AWSError, data: SecurityHub.Types.EnableSecurityHubResponse) => void): Request<SecurityHub.Types.EnableSecurityHubResponse, AWSError>;
/**
* Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie. To learn more, see Setting Up AWS Security Hub.
*/
enableSecurityHub(callback?: (err: AWSError, data: SecurityHub.Types.EnableSecurityHubResponse) => void): Request<SecurityHub.Types.EnableSecurityHubResponse, AWSError>;
/**
* Returns a list of the standards that are currently enabled.
*/
getEnabledStandards(params: SecurityHub.Types.GetEnabledStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetEnabledStandardsResponse) => void): Request<SecurityHub.Types.GetEnabledStandardsResponse, AWSError>;
/**
* Returns a list of the standards that are currently enabled.
*/
getEnabledStandards(callback?: (err: AWSError, data: SecurityHub.Types.GetEnabledStandardsResponse) => void): Request<SecurityHub.Types.GetEnabledStandardsResponse, AWSError>;
/**
* Returns a list of findings that match the specified criteria.
*/
getFindings(params: SecurityHub.Types.GetFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetFindingsResponse) => void): Request<SecurityHub.Types.GetFindingsResponse, AWSError>;
/**
* Returns a list of findings that match the specified criteria.
*/
getFindings(callback?: (err: AWSError, data: SecurityHub.Types.GetFindingsResponse) => void): Request<SecurityHub.Types.GetFindingsResponse, AWSError>;
/**
* Lists the results of the Security Hub insight that the insight ARN specifies.
*/
getInsightResults(params: SecurityHub.Types.GetInsightResultsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInsightResultsResponse) => void): Request<SecurityHub.Types.GetInsightResultsResponse, AWSError>;
/**
* Lists the results of the Security Hub insight that the insight ARN specifies.
*/
getInsightResults(callback?: (err: AWSError, data: SecurityHub.Types.GetInsightResultsResponse) => void): Request<SecurityHub.Types.GetInsightResultsResponse, AWSError>;
/**
* Lists and describes insights that insight ARNs specify.
*/
getInsights(params: SecurityHub.Types.GetInsightsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInsightsResponse) => void): Request<SecurityHub.Types.GetInsightsResponse, AWSError>;
/**
* Lists and describes insights that insight ARNs specify.
*/
getInsights(callback?: (err: AWSError, data: SecurityHub.Types.GetInsightsResponse) => void): Request<SecurityHub.Types.GetInsightsResponse, AWSError>;
/**
* Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
*/
getInvitationsCount(params: SecurityHub.Types.GetInvitationsCountRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInvitationsCountResponse) => void): Request<SecurityHub.Types.GetInvitationsCountResponse, AWSError>;
/**
* Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
*/
getInvitationsCount(callback?: (err: AWSError, data: SecurityHub.Types.GetInvitationsCountResponse) => void): Request<SecurityHub.Types.GetInvitationsCountResponse, AWSError>;
/**
* Provides the details for the Security Hub master account to the current member account.
*/
getMasterAccount(params: SecurityHub.Types.GetMasterAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetMasterAccountResponse) => void): Request<SecurityHub.Types.GetMasterAccountResponse, AWSError>;
/**
* Provides the details for the Security Hub master account to the current member account.
*/
getMasterAccount(callback?: (err: AWSError, data: SecurityHub.Types.GetMasterAccountResponse) => void): Request<SecurityHub.Types.GetMasterAccountResponse, AWSError>;
/**
* Returns the details on the Security Hub member accounts that the account IDs specify.
*/
getMembers(params: SecurityHub.Types.GetMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetMembersResponse) => void): Request<SecurityHub.Types.GetMembersResponse, AWSError>;
/**
* Returns the details on the Security Hub member accounts that the account IDs specify.
*/
getMembers(callback?: (err: AWSError, data: SecurityHub.Types.GetMembersResponse) => void): Request<SecurityHub.Types.GetMembersResponse, AWSError>;
/**
* Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from. Before you can use this action to invite a member, you must first create the member account in Security Hub by using the CreateMembers action. When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from member account.
*/
inviteMembers(params: SecurityHub.Types.InviteMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.InviteMembersResponse) => void): Request<SecurityHub.Types.InviteMembersResponse, AWSError>;
/**
* Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from. Before you can use this action to invite a member, you must first create the member account in Security Hub by using the CreateMembers action. When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from member account.
*/
inviteMembers(callback?: (err: AWSError, data: SecurityHub.Types.InviteMembersResponse) => void): Request<SecurityHub.Types.InviteMembersResponse, AWSError>;
/**
* Lists all findings-generating solutions (products) whose findings you have subscribed to receive in Security Hub.
*/
listEnabledProductsForImport(params: SecurityHub.Types.ListEnabledProductsForImportRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListEnabledProductsForImportResponse) => void): Request<SecurityHub.Types.ListEnabledProductsForImportResponse, AWSError>;
/**
* Lists all findings-generating solutions (products) whose findings you have subscribed to receive in Security Hub.
*/
listEnabledProductsForImport(callback?: (err: AWSError, data: SecurityHub.Types.ListEnabledProductsForImportResponse) => void): Request<SecurityHub.Types.ListEnabledProductsForImportResponse, AWSError>;
/**
* Lists all Security Hub membership invitations that were sent to the current AWS account.
*/
listInvitations(params: SecurityHub.Types.ListInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListInvitationsResponse) => void): Request<SecurityHub.Types.ListInvitationsResponse, AWSError>;
/**
* Lists all Security Hub membership invitations that were sent to the current AWS account.
*/
listInvitations(callback?: (err: AWSError, data: SecurityHub.Types.ListInvitationsResponse) => void): Request<SecurityHub.Types.ListInvitationsResponse, AWSError>;
/**
* Lists details about all member accounts for the current Security Hub master account.
*/
listMembers(params: SecurityHub.Types.ListMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListMembersResponse) => void): Request<SecurityHub.Types.ListMembersResponse, AWSError>;
/**
* Lists details about all member accounts for the current Security Hub master account.
*/
listMembers(callback?: (err: AWSError, data: SecurityHub.Types.ListMembersResponse) => void): Request<SecurityHub.Types.ListMembersResponse, AWSError>;
/**
* Returns a list of tags associated with a resource.
*/
listTagsForResource(params: SecurityHub.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListTagsForResourceResponse) => void): Request<SecurityHub.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of tags associated with a resource.
*/
listTagsForResource(callback?: (err: AWSError, data: SecurityHub.Types.ListTagsForResourceResponse) => void): Request<SecurityHub.Types.ListTagsForResourceResponse, AWSError>;
/**
* Adds one or more tags to a resource.
*/
tagResource(params: SecurityHub.Types.TagResourceRequest, callback?: (err: AWSError, data: SecurityHub.Types.TagResourceResponse) => void): Request<SecurityHub.Types.TagResourceResponse, AWSError>;
/**
* Adds one or more tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: SecurityHub.Types.TagResourceResponse) => void): Request<SecurityHub.Types.TagResourceResponse, AWSError>;
/**
* Removes one or more tags from a resource.
*/
untagResource(params: SecurityHub.Types.UntagResourceRequest, callback?: (err: AWSError, data: SecurityHub.Types.UntagResourceResponse) => void): Request<SecurityHub.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: SecurityHub.Types.UntagResourceResponse) => void): Request<SecurityHub.Types.UntagResourceResponse, AWSError>;
/**
* Updates the name and description of a custom action target in Security Hub.
*/
updateActionTarget(params: SecurityHub.Types.UpdateActionTargetRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateActionTargetResponse) => void): Request<SecurityHub.Types.UpdateActionTargetResponse, AWSError>;
/**
* Updates the name and description of a custom action target in Security Hub.
*/
updateActionTarget(callback?: (err: AWSError, data: SecurityHub.Types.UpdateActionTargetResponse) => void): Request<SecurityHub.Types.UpdateActionTargetResponse, AWSError>;
/**
* Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
*/
updateFindings(params: SecurityHub.Types.UpdateFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateFindingsResponse) => void): Request<SecurityHub.Types.UpdateFindingsResponse, AWSError>;
/**
* Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
*/
updateFindings(callback?: (err: AWSError, data: SecurityHub.Types.UpdateFindingsResponse) => void): Request<SecurityHub.Types.UpdateFindingsResponse, AWSError>;
/**
* Updates the Security Hub insight that the insight ARN specifies.
*/
updateInsight(params: SecurityHub.Types.UpdateInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateInsightResponse) => void): Request<SecurityHub.Types.UpdateInsightResponse, AWSError>;
/**
* Updates the Security Hub insight that the insight ARN specifies.
*/
updateInsight(callback?: (err: AWSError, data: SecurityHub.Types.UpdateInsightResponse) => void): Request<SecurityHub.Types.UpdateInsightResponse, AWSError>;
}
declare namespace SecurityHub {
export interface AcceptInvitationRequest {
/**
* The account ID of the Security Hub master account that sent the invitation.
*/
MasterId: NonEmptyString;
/**
* The ID of the invitation sent from the Security Hub master account.
*/
InvitationId: NonEmptyString;
}
export interface AcceptInvitationResponse {
}
export interface AccountDetails {
/**
* The ID of an AWS account.
*/
AccountId?: AccountId;
/**
* The email of an AWS account.
*/
Email?: NonEmptyString;
}
export type AccountDetailsList = AccountDetails[];
export type AccountId = string;
export type AccountIdList = NonEmptyString[];
export interface ActionTarget {
/**
* The ARN for the target action.
*/
ActionTargetArn: NonEmptyString;
/**
* The name of the action target.
*/
Name: NonEmptyString;
/**
* The description of the target action.
*/
Description: NonEmptyString;
}
export type ActionTargetList = ActionTarget[];
export type ArnList = NonEmptyString[];
export interface AwsEc2InstanceDetails {
/**
* The instance type of the instance.
*/
Type?: NonEmptyString;
/**
* The Amazon Machine Image (AMI) ID of the instance.
*/
ImageId?: NonEmptyString;
/**
* The IPv4 addresses associated with the instance.
*/
IpV4Addresses?: StringList;
/**
* The IPv6 addresses associated with the instance.
*/
IpV6Addresses?: StringList;
/**
* The key name associated with the instance.
*/
KeyName?: NonEmptyString;
/**
* The IAM profile ARN of the instance.
*/
IamInstanceProfileArn?: NonEmptyString;
/**
* The identifier of the VPC that the instance was launched in.
*/
VpcId?: NonEmptyString;
/**
* The identifier of the subnet that the instance was launched in.
*/
SubnetId?: NonEmptyString;
/**
* The date/time the instance was launched.
*/
LaunchedAt?: NonEmptyString;
}
export interface AwsIamAccessKeyDetails {
/**
* The user associated with the IAM access key related to a finding.
*/
UserName?: NonEmptyString;
/**
* The status of the IAM access key related to a finding.
*/
Status?: AwsIamAccessKeyStatus;
/**
* The creation date/time of the IAM access key related to a finding.
*/
CreatedAt?: NonEmptyString;
}
export type AwsIamAccessKeyStatus = "Active"|"Inactive"|string;
export interface AwsS3BucketDetails {
/**
* The canonical user ID of the owner of the S3 bucket.
*/
OwnerId?: NonEmptyString;
/**
* The display name of the owner of the S3 bucket.
*/
OwnerName?: NonEmptyString;
}
export interface AwsSecurityFinding {
/**
* The schema version that a finding is formatted for.
*/
SchemaVersion: NonEmptyString;
/**
* The security findings provider-specific identifier for a finding.
*/
Id: NonEmptyString;
/**
* The ARN generated by Security Hub that uniquely identifies a third-party company (security-findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.
*/
ProductArn: NonEmptyString;
/**
* The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.
*/
GeneratorId: NonEmptyString;
/**
* The AWS account ID that a finding is generated in.
*/
AwsAccountId: NonEmptyString;
/**
* One or more finding types in the format of namespace/category/classifier that classify a finding. Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
*/
Types: TypeList;
/**
* An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.
*/
FirstObservedAt?: NonEmptyString;
/**
* An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.
*/
LastObservedAt?: NonEmptyString;
/**
* An ISO8601-formatted timestamp that indicates when the security-findings provider created the potential security issue that a finding captured.
*/
CreatedAt: NonEmptyString;
/**
* An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.
*/
UpdatedAt: NonEmptyString;
/**
* A finding's severity.
*/
Severity: Severity;
/**
* A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
*/
Confidence?: Integer;
/**
* The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
*/
Criticality?: Integer;
/**
* A finding's title. In this release, Title is a required property.
*/
Title: NonEmptyString;
/**
* A finding's description. In this release, Description is a required property.
*/
Description: NonEmptyString;
/**
* A data type that describes the remediation options for a finding.
*/
Remediation?: Remediation;
/**
* A URL that links to a page about the current finding in the security-findings provider's solution.
*/
SourceUrl?: NonEmptyString;
/**
* A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.
*/
ProductFields?: FieldMap;
/**
* A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
*/
UserDefinedFields?: FieldMap;
/**
* A list of malware related to a finding.
*/
Malware?: MalwareList;
/**
* The details of network-related information about a finding.
*/
Network?: Network;
/**
* The details of process-related information about a finding.
*/
Process?: ProcessDetails;
/**
* Threat intel details related to a finding.
*/
ThreatIntelIndicators?: ThreatIntelIndicatorList;
/**
* A set of resource data types that describe the resources that the finding refers to.
*/
Resources: ResourceList;
/**
* This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.
*/
Compliance?: Compliance;
/**
* Indicates the veracity of a finding.
*/
VerificationState?: VerificationState;
/**
* The workflow state of a finding.
*/
WorkflowState?: WorkflowState;
/**
* The record state of a finding.
*/
RecordState?: RecordState;
/**
* A list of related findings.
*/
RelatedFindings?: RelatedFindingList;
/**
* A user-defined note added to a finding.
*/
Note?: Note;
}
export interface AwsSecurityFindingFilters {
/**
* The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.
*/
ProductArn?: StringFilterList;
/**
* The AWS account ID that a finding is generated in.
*/
AwsAccountId?: StringFilterList;
/**
* The security findings provider-specific identifier for a finding.
*/
Id?: StringFilterList;
/**
* The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.
*/
GeneratorId?: StringFilterList;
/**
* A finding type in the format of namespace/category/classifier that classifies a finding.
*/
Type?: StringFilterList;
/**
* An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.
*/
FirstObservedAt?: DateFilterList;
/**
* An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.
*/
LastObservedAt?: DateFilterList;
/**
* An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.
*/
CreatedAt?: DateFilterList;
/**
* An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.
*/
UpdatedAt?: DateFilterList;
/**
* The native severity as defined by the security-findings provider's solution that generated the finding.
*/
SeverityProduct?: NumberFilterList;
/**
* The normalized severity of a finding.
*/
SeverityNormalized?: NumberFilterList;
/**
* The label of a finding's severity.
*/
SeverityLabel?: StringFilterList;
/**
* A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
*/
Confidence?: NumberFilterList;
/**
* The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
*/
Criticality?: NumberFilterList;
/**
* A finding's title.
*/
Title?: StringFilterList;
/**
* A finding's description.
*/
Description?: StringFilterList;
/**
* The recommendation of what to do about the issue described in a finding.
*/
RecommendationText?: StringFilterList;
/**
* A URL that links to a page about the current finding in the security-findings provider's solution.
*/
SourceUrl?: StringFilterList;
/**
* A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.
*/
ProductFields?: MapFilterList;
/**
* The name of the solution (product) that generates findings.
*/
ProductName?: StringFilterList;
/**
* The name of the findings provider (company) that owns the solution (product) that generates findings.
*/
CompanyName?: StringFilterList;
/**
* A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
*/
UserDefinedFields?: MapFilterList;
/**
* The name of the malware that was observed.
*/
MalwareName?: StringFilterList;
/**
* The type of the malware that was observed.
*/
MalwareType?: StringFilterList;
/**
* The filesystem path of the malware that was observed.
*/
MalwarePath?: StringFilterList;
/**
* The state of the malware that was observed.
*/
MalwareState?: StringFilterList;
/**
* Indicates the direction of network traffic associated with a finding.
*/
NetworkDirection?: StringFilterList;
/**
* The protocol of network-related information about a finding.
*/
NetworkProtocol?: StringFilterList;
/**
* The source IPv4 address of network-related information about a finding.
*/
NetworkSourceIpV4?: IpFilterList;
/**
* The source IPv6 address of network-related information about a finding.
*/
NetworkSourceIpV6?: IpFilterList;
/**
* The source port of network-related information about a finding.
*/
NetworkSourcePort?: NumberFilterList;
/**
* The source domain of network-related information about a finding.
*/
NetworkSourceDomain?: StringFilterList;
/**
* The source media access control (MAC) address of network-related information about a finding.
*/
NetworkSourceMac?: StringFilterList;
/**
* The destination IPv4 address of network-related information about a finding.
*/
NetworkDestinationIpV4?: IpFilterList;
/**
* The destination IPv6 address of network-related information about a finding.
*/
NetworkDestinationIpV6?: IpFilterList;
/**
* The destination port of network-related information about a finding.
*/
NetworkDestinationPort?: NumberFilterList;
/**
* The destination domain of network-related information about a finding.
*/
NetworkDestinationDomain?: StringFilterList;
/**
* The name of the process.
*/
ProcessName?: StringFilterList;
/**
* The path to the process executable.
*/
ProcessPath?: StringFilterList;
/**
* The process ID.
*/
ProcessPid?: NumberFilterList;
/**
* The parent process ID.
*/
ProcessParentPid?: NumberFilterList;
/**
* The date/time that the process was launched.
*/
ProcessLaunchedAt?: DateFilterList;
/**
* The date/time that the process was terminated.
*/
ProcessTerminatedAt?: DateFilterList;
/**
* The type of a threat intel indicator.
*/
ThreatIntelIndicatorType?: StringFilterList;
/**
* The value of a threat intel indicator.
*/
ThreatIntelIndicatorValue?: StringFilterList;
/**
* The category of a threat intel indicator.
*/
ThreatIntelIndicatorCategory?: StringFilterList;
/**
* The date/time of the last observation of a threat intel indicator.
*/
ThreatIntelIndicatorLastObservedAt?: DateFilterList;
/**
* The source of the threat intel.
*/
ThreatIntelIndicatorSource?: StringFilterList;
/**
* The URL for more details from the source of the threat intel.
*/
ThreatIntelIndicatorSourceUrl?: StringFilterList;
/**
* Specifies the type of the resource that details are provided for.
*/
ResourceType?: StringFilterList;
/**
* The canonical identifier for the given resource type.
*/
ResourceId?: StringFilterList;
/**
* The canonical AWS partition name that the Region is assigned to.
*/
ResourcePartition?: StringFilterList;
/**
* The canonical AWS external Region name where this resource is located.
*/
ResourceRegion?: StringFilterList;
/**
* A list of AWS tags associated with a resource at the time the finding was processed.
*/
ResourceTags?: MapFilterList;
/**
* The instance type of the instance.
*/
ResourceAwsEc2InstanceType?: StringFilterList;
/**
* The Amazon Machine Image (AMI) ID of the instance.
*/
ResourceAwsEc2InstanceImageId?: StringFilterList;
/**
* The IPv4 addresses associated with the instance.
*/
ResourceAwsEc2InstanceIpV4Addresses?: IpFilterList;
/**
* The IPv6 addresses associated with the instance.
*/
ResourceAwsEc2InstanceIpV6Addresses?: IpFilterList;
/**
* The key name associated with the instance.
*/
ResourceAwsEc2InstanceKeyName?: StringFilterList;
/**
* The IAM profile ARN of the instance.
*/
ResourceAwsEc2InstanceIamInstanceProfileArn?: StringFilterList;
/**
* The identifier of the VPC that the instance was launched in.
*/
ResourceAwsEc2InstanceVpcId?: StringFilterList;
/**
* The identifier of the subnet that the instance was launched in.
*/
ResourceAwsEc2InstanceSubnetId?: StringFilterList;
/**
* The date/time the instance was launched.
*/
ResourceAwsEc2InstanceLaunchedAt?: DateFilterList;
/**
* The canonical user ID of the owner of the S3 bucket.
*/
ResourceAwsS3BucketOwnerId?: StringFilterList;
/**
* The display name of the owner of the S3 bucket.
*/
ResourceAwsS3BucketOwnerName?: StringFilterList;
/**
* The user associated with the IAM access key related to a finding.
*/
ResourceAwsIamAccessKeyUserName?: StringFilterList;
/**
* The status of the IAM access key related to a finding.
*/
ResourceAwsIamAccessKeyStatus?: StringFilterList;
/**
* The creation date/time of the IAM access key related to a finding.
*/
ResourceAwsIamAccessKeyCreatedAt?: DateFilterList;
/**
* The name of the container related to a finding.
*/
ResourceContainerName?: StringFilterList;
/**
* The identifier of the image related to a finding.
*/
ResourceContainerImageId?: StringFilterList;
/**
* The name of the image related to a finding.
*/
ResourceContainerImageName?: StringFilterList;
/**
* The date/time that the container was started.
*/
ResourceContainerLaunchedAt?: DateFilterList;
/**
* The details of a resource that doesn't have a specific subfield for the resource type defined.
*/
ResourceDetailsOther?: MapFilterList;
/**
* Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.
*/
ComplianceStatus?: StringFilterList;
/**
* The veracity of a finding.
*/
VerificationState?: StringFilterList;
/**
* The workflow state of a finding.
*/
WorkflowState?: StringFilterList;
/**
* The updated record state for the finding.
*/
RecordState?: StringFilterList;
/**
* The ARN of the solution that generated a related finding.
*/
RelatedFindingsProductArn?: StringFilterList;
/**
* The solution-generated identifier for a related finding.
*/
RelatedFindingsId?: StringFilterList;
/**
* The text of a note.
*/
NoteText?: StringFilterList;
/**
* The timestamp of when the note was updated.
*/
NoteUpdatedAt?: DateFilterList;
/**
* The principal that created a note.
*/
NoteUpdatedBy?: StringFilterList;
/**
* A keyword for a finding.
*/
Keyword?: KeywordFilterList;
}
export type AwsSecurityFindingList = AwsSecurityFinding[];
export interface BatchDisableStandardsRequest {
/**
* The ARNs of the standards subscriptions to disable.
*/
StandardsSubscriptionArns: StandardsSubscriptionArns;
}
export interface BatchDisableStandardsResponse {
/**
* The details of the standards subscriptions that were disabled.
*/
StandardsSubscriptions?: StandardsSubscriptions;
}
export interface BatchEnableStandardsRequest {
/**
* The list of standards compliance checks to enable. In this release, Security Hub supports only the CIS AWS Foundations standard. The ARN for the standard is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.
*/
StandardsSubscriptionRequests: StandardsSubscriptionRequests;
}
export interface BatchEnableStandardsResponse {
/**
* The details of the standards subscriptions that were enabled.
*/
StandardsSubscriptions?: StandardsSubscriptions;
}
export interface BatchImportFindingsRequest {
/**
* A list of findings to import. To successfully import a finding, it must follow the AWS Security Finding Format.
*/
Findings: AwsSecurityFindingList;
}
export interface BatchImportFindingsResponse {
/**
* The number of findings that failed to import.
*/
FailedCount: Integer;
/**
* The number of findings that were successfully imported.
*/
SuccessCount: Integer;
/**
* The list of the findings that failed to import.
*/
FailedFindings?: ImportFindingsErrorList;
}
export type Boolean = boolean;
export type CategoryList = NonEmptyString[];
export interface Compliance {
/**
* The result of a compliance check.
*/
Status?: ComplianceStatus;
}
export type ComplianceStatus = "PASSED"|"WARNING"|"FAILED"|"NOT_AVAILABLE"|string;
export interface ContainerDetails {
/**
* The name of the container related to a finding.
*/
Name?: NonEmptyString;
/**
* The identifier of the image related to a finding.
*/
ImageId?: NonEmptyString;
/**
* The name of the image related to a finding.
*/
ImageName?: NonEmptyString;
/**
* The date and time when the container started.
*/
LaunchedAt?: NonEmptyString;
}
export interface CreateActionTargetRequest {
/**
* The name of the custom action target.
*/
Name: NonEmptyString;
/**
* The description for the custom action target.
*/
Description: NonEmptyString;
/**
* The ID for the custom action target.
*/
Id: NonEmptyString;
}
export interface CreateActionTargetResponse {
/**
* The ARN for the custom action target.
*/
ActionTargetArn: NonEmptyString;
}
export interface CreateInsightRequest {
/**
* The name of the custom insight to create.
*/
Name: NonEmptyString;
/**
* One or more attributes used to filter the findings included in the insight. Only findings that match the criteria defined in the filters are included in the insight.
*/
Filters: AwsSecurityFindingFilters;
/**
* The attribute used as the aggregator to group related findings for the insight.
*/
GroupByAttribute: NonEmptyString;
}
export interface CreateInsightResponse {
/**
* The ARN of the insight created.
*/
InsightArn: NonEmptyString;
}
export interface CreateMembersRequest {
/**
* A list of account ID and email address pairs of the accounts to associate with the Security Hub master account.
*/
AccountDetails?: AccountDetailsList;
}
export interface CreateMembersResponse {
/**
* A list of account ID and email address pairs of the AWS accounts that weren't processed.
*/
UnprocessedAccounts?: ResultList;
}
export interface DateFilter {
/**
* A start date for the date filter.
*/
Start?: NonEmptyString;
/**
* An end date for the date filter.
*/
End?: NonEmptyString;
/**
* A date range for the date filter.
*/
DateRange?: DateRange;
}
export type DateFilterList = DateFilter[];
export interface DateRange {
/**
* A date range value for the date filter.
*/
Value?: Integer;
/**
* A date range unit for the date filter.
*/
Unit?: DateRangeUnit;
}
export type DateRangeUnit = "DAYS"|string;
export interface DeclineInvitationsRequest {
/**
* A list of account IDs that specify the accounts that invitations to Security Hub are declined from.
*/
AccountIds: AccountIdList;
}
export interface DeclineInvitationsResponse {
/**
* A list of account ID and email address pairs of the AWS accounts that weren't processed.
*/
UnprocessedAccounts?: ResultList;
}
export interface DeleteActionTargetRequest {
/**
* The ARN of the custom action target to delete.
*/
ActionTargetArn: NonEmptyString;
}
export interface DeleteActionTargetResponse {
/**
* The ARN of the custom action target that was deleted.
*/
ActionTargetArn: NonEmptyString;
}
export interface DeleteInsightRequest {
/**
* The ARN of the insight to delete.
*/
InsightArn: NonEmptyString;
}
export interface DeleteInsightResponse {
/**
* The ARN of the insight that was deleted.
*/
InsightArn: NonEmptyString;
}
export interface DeleteInvitationsRequest {
/**
* A list of the account IDs that sent the invitations to delete.
*/
AccountIds: AccountIdList;
}
export interface DeleteInvitationsResponse {
/**
* A list of account ID and email address pairs of the AWS accounts that invitations weren't deleted for.
*/
UnprocessedAccounts?: ResultList;
}
export interface DeleteMembersRequest {
/**
* A list of account IDs of the member accounts to delete.
*/
AccountIds?: AccountIdList;
}
export interface DeleteMembersResponse {
/**
* A list of account ID and email address pairs of the AWS accounts that weren't deleted.
*/
UnprocessedAccounts?: ResultList;
}
export interface DescribeActionTargetsRequest {
/**
* A list of custom action target ARNs for the custom action targets to retrieve.
*/
ActionTargetArns?: ArnList;
/**
* The token that is required for pagination.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return.
*/
MaxResults?: MaxResults;
}
export interface DescribeActionTargetsResponse {
/**
* A list of ActionTarget objects. Each object includes the ActionTargetArn, Description, and Name of a custom action target available in Security Hub.
*/
ActionTargets: ActionTargetList;
/**
* The token that is required for pagination.
*/
NextToken?: NextToken;
}
export interface DescribeHubRequest {
/**
* The ARN of the Hub resource to retrieve.
*/
HubArn?: NonEmptyString;
}
export interface DescribeHubResponse {
/**
* The ARN of the Hub resource retrieved.
*/
HubArn?: NonEmptyString;
/**
* The date and time when Security Hub was enabled in the account.
*/
SubscribedAt?: NonEmptyString;
}
export interface DescribeProductsRequest {
/**
* The token that is required for pagination.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return.
*/
MaxResults?: MaxResults;
}
export interface DescribeProductsResponse {
/**
* A list of products, including details for each product.
*/
Products: ProductsList;
/**
* The token that is required for pagination.
*/
NextToken?: NextToken;
}
export interface DisableImportFindingsForProductRequest {
/**
* The ARN of the integrated product to disable the integration for.
*/
ProductSubscriptionArn: NonEmptyString;
}
export interface DisableImportFindingsForProductResponse {
}
export interface DisableSecurityHubRequest {
}
export interface DisableSecurityHubResponse {
}
export interface DisassociateFromMasterAccountRequest {
}
export interface DisassociateFromMasterAccountResponse {
}
export interface DisassociateMembersRequest {
/**
* The account IDs of the member accounts to disassociate from the master account.
*/
AccountIds?: AccountIdList;
}
export interface DisassociateMembersResponse {
}
export type Double = number;
export interface EnableImportFindingsForProductRequest {
/**
* The ARN of the product to enable the integration for.
*/
ProductArn: NonEmptyString;
}
export interface EnableImportFindingsForProductResponse {
/**
* The ARN of your subscription to the product to enable integrations for.
*/
ProductSubscriptionArn?: NonEmptyString;
}
export interface EnableSecurityHubRequest {
/**
* The tags to add to the Hub resource when you enable Security Hub.
*/
Tags?: TagMap;
}
export interface EnableSecurityHubResponse {
}
export type FieldMap = {[key: string]: NonEmptyString};
export interface GetEnabledStandardsRequest {
/**
* A list of the standards subscription ARNs for the standards to retrieve.
*/
StandardsSubscriptionArns?: StandardsSubscriptionArns;
/**
* Paginates results. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in the response.
*/
MaxResults?: MaxResults;
}
export interface GetEnabledStandardsResponse {
/**
* A list of StandardsSubscriptions objects that include information about the enabled standards.
*/
StandardsSubscriptions?: StandardsSubscriptions;
/**
* The token that is required for pagination.
*/
NextToken?: NextToken;
}
export interface GetFindingsRequest {
/**
* The findings attributes used to define a condition to filter the findings returned.
*/
Filters?: AwsSecurityFindingFilters;
/**
* Findings attributes used to sort the list of findings returned.
*/
SortCriteria?: SortCriteria;
/**
* Paginates results. On your first call to the GetFindings operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
*/
NextToken?: NextToken;
/**
* The maximum number of findings to return.
*/
MaxResults?: MaxResults;
}
export interface GetFindingsResponse {
/**
* The findings that matched the filters specified in the request.
*/
Findings: AwsSecurityFindingList;
/**
* The token that is required for pagination.
*/
NextToken?: NextToken;
}
export interface GetInsightResultsRequest {
/**
* The ARN of the insight whose results you want to see.
*/
InsightArn: NonEmptyString;
}
export interface GetInsightResultsResponse {
/**
* The insight results returned by the operation.
*/
InsightResults: InsightResults;
}
export interface GetInsightsRequest {
/**
* The ARNs of the insights that you want to describe.
*/
InsightArns?: ArnList;
/**
* Paginates results. On your first call to the GetInsights operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
*/
NextToken?: NextToken;
/**
* The maximum number of items that you want in the response.
*/
MaxResults?: MaxResults;
}
export interface GetInsightsResponse {
/**
* The insights returned by the operation.
*/
Insights: InsightList;
/**
* The token that is required for pagination.
*/
NextToken?: NextToken;
}
export interface GetInvitationsCountRequest {
}
export interface GetInvitationsCountResponse {
/**
* The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.
*/
InvitationsCount?: Integer;
}
export interface GetMasterAccountRequest {
}
export interface GetMasterAccountResponse {
/**
* A list of details about the Security Hub master account for the current member account.
*/
Master?: Invitation;
}
export interface GetMembersRequest {
/**
* A list of account IDs for the Security Hub member accounts that you want to return the details for.
*/
AccountIds: AccountIdList;
}
export interface GetMembersResponse {
/**
* A list of details about the Security Hub member accounts.
*/
Members?: MemberList;
/**
* A list of account ID and email address pairs of the AWS accounts that couldn't be processed.
*/
UnprocessedAccounts?: ResultList;
}
export interface ImportFindingsError {
/**
* The ID of the error made during the BatchImportFindings operation.
*/
Id: NonEmptyString;
/**
* The code of the error made during the BatchImportFindings operation.
*/
ErrorCode: NonEmptyString;
/**
* The message of the error made during the BatchImportFindings operation.
*/
ErrorMessage: NonEmptyString;
}
export type ImportFindingsErrorList = ImportFindingsError[];
export interface Insight {
/**
* The ARN of a Security Hub insight.
*/
InsightArn: NonEmptyString;
/**
* The name of a Security Hub insight.
*/
Name: NonEmptyString;
/**
* One or more attributes used to filter the findings included in the insight. Only findings that match the criteria defined in the filters are included in the insight.
*/
Filters: AwsSecurityFindingFilters;
/**
* The attribute that the insight's findings are grouped by. This attribute is used as a findings aggregator for the purposes of viewing and managing multiple related findings under a single operand.
*/
GroupByAttribute: NonEmptyString;
}
export type InsightList = Insight[];
export interface InsightResultValue {
/**
* The value of the attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.
*/
GroupByAttributeValue: NonEmptyString;
/**
* The number of findings returned for each GroupByAttributeValue.
*/
Count: Integer;
}
export type InsightResultValueList = InsightResultValue[];
export interface InsightResults {
/**
* The ARN of the insight whose results are returned by the GetInsightResults operation.
*/
InsightArn: NonEmptyString;
/**
* The attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.
*/
GroupByAttribute: NonEmptyString;
/**
* The list of insight result values returned by the GetInsightResults operation.
*/
ResultValues: InsightResultValueList;
}
export type Integer = number;
export interface Invitation {
/**
* The account ID of the Security Hub master account that the invitation was sent from.
*/
AccountId?: AccountId;
/**
* The ID of the invitation sent to the member account.
*/
InvitationId?: NonEmptyString;
/**
* The timestamp of when the invitation was sent.
*/
InvitedAt?: Timestamp;
/**
* The current status of the association between member and master accounts.
*/
MemberStatus?: NonEmptyString;
}
export type InvitationList = Invitation[];
export interface InviteMembersRequest {
/**
* A list of IDs of the AWS accounts that you want to invite to Security Hub as members.
*/
AccountIds?: AccountIdList;
}
export interface InviteMembersResponse {
/**
* A list of account ID and email address pairs of the AWS accounts that couldn't be processed.
*/
UnprocessedAccounts?: ResultList;
}
export interface IpFilter {
/**
* A finding's CIDR value.
*/
Cidr?: NonEmptyString;
}
export type IpFilterList = IpFilter[];
export interface KeywordFilter {
/**
* A value for the keyword.
*/
Value?: NonEmptyString;
}
export type KeywordFilterList = KeywordFilter[];
export interface ListEnabledProductsForImportRequest {
/**
* Paginates results. On your first call to the ListEnabledProductsForImport operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: NextToken;
/**
* The maximum number of items that you want in the response.
*/
MaxResults?: MaxResults;
}
export interface ListEnabledProductsForImportResponse {
/**
* A list of ARNs for the resources that represent your subscriptions to products.
*/
ProductSubscriptions?: ProductSubscriptionArnList;
/**
* The token that is required for pagination.
*/
NextToken?: NextToken;
}
export interface ListInvitationsRequest {
/**
* The maximum number of items that you want in the response.
*/
MaxResults?: MaxResults;
/**
* Paginates results. On your first call to the ListInvitations operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
*/
NextToken?: NextToken;
}
export interface ListInvitationsResponse {
/**
* The details of the invitations returned by the operation.
*/
Invitations?: InvitationList;
/**
* The token that is required for pagination.
*/
NextToken?: NonEmptyString;
}
export interface ListMembersRequest {
/**
* Specifies which member accounts the response includes based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the master is set to ENABLED or DISABLED. If onlyAssociated is set to FALSE, the response includes all existing member accounts.
*/
OnlyAssociated?: Boolean;
/**
* The maximum number of items that you want in the response.
*/
MaxResults?: MaxResults;
/**
* Paginates results. Set the value of this parameter to NULL on your first call to the ListMembers operation. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
*/
NextToken?: NextToken;
}
export interface ListMembersResponse {
/**
* Member details returned by the operation.
*/
Members?: MemberList;
/**
* The token that is required for pagination.
*/
NextToken?: NonEmptyString;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the resource to retrieve tags for.
*/
ResourceArn: ResourceArn;
}
export interface ListTagsForResourceResponse {
/**
* The tags associated with a resource.
*/
Tags?: TagMap;
}
export interface Malware {
/**
* The name of the malware that was observed.
*/
Name: NonEmptyString;
/**
* The type of the malware that was observed.
*/
Type?: MalwareType;
/**
* The file system path of the malware that was observed.
*/
Path?: NonEmptyString;
/**
* The state of the malware that was observed.
*/
State?: MalwareState;
}
export type MalwareList = Malware[];
export type MalwareState = "OBSERVED"|"REMOVAL_FAILED"|"REMOVED"|string;
export type MalwareType = "ADWARE"|"BLENDED_THREAT"|"BOTNET_AGENT"|"COIN_MINER"|"EXPLOIT_KIT"|"KEYLOGGER"|"MACRO"|"POTENTIALLY_UNWANTED"|"SPYWARE"|"RANSOMWARE"|"REMOTE_ACCESS"|"ROOTKIT"|"TROJAN"|"VIRUS"|"WORM"|string;
export interface MapFilter {
/**
* The key of the map filter.
*/
Key?: NonEmptyString;
/**
* The value for the key in the map filter.
*/
Value?: NonEmptyString;
/**
* The condition to apply to a key value when querying for findings with a map filter.
*/
Comparison?: MapFilterComparison;
}
export type MapFilterComparison = "EQUALS"|string;
export type MapFilterList = MapFilter[];
export type MaxResults = number;
export interface Member {
/**
* The AWS account ID of the member account.
*/
AccountId?: AccountId;
/**
* The email address of the member account.
*/
Email?: NonEmptyString;
/**
* The AWS account ID of the Security Hub master account associated with this member account.
*/
MasterId?: NonEmptyString;
/**
* The status of the relationship between the member account and its master account.
*/
MemberStatus?: NonEmptyString;
/**
* A timestamp for the date and time when the invitation was sent to the member account.
*/
InvitedAt?: Timestamp;
/**
* The timestamp for the date and time when the member account was updated.
*/
UpdatedAt?: Timestamp;
}
export type MemberList = Member[];
export interface Network {
/**
* The direction of network traffic associated with a finding.
*/
Direction?: NetworkDirection;
/**
* The protocol of network-related information about a finding.
*/
Protocol?: NonEmptyString;
/**
* The source IPv4 address of network-related information about a finding.
*/
SourceIpV4?: NonEmptyString;
/**
* The source IPv6 address of network-related information about a finding.
*/
SourceIpV6?: NonEmptyString;
/**
* The source port of network-related information about a finding.
*/
SourcePort?: Integer;
/**
* The source domain of network-related information about a finding.
*/
SourceDomain?: NonEmptyString;
/**
* The source media access control (MAC) address of network-related information about a finding.
*/
SourceMac?: NonEmptyString;
/**
* The destination IPv4 address of network-related information about a finding.
*/
DestinationIpV4?: NonEmptyString;
/**
* The destination IPv6 address of network-related information about a finding.
*/
DestinationIpV6?: NonEmptyString;
/**
* The destination port of network-related information about a finding.
*/
DestinationPort?: Integer;
/**
* The destination domain of network-related information about a finding.
*/
DestinationDomain?: NonEmptyString;
}
export type NetworkDirection = "IN"|"OUT"|string;
export type NextToken = string;
export type NonEmptyString = string;
export interface Note {
/**
* The text of a note.
*/
Text: NonEmptyString;
/**
* The principal that created a note.
*/
UpdatedBy: NonEmptyString;
/**
* The timestamp of when the note was updated.
*/
UpdatedAt: NonEmptyString;
}
export interface NoteUpdate {
/**
* The updated note text.
*/
Text: NonEmptyString;
/**
* The principal that updated the note.
*/
UpdatedBy: NonEmptyString;
}
export interface NumberFilter {
/**
* The greater-than-equal condition to be applied to a single field when querying for findings.
*/
Gte?: Double;
/**
* The less-than-equal condition to be applied to a single field when querying for findings.
*/
Lte?: Double;
/**
* The equal-to condition to be applied to a single field when querying for findings.
*/
Eq?: Double;
}
export type NumberFilterList = NumberFilter[];
export type Partition = "aws"|"aws-cn"|"aws-us-gov"|string;
export interface ProcessDetails {
/**
* The name of the process.
*/
Name?: NonEmptyString;
/**
* The path to the process executable.
*/
Path?: NonEmptyString;
/**
* The process ID.
*/
Pid?: Integer;
/**
* The parent process ID.
*/
ParentPid?: Integer;
/**
* The date/time that the process was launched.
*/
LaunchedAt?: NonEmptyString;
/**
* The date and time when the process was terminated.
*/
TerminatedAt?: NonEmptyString;
}
export interface Product {
/**
* The ARN assigned to the product.
*/
ProductArn: NonEmptyString;
/**
* The name of the product.
*/
ProductName?: NonEmptyString;
/**
* The name of the company that provides the product.
*/
CompanyName?: NonEmptyString;
/**
* A description of the product.
*/
Description?: NonEmptyString;
/**
* The categories assigned to the product.
*/
Categories?: CategoryList;
/**
* The URL for the page that contains more information about the product.
*/
MarketplaceUrl?: NonEmptyString;
/**
* The URL used to activate the product.
*/
ActivationUrl?: NonEmptyString;
/**
* The resource policy associated with the product.
*/
ProductSubscriptionResourcePolicy?: NonEmptyString;
}
export type ProductSubscriptionArnList = NonEmptyString[];
export type ProductsList = Product[];
export interface Recommendation {
/**
* Describes the recommended steps to take to remediate an issue identified in a finding.
*/
Text?: NonEmptyString;
/**
* A URL to a page or site that contains information about how to remediate a finding.
*/
Url?: NonEmptyString;
}
export type RecordState = "ACTIVE"|"ARCHIVED"|string;
export interface RelatedFinding {
/**
* The ARN of the product that generated a related finding.
*/
ProductArn: NonEmptyString;
/**
* The product-generated identifier for a related finding.
*/
Id: NonEmptyString;
}
export type RelatedFindingList = RelatedFinding[];
export interface Remediation {
/**
* A recommendation on the steps to take to remediate the issue identified by a finding.
*/
Recommendation?: Recommendation;
}
export interface Resource {
/**
* The type of the resource that details are provided for.
*/
Type: NonEmptyString;
/**
* The canonical identifier for the given resource type.
*/
Id: NonEmptyString;
/**
* The canonical AWS partition name that the Region is assigned to.
*/
Partition?: Partition;
/**
* The canonical AWS external Region name where this resource is located.
*/
Region?: NonEmptyString;
/**
* A list of AWS tags associated with a resource at the time the finding was processed.
*/
Tags?: FieldMap;
/**
* Additional details about the resource related to a finding.
*/
Details?: ResourceDetails;
}
export type ResourceArn = string;
export interface ResourceDetails {
/**
* Details about an Amazon EC2 instance related to a finding.
*/
AwsEc2Instance?: AwsEc2InstanceDetails;
/**
* Details about an Amazon S3 Bucket related to a finding.
*/
AwsS3Bucket?: AwsS3BucketDetails;
/**
* Details about an IAM access key related to a finding.
*/
AwsIamAccessKey?: AwsIamAccessKeyDetails;
/**
* Details about a container resource related to a finding.
*/
Container?: ContainerDetails;
/**
* Details about a resource that doesn't have a specific type defined.
*/
Other?: FieldMap;
}
export type ResourceList = Resource[];
export interface Result {
/**
* An AWS account ID of the account that wasn't be processed.
*/
AccountId?: AccountId;
/**
* The reason that the account wasn't be processed.
*/
ProcessingResult?: NonEmptyString;
}
export type ResultList = Result[];
export interface Severity {
/**
* The native severity as defined by the AWS service or integrated partner product that generated the finding.
*/
Product?: Double;
/**
* The normalized severity of a finding.
*/
Normalized: Integer;
}
export type SortCriteria = SortCriterion[];
export interface SortCriterion {
/**
* The finding attribute used to sort findings.
*/
Field?: NonEmptyString;
/**
* The order used to sort findings.
*/
SortOrder?: SortOrder;
}
export type SortOrder = "asc"|"desc"|string;
export type StandardsInputParameterMap = {[key: string]: NonEmptyString};
export type StandardsStatus = "PENDING"|"READY"|"FAILED"|"DELETING"|"INCOMPLETE"|string;
export interface StandardsSubscription {
/**
* The ARN of a resource that represents your subscription to a supported standard.
*/
StandardsSubscriptionArn: NonEmptyString;
/**
* The ARN of a standard. In this release, Security Hub supports only the CIS AWS Foundations standard, which uses the following ARN: arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.
*/
StandardsArn: NonEmptyString;
/**
* A key-value pair of input for the standard.
*/
StandardsInput: StandardsInputParameterMap;
/**
* The status of the standards subscription.
*/
StandardsStatus: StandardsStatus;
}
export type StandardsSubscriptionArns = NonEmptyString[];
export interface StandardsSubscriptionRequest {
/**
* The ARN of the standard that you want to enable. In this release, Security Hub only supports the CIS AWS Foundations standard. Its ARN is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.
*/
StandardsArn: NonEmptyString;
/**
* A key-value pair of input for the standard.
*/
StandardsInput?: StandardsInputParameterMap;
}
export type StandardsSubscriptionRequests = StandardsSubscriptionRequest[];
export type StandardsSubscriptions = StandardsSubscription[];
export interface StringFilter {
/**
* The string filter value.
*/
Value?: NonEmptyString;
/**
* The condition to be applied to a string value when querying for findings.
*/
Comparison?: StringFilterComparison;
}
export type StringFilterComparison = "EQUALS"|"PREFIX"|string;
export type StringFilterList = StringFilter[];
export type StringList = NonEmptyString[];
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The ARN of the resource to apply the tags to.
*/
ResourceArn: ResourceArn;
/**
* The tags to add to the resource.
*/
Tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export interface ThreatIntelIndicator {
/**
* The type of a threat intel indicator.
*/
Type?: ThreatIntelIndicatorType;
/**
* The value of a threat intel indicator.
*/
Value?: NonEmptyString;
/**
* The category of a threat intel indicator.
*/
Category?: ThreatIntelIndicatorCategory;
/**
* The date and time when the most recent instance of a threat intel indicator was observed.
*/
LastObservedAt?: NonEmptyString;
/**
* The source of the threat intel indicator.
*/
Source?: NonEmptyString;
/**
* The URL to the page or site where you can get more information about the threat intel indicator.
*/
SourceUrl?: NonEmptyString;
}
export type ThreatIntelIndicatorCategory = "BACKDOOR"|"CARD_STEALER"|"COMMAND_AND_CONTROL"|"DROP_SITE"|"EXPLOIT_SITE"|"KEYLOGGER"|string;
export type ThreatIntelIndicatorList = ThreatIntelIndicator[];
export type ThreatIntelIndicatorType = "DOMAIN"|"EMAIL_ADDRESS"|"HASH_MD5"|"HASH_SHA1"|"HASH_SHA256"|"HASH_SHA512"|"IPV4_ADDRESS"|"IPV6_ADDRESS"|"MUTEX"|"PROCESS"|"URL"|string;
export type Timestamp = Date;
export type TypeList = NonEmptyString[];
export interface UntagResourceRequest {
/**
* The ARN of the resource to remove the tags from.
*/
ResourceArn: ResourceArn;
/**
* The tag keys associated with the tags to remove from the resource.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateActionTargetRequest {
/**
* The ARN of the custom action target to update.
*/
ActionTargetArn: NonEmptyString;
/**
* The updated name of the custom action target.
*/
Name?: NonEmptyString;
/**
* The updated description for the custom action target.
*/
Description?: NonEmptyString;
}
export interface UpdateActionTargetResponse {
}
export interface UpdateFindingsRequest {
/**
* A collection of attributes that specify which findings you want to update.
*/
Filters: AwsSecurityFindingFilters;
/**
* The updated note for the finding.
*/
Note?: NoteUpdate;
/**
* The updated record state for the finding.
*/
RecordState?: RecordState;
}
export interface UpdateFindingsResponse {
}
export interface UpdateInsightRequest {
/**
* The ARN of the insight that you want to update.
*/
InsightArn: NonEmptyString;
/**
* The updated name for the insight.
*/
Name?: NonEmptyString;
/**
* The updated filters that define this insight.
*/
Filters?: AwsSecurityFindingFilters;
/**
* The updated GroupBy attribute that defines this insight.
*/
GroupByAttribute?: NonEmptyString;
}
export interface UpdateInsightResponse {
}
export type VerificationState = "UNKNOWN"|"TRUE_POSITIVE"|"FALSE_POSITIVE"|"BENIGN_POSITIVE"|string;
export type WorkflowState = "NEW"|"ASSIGNED"|"IN_PROGRESS"|"DEFERRED"|"RESOLVED"|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 = "2018-10-26"|"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 SecurityHub client.
*/
export import Types = SecurityHub;
}
export = SecurityHub;