@aws-sdk/client-guardduty 3.1122.0 → 3.1124.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -0
- package/dist-cjs/index.js +558 -96
- package/dist-es/GuardDuty.js +30 -0
- package/dist-es/commands/CreateCustomDetectionRuleAssociationCommand.js +4 -0
- package/dist-es/commands/CreateCustomDetectionRuleOrgConfigurationCommand.js +4 -0
- package/dist-es/commands/DeleteCustomDetectionRuleAssociationCommand.js +4 -0
- package/dist-es/commands/DeleteCustomDetectionRuleOrgConfigurationCommand.js +4 -0
- package/dist-es/commands/GetCustomDetectionRuleAssociationCommand.js +4 -0
- package/dist-es/commands/GetCustomDetectionRuleCommand.js +4 -0
- package/dist-es/commands/GetCustomDetectionRuleOrgConfigurationCommand.js +4 -0
- package/dist-es/commands/ListCustomDetectionRuleAssociationsCommand.js +4 -0
- package/dist-es/commands/ListCustomDetectionRuleOrgConfigurationsCommand.js +4 -0
- package/dist-es/commands/ListCustomDetectionRulesCommand.js +4 -0
- package/dist-es/commands/UpdateCustomDetectionRuleAssociationCommand.js +4 -0
- package/dist-es/commands/UpdateCustomDetectionRuleOrgConfigurationCommand.js +4 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/models/enums.js +37 -0
- package/dist-es/pagination/ListCustomDetectionRuleAssociationsPaginator.js +4 -0
- package/dist-es/pagination/ListCustomDetectionRuleOrgConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/ListCustomDetectionRulesPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +398 -95
- package/dist-types/GuardDuty.d.ts +108 -0
- package/dist-types/GuardDutyClient.d.ts +14 -2
- package/dist-types/commands/CreateCustomDetectionRuleAssociationCommand.d.ts +100 -0
- package/dist-types/commands/CreateCustomDetectionRuleOrgConfigurationCommand.d.ts +92 -0
- package/dist-types/commands/DeleteCustomDetectionRuleAssociationCommand.d.ts +82 -0
- package/dist-types/commands/DeleteCustomDetectionRuleOrgConfigurationCommand.d.ts +85 -0
- package/dist-types/commands/GetCustomDetectionRuleAssociationCommand.d.ts +96 -0
- package/dist-types/commands/GetCustomDetectionRuleCommand.d.ts +100 -0
- package/dist-types/commands/GetCustomDetectionRuleOrgConfigurationCommand.d.ts +98 -0
- package/dist-types/commands/GetFilterCommand.d.ts +1 -1
- package/dist-types/commands/GetFindingsCommand.d.ts +1 -1
- package/dist-types/commands/GetFindingsStatisticsCommand.d.ts +1 -1
- package/dist-types/commands/GetIPSetCommand.d.ts +1 -1
- package/dist-types/commands/GetInvestigationCommand.d.ts +1 -1
- package/dist-types/commands/GetInvitationsCountCommand.d.ts +1 -1
- package/dist-types/commands/GetMalwareProtectionPlanCommand.d.ts +1 -1
- package/dist-types/commands/GetMalwareScanCommand.d.ts +1 -2
- package/dist-types/commands/ListCustomDetectionRuleAssociationsCommand.d.ts +94 -0
- package/dist-types/commands/ListCustomDetectionRuleOrgConfigurationsCommand.d.ts +93 -0
- package/dist-types/commands/ListCustomDetectionRulesCommand.d.ts +107 -0
- package/dist-types/commands/UpdateCustomDetectionRuleAssociationCommand.d.ts +86 -0
- package/dist-types/commands/UpdateCustomDetectionRuleOrgConfigurationCommand.d.ts +91 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/models/enums.d.ts +101 -0
- package/dist-types/models/models_0.d.ts +388 -379
- package/dist-types/models/models_1.d.ts +701 -2
- package/dist-types/pagination/ListCustomDetectionRuleAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCustomDetectionRuleOrgConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCustomDetectionRulesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/schemas/schemas_0.d.ts +44 -0
- package/dist-types/ts3.4/GuardDuty.d.ts +228 -0
- package/dist-types/ts3.4/GuardDutyClient.d.ts +72 -0
- package/dist-types/ts3.4/commands/CreateCustomDetectionRuleAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateCustomDetectionRuleOrgConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteCustomDetectionRuleAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteCustomDetectionRuleOrgConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetCustomDetectionRuleAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetCustomDetectionRuleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetCustomDetectionRuleOrgConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetFilterCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetFindingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetFindingsStatisticsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetIPSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInvestigationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInvitationsCountCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMalwareProtectionPlanCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMalwareScanCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/ListCustomDetectionRuleAssociationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListCustomDetectionRuleOrgConfigurationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListCustomDetectionRulesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateCustomDetectionRuleAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateCustomDetectionRuleOrgConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/models/enums.d.ts +49 -0
- package/dist-types/ts3.4/models/models_0.d.ts +118 -117
- package/dist-types/ts3.4/models/models_1.d.ts +187 -1
- package/dist-types/ts3.4/pagination/ListCustomDetectionRuleAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCustomDetectionRuleOrgConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCustomDetectionRulesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +44 -0
- package/package.json +2 -2
|
@@ -1,5 +1,468 @@
|
|
|
1
|
-
import type { AutoEnableMembers, Confidence, DataSource, DetectionSource, EbsSnapshotPreservation, FeatureStatus, Feedback, FilterAction, FindingPublishingFrequency, InvestigationSortField, InvestigationStatus, ListMalwareScansCriterionKey, MalwareProtectionResourceType, MalwareProtectionScanStatus, MalwareProtectionScanType, OrderBy, OrgFeature, OrgFeatureAdditionalConfiguration, OrgFeatureStatus, RiskLevel, ScanCategory, ScanCriterionKey, ScanResultStatus, ScanStatusReason, ThreatEntitySetFormat, ThreatEntitySetStatus, ThreatIntelSetFormat, ThreatIntelSetStatus, TrustedEntitySetFormat, TrustedEntitySetStatus, UsageFeature, UsageStatisticType } from "./enums";
|
|
2
|
-
import type { AccountFreeTrialInfo, AdminAccount, ContinuousScanDetails, CoverageFilterCriteria, CoverageResource, CoverageSortCriteria, DataSourceConfigurations, DataSourceConfigurationsResult, Destination, DestinationProperties, DetectorFeatureConfiguration, EbsSnapshot, FilterCondition, FindingCriteria, IncrementalScanDetails, ItemDetails, MalwareProtectionPlanActions,
|
|
1
|
+
import type { AssociationMode, AutoEnableMembers, Confidence, DataSource, DetectionRuleConfigurationStatus, DetectionRuleDataSource, DetectionRuleSeverity, DetectionSource, EbsSnapshotPreservation, FeatureStatus, Feedback, FilterAction, FindingPublishingFrequency, FindingStatisticType, GroupByType, InvestigationSortField, InvestigationStatus, IpSetFormat, IpSetStatus, ListMalwareScansCriterionKey, MalwareProtectionPlanStatus, MalwareProtectionResourceType, MalwareProtectionScanStatus, MalwareProtectionScanType, OrderBy, OrgFeature, OrgFeatureAdditionalConfiguration, OrgFeatureStatus, RiskLevel, RuleLanguage, RuleSchema, ScanCategory, ScanCriterionKey, ScanResultStatus, ScanStatusReason, ThreatEntitySetFormat, ThreatEntitySetStatus, ThreatIntelSetFormat, ThreatIntelSetStatus, TrustedEntitySetFormat, TrustedEntitySetStatus, UsageFeature, UsageStatisticType } from "./enums";
|
|
2
|
+
import type { AccountFreeTrialInfo, AdminAccount, AssociationSummary, CloudDetails, ContinuousScanDetails, CoverageFilterCriteria, CoverageResource, CoverageSortCriteria, CreateProtectedResource, DataSourceConfigurations, DataSourceConfigurationsResult, Destination, DestinationProperties, DetectionRuleFilter, DetectionRuleOrgConfigurationSummary, DetectorFeatureConfiguration, EbsSnapshot, FilterCondition, Finding, FindingCriteria, FindingStatistics, IncrementalScanDetails, ItemDetails, MalwareProtectionPlanActions, ScanConfigurationContinuousScanDetails, SortCriteria, TriggerDetails, UnprocessedAccount, VolumeDetail } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface GetFilterRequest {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The unique ID of the detector that is associated with this filter.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
DetectorId: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The name of the filter you want to get.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
FilterName: string | undefined;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
export interface GetFilterResponse {
|
|
22
|
+
/**
|
|
23
|
+
* <p>The name of the filter.</p>
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
Name: string | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* <p>The description of the filter.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
Description?: string | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* <p>Specifies the action that is to be applied to the findings that match the filter.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
Action: FilterAction | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* <p>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.</p>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
Rank?: number | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* <p>Represents the criteria to be used in the filter for querying findings.</p>
|
|
44
|
+
* @public
|
|
45
|
+
*/
|
|
46
|
+
FindingCriteria: FindingCriteria | undefined;
|
|
47
|
+
/**
|
|
48
|
+
* <p>The tags of the filter resource.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
Tags?: Record<string, string> | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* <p>The timestamp when the filter was created. This field is not available for filters that were created before the lifecycle metadata feature was enabled (legacy filters).</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
CreatedAt?: Date | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* <p>The timestamp when the filter was last updated. For legacy filters, this field is present only after the filter has been updated at least once since the lifecycle metadata feature was enabled.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
UpdatedAt?: Date | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* <p>The version of the filter. Every time the filter is updated, the version increments by 1. This field is not available for legacy filters that were created before the lifecycle metadata feature was enabled.</p>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
Version?: number | undefined;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export interface GetFindingsRequest {
|
|
72
|
+
/**
|
|
73
|
+
* <p>The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
DetectorId: string | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The IDs of the findings that you want to retrieve.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
FindingIds: string[] | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* <p>Represents the criteria used for sorting findings.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
SortCriteria?: SortCriteria | undefined;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export interface GetFindingsResponse {
|
|
92
|
+
/**
|
|
93
|
+
* <p>A list of findings.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
Findings: Finding[] | undefined;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export interface GetFindingsStatisticsRequest {
|
|
102
|
+
/**
|
|
103
|
+
* <p>The ID of the detector whose findings statistics you want to retrieve.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
DetectorId: string | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* <p>The types of finding statistics to retrieve.</p>
|
|
109
|
+
*
|
|
110
|
+
* @deprecated This parameter is deprecated, please use GroupBy instead.
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
FindingStatisticTypes?: FindingStatisticType[] | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* <p>Represents the criteria that is used for querying findings.</p>
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
FindingCriteria?: FindingCriteria | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* <p>Displays the findings statistics grouped by one of the listed valid values.</p>
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
GroupBy?: GroupByType | undefined;
|
|
124
|
+
/**
|
|
125
|
+
* <p>Displays the sorted findings in the requested order. The default value of <code>orderBy</code> is <code>DESC</code>.</p> <p>You can use this parameter only with the <code>groupBy</code> parameter.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
OrderBy?: OrderBy | undefined;
|
|
129
|
+
/**
|
|
130
|
+
* <p>The maximum number of results to be returned in the response. The default value is 25.</p> <p>You can use this parameter only with the <code>groupBy</code> parameter.</p>
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
MaxResults?: number | undefined;
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
export interface GetFindingsStatisticsResponse {
|
|
139
|
+
/**
|
|
140
|
+
* <p>The finding statistics object.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
FindingStatistics: FindingStatistics | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* <p>The pagination parameter to be used on the next list operation to retrieve more items.</p> <p>This parameter is currently not supported.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
NextToken?: string | undefined;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export interface GetInvestigationRequest {
|
|
154
|
+
/**
|
|
155
|
+
* <p>The unique ID of the GuardDuty detector associated with the investigation.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
DetectorId: string | undefined;
|
|
159
|
+
/**
|
|
160
|
+
* <p>The unique identifier of the investigation to retrieve.</p>
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
InvestigationId: string | undefined;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* <p>Contains information about the product that produced an investigation.</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
export interface Product {
|
|
170
|
+
/**
|
|
171
|
+
* <p>The name of the product.</p>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
Name: string | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* <p>The specific feature within the product that produced the investigation.</p>
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
Feature?: string | undefined;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* <p>Contains metadata about the product and version that produced an investigation.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export interface InvestigationMetadata {
|
|
186
|
+
/**
|
|
187
|
+
* <p>The version of the investigation engine that produced the results.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
Version: string | undefined;
|
|
191
|
+
/**
|
|
192
|
+
* <p>Information about the product that produced the investigation.</p>
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
Product: Product | undefined;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* <p>Contains the details and results of a GuardDuty investigation.</p>
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
export interface Investigation {
|
|
202
|
+
/**
|
|
203
|
+
* <p>The unique identifier of the investigation.</p>
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
InvestigationId: string | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* <p>The current status of the investigation. Possible values are <code>RUNNING</code>, <code>COMPLETED</code>, and <code>FAILED</code>.</p>
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
Status: InvestigationStatus | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* <p>The natural-language prompt that initiated this investigation.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
TriggerPrompt: string | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* <p>The account that initiated the investigation.</p>
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
TriggeredBy: string | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* <p>Metadata about the product and version that produced the investigation.</p>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
Metadata?: InvestigationMetadata | undefined;
|
|
227
|
+
/**
|
|
228
|
+
* <p>Details about the cloud environment in which the investigation was performed, including the provider, region, and account.</p>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
Cloud?: CloudDetails | undefined;
|
|
232
|
+
/**
|
|
233
|
+
* <p>The assessed risk level of the investigated threat. Possible values are <code>Info</code>, <code>Low</code>, <code>Medium</code>, <code>High</code>, and <code>Critical</code>.</p>
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
RiskLevel?: RiskLevel | undefined;
|
|
237
|
+
/**
|
|
238
|
+
* <p>A human-readable description of the assessed risk.</p>
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
Risk?: string | undefined;
|
|
242
|
+
/**
|
|
243
|
+
* <p>The confidence level of the investigation's assessment. Possible values are <code>Unknown</code>, <code>Low</code>, <code>Medium</code>, and <code>High</code>.</p>
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
246
|
+
Confidence?: Confidence | undefined;
|
|
247
|
+
/**
|
|
248
|
+
* <p>A structured summary of the investigation findings, including affected resources, threat assessment, and recommended remediation steps.</p>
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
Summary?: string | undefined;
|
|
252
|
+
/**
|
|
253
|
+
* <p>The timestamp at which the investigation started.</p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
StartTime?: Date | undefined;
|
|
257
|
+
/**
|
|
258
|
+
* <p>The timestamp at which the investigation completed.</p>
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
EndTime?: Date | undefined;
|
|
262
|
+
/**
|
|
263
|
+
* <p>Details about the error if the investigation status is <code>FAILED</code>.</p>
|
|
264
|
+
* @public
|
|
265
|
+
*/
|
|
266
|
+
Error?: string | undefined;
|
|
267
|
+
}
|
|
268
|
+
/**
|
|
269
|
+
* @public
|
|
270
|
+
*/
|
|
271
|
+
export interface GetInvestigationResponse {
|
|
272
|
+
/**
|
|
273
|
+
* <p>The details and results of the requested investigation.</p>
|
|
274
|
+
* @public
|
|
275
|
+
*/
|
|
276
|
+
Investigation: Investigation | undefined;
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* @public
|
|
280
|
+
*/
|
|
281
|
+
export interface GetInvitationsCountRequest {
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* @public
|
|
285
|
+
*/
|
|
286
|
+
export interface GetInvitationsCountResponse {
|
|
287
|
+
/**
|
|
288
|
+
* <p>The number of received invitations.</p>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
InvitationsCount?: number | undefined;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* @public
|
|
295
|
+
*/
|
|
296
|
+
export interface GetIPSetRequest {
|
|
297
|
+
/**
|
|
298
|
+
* <p>The unique ID of the detector that is associated with the IPSet.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
|
|
299
|
+
* @public
|
|
300
|
+
*/
|
|
301
|
+
DetectorId: string | undefined;
|
|
302
|
+
/**
|
|
303
|
+
* <p>The unique ID of the IPSet to retrieve.</p>
|
|
304
|
+
* @public
|
|
305
|
+
*/
|
|
306
|
+
IpSetId: string | undefined;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
export interface GetIPSetResponse {
|
|
312
|
+
/**
|
|
313
|
+
* <p>The user-friendly name for the IPSet.</p>
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
Name: string | undefined;
|
|
317
|
+
/**
|
|
318
|
+
* <p>The format of the file that contains the IPSet.</p>
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
Format: IpSetFormat | undefined;
|
|
322
|
+
/**
|
|
323
|
+
* <p>The URI of the file that contains the IPSet.</p>
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
326
|
+
Location: string | undefined;
|
|
327
|
+
/**
|
|
328
|
+
* <p>The status of IPSet file that was uploaded.</p>
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
331
|
+
Status: IpSetStatus | undefined;
|
|
332
|
+
/**
|
|
333
|
+
* <p>The tags of the IPSet resource.</p>
|
|
334
|
+
* @public
|
|
335
|
+
*/
|
|
336
|
+
Tags?: Record<string, string> | undefined;
|
|
337
|
+
/**
|
|
338
|
+
* <p>The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the <b>location</b> parameter. This field appears in the response only if it was provided during IPSet creation or update.</p>
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
ExpectedBucketOwner?: string | undefined;
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
export interface GetMalwareProtectionPlanRequest {
|
|
347
|
+
/**
|
|
348
|
+
* <p>A unique identifier associated with Malware Protection plan resource.</p>
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
MalwareProtectionPlanId: string | undefined;
|
|
352
|
+
}
|
|
353
|
+
/**
|
|
354
|
+
* <p>Information about the issue code and message associated to the status of your Malware Protection plan.</p>
|
|
355
|
+
* @public
|
|
356
|
+
*/
|
|
357
|
+
export interface MalwareProtectionPlanStatusReason {
|
|
358
|
+
/**
|
|
359
|
+
* <p>Issue code.</p>
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
Code?: string | undefined;
|
|
363
|
+
/**
|
|
364
|
+
* <p>Issue message that specifies the reason. For information about potential troubleshooting steps, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/troubleshoot-s3-malware-protection-status-errors.html">Troubleshooting Malware Protection for S3 status issues</a> in the <i>Amazon GuardDuty User Guide</i>.</p>
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
Message?: string | undefined;
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
372
|
+
export interface GetMalwareProtectionPlanResponse {
|
|
373
|
+
/**
|
|
374
|
+
* <p>Amazon Resource Name (ARN) of the protected resource.</p>
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
Arn?: string | undefined;
|
|
378
|
+
/**
|
|
379
|
+
* <p>Amazon Resource Name (ARN) of the IAM role that includes the permissions to scan and add tags to the associated protected resource.</p>
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
382
|
+
Role?: string | undefined;
|
|
383
|
+
/**
|
|
384
|
+
* <p>Information about the protected resource that is associated with the created Malware Protection plan. Presently, <code>S3Bucket</code> is the only supported protected resource.</p>
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
ProtectedResource?: CreateProtectedResource | undefined;
|
|
388
|
+
/**
|
|
389
|
+
* <p>Information about whether the tags will be added to the S3 object after scanning.</p>
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
Actions?: MalwareProtectionPlanActions | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* <p>The timestamp when the Malware Protection plan resource was created.</p>
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
CreatedAt?: Date | undefined;
|
|
398
|
+
/**
|
|
399
|
+
* <p>Malware Protection plan status.</p>
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
Status?: MalwareProtectionPlanStatus | undefined;
|
|
403
|
+
/**
|
|
404
|
+
* <p>Information about the issue code and message associated to the status of your Malware Protection plan.</p>
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
StatusReasons?: MalwareProtectionPlanStatusReason[] | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* <p>Tags added to the Malware Protection plan resource.</p>
|
|
410
|
+
* @public
|
|
411
|
+
*/
|
|
412
|
+
Tags?: Record<string, string> | undefined;
|
|
413
|
+
}
|
|
414
|
+
/**
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
417
|
+
export interface GetMalwareScanRequest {
|
|
418
|
+
/**
|
|
419
|
+
* <p>A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.</p>
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
ScanId: string | undefined;
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* <p>Contains information about the recovery point configuration used in the scan.</p>
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
export interface ScanConfigurationRecoveryPoint {
|
|
429
|
+
/**
|
|
430
|
+
* <p>The name of the Amazon Web Services Backup vault that contains the recovery point for the scanned.</p>
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
BackupVaultName?: string | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* <p>The time range within the continuous backup in Amazon Web Services Backup that was scanned for a point-in-time recovery resource.</p>
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
ContinuousScanDetails?: ScanConfigurationContinuousScanDetails | undefined;
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* <p>Contains information about the configuration used for the malware scan.</p>
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
export interface ScanConfiguration {
|
|
445
|
+
/**
|
|
446
|
+
* <p>Amazon Resource Name (ARN) of the IAM role that should contain the required permissions for the scan.</p>
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
Role?: string | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* <p>Information about the entity that triggered the malware scan.</p>
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
TriggerDetails?: TriggerDetails | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* <p>Information about the incremental scan configuration, if applicable.</p>
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
IncrementalScanDetails?: IncrementalScanDetails | undefined;
|
|
460
|
+
/**
|
|
461
|
+
* <p>Information about the recovery point configuration used for the scan, if applicable.</p>
|
|
462
|
+
* @public
|
|
463
|
+
*/
|
|
464
|
+
RecoveryPoint?: ScanConfigurationRecoveryPoint | undefined;
|
|
465
|
+
}
|
|
3
466
|
/**
|
|
4
467
|
* <p>Contains additional information about a resource that was scanned.</p>
|
|
5
468
|
* @public
|
|
@@ -1116,6 +1579,187 @@ export interface ListCoverageResponse {
|
|
|
1116
1579
|
*/
|
|
1117
1580
|
NextToken?: string | undefined;
|
|
1118
1581
|
}
|
|
1582
|
+
/**
|
|
1583
|
+
* @public
|
|
1584
|
+
*/
|
|
1585
|
+
export interface ListCustomDetectionRuleAssociationsRequest {
|
|
1586
|
+
/**
|
|
1587
|
+
* <p>The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.</p>
|
|
1588
|
+
* @public
|
|
1589
|
+
*/
|
|
1590
|
+
MaxResults?: number | undefined;
|
|
1591
|
+
/**
|
|
1592
|
+
* <p>A pagination token from a previous response. Use this token to retrieve the next page of results.</p>
|
|
1593
|
+
* @public
|
|
1594
|
+
*/
|
|
1595
|
+
NextToken?: string | undefined;
|
|
1596
|
+
/**
|
|
1597
|
+
* <p>The unique identifier for the custom detection rule to filter associations by.</p>
|
|
1598
|
+
* @public
|
|
1599
|
+
*/
|
|
1600
|
+
RuleId?: string | undefined;
|
|
1601
|
+
/**
|
|
1602
|
+
* <p>The rule execution mode to filter associations by.</p>
|
|
1603
|
+
* @public
|
|
1604
|
+
*/
|
|
1605
|
+
Mode?: AssociationMode | undefined;
|
|
1606
|
+
}
|
|
1607
|
+
/**
|
|
1608
|
+
* @public
|
|
1609
|
+
*/
|
|
1610
|
+
export interface ListCustomDetectionRuleAssociationsResponse {
|
|
1611
|
+
/**
|
|
1612
|
+
* <p>A list of custom detection rule association summaries.</p>
|
|
1613
|
+
* @public
|
|
1614
|
+
*/
|
|
1615
|
+
RuleAssociations: AssociationSummary[] | undefined;
|
|
1616
|
+
/**
|
|
1617
|
+
* <p>A pagination token to retrieve the next page of results. If this field is empty, there are no additional results.</p>
|
|
1618
|
+
* @public
|
|
1619
|
+
*/
|
|
1620
|
+
NextToken?: string | undefined;
|
|
1621
|
+
}
|
|
1622
|
+
/**
|
|
1623
|
+
* @public
|
|
1624
|
+
*/
|
|
1625
|
+
export interface ListCustomDetectionRuleOrgConfigurationsRequest {
|
|
1626
|
+
/**
|
|
1627
|
+
* <p>The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.</p>
|
|
1628
|
+
* @public
|
|
1629
|
+
*/
|
|
1630
|
+
MaxResults?: number | undefined;
|
|
1631
|
+
/**
|
|
1632
|
+
* <p>A pagination token from a previous response. Use this token to retrieve the next page of results.</p>
|
|
1633
|
+
* @public
|
|
1634
|
+
*/
|
|
1635
|
+
NextToken?: string | undefined;
|
|
1636
|
+
/**
|
|
1637
|
+
* <p>The configuration status to filter by.</p>
|
|
1638
|
+
* @public
|
|
1639
|
+
*/
|
|
1640
|
+
Status?: DetectionRuleConfigurationStatus | undefined;
|
|
1641
|
+
}
|
|
1642
|
+
/**
|
|
1643
|
+
* @public
|
|
1644
|
+
*/
|
|
1645
|
+
export interface ListCustomDetectionRuleOrgConfigurationsResponse {
|
|
1646
|
+
/**
|
|
1647
|
+
* <p>A list of organization configurations for custom detection rules.</p>
|
|
1648
|
+
* @public
|
|
1649
|
+
*/
|
|
1650
|
+
Configurations: DetectionRuleOrgConfigurationSummary[] | undefined;
|
|
1651
|
+
/**
|
|
1652
|
+
* <p>A pagination token to retrieve the next page of results. If this field is empty, there are no additional results.</p>
|
|
1653
|
+
* @public
|
|
1654
|
+
*/
|
|
1655
|
+
NextToken?: string | undefined;
|
|
1656
|
+
}
|
|
1657
|
+
/**
|
|
1658
|
+
* @public
|
|
1659
|
+
*/
|
|
1660
|
+
export interface ListCustomDetectionRulesRequest {
|
|
1661
|
+
/**
|
|
1662
|
+
* <p>The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.</p>
|
|
1663
|
+
* @public
|
|
1664
|
+
*/
|
|
1665
|
+
MaxResults?: number | undefined;
|
|
1666
|
+
/**
|
|
1667
|
+
* <p>A pagination token from a previous response. Use this token to retrieve the next page of results.</p>
|
|
1668
|
+
* @public
|
|
1669
|
+
*/
|
|
1670
|
+
NextToken?: string | undefined;
|
|
1671
|
+
/**
|
|
1672
|
+
* <p>A list of filter criteria to apply when listing custom detection rules.</p>
|
|
1673
|
+
* @public
|
|
1674
|
+
*/
|
|
1675
|
+
Filters?: DetectionRuleFilter[] | undefined;
|
|
1676
|
+
}
|
|
1677
|
+
/**
|
|
1678
|
+
* <p>Contains summary information about a custom detection rule.</p>
|
|
1679
|
+
* @public
|
|
1680
|
+
*/
|
|
1681
|
+
export interface RuleSummary {
|
|
1682
|
+
/**
|
|
1683
|
+
* <p>The unique identifier for the rule.</p>
|
|
1684
|
+
* @public
|
|
1685
|
+
*/
|
|
1686
|
+
RuleId: string | undefined;
|
|
1687
|
+
/**
|
|
1688
|
+
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
1689
|
+
* @public
|
|
1690
|
+
*/
|
|
1691
|
+
Arn: string | undefined;
|
|
1692
|
+
/**
|
|
1693
|
+
* <p>The display name of the rule.</p>
|
|
1694
|
+
* @public
|
|
1695
|
+
*/
|
|
1696
|
+
Name: string | undefined;
|
|
1697
|
+
/**
|
|
1698
|
+
* <p>A description of what the rule detects.</p>
|
|
1699
|
+
* @public
|
|
1700
|
+
*/
|
|
1701
|
+
Description: string | undefined;
|
|
1702
|
+
/**
|
|
1703
|
+
* <p>The severity level assigned to findings generated by this rule.</p>
|
|
1704
|
+
* @public
|
|
1705
|
+
*/
|
|
1706
|
+
Severity: DetectionRuleSeverity | undefined;
|
|
1707
|
+
/**
|
|
1708
|
+
* <p>The data source that the rule analyzes.</p>
|
|
1709
|
+
* @public
|
|
1710
|
+
*/
|
|
1711
|
+
DataSource: DetectionRuleDataSource | undefined;
|
|
1712
|
+
/**
|
|
1713
|
+
* <p>The MITRE ATT&CK tactic associated with the rule.</p>
|
|
1714
|
+
* @public
|
|
1715
|
+
*/
|
|
1716
|
+
Tactic: string | undefined;
|
|
1717
|
+
/**
|
|
1718
|
+
* <p>The MITRE ATT&CK technique associated with the rule.</p>
|
|
1719
|
+
* @public
|
|
1720
|
+
*/
|
|
1721
|
+
Technique: string | undefined;
|
|
1722
|
+
/**
|
|
1723
|
+
* <p>The Amazon Web Services service associated with the rule.</p>
|
|
1724
|
+
* @public
|
|
1725
|
+
*/
|
|
1726
|
+
Service: string | undefined;
|
|
1727
|
+
/**
|
|
1728
|
+
* <p>The language used for the detection logic expression.</p>
|
|
1729
|
+
* @public
|
|
1730
|
+
*/
|
|
1731
|
+
Language?: RuleLanguage | undefined;
|
|
1732
|
+
/**
|
|
1733
|
+
* <p>The schema version used by the rule definition.</p>
|
|
1734
|
+
* @public
|
|
1735
|
+
*/
|
|
1736
|
+
Schema?: RuleSchema | undefined;
|
|
1737
|
+
/**
|
|
1738
|
+
* <p>The timestamp when the rule was created.</p>
|
|
1739
|
+
* @public
|
|
1740
|
+
*/
|
|
1741
|
+
CreatedAt: Date | undefined;
|
|
1742
|
+
/**
|
|
1743
|
+
* <p>The timestamp when the rule was last updated.</p>
|
|
1744
|
+
* @public
|
|
1745
|
+
*/
|
|
1746
|
+
UpdatedAt?: Date | undefined;
|
|
1747
|
+
}
|
|
1748
|
+
/**
|
|
1749
|
+
* @public
|
|
1750
|
+
*/
|
|
1751
|
+
export interface ListCustomDetectionRulesResponse {
|
|
1752
|
+
/**
|
|
1753
|
+
* <p>A list of custom detection rule summaries.</p>
|
|
1754
|
+
* @public
|
|
1755
|
+
*/
|
|
1756
|
+
Rules: RuleSummary[] | undefined;
|
|
1757
|
+
/**
|
|
1758
|
+
* <p>A pagination token to retrieve the next page of results. If this field is empty, there are no additional results.</p>
|
|
1759
|
+
* @public
|
|
1760
|
+
*/
|
|
1761
|
+
NextToken?: string | undefined;
|
|
1762
|
+
}
|
|
1119
1763
|
/**
|
|
1120
1764
|
* @public
|
|
1121
1765
|
*/
|
|
@@ -2016,6 +2660,61 @@ export interface UntagResourceRequest {
|
|
|
2016
2660
|
*/
|
|
2017
2661
|
export interface UntagResourceResponse {
|
|
2018
2662
|
}
|
|
2663
|
+
/**
|
|
2664
|
+
* @public
|
|
2665
|
+
*/
|
|
2666
|
+
export interface UpdateCustomDetectionRuleAssociationRequest {
|
|
2667
|
+
/**
|
|
2668
|
+
* <p>The unique identifier for the custom detection rule.</p>
|
|
2669
|
+
* @public
|
|
2670
|
+
*/
|
|
2671
|
+
RuleId: string | undefined;
|
|
2672
|
+
/**
|
|
2673
|
+
* <p>The unique identifier for the association to update.</p>
|
|
2674
|
+
* @public
|
|
2675
|
+
*/
|
|
2676
|
+
AssociationId: string | undefined;
|
|
2677
|
+
/**
|
|
2678
|
+
* <p>The rule execution mode. Valid values: <code>LIVE</code> | <code>DRY_RUN</code>.</p>
|
|
2679
|
+
* @public
|
|
2680
|
+
*/
|
|
2681
|
+
Mode: AssociationMode | undefined;
|
|
2682
|
+
}
|
|
2683
|
+
/**
|
|
2684
|
+
* @public
|
|
2685
|
+
*/
|
|
2686
|
+
export interface UpdateCustomDetectionRuleAssociationResponse {
|
|
2687
|
+
}
|
|
2688
|
+
/**
|
|
2689
|
+
* @public
|
|
2690
|
+
*/
|
|
2691
|
+
export interface UpdateCustomDetectionRuleOrgConfigurationRequest {
|
|
2692
|
+
/**
|
|
2693
|
+
* <p>The unique identifier for the custom detection rule.</p>
|
|
2694
|
+
* @public
|
|
2695
|
+
*/
|
|
2696
|
+
RuleId: string | undefined;
|
|
2697
|
+
/**
|
|
2698
|
+
* <p>The execution mode of the organization configuration. Valid values: <code>LIVE</code> | <code>DRY_RUN</code>.</p>
|
|
2699
|
+
* @public
|
|
2700
|
+
*/
|
|
2701
|
+
Mode: AssociationMode | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The account IDs to include in the organization configuration. Mutually exclusive with <code>ExcludeAccountIds</code>.</p>
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
IncludeAccountIds?: string[] | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>The account IDs to exclude from the organization configuration. Mutually exclusive with <code>IncludeAccountIds</code>.</p>
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
ExcludeAccountIds?: string[] | undefined;
|
|
2712
|
+
}
|
|
2713
|
+
/**
|
|
2714
|
+
* @public
|
|
2715
|
+
*/
|
|
2716
|
+
export interface UpdateCustomDetectionRuleOrgConfigurationResponse {
|
|
2717
|
+
}
|
|
2019
2718
|
/**
|
|
2020
2719
|
* @public
|
|
2021
2720
|
*/
|