@aws-sdk/client-securityhub 3.378.0 → 3.382.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/dist-types/endpoint/EndpointParameters.d.ts +3 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1309 -0
- package/dist-types/models/models_1.d.ts +1324 -0
- package/dist-types/models/models_2.d.ts +489 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/package.json +7 -7
|
@@ -14,47 +14,56 @@ import { SecurityHubServiceException as __BaseException } from "./SecurityHubSer
|
|
|
14
14
|
*/
|
|
15
15
|
export interface AwsSecurityFinding {
|
|
16
16
|
/**
|
|
17
|
+
* @public
|
|
17
18
|
* <p>The schema version that a finding is formatted for.</p>
|
|
18
19
|
*/
|
|
19
20
|
SchemaVersion: string | undefined;
|
|
20
21
|
/**
|
|
22
|
+
* @public
|
|
21
23
|
* <p>The security findings provider-specific identifier for a finding.</p>
|
|
22
24
|
*/
|
|
23
25
|
Id: string | undefined;
|
|
24
26
|
/**
|
|
27
|
+
* @public
|
|
25
28
|
* <p>The ARN generated by Security Hub that uniquely identifies a product that generates findings.
|
|
26
29
|
* This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for
|
|
27
30
|
* a custom integration.</p>
|
|
28
31
|
*/
|
|
29
32
|
ProductArn: string | undefined;
|
|
30
33
|
/**
|
|
34
|
+
* @public
|
|
31
35
|
* <p>The name of the product that generated the finding.</p>
|
|
32
36
|
* <p>Security Hub populates this attribute automatically for each finding. You cannot update this attribute with <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is a custom integration.</p>
|
|
33
37
|
* <p>When you use the Security Hub console or API to filter findings by product name, you use this attribute.</p>
|
|
34
38
|
*/
|
|
35
39
|
ProductName?: string;
|
|
36
40
|
/**
|
|
41
|
+
* @public
|
|
37
42
|
* <p>The name of the company for the product that generated the finding.</p>
|
|
38
43
|
* <p>Security Hub populates this attribute automatically for each finding. You cannot update this attribute with <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is a custom integration.</p>
|
|
39
44
|
* <p>When you use the Security Hub console or API to filter findings by company name, you use this attribute.</p>
|
|
40
45
|
*/
|
|
41
46
|
CompanyName?: string;
|
|
42
47
|
/**
|
|
48
|
+
* @public
|
|
43
49
|
* <p>The Region from which the finding was generated.</p>
|
|
44
50
|
* <p>Security Hub populates this attribute automatically for each finding. You cannot update it using <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>.</p>
|
|
45
51
|
*/
|
|
46
52
|
Region?: string;
|
|
47
53
|
/**
|
|
54
|
+
* @public
|
|
48
55
|
* <p>The identifier for the solution-specific component (a discrete unit of logic) that
|
|
49
56
|
* generated a finding. In various security findings providers' solutions, this generator can
|
|
50
57
|
* be called a rule, a check, a detector, a plugin, etc. </p>
|
|
51
58
|
*/
|
|
52
59
|
GeneratorId: string | undefined;
|
|
53
60
|
/**
|
|
61
|
+
* @public
|
|
54
62
|
* <p>The Amazon Web Services account ID that a finding is generated in.</p>
|
|
55
63
|
*/
|
|
56
64
|
AwsAccountId: string | undefined;
|
|
57
65
|
/**
|
|
66
|
+
* @public
|
|
58
67
|
* <p>One or more finding types in the format of <code>namespace/category/classifier</code>
|
|
59
68
|
* that classify a finding.</p>
|
|
60
69
|
* <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual
|
|
@@ -62,6 +71,7 @@ export interface AwsSecurityFinding {
|
|
|
62
71
|
*/
|
|
63
72
|
Types?: string[];
|
|
64
73
|
/**
|
|
74
|
+
* @public
|
|
65
75
|
* <p>Indicates when the security findings provider first observed the potential security
|
|
66
76
|
* issue that a finding captured.</p>
|
|
67
77
|
* <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
|
|
@@ -70,6 +80,7 @@ export interface AwsSecurityFinding {
|
|
|
70
80
|
*/
|
|
71
81
|
FirstObservedAt?: string;
|
|
72
82
|
/**
|
|
83
|
+
* @public
|
|
73
84
|
* <p>Indicates when the security findings provider most recently observed the potential
|
|
74
85
|
* security issue that a finding captured.</p>
|
|
75
86
|
* <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
|
|
@@ -78,6 +89,7 @@ export interface AwsSecurityFinding {
|
|
|
78
89
|
*/
|
|
79
90
|
LastObservedAt?: string;
|
|
80
91
|
/**
|
|
92
|
+
* @public
|
|
81
93
|
* <p>Indicates when the security findings provider created the potential security issue that
|
|
82
94
|
* a finding captured.</p>
|
|
83
95
|
* <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
|
|
@@ -86,6 +98,7 @@ export interface AwsSecurityFinding {
|
|
|
86
98
|
*/
|
|
87
99
|
CreatedAt: string | undefined;
|
|
88
100
|
/**
|
|
101
|
+
* @public
|
|
89
102
|
* <p>Indicates when the security findings provider last updated the finding record.</p>
|
|
90
103
|
* <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
|
|
91
104
|
* Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
|
|
@@ -93,10 +106,12 @@ export interface AwsSecurityFinding {
|
|
|
93
106
|
*/
|
|
94
107
|
UpdatedAt: string | undefined;
|
|
95
108
|
/**
|
|
109
|
+
* @public
|
|
96
110
|
* <p>A finding's severity.</p>
|
|
97
111
|
*/
|
|
98
112
|
Severity?: Severity;
|
|
99
113
|
/**
|
|
114
|
+
* @public
|
|
100
115
|
* <p>A finding's confidence. Confidence is defined as the likelihood that a finding
|
|
101
116
|
* accurately identifies the behavior or issue that it was intended to identify.</p>
|
|
102
117
|
* <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent
|
|
@@ -104,12 +119,14 @@ export interface AwsSecurityFinding {
|
|
|
104
119
|
*/
|
|
105
120
|
Confidence?: number;
|
|
106
121
|
/**
|
|
122
|
+
* @public
|
|
107
123
|
* <p>The level of importance assigned to the resources associated with the finding.</p>
|
|
108
124
|
* <p>A score of 0 means that the underlying resources have no criticality, and a score of 100
|
|
109
125
|
* is reserved for the most critical resources.</p>
|
|
110
126
|
*/
|
|
111
127
|
Criticality?: number;
|
|
112
128
|
/**
|
|
129
|
+
* @public
|
|
113
130
|
* <p>A finding's title.</p>
|
|
114
131
|
* <note>
|
|
115
132
|
* <p>In this release, <code>Title</code> is a required property.</p>
|
|
@@ -117,6 +134,7 @@ export interface AwsSecurityFinding {
|
|
|
117
134
|
*/
|
|
118
135
|
Title: string | undefined;
|
|
119
136
|
/**
|
|
137
|
+
* @public
|
|
120
138
|
* <p>A finding's description.</p>
|
|
121
139
|
* <note>
|
|
122
140
|
* <p>In this release, <code>Description</code> is a required property.</p>
|
|
@@ -124,106 +142,129 @@ export interface AwsSecurityFinding {
|
|
|
124
142
|
*/
|
|
125
143
|
Description: string | undefined;
|
|
126
144
|
/**
|
|
145
|
+
* @public
|
|
127
146
|
* <p>A data type that describes the remediation options for a finding.</p>
|
|
128
147
|
*/
|
|
129
148
|
Remediation?: Remediation;
|
|
130
149
|
/**
|
|
150
|
+
* @public
|
|
131
151
|
* <p>A URL that links to a page about the current finding in the security findings provider's
|
|
132
152
|
* solution.</p>
|
|
133
153
|
*/
|
|
134
154
|
SourceUrl?: string;
|
|
135
155
|
/**
|
|
156
|
+
* @public
|
|
136
157
|
* <p>A data type where security findings providers can include additional solution-specific
|
|
137
158
|
* details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p>
|
|
138
159
|
* <p>Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.</p>
|
|
139
160
|
*/
|
|
140
161
|
ProductFields?: Record<string, string>;
|
|
141
162
|
/**
|
|
163
|
+
* @public
|
|
142
164
|
* <p>A list of name/value string pairs associated with the finding. These are custom,
|
|
143
165
|
* user-defined fields added to a finding. </p>
|
|
144
166
|
*/
|
|
145
167
|
UserDefinedFields?: Record<string, string>;
|
|
146
168
|
/**
|
|
169
|
+
* @public
|
|
147
170
|
* <p>A list of malware related to a finding.</p>
|
|
148
171
|
*/
|
|
149
172
|
Malware?: Malware[];
|
|
150
173
|
/**
|
|
174
|
+
* @public
|
|
151
175
|
* <p>The details of network-related information about a finding.</p>
|
|
152
176
|
*/
|
|
153
177
|
Network?: Network;
|
|
154
178
|
/**
|
|
179
|
+
* @public
|
|
155
180
|
* <p>Provides information about a network path that is relevant to a finding. Each entry
|
|
156
181
|
* under <code>NetworkPath</code> represents a component of that path.</p>
|
|
157
182
|
*/
|
|
158
183
|
NetworkPath?: NetworkPathComponent[];
|
|
159
184
|
/**
|
|
185
|
+
* @public
|
|
160
186
|
* <p>The details of process-related information about a finding.</p>
|
|
161
187
|
*/
|
|
162
188
|
Process?: ProcessDetails;
|
|
163
189
|
/**
|
|
190
|
+
* @public
|
|
164
191
|
* <p>Details about the threat detected in a security finding and the file paths that were affected by the threat.
|
|
165
192
|
* </p>
|
|
166
193
|
*/
|
|
167
194
|
Threats?: Threat[];
|
|
168
195
|
/**
|
|
196
|
+
* @public
|
|
169
197
|
* <p>Threat intelligence details related to a finding.</p>
|
|
170
198
|
*/
|
|
171
199
|
ThreatIntelIndicators?: ThreatIntelIndicator[];
|
|
172
200
|
/**
|
|
201
|
+
* @public
|
|
173
202
|
* <p>A set of resource data types that describe the resources that the finding refers
|
|
174
203
|
* to.</p>
|
|
175
204
|
*/
|
|
176
205
|
Resources: Resource[] | undefined;
|
|
177
206
|
/**
|
|
207
|
+
* @public
|
|
178
208
|
* <p>This data type is exclusive to findings that are generated as the result of a check run
|
|
179
209
|
* against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations.
|
|
180
210
|
* Contains security standard-related finding details.</p>
|
|
181
211
|
*/
|
|
182
212
|
Compliance?: Compliance;
|
|
183
213
|
/**
|
|
214
|
+
* @public
|
|
184
215
|
* <p>Indicates the veracity of a finding. </p>
|
|
185
216
|
*/
|
|
186
217
|
VerificationState?: VerificationState | string;
|
|
187
218
|
/**
|
|
219
|
+
* @public
|
|
188
220
|
* @deprecated
|
|
189
221
|
*
|
|
190
222
|
* <p>The workflow state of a finding. </p>
|
|
191
223
|
*/
|
|
192
224
|
WorkflowState?: WorkflowState | string;
|
|
193
225
|
/**
|
|
226
|
+
* @public
|
|
194
227
|
* <p>Provides information about the status of the investigation into a finding.</p>
|
|
195
228
|
*/
|
|
196
229
|
Workflow?: Workflow;
|
|
197
230
|
/**
|
|
231
|
+
* @public
|
|
198
232
|
* <p>The record state of a finding.</p>
|
|
199
233
|
*/
|
|
200
234
|
RecordState?: RecordState | string;
|
|
201
235
|
/**
|
|
236
|
+
* @public
|
|
202
237
|
* <p>A list of related findings.</p>
|
|
203
238
|
*/
|
|
204
239
|
RelatedFindings?: RelatedFinding[];
|
|
205
240
|
/**
|
|
241
|
+
* @public
|
|
206
242
|
* <p>A user-defined note added to a finding.</p>
|
|
207
243
|
*/
|
|
208
244
|
Note?: Note;
|
|
209
245
|
/**
|
|
246
|
+
* @public
|
|
210
247
|
* <p>Provides a list of vulnerabilities associated with the findings.</p>
|
|
211
248
|
*/
|
|
212
249
|
Vulnerabilities?: Vulnerability[];
|
|
213
250
|
/**
|
|
251
|
+
* @public
|
|
214
252
|
* <p>Provides an overview of the patch compliance status for an instance against a selected
|
|
215
253
|
* compliance standard.</p>
|
|
216
254
|
*/
|
|
217
255
|
PatchSummary?: PatchSummary;
|
|
218
256
|
/**
|
|
257
|
+
* @public
|
|
219
258
|
* <p>Provides details about an action that affects or that was taken on a resource.</p>
|
|
220
259
|
*/
|
|
221
260
|
Action?: Action;
|
|
222
261
|
/**
|
|
262
|
+
* @public
|
|
223
263
|
* <p>In a <code>BatchImportFindings</code> request, finding providers use <code>FindingProviderFields</code> to provide and update their own values for confidence, criticality, related findings, severity, and types.</p>
|
|
224
264
|
*/
|
|
225
265
|
FindingProviderFields?: FindingProviderFields;
|
|
226
266
|
/**
|
|
267
|
+
* @public
|
|
227
268
|
* <p>Indicates whether the finding is a sample finding.</p>
|
|
228
269
|
*/
|
|
229
270
|
Sample?: boolean;
|
|
@@ -234,6 +275,7 @@ export interface AwsSecurityFinding {
|
|
|
234
275
|
*/
|
|
235
276
|
export interface KeywordFilter {
|
|
236
277
|
/**
|
|
278
|
+
* @public
|
|
237
279
|
* <p>A value for the keyword.</p>
|
|
238
280
|
*/
|
|
239
281
|
Value?: string;
|
|
@@ -244,6 +286,7 @@ export interface KeywordFilter {
|
|
|
244
286
|
*/
|
|
245
287
|
export interface IpFilter {
|
|
246
288
|
/**
|
|
289
|
+
* @public
|
|
247
290
|
* <p>A finding's CIDR value.</p>
|
|
248
291
|
*/
|
|
249
292
|
Cidr?: string;
|
|
@@ -254,6 +297,7 @@ export interface IpFilter {
|
|
|
254
297
|
*/
|
|
255
298
|
export interface BooleanFilter {
|
|
256
299
|
/**
|
|
300
|
+
* @public
|
|
257
301
|
* <p>The value of the boolean.</p>
|
|
258
302
|
*/
|
|
259
303
|
Value?: boolean;
|
|
@@ -267,59 +311,70 @@ export interface BooleanFilter {
|
|
|
267
311
|
*/
|
|
268
312
|
export interface AwsSecurityFindingFilters {
|
|
269
313
|
/**
|
|
314
|
+
* @public
|
|
270
315
|
* <p>The ARN generated by Security Hub that uniquely identifies a third-party company
|
|
271
316
|
* (security findings provider) after this provider's product (solution that generates
|
|
272
317
|
* findings) is registered with Security Hub.</p>
|
|
273
318
|
*/
|
|
274
319
|
ProductArn?: StringFilter[];
|
|
275
320
|
/**
|
|
321
|
+
* @public
|
|
276
322
|
* <p>The Amazon Web Services account ID that a finding is generated in.</p>
|
|
277
323
|
*/
|
|
278
324
|
AwsAccountId?: StringFilter[];
|
|
279
325
|
/**
|
|
326
|
+
* @public
|
|
280
327
|
* <p>The security findings provider-specific identifier for a finding.</p>
|
|
281
328
|
*/
|
|
282
329
|
Id?: StringFilter[];
|
|
283
330
|
/**
|
|
331
|
+
* @public
|
|
284
332
|
* <p>The identifier for the solution-specific component (a discrete unit of logic) that
|
|
285
333
|
* generated a finding. In various security findings providers' solutions, this generator can
|
|
286
334
|
* be called a rule, a check, a detector, a plugin, etc.</p>
|
|
287
335
|
*/
|
|
288
336
|
GeneratorId?: StringFilter[];
|
|
289
337
|
/**
|
|
338
|
+
* @public
|
|
290
339
|
* <p>The Region from which the finding was generated.</p>
|
|
291
340
|
*/
|
|
292
341
|
Region?: StringFilter[];
|
|
293
342
|
/**
|
|
343
|
+
* @public
|
|
294
344
|
* <p>A finding type in the format of <code>namespace/category/classifier</code> that
|
|
295
345
|
* classifies a finding.</p>
|
|
296
346
|
*/
|
|
297
347
|
Type?: StringFilter[];
|
|
298
348
|
/**
|
|
349
|
+
* @public
|
|
299
350
|
* <p>An ISO8601-formatted timestamp that indicates when the security findings provider first
|
|
300
351
|
* observed the potential security issue that a finding captured.</p>
|
|
301
352
|
* <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
|
|
302
353
|
*/
|
|
303
354
|
FirstObservedAt?: DateFilter[];
|
|
304
355
|
/**
|
|
356
|
+
* @public
|
|
305
357
|
* <p>An ISO8601-formatted timestamp that indicates when the security findings provider most
|
|
306
358
|
* recently observed the potential security issue that a finding captured.</p>
|
|
307
359
|
* <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
|
|
308
360
|
*/
|
|
309
361
|
LastObservedAt?: DateFilter[];
|
|
310
362
|
/**
|
|
363
|
+
* @public
|
|
311
364
|
* <p>An ISO8601-formatted timestamp that indicates when the security findings provider
|
|
312
365
|
* captured the potential security issue that a finding captured.</p>
|
|
313
366
|
* <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
|
|
314
367
|
*/
|
|
315
368
|
CreatedAt?: DateFilter[];
|
|
316
369
|
/**
|
|
370
|
+
* @public
|
|
317
371
|
* <p>An ISO8601-formatted timestamp that indicates when the security findings provider last
|
|
318
372
|
* updated the finding record. </p>
|
|
319
373
|
* <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
|
|
320
374
|
*/
|
|
321
375
|
UpdatedAt?: DateFilter[];
|
|
322
376
|
/**
|
|
377
|
+
* @public
|
|
323
378
|
* @deprecated
|
|
324
379
|
*
|
|
325
380
|
* <p>The native severity as defined by the security findings provider's solution that
|
|
@@ -327,16 +382,19 @@ export interface AwsSecurityFindingFilters {
|
|
|
327
382
|
*/
|
|
328
383
|
SeverityProduct?: NumberFilter[];
|
|
329
384
|
/**
|
|
385
|
+
* @public
|
|
330
386
|
* @deprecated
|
|
331
387
|
*
|
|
332
388
|
* <p>The normalized severity of a finding.</p>
|
|
333
389
|
*/
|
|
334
390
|
SeverityNormalized?: NumberFilter[];
|
|
335
391
|
/**
|
|
392
|
+
* @public
|
|
336
393
|
* <p>The label of a finding's severity.</p>
|
|
337
394
|
*/
|
|
338
395
|
SeverityLabel?: StringFilter[];
|
|
339
396
|
/**
|
|
397
|
+
* @public
|
|
340
398
|
* <p>A finding's confidence. Confidence is defined as the likelihood that a finding
|
|
341
399
|
* accurately identifies the behavior or issue that it was intended to identify.</p>
|
|
342
400
|
* <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent
|
|
@@ -344,284 +402,350 @@ export interface AwsSecurityFindingFilters {
|
|
|
344
402
|
*/
|
|
345
403
|
Confidence?: NumberFilter[];
|
|
346
404
|
/**
|
|
405
|
+
* @public
|
|
347
406
|
* <p>The level of importance assigned to the resources associated with the finding.</p>
|
|
348
407
|
* <p>A score of 0 means that the underlying resources have no criticality, and a score of 100
|
|
349
408
|
* is reserved for the most critical resources.</p>
|
|
350
409
|
*/
|
|
351
410
|
Criticality?: NumberFilter[];
|
|
352
411
|
/**
|
|
412
|
+
* @public
|
|
353
413
|
* <p>A finding's title.</p>
|
|
354
414
|
*/
|
|
355
415
|
Title?: StringFilter[];
|
|
356
416
|
/**
|
|
417
|
+
* @public
|
|
357
418
|
* <p>A finding's description.</p>
|
|
358
419
|
*/
|
|
359
420
|
Description?: StringFilter[];
|
|
360
421
|
/**
|
|
422
|
+
* @public
|
|
361
423
|
* <p>The recommendation of what to do about the issue described in a finding.</p>
|
|
362
424
|
*/
|
|
363
425
|
RecommendationText?: StringFilter[];
|
|
364
426
|
/**
|
|
427
|
+
* @public
|
|
365
428
|
* <p>A URL that links to a page about the current finding in the security findings provider's
|
|
366
429
|
* solution.</p>
|
|
367
430
|
*/
|
|
368
431
|
SourceUrl?: StringFilter[];
|
|
369
432
|
/**
|
|
433
|
+
* @public
|
|
370
434
|
* <p>A data type where security findings providers can include additional solution-specific
|
|
371
435
|
* details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p>
|
|
372
436
|
*/
|
|
373
437
|
ProductFields?: MapFilter[];
|
|
374
438
|
/**
|
|
439
|
+
* @public
|
|
375
440
|
* <p>The name of the solution (product) that generates findings.</p>
|
|
376
441
|
*/
|
|
377
442
|
ProductName?: StringFilter[];
|
|
378
443
|
/**
|
|
444
|
+
* @public
|
|
379
445
|
* <p>The name of the findings provider (company) that owns the solution (product) that
|
|
380
446
|
* generates findings.</p>
|
|
381
447
|
*/
|
|
382
448
|
CompanyName?: StringFilter[];
|
|
383
449
|
/**
|
|
450
|
+
* @public
|
|
384
451
|
* <p>A list of name/value string pairs associated with the finding. These are custom,
|
|
385
452
|
* user-defined fields added to a finding. </p>
|
|
386
453
|
*/
|
|
387
454
|
UserDefinedFields?: MapFilter[];
|
|
388
455
|
/**
|
|
456
|
+
* @public
|
|
389
457
|
* <p>The name of the malware that was observed.</p>
|
|
390
458
|
*/
|
|
391
459
|
MalwareName?: StringFilter[];
|
|
392
460
|
/**
|
|
461
|
+
* @public
|
|
393
462
|
* <p>The type of the malware that was observed.</p>
|
|
394
463
|
*/
|
|
395
464
|
MalwareType?: StringFilter[];
|
|
396
465
|
/**
|
|
466
|
+
* @public
|
|
397
467
|
* <p>The filesystem path of the malware that was observed.</p>
|
|
398
468
|
*/
|
|
399
469
|
MalwarePath?: StringFilter[];
|
|
400
470
|
/**
|
|
471
|
+
* @public
|
|
401
472
|
* <p>The state of the malware that was observed.</p>
|
|
402
473
|
*/
|
|
403
474
|
MalwareState?: StringFilter[];
|
|
404
475
|
/**
|
|
476
|
+
* @public
|
|
405
477
|
* <p>Indicates the direction of network traffic associated with a finding.</p>
|
|
406
478
|
*/
|
|
407
479
|
NetworkDirection?: StringFilter[];
|
|
408
480
|
/**
|
|
481
|
+
* @public
|
|
409
482
|
* <p>The protocol of network-related information about a finding.</p>
|
|
410
483
|
*/
|
|
411
484
|
NetworkProtocol?: StringFilter[];
|
|
412
485
|
/**
|
|
486
|
+
* @public
|
|
413
487
|
* <p>The source IPv4 address of network-related information about a finding.</p>
|
|
414
488
|
*/
|
|
415
489
|
NetworkSourceIpV4?: IpFilter[];
|
|
416
490
|
/**
|
|
491
|
+
* @public
|
|
417
492
|
* <p>The source IPv6 address of network-related information about a finding.</p>
|
|
418
493
|
*/
|
|
419
494
|
NetworkSourceIpV6?: IpFilter[];
|
|
420
495
|
/**
|
|
496
|
+
* @public
|
|
421
497
|
* <p>The source port of network-related information about a finding.</p>
|
|
422
498
|
*/
|
|
423
499
|
NetworkSourcePort?: NumberFilter[];
|
|
424
500
|
/**
|
|
501
|
+
* @public
|
|
425
502
|
* <p>The source domain of network-related information about a finding.</p>
|
|
426
503
|
*/
|
|
427
504
|
NetworkSourceDomain?: StringFilter[];
|
|
428
505
|
/**
|
|
506
|
+
* @public
|
|
429
507
|
* <p>The source media access control (MAC) address of network-related information about a
|
|
430
508
|
* finding.</p>
|
|
431
509
|
*/
|
|
432
510
|
NetworkSourceMac?: StringFilter[];
|
|
433
511
|
/**
|
|
512
|
+
* @public
|
|
434
513
|
* <p>The destination IPv4 address of network-related information about a finding.</p>
|
|
435
514
|
*/
|
|
436
515
|
NetworkDestinationIpV4?: IpFilter[];
|
|
437
516
|
/**
|
|
517
|
+
* @public
|
|
438
518
|
* <p>The destination IPv6 address of network-related information about a finding.</p>
|
|
439
519
|
*/
|
|
440
520
|
NetworkDestinationIpV6?: IpFilter[];
|
|
441
521
|
/**
|
|
522
|
+
* @public
|
|
442
523
|
* <p>The destination port of network-related information about a finding.</p>
|
|
443
524
|
*/
|
|
444
525
|
NetworkDestinationPort?: NumberFilter[];
|
|
445
526
|
/**
|
|
527
|
+
* @public
|
|
446
528
|
* <p>The destination domain of network-related information about a finding.</p>
|
|
447
529
|
*/
|
|
448
530
|
NetworkDestinationDomain?: StringFilter[];
|
|
449
531
|
/**
|
|
532
|
+
* @public
|
|
450
533
|
* <p>The name of the process.</p>
|
|
451
534
|
*/
|
|
452
535
|
ProcessName?: StringFilter[];
|
|
453
536
|
/**
|
|
537
|
+
* @public
|
|
454
538
|
* <p>The path to the process executable.</p>
|
|
455
539
|
*/
|
|
456
540
|
ProcessPath?: StringFilter[];
|
|
457
541
|
/**
|
|
542
|
+
* @public
|
|
458
543
|
* <p>The process ID.</p>
|
|
459
544
|
*/
|
|
460
545
|
ProcessPid?: NumberFilter[];
|
|
461
546
|
/**
|
|
547
|
+
* @public
|
|
462
548
|
* <p>The parent process ID. This field accepts positive integers between <code>O</code> and <code>2147483647</code>.</p>
|
|
463
549
|
*/
|
|
464
550
|
ProcessParentPid?: NumberFilter[];
|
|
465
551
|
/**
|
|
552
|
+
* @public
|
|
466
553
|
* <p>A timestamp that identifies when the process was launched.</p>
|
|
467
554
|
* <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
|
|
468
555
|
*/
|
|
469
556
|
ProcessLaunchedAt?: DateFilter[];
|
|
470
557
|
/**
|
|
558
|
+
* @public
|
|
471
559
|
* <p>A timestamp that identifies when the process was terminated.</p>
|
|
472
560
|
* <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
|
|
473
561
|
*/
|
|
474
562
|
ProcessTerminatedAt?: DateFilter[];
|
|
475
563
|
/**
|
|
564
|
+
* @public
|
|
476
565
|
* <p>The type of a threat intelligence indicator.</p>
|
|
477
566
|
*/
|
|
478
567
|
ThreatIntelIndicatorType?: StringFilter[];
|
|
479
568
|
/**
|
|
569
|
+
* @public
|
|
480
570
|
* <p>The value of a threat intelligence indicator.</p>
|
|
481
571
|
*/
|
|
482
572
|
ThreatIntelIndicatorValue?: StringFilter[];
|
|
483
573
|
/**
|
|
574
|
+
* @public
|
|
484
575
|
* <p>The category of a threat intelligence indicator.</p>
|
|
485
576
|
*/
|
|
486
577
|
ThreatIntelIndicatorCategory?: StringFilter[];
|
|
487
578
|
/**
|
|
579
|
+
* @public
|
|
488
580
|
* <p>A timestamp that identifies the last observation of a threat intelligence indicator.</p>
|
|
489
581
|
*/
|
|
490
582
|
ThreatIntelIndicatorLastObservedAt?: DateFilter[];
|
|
491
583
|
/**
|
|
584
|
+
* @public
|
|
492
585
|
* <p>The source of the threat intelligence.</p>
|
|
493
586
|
*/
|
|
494
587
|
ThreatIntelIndicatorSource?: StringFilter[];
|
|
495
588
|
/**
|
|
589
|
+
* @public
|
|
496
590
|
* <p>The URL for more details from the source of the threat intelligence.</p>
|
|
497
591
|
*/
|
|
498
592
|
ThreatIntelIndicatorSourceUrl?: StringFilter[];
|
|
499
593
|
/**
|
|
594
|
+
* @public
|
|
500
595
|
* <p>Specifies the type of the resource that details are provided for.</p>
|
|
501
596
|
*/
|
|
502
597
|
ResourceType?: StringFilter[];
|
|
503
598
|
/**
|
|
599
|
+
* @public
|
|
504
600
|
* <p>The canonical identifier for the given resource type.</p>
|
|
505
601
|
*/
|
|
506
602
|
ResourceId?: StringFilter[];
|
|
507
603
|
/**
|
|
604
|
+
* @public
|
|
508
605
|
* <p>The canonical Amazon Web Services partition name that the Region is assigned to.</p>
|
|
509
606
|
*/
|
|
510
607
|
ResourcePartition?: StringFilter[];
|
|
511
608
|
/**
|
|
609
|
+
* @public
|
|
512
610
|
* <p>The canonical Amazon Web Services external Region name where this resource is located.</p>
|
|
513
611
|
*/
|
|
514
612
|
ResourceRegion?: StringFilter[];
|
|
515
613
|
/**
|
|
614
|
+
* @public
|
|
516
615
|
* <p>A list of Amazon Web Services tags associated with a resource at the time the finding was
|
|
517
616
|
* processed.</p>
|
|
518
617
|
*/
|
|
519
618
|
ResourceTags?: MapFilter[];
|
|
520
619
|
/**
|
|
620
|
+
* @public
|
|
521
621
|
* <p>The instance type of the instance.</p>
|
|
522
622
|
*/
|
|
523
623
|
ResourceAwsEc2InstanceType?: StringFilter[];
|
|
524
624
|
/**
|
|
625
|
+
* @public
|
|
525
626
|
* <p>The Amazon Machine Image (AMI) ID of the instance.</p>
|
|
526
627
|
*/
|
|
527
628
|
ResourceAwsEc2InstanceImageId?: StringFilter[];
|
|
528
629
|
/**
|
|
630
|
+
* @public
|
|
529
631
|
* <p>The IPv4 addresses associated with the instance.</p>
|
|
530
632
|
*/
|
|
531
633
|
ResourceAwsEc2InstanceIpV4Addresses?: IpFilter[];
|
|
532
634
|
/**
|
|
635
|
+
* @public
|
|
533
636
|
* <p>The IPv6 addresses associated with the instance.</p>
|
|
534
637
|
*/
|
|
535
638
|
ResourceAwsEc2InstanceIpV6Addresses?: IpFilter[];
|
|
536
639
|
/**
|
|
640
|
+
* @public
|
|
537
641
|
* <p>The key name associated with the instance.</p>
|
|
538
642
|
*/
|
|
539
643
|
ResourceAwsEc2InstanceKeyName?: StringFilter[];
|
|
540
644
|
/**
|
|
645
|
+
* @public
|
|
541
646
|
* <p>The IAM profile ARN of the instance.</p>
|
|
542
647
|
*/
|
|
543
648
|
ResourceAwsEc2InstanceIamInstanceProfileArn?: StringFilter[];
|
|
544
649
|
/**
|
|
650
|
+
* @public
|
|
545
651
|
* <p>The identifier of the VPC that the instance was launched in.</p>
|
|
546
652
|
*/
|
|
547
653
|
ResourceAwsEc2InstanceVpcId?: StringFilter[];
|
|
548
654
|
/**
|
|
655
|
+
* @public
|
|
549
656
|
* <p>The identifier of the subnet that the instance was launched in.</p>
|
|
550
657
|
*/
|
|
551
658
|
ResourceAwsEc2InstanceSubnetId?: StringFilter[];
|
|
552
659
|
/**
|
|
660
|
+
* @public
|
|
553
661
|
* <p>The date and time the instance was launched.</p>
|
|
554
662
|
*/
|
|
555
663
|
ResourceAwsEc2InstanceLaunchedAt?: DateFilter[];
|
|
556
664
|
/**
|
|
665
|
+
* @public
|
|
557
666
|
* <p>The canonical user ID of the owner of the S3 bucket.</p>
|
|
558
667
|
*/
|
|
559
668
|
ResourceAwsS3BucketOwnerId?: StringFilter[];
|
|
560
669
|
/**
|
|
670
|
+
* @public
|
|
561
671
|
* <p>The display name of the owner of the S3 bucket.</p>
|
|
562
672
|
*/
|
|
563
673
|
ResourceAwsS3BucketOwnerName?: StringFilter[];
|
|
564
674
|
/**
|
|
675
|
+
* @public
|
|
565
676
|
* @deprecated
|
|
566
677
|
*
|
|
567
678
|
* <p>The user associated with the IAM access key related to a finding.</p>
|
|
568
679
|
*/
|
|
569
680
|
ResourceAwsIamAccessKeyUserName?: StringFilter[];
|
|
570
681
|
/**
|
|
682
|
+
* @public
|
|
571
683
|
* <p>The name of the principal that is associated with an IAM access key.</p>
|
|
572
684
|
*/
|
|
573
685
|
ResourceAwsIamAccessKeyPrincipalName?: StringFilter[];
|
|
574
686
|
/**
|
|
687
|
+
* @public
|
|
575
688
|
* <p>The status of the IAM access key related to a finding.</p>
|
|
576
689
|
*/
|
|
577
690
|
ResourceAwsIamAccessKeyStatus?: StringFilter[];
|
|
578
691
|
/**
|
|
692
|
+
* @public
|
|
579
693
|
* <p>The creation date/time of the IAM access key related to a finding.</p>
|
|
580
694
|
*/
|
|
581
695
|
ResourceAwsIamAccessKeyCreatedAt?: DateFilter[];
|
|
582
696
|
/**
|
|
697
|
+
* @public
|
|
583
698
|
* <p>The name of an IAM user.</p>
|
|
584
699
|
*/
|
|
585
700
|
ResourceAwsIamUserUserName?: StringFilter[];
|
|
586
701
|
/**
|
|
702
|
+
* @public
|
|
587
703
|
* <p>The name of the container related to a finding.</p>
|
|
588
704
|
*/
|
|
589
705
|
ResourceContainerName?: StringFilter[];
|
|
590
706
|
/**
|
|
707
|
+
* @public
|
|
591
708
|
* <p>The identifier of the image related to a finding.</p>
|
|
592
709
|
*/
|
|
593
710
|
ResourceContainerImageId?: StringFilter[];
|
|
594
711
|
/**
|
|
712
|
+
* @public
|
|
595
713
|
* <p>The name of the image related to a finding.</p>
|
|
596
714
|
*/
|
|
597
715
|
ResourceContainerImageName?: StringFilter[];
|
|
598
716
|
/**
|
|
717
|
+
* @public
|
|
599
718
|
* <p>A timestamp that identifies when the container was started.</p>
|
|
600
719
|
* <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
|
|
601
720
|
*/
|
|
602
721
|
ResourceContainerLaunchedAt?: DateFilter[];
|
|
603
722
|
/**
|
|
723
|
+
* @public
|
|
604
724
|
* <p>The details of a resource that doesn't have a specific subfield for the resource type
|
|
605
725
|
* defined.</p>
|
|
606
726
|
*/
|
|
607
727
|
ResourceDetailsOther?: MapFilter[];
|
|
608
728
|
/**
|
|
729
|
+
* @public
|
|
609
730
|
* <p>Exclusive to findings that are generated as the result of a check run against a specific
|
|
610
731
|
* rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security
|
|
611
732
|
* standard-related finding details.</p>
|
|
612
733
|
*/
|
|
613
734
|
ComplianceStatus?: StringFilter[];
|
|
614
735
|
/**
|
|
736
|
+
* @public
|
|
615
737
|
* <p>The veracity of a finding.</p>
|
|
616
738
|
*/
|
|
617
739
|
VerificationState?: StringFilter[];
|
|
618
740
|
/**
|
|
741
|
+
* @public
|
|
619
742
|
* <p>The workflow state of a finding.</p>
|
|
620
743
|
* <p>Note that this field is deprecated. To search for a finding based on its workflow
|
|
621
744
|
* status, use <code>WorkflowStatus</code>.</p>
|
|
622
745
|
*/
|
|
623
746
|
WorkflowState?: StringFilter[];
|
|
624
747
|
/**
|
|
748
|
+
* @public
|
|
625
749
|
* <p>The status of the investigation into a finding. Allowed values are the following.</p>
|
|
626
750
|
* <ul>
|
|
627
751
|
* <li>
|
|
@@ -694,36 +818,44 @@ export interface AwsSecurityFindingFilters {
|
|
|
694
818
|
*/
|
|
695
819
|
WorkflowStatus?: StringFilter[];
|
|
696
820
|
/**
|
|
821
|
+
* @public
|
|
697
822
|
* <p>The updated record state for the finding.</p>
|
|
698
823
|
*/
|
|
699
824
|
RecordState?: StringFilter[];
|
|
700
825
|
/**
|
|
826
|
+
* @public
|
|
701
827
|
* <p>The ARN of the solution that generated a related finding.</p>
|
|
702
828
|
*/
|
|
703
829
|
RelatedFindingsProductArn?: StringFilter[];
|
|
704
830
|
/**
|
|
831
|
+
* @public
|
|
705
832
|
* <p>The solution-generated identifier for a related finding.</p>
|
|
706
833
|
*/
|
|
707
834
|
RelatedFindingsId?: StringFilter[];
|
|
708
835
|
/**
|
|
836
|
+
* @public
|
|
709
837
|
* <p>The text of a note.</p>
|
|
710
838
|
*/
|
|
711
839
|
NoteText?: StringFilter[];
|
|
712
840
|
/**
|
|
841
|
+
* @public
|
|
713
842
|
* <p>The timestamp of when the note was updated.</p>
|
|
714
843
|
*/
|
|
715
844
|
NoteUpdatedAt?: DateFilter[];
|
|
716
845
|
/**
|
|
846
|
+
* @public
|
|
717
847
|
* <p>The principal that created a note.</p>
|
|
718
848
|
*/
|
|
719
849
|
NoteUpdatedBy?: StringFilter[];
|
|
720
850
|
/**
|
|
851
|
+
* @public
|
|
721
852
|
* @deprecated
|
|
722
853
|
*
|
|
723
854
|
* <p>A keyword for a finding.</p>
|
|
724
855
|
*/
|
|
725
856
|
Keyword?: KeywordFilter[];
|
|
726
857
|
/**
|
|
858
|
+
* @public
|
|
727
859
|
* <p>The finding provider value for the finding confidence. Confidence is defined as the likelihood
|
|
728
860
|
* that a finding accurately identifies the behavior or issue that it was intended to
|
|
729
861
|
* identify.</p>
|
|
@@ -732,6 +864,7 @@ export interface AwsSecurityFindingFilters {
|
|
|
732
864
|
*/
|
|
733
865
|
FindingProviderFieldsConfidence?: NumberFilter[];
|
|
734
866
|
/**
|
|
867
|
+
* @public
|
|
735
868
|
* <p>The finding provider value for the level of importance assigned to the resources associated with
|
|
736
869
|
* the findings.</p>
|
|
737
870
|
* <p>A score of 0 means that the underlying resources have no criticality, and a score of 100
|
|
@@ -739,22 +872,27 @@ export interface AwsSecurityFindingFilters {
|
|
|
739
872
|
*/
|
|
740
873
|
FindingProviderFieldsCriticality?: NumberFilter[];
|
|
741
874
|
/**
|
|
875
|
+
* @public
|
|
742
876
|
* <p>The finding identifier of a related finding that is identified by the finding provider.</p>
|
|
743
877
|
*/
|
|
744
878
|
FindingProviderFieldsRelatedFindingsId?: StringFilter[];
|
|
745
879
|
/**
|
|
880
|
+
* @public
|
|
746
881
|
* <p>The ARN of the solution that generated a related finding that is identified by the finding provider.</p>
|
|
747
882
|
*/
|
|
748
883
|
FindingProviderFieldsRelatedFindingsProductArn?: StringFilter[];
|
|
749
884
|
/**
|
|
885
|
+
* @public
|
|
750
886
|
* <p>The finding provider value for the severity label.</p>
|
|
751
887
|
*/
|
|
752
888
|
FindingProviderFieldsSeverityLabel?: StringFilter[];
|
|
753
889
|
/**
|
|
890
|
+
* @public
|
|
754
891
|
* <p>The finding provider's original value for the severity.</p>
|
|
755
892
|
*/
|
|
756
893
|
FindingProviderFieldsSeverityOriginal?: StringFilter[];
|
|
757
894
|
/**
|
|
895
|
+
* @public
|
|
758
896
|
* <p>One or more finding types that the finding provider assigned to the finding. Uses the format of <code>namespace/category/classifier</code>
|
|
759
897
|
* that classify a finding.</p>
|
|
760
898
|
* <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual
|
|
@@ -762,10 +900,12 @@ export interface AwsSecurityFindingFilters {
|
|
|
762
900
|
*/
|
|
763
901
|
FindingProviderFieldsTypes?: StringFilter[];
|
|
764
902
|
/**
|
|
903
|
+
* @public
|
|
765
904
|
* <p>Indicates whether or not sample findings are included in the filter results.</p>
|
|
766
905
|
*/
|
|
767
906
|
Sample?: BooleanFilter[];
|
|
768
907
|
/**
|
|
908
|
+
* @public
|
|
769
909
|
* <p>
|
|
770
910
|
* The unique identifier of a control across standards. Values for this field typically consist of an
|
|
771
911
|
* Amazon Web Service and a number, such as APIGateway.5.
|
|
@@ -773,6 +913,7 @@ export interface AwsSecurityFindingFilters {
|
|
|
773
913
|
*/
|
|
774
914
|
ComplianceSecurityControlId?: StringFilter[];
|
|
775
915
|
/**
|
|
916
|
+
* @public
|
|
776
917
|
* <p>
|
|
777
918
|
* The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the
|
|
778
919
|
* Amazon Resource Name (ARN) returned for a standard in the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html">DescribeStandards</a> API response.
|
|
@@ -786,10 +927,12 @@ export interface AwsSecurityFindingFilters {
|
|
|
786
927
|
*/
|
|
787
928
|
export interface AwsSecurityFindingIdentifier {
|
|
788
929
|
/**
|
|
930
|
+
* @public
|
|
789
931
|
* <p>The identifier of the finding that was specified by the finding provider.</p>
|
|
790
932
|
*/
|
|
791
933
|
Id: string | undefined;
|
|
792
934
|
/**
|
|
935
|
+
* @public
|
|
793
936
|
* <p>The ARN generated by Security Hub that uniquely identifies a product that generates findings.
|
|
794
937
|
* This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for
|
|
795
938
|
* a custom integration.</p>
|
|
@@ -801,6 +944,7 @@ export interface AwsSecurityFindingIdentifier {
|
|
|
801
944
|
*/
|
|
802
945
|
export interface BatchDeleteAutomationRulesRequest {
|
|
803
946
|
/**
|
|
947
|
+
* @public
|
|
804
948
|
* <p>
|
|
805
949
|
* A list of Amazon Resource Names (ARNs) for the rules that are to be deleted.
|
|
806
950
|
* </p>
|
|
@@ -816,18 +960,21 @@ export interface BatchDeleteAutomationRulesRequest {
|
|
|
816
960
|
*/
|
|
817
961
|
export interface UnprocessedAutomationRule {
|
|
818
962
|
/**
|
|
963
|
+
* @public
|
|
819
964
|
* <p>
|
|
820
965
|
* The Amazon Resource Name (ARN) for the unprocessed automation rule.
|
|
821
966
|
* </p>
|
|
822
967
|
*/
|
|
823
968
|
RuleArn?: string;
|
|
824
969
|
/**
|
|
970
|
+
* @public
|
|
825
971
|
* <p>
|
|
826
972
|
* The error code associated with the unprocessed automation rule.
|
|
827
973
|
* </p>
|
|
828
974
|
*/
|
|
829
975
|
ErrorCode?: number;
|
|
830
976
|
/**
|
|
977
|
+
* @public
|
|
831
978
|
* <p>
|
|
832
979
|
* An error message describing why a request didn't process a specific rule.
|
|
833
980
|
* </p>
|
|
@@ -839,12 +986,14 @@ export interface UnprocessedAutomationRule {
|
|
|
839
986
|
*/
|
|
840
987
|
export interface BatchDeleteAutomationRulesResponse {
|
|
841
988
|
/**
|
|
989
|
+
* @public
|
|
842
990
|
* <p>
|
|
843
991
|
* A list of properly processed rule ARNs.
|
|
844
992
|
* </p>
|
|
845
993
|
*/
|
|
846
994
|
ProcessedAutomationRules?: string[];
|
|
847
995
|
/**
|
|
996
|
+
* @public
|
|
848
997
|
* <p>
|
|
849
998
|
* A list of objects containing <code>RuleArn</code>, <code>ErrorCode</code>, and <code>ErrorMessage</code>. This parameter
|
|
850
999
|
* tells you which automation rules the request didn't delete and why.
|
|
@@ -857,6 +1006,7 @@ export interface BatchDeleteAutomationRulesResponse {
|
|
|
857
1006
|
*/
|
|
858
1007
|
export interface BatchDisableStandardsRequest {
|
|
859
1008
|
/**
|
|
1009
|
+
* @public
|
|
860
1010
|
* <p>The ARNs of the standards subscriptions to disable.</p>
|
|
861
1011
|
*/
|
|
862
1012
|
StandardsSubscriptionArns: string[] | undefined;
|
|
@@ -894,6 +1044,7 @@ export type StatusReasonCode = (typeof StatusReasonCode)[keyof typeof StatusReas
|
|
|
894
1044
|
*/
|
|
895
1045
|
export interface StandardsStatusReason {
|
|
896
1046
|
/**
|
|
1047
|
+
* @public
|
|
897
1048
|
* <p>The reason code that represents the reason for the current status of a standard subscription.</p>
|
|
898
1049
|
*/
|
|
899
1050
|
StatusReasonCode: StatusReasonCode | string | undefined;
|
|
@@ -904,18 +1055,22 @@ export interface StandardsStatusReason {
|
|
|
904
1055
|
*/
|
|
905
1056
|
export interface StandardsSubscription {
|
|
906
1057
|
/**
|
|
1058
|
+
* @public
|
|
907
1059
|
* <p>The ARN of a resource that represents your subscription to a supported standard.</p>
|
|
908
1060
|
*/
|
|
909
1061
|
StandardsSubscriptionArn: string | undefined;
|
|
910
1062
|
/**
|
|
1063
|
+
* @public
|
|
911
1064
|
* <p>The ARN of a standard.</p>
|
|
912
1065
|
*/
|
|
913
1066
|
StandardsArn: string | undefined;
|
|
914
1067
|
/**
|
|
1068
|
+
* @public
|
|
915
1069
|
* <p>A key-value pair of input for the standard.</p>
|
|
916
1070
|
*/
|
|
917
1071
|
StandardsInput: Record<string, string> | undefined;
|
|
918
1072
|
/**
|
|
1073
|
+
* @public
|
|
919
1074
|
* <p>The status of the standard subscription.</p>
|
|
920
1075
|
* <p>The status values are as follows:</p>
|
|
921
1076
|
* <ul>
|
|
@@ -943,6 +1098,7 @@ export interface StandardsSubscription {
|
|
|
943
1098
|
*/
|
|
944
1099
|
StandardsStatus: StandardsStatus | string | undefined;
|
|
945
1100
|
/**
|
|
1101
|
+
* @public
|
|
946
1102
|
* <p>The reason for the current status.</p>
|
|
947
1103
|
*/
|
|
948
1104
|
StandardsStatusReason?: StandardsStatusReason;
|
|
@@ -952,6 +1108,7 @@ export interface StandardsSubscription {
|
|
|
952
1108
|
*/
|
|
953
1109
|
export interface BatchDisableStandardsResponse {
|
|
954
1110
|
/**
|
|
1111
|
+
* @public
|
|
955
1112
|
* <p>The details of the standards subscriptions that were disabled.</p>
|
|
956
1113
|
*/
|
|
957
1114
|
StandardsSubscriptions?: StandardsSubscription[];
|
|
@@ -962,11 +1119,13 @@ export interface BatchDisableStandardsResponse {
|
|
|
962
1119
|
*/
|
|
963
1120
|
export interface StandardsSubscriptionRequest {
|
|
964
1121
|
/**
|
|
1122
|
+
* @public
|
|
965
1123
|
* <p>The ARN of the standard that you want to enable. To view the list of available standards
|
|
966
1124
|
* and their ARNs, use the <code>DescribeStandards</code> operation.</p>
|
|
967
1125
|
*/
|
|
968
1126
|
StandardsArn: string | undefined;
|
|
969
1127
|
/**
|
|
1128
|
+
* @public
|
|
970
1129
|
* <p>A key-value pair of input for the standard.</p>
|
|
971
1130
|
*/
|
|
972
1131
|
StandardsInput?: Record<string, string>;
|
|
@@ -976,6 +1135,7 @@ export interface StandardsSubscriptionRequest {
|
|
|
976
1135
|
*/
|
|
977
1136
|
export interface BatchEnableStandardsRequest {
|
|
978
1137
|
/**
|
|
1138
|
+
* @public
|
|
979
1139
|
* <p>The list of standards checks to enable.</p>
|
|
980
1140
|
*/
|
|
981
1141
|
StandardsSubscriptionRequests: StandardsSubscriptionRequest[] | undefined;
|
|
@@ -985,6 +1145,7 @@ export interface BatchEnableStandardsRequest {
|
|
|
985
1145
|
*/
|
|
986
1146
|
export interface BatchEnableStandardsResponse {
|
|
987
1147
|
/**
|
|
1148
|
+
* @public
|
|
988
1149
|
* <p>The details of the standards subscriptions that were enabled.</p>
|
|
989
1150
|
*/
|
|
990
1151
|
StandardsSubscriptions?: StandardsSubscription[];
|
|
@@ -994,6 +1155,7 @@ export interface BatchEnableStandardsResponse {
|
|
|
994
1155
|
*/
|
|
995
1156
|
export interface BatchGetAutomationRulesRequest {
|
|
996
1157
|
/**
|
|
1158
|
+
* @public
|
|
997
1159
|
* <p>
|
|
998
1160
|
* A list of rule ARNs to get details for.
|
|
999
1161
|
* </p>
|
|
@@ -1005,12 +1167,14 @@ export interface BatchGetAutomationRulesRequest {
|
|
|
1005
1167
|
*/
|
|
1006
1168
|
export interface BatchGetAutomationRulesResponse {
|
|
1007
1169
|
/**
|
|
1170
|
+
* @public
|
|
1008
1171
|
* <p>
|
|
1009
1172
|
* A list of rule details for the provided rule ARNs.
|
|
1010
1173
|
* </p>
|
|
1011
1174
|
*/
|
|
1012
1175
|
Rules?: AutomationRulesConfig[];
|
|
1013
1176
|
/**
|
|
1177
|
+
* @public
|
|
1014
1178
|
* <p>
|
|
1015
1179
|
* A list of objects containing <code>RuleArn</code>, <code>ErrorCode</code>, and <code>ErrorMessage</code>. This parameter
|
|
1016
1180
|
* tells you which automation rules the request didn't retrieve and why.
|
|
@@ -1023,6 +1187,7 @@ export interface BatchGetAutomationRulesResponse {
|
|
|
1023
1187
|
*/
|
|
1024
1188
|
export interface BatchGetSecurityControlsRequest {
|
|
1025
1189
|
/**
|
|
1190
|
+
* @public
|
|
1026
1191
|
* <p> A list of security controls (identified with <code>SecurityControlId</code>,
|
|
1027
1192
|
* <code>SecurityControlArn</code>, or a mix of both parameters). The security control ID
|
|
1028
1193
|
* or Amazon Resource Name (ARN) is the same across standards. </p>
|
|
@@ -1063,6 +1228,7 @@ export type SeverityRating = (typeof SeverityRating)[keyof typeof SeverityRating
|
|
|
1063
1228
|
*/
|
|
1064
1229
|
export interface SecurityControl {
|
|
1065
1230
|
/**
|
|
1231
|
+
* @public
|
|
1066
1232
|
* <p>
|
|
1067
1233
|
* The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a
|
|
1068
1234
|
* number, such as APIGateway.3.
|
|
@@ -1070,29 +1236,34 @@ export interface SecurityControl {
|
|
|
1070
1236
|
*/
|
|
1071
1237
|
SecurityControlId: string | undefined;
|
|
1072
1238
|
/**
|
|
1239
|
+
* @public
|
|
1073
1240
|
* <p> The Amazon Resource Name (ARN) for a security control across standards, such as
|
|
1074
1241
|
* <code>arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1</code>. This
|
|
1075
1242
|
* parameter doesn't mention a specific standard. </p>
|
|
1076
1243
|
*/
|
|
1077
1244
|
SecurityControlArn: string | undefined;
|
|
1078
1245
|
/**
|
|
1246
|
+
* @public
|
|
1079
1247
|
* <p>The title of a security control.
|
|
1080
1248
|
* </p>
|
|
1081
1249
|
*/
|
|
1082
1250
|
Title: string | undefined;
|
|
1083
1251
|
/**
|
|
1252
|
+
* @public
|
|
1084
1253
|
* <p> The description of a security control across standards. This typically summarizes how
|
|
1085
1254
|
* Security Hub evaluates the control and the conditions under which it produces a
|
|
1086
1255
|
* failed finding. This parameter doesn't reference a specific standard. </p>
|
|
1087
1256
|
*/
|
|
1088
1257
|
Description: string | undefined;
|
|
1089
1258
|
/**
|
|
1259
|
+
* @public
|
|
1090
1260
|
* <p>
|
|
1091
1261
|
* A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
|
|
1092
1262
|
* </p>
|
|
1093
1263
|
*/
|
|
1094
1264
|
RemediationUrl: string | undefined;
|
|
1095
1265
|
/**
|
|
1266
|
+
* @public
|
|
1096
1267
|
* <p>
|
|
1097
1268
|
* The severity of a security control. For more information about how Security Hub determines control severity, see
|
|
1098
1269
|
* <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity">Assigning severity to control findings</a> in the
|
|
@@ -1101,6 +1272,7 @@ export interface SecurityControl {
|
|
|
1101
1272
|
*/
|
|
1102
1273
|
SeverityRating: SeverityRating | string | undefined;
|
|
1103
1274
|
/**
|
|
1275
|
+
* @public
|
|
1104
1276
|
* <p>
|
|
1105
1277
|
* The enablement status of a security control in a specific standard.
|
|
1106
1278
|
* </p>
|
|
@@ -1127,18 +1299,21 @@ export type UnprocessedErrorCode = (typeof UnprocessedErrorCode)[keyof typeof Un
|
|
|
1127
1299
|
*/
|
|
1128
1300
|
export interface UnprocessedSecurityControl {
|
|
1129
1301
|
/**
|
|
1302
|
+
* @public
|
|
1130
1303
|
* <p> The control (identified with <code>SecurityControlId</code>,
|
|
1131
1304
|
* <code>SecurityControlArn</code>, or a mix of both parameters) for which a response
|
|
1132
1305
|
* couldn't be returned. </p>
|
|
1133
1306
|
*/
|
|
1134
1307
|
SecurityControlId: string | undefined;
|
|
1135
1308
|
/**
|
|
1309
|
+
* @public
|
|
1136
1310
|
* <p>
|
|
1137
1311
|
* The error code for the unprocessed security control.
|
|
1138
1312
|
* </p>
|
|
1139
1313
|
*/
|
|
1140
1314
|
ErrorCode: UnprocessedErrorCode | string | undefined;
|
|
1141
1315
|
/**
|
|
1316
|
+
* @public
|
|
1142
1317
|
* <p>
|
|
1143
1318
|
* The reason why the security control was unprocessed.
|
|
1144
1319
|
* </p>
|
|
@@ -1150,6 +1325,7 @@ export interface UnprocessedSecurityControl {
|
|
|
1150
1325
|
*/
|
|
1151
1326
|
export interface BatchGetSecurityControlsResponse {
|
|
1152
1327
|
/**
|
|
1328
|
+
* @public
|
|
1153
1329
|
* <p>
|
|
1154
1330
|
* An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control.
|
|
1155
1331
|
* The same information is returned whether the request includes <code>SecurityControlId</code> or <code>SecurityControlArn</code>.
|
|
@@ -1157,6 +1333,7 @@ export interface BatchGetSecurityControlsResponse {
|
|
|
1157
1333
|
*/
|
|
1158
1334
|
SecurityControls: SecurityControl[] | undefined;
|
|
1159
1335
|
/**
|
|
1336
|
+
* @public
|
|
1160
1337
|
* <p>
|
|
1161
1338
|
* A security control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) for which
|
|
1162
1339
|
* details cannot be returned.
|
|
@@ -1173,6 +1350,7 @@ export interface BatchGetSecurityControlsResponse {
|
|
|
1173
1350
|
*/
|
|
1174
1351
|
export interface StandardsControlAssociationId {
|
|
1175
1352
|
/**
|
|
1353
|
+
* @public
|
|
1176
1354
|
* <p>
|
|
1177
1355
|
* The unique identifier (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) of a security
|
|
1178
1356
|
* control across standards.
|
|
@@ -1180,6 +1358,7 @@ export interface StandardsControlAssociationId {
|
|
|
1180
1358
|
*/
|
|
1181
1359
|
SecurityControlId: string | undefined;
|
|
1182
1360
|
/**
|
|
1361
|
+
* @public
|
|
1183
1362
|
* <p>
|
|
1184
1363
|
* The ARN of a standard.
|
|
1185
1364
|
* </p>
|
|
@@ -1191,6 +1370,7 @@ export interface StandardsControlAssociationId {
|
|
|
1191
1370
|
*/
|
|
1192
1371
|
export interface BatchGetStandardsControlAssociationsRequest {
|
|
1193
1372
|
/**
|
|
1373
|
+
* @public
|
|
1194
1374
|
* <p>
|
|
1195
1375
|
* An array with one or more objects that includes a security control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard.
|
|
1196
1376
|
* This field is used to query the enablement status of a control in a specified standard. The security control ID or ARN is the same across standards.
|
|
@@ -1204,12 +1384,14 @@ export interface BatchGetStandardsControlAssociationsRequest {
|
|
|
1204
1384
|
*/
|
|
1205
1385
|
export interface StandardsControlAssociationDetail {
|
|
1206
1386
|
/**
|
|
1387
|
+
* @public
|
|
1207
1388
|
* <p>
|
|
1208
1389
|
* The Amazon Resource Name (ARN) of a security standard.
|
|
1209
1390
|
* </p>
|
|
1210
1391
|
*/
|
|
1211
1392
|
StandardsArn: string | undefined;
|
|
1212
1393
|
/**
|
|
1394
|
+
* @public
|
|
1213
1395
|
* <p>
|
|
1214
1396
|
* The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service
|
|
1215
1397
|
* name and a number, such as APIGateway.3.
|
|
@@ -1217,42 +1399,49 @@ export interface StandardsControlAssociationDetail {
|
|
|
1217
1399
|
*/
|
|
1218
1400
|
SecurityControlId: string | undefined;
|
|
1219
1401
|
/**
|
|
1402
|
+
* @public
|
|
1220
1403
|
* <p> The ARN of a security control across standards, such as
|
|
1221
1404
|
* <code>arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1</code>. This
|
|
1222
1405
|
* parameter doesn't mention a specific standard. </p>
|
|
1223
1406
|
*/
|
|
1224
1407
|
SecurityControlArn: string | undefined;
|
|
1225
1408
|
/**
|
|
1409
|
+
* @public
|
|
1226
1410
|
* <p>
|
|
1227
1411
|
* Specifies whether a control is enabled or disabled in a specified standard.
|
|
1228
1412
|
* </p>
|
|
1229
1413
|
*/
|
|
1230
1414
|
AssociationStatus: AssociationStatus | string | undefined;
|
|
1231
1415
|
/**
|
|
1416
|
+
* @public
|
|
1232
1417
|
* <p>
|
|
1233
1418
|
* The requirement that underlies a control in the compliance framework related to the standard.
|
|
1234
1419
|
* </p>
|
|
1235
1420
|
*/
|
|
1236
1421
|
RelatedRequirements?: string[];
|
|
1237
1422
|
/**
|
|
1423
|
+
* @public
|
|
1238
1424
|
* <p>
|
|
1239
1425
|
* The time at which the enablement status of the control in the specified standard was last updated.
|
|
1240
1426
|
* </p>
|
|
1241
1427
|
*/
|
|
1242
1428
|
UpdatedAt?: Date;
|
|
1243
1429
|
/**
|
|
1430
|
+
* @public
|
|
1244
1431
|
* <p>
|
|
1245
1432
|
* The reason for updating the enablement status of a control in a specified standard.
|
|
1246
1433
|
* </p>
|
|
1247
1434
|
*/
|
|
1248
1435
|
UpdatedReason?: string;
|
|
1249
1436
|
/**
|
|
1437
|
+
* @public
|
|
1250
1438
|
* <p>
|
|
1251
1439
|
* The title of a control. This field may reference a specific standard.
|
|
1252
1440
|
* </p>
|
|
1253
1441
|
*/
|
|
1254
1442
|
StandardsControlTitle?: string;
|
|
1255
1443
|
/**
|
|
1444
|
+
* @public
|
|
1256
1445
|
* <p>
|
|
1257
1446
|
* The description of a control. This typically summarizes how Security Hub evaluates the control and the
|
|
1258
1447
|
* conditions under which it produces a failed finding. This parameter may reference a specific standard.
|
|
@@ -1260,6 +1449,7 @@ export interface StandardsControlAssociationDetail {
|
|
|
1260
1449
|
*/
|
|
1261
1450
|
StandardsControlDescription?: string;
|
|
1262
1451
|
/**
|
|
1452
|
+
* @public
|
|
1263
1453
|
* <p> Provides the input parameter that Security Hub uses to call the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_UpdateStandardsControl.html">UpdateStandardsControl</a> API. This API can be used to enable or disable a control
|
|
1264
1454
|
* in a specified standard. </p>
|
|
1265
1455
|
*/
|
|
@@ -1273,6 +1463,7 @@ export interface StandardsControlAssociationDetail {
|
|
|
1273
1463
|
*/
|
|
1274
1464
|
export interface UnprocessedStandardsControlAssociation {
|
|
1275
1465
|
/**
|
|
1466
|
+
* @public
|
|
1276
1467
|
* <p> An array with one or more objects that includes a security control (identified with
|
|
1277
1468
|
* <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both
|
|
1278
1469
|
* parameters) and the Amazon Resource Name (ARN) of a standard. This parameter shows the
|
|
@@ -1281,11 +1472,13 @@ export interface UnprocessedStandardsControlAssociation {
|
|
|
1281
1472
|
*/
|
|
1282
1473
|
StandardsControlAssociationId: StandardsControlAssociationId | undefined;
|
|
1283
1474
|
/**
|
|
1475
|
+
* @public
|
|
1284
1476
|
* <p>The error code for the unprocessed standard and control association.
|
|
1285
1477
|
* </p>
|
|
1286
1478
|
*/
|
|
1287
1479
|
ErrorCode: UnprocessedErrorCode | string | undefined;
|
|
1288
1480
|
/**
|
|
1481
|
+
* @public
|
|
1289
1482
|
* <p>The reason why the standard and control association was unprocessed. </p>
|
|
1290
1483
|
*/
|
|
1291
1484
|
ErrorReason?: string;
|
|
@@ -1295,12 +1488,14 @@ export interface UnprocessedStandardsControlAssociation {
|
|
|
1295
1488
|
*/
|
|
1296
1489
|
export interface BatchGetStandardsControlAssociationsResponse {
|
|
1297
1490
|
/**
|
|
1491
|
+
* @public
|
|
1298
1492
|
* <p>Provides the enablement status of a security control in a specified standard and other details for the control in relation to
|
|
1299
1493
|
* the specified standard.
|
|
1300
1494
|
* </p>
|
|
1301
1495
|
*/
|
|
1302
1496
|
StandardsControlAssociationDetails: StandardsControlAssociationDetail[] | undefined;
|
|
1303
1497
|
/**
|
|
1498
|
+
* @public
|
|
1304
1499
|
* <p>
|
|
1305
1500
|
* A security control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) whose enablement
|
|
1306
1501
|
* status in a specified standard cannot be returned.
|
|
@@ -1313,6 +1508,7 @@ export interface BatchGetStandardsControlAssociationsResponse {
|
|
|
1313
1508
|
*/
|
|
1314
1509
|
export interface BatchImportFindingsRequest {
|
|
1315
1510
|
/**
|
|
1511
|
+
* @public
|
|
1316
1512
|
* <p>A list of findings to import. To successfully import a finding, it must follow the
|
|
1317
1513
|
* <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html">Amazon Web Services Security Finding Format</a>. Maximum of 100 findings per request.</p>
|
|
1318
1514
|
*/
|
|
@@ -1325,14 +1521,17 @@ export interface BatchImportFindingsRequest {
|
|
|
1325
1521
|
*/
|
|
1326
1522
|
export interface ImportFindingsError {
|
|
1327
1523
|
/**
|
|
1524
|
+
* @public
|
|
1328
1525
|
* <p>The identifier of the finding that could not be updated.</p>
|
|
1329
1526
|
*/
|
|
1330
1527
|
Id: string | undefined;
|
|
1331
1528
|
/**
|
|
1529
|
+
* @public
|
|
1332
1530
|
* <p>The code of the error returned by the <code>BatchImportFindings</code> operation.</p>
|
|
1333
1531
|
*/
|
|
1334
1532
|
ErrorCode: string | undefined;
|
|
1335
1533
|
/**
|
|
1534
|
+
* @public
|
|
1336
1535
|
* <p>The message of the error returned by the <code>BatchImportFindings</code>
|
|
1337
1536
|
* operation.</p>
|
|
1338
1537
|
*/
|
|
@@ -1343,14 +1542,17 @@ export interface ImportFindingsError {
|
|
|
1343
1542
|
*/
|
|
1344
1543
|
export interface BatchImportFindingsResponse {
|
|
1345
1544
|
/**
|
|
1545
|
+
* @public
|
|
1346
1546
|
* <p>The number of findings that failed to import.</p>
|
|
1347
1547
|
*/
|
|
1348
1548
|
FailedCount: number | undefined;
|
|
1349
1549
|
/**
|
|
1550
|
+
* @public
|
|
1350
1551
|
* <p>The number of findings that were successfully imported.</p>
|
|
1351
1552
|
*/
|
|
1352
1553
|
SuccessCount: number | undefined;
|
|
1353
1554
|
/**
|
|
1555
|
+
* @public
|
|
1354
1556
|
* <p>The list of findings that failed to import.</p>
|
|
1355
1557
|
*/
|
|
1356
1558
|
FailedFindings?: ImportFindingsError[];
|
|
@@ -1363,12 +1565,14 @@ export interface BatchImportFindingsResponse {
|
|
|
1363
1565
|
*/
|
|
1364
1566
|
export interface UpdateAutomationRulesRequestItem {
|
|
1365
1567
|
/**
|
|
1568
|
+
* @public
|
|
1366
1569
|
* <p>
|
|
1367
1570
|
* The Amazon Resource Name (ARN) for the rule.
|
|
1368
1571
|
* </p>
|
|
1369
1572
|
*/
|
|
1370
1573
|
RuleArn: string | undefined;
|
|
1371
1574
|
/**
|
|
1575
|
+
* @public
|
|
1372
1576
|
* <p>
|
|
1373
1577
|
* Whether the rule is active after it is created. If
|
|
1374
1578
|
* this parameter is equal to <code>ENABLED</code>, Security Hub starts applying the rule to findings
|
|
@@ -1380,24 +1584,28 @@ export interface UpdateAutomationRulesRequestItem {
|
|
|
1380
1584
|
*/
|
|
1381
1585
|
RuleStatus?: RuleStatus | string;
|
|
1382
1586
|
/**
|
|
1587
|
+
* @public
|
|
1383
1588
|
* <p> An integer ranging from 1 to 1000 that represents the order in which the rule action is
|
|
1384
1589
|
* applied to findings. Security Hub applies rules with lower values for this parameter
|
|
1385
1590
|
* first. </p>
|
|
1386
1591
|
*/
|
|
1387
1592
|
RuleOrder?: number;
|
|
1388
1593
|
/**
|
|
1594
|
+
* @public
|
|
1389
1595
|
* <p>
|
|
1390
1596
|
* A description of the rule.
|
|
1391
1597
|
* </p>
|
|
1392
1598
|
*/
|
|
1393
1599
|
Description?: string;
|
|
1394
1600
|
/**
|
|
1601
|
+
* @public
|
|
1395
1602
|
* <p>
|
|
1396
1603
|
* The name of the rule.
|
|
1397
1604
|
* </p>
|
|
1398
1605
|
*/
|
|
1399
1606
|
RuleName?: string;
|
|
1400
1607
|
/**
|
|
1608
|
+
* @public
|
|
1401
1609
|
* <p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding
|
|
1402
1610
|
* matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
|
|
1403
1611
|
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
|
|
@@ -1405,6 +1613,7 @@ export interface UpdateAutomationRulesRequestItem {
|
|
|
1405
1613
|
*/
|
|
1406
1614
|
IsTerminal?: boolean;
|
|
1407
1615
|
/**
|
|
1616
|
+
* @public
|
|
1408
1617
|
* <p>
|
|
1409
1618
|
* A set of ASFF finding field attributes and corresponding expected values that
|
|
1410
1619
|
* Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in
|
|
@@ -1413,6 +1622,7 @@ export interface UpdateAutomationRulesRequestItem {
|
|
|
1413
1622
|
*/
|
|
1414
1623
|
Criteria?: AutomationRulesFindingFilters;
|
|
1415
1624
|
/**
|
|
1625
|
+
* @public
|
|
1416
1626
|
* <p>
|
|
1417
1627
|
* One or more actions to update finding fields if a finding matches the conditions
|
|
1418
1628
|
* specified in <code>Criteria</code>.
|
|
@@ -1425,6 +1635,7 @@ export interface UpdateAutomationRulesRequestItem {
|
|
|
1425
1635
|
*/
|
|
1426
1636
|
export interface BatchUpdateAutomationRulesRequest {
|
|
1427
1637
|
/**
|
|
1638
|
+
* @public
|
|
1428
1639
|
* <p>
|
|
1429
1640
|
* An array of ARNs for the rules that are to be updated. Optionally, you can also include
|
|
1430
1641
|
* <code>RuleStatus</code> and <code>RuleOrder</code>.
|
|
@@ -1437,12 +1648,14 @@ export interface BatchUpdateAutomationRulesRequest {
|
|
|
1437
1648
|
*/
|
|
1438
1649
|
export interface BatchUpdateAutomationRulesResponse {
|
|
1439
1650
|
/**
|
|
1651
|
+
* @public
|
|
1440
1652
|
* <p>
|
|
1441
1653
|
* A list of properly processed rule ARNs.
|
|
1442
1654
|
* </p>
|
|
1443
1655
|
*/
|
|
1444
1656
|
ProcessedAutomationRules?: string[];
|
|
1445
1657
|
/**
|
|
1658
|
+
* @public
|
|
1446
1659
|
* <p>
|
|
1447
1660
|
* A list of objects containing <code>RuleArn</code>, <code>ErrorCode</code>, and <code>ErrorMessage</code>. This parameter
|
|
1448
1661
|
* tells you which automation rules the request didn't update and why.
|
|
@@ -1455,6 +1668,7 @@ export interface BatchUpdateAutomationRulesResponse {
|
|
|
1455
1668
|
*/
|
|
1456
1669
|
export interface BatchUpdateFindingsRequest {
|
|
1457
1670
|
/**
|
|
1671
|
+
* @public
|
|
1458
1672
|
* <p>The list of findings to update. <code>BatchUpdateFindings</code> can be used to update
|
|
1459
1673
|
* up to 100 findings at a time.</p>
|
|
1460
1674
|
* <p>For each finding, the list provides the finding identifier and the ARN of the finding
|
|
@@ -1462,14 +1676,17 @@ export interface BatchUpdateFindingsRequest {
|
|
|
1462
1676
|
*/
|
|
1463
1677
|
FindingIdentifiers: AwsSecurityFindingIdentifier[] | undefined;
|
|
1464
1678
|
/**
|
|
1679
|
+
* @public
|
|
1465
1680
|
* <p>The updated note.</p>
|
|
1466
1681
|
*/
|
|
1467
1682
|
Note?: NoteUpdate;
|
|
1468
1683
|
/**
|
|
1684
|
+
* @public
|
|
1469
1685
|
* <p>Used to update the finding severity.</p>
|
|
1470
1686
|
*/
|
|
1471
1687
|
Severity?: SeverityUpdate;
|
|
1472
1688
|
/**
|
|
1689
|
+
* @public
|
|
1473
1690
|
* <p>Indicates the veracity of a finding.</p>
|
|
1474
1691
|
* <p>The available values for <code>VerificationState</code> are as follows.</p>
|
|
1475
1692
|
* <ul>
|
|
@@ -1495,6 +1712,7 @@ export interface BatchUpdateFindingsRequest {
|
|
|
1495
1712
|
*/
|
|
1496
1713
|
VerificationState?: VerificationState | string;
|
|
1497
1714
|
/**
|
|
1715
|
+
* @public
|
|
1498
1716
|
* <p>The updated value for the finding confidence. Confidence is defined as the likelihood
|
|
1499
1717
|
* that a finding accurately identifies the behavior or issue that it was intended to
|
|
1500
1718
|
* identify.</p>
|
|
@@ -1503,6 +1721,7 @@ export interface BatchUpdateFindingsRequest {
|
|
|
1503
1721
|
*/
|
|
1504
1722
|
Confidence?: number;
|
|
1505
1723
|
/**
|
|
1724
|
+
* @public
|
|
1506
1725
|
* <p>The updated value for the level of importance assigned to the resources associated with
|
|
1507
1726
|
* the findings.</p>
|
|
1508
1727
|
* <p>A score of 0 means that the underlying resources have no criticality, and a score of 100
|
|
@@ -1510,6 +1729,7 @@ export interface BatchUpdateFindingsRequest {
|
|
|
1510
1729
|
*/
|
|
1511
1730
|
Criticality?: number;
|
|
1512
1731
|
/**
|
|
1732
|
+
* @public
|
|
1513
1733
|
* <p>One or more finding types in the format of namespace/category/classifier that classify a
|
|
1514
1734
|
* finding.</p>
|
|
1515
1735
|
* <p>Valid namespace values are as follows.</p>
|
|
@@ -1533,16 +1753,19 @@ export interface BatchUpdateFindingsRequest {
|
|
|
1533
1753
|
*/
|
|
1534
1754
|
Types?: string[];
|
|
1535
1755
|
/**
|
|
1756
|
+
* @public
|
|
1536
1757
|
* <p>A list of name/value string pairs associated with the finding. These are custom,
|
|
1537
1758
|
* user-defined fields added to a finding.</p>
|
|
1538
1759
|
*/
|
|
1539
1760
|
UserDefinedFields?: Record<string, string>;
|
|
1540
1761
|
/**
|
|
1762
|
+
* @public
|
|
1541
1763
|
* <p>Used to update the workflow status of a finding.</p>
|
|
1542
1764
|
* <p>The workflow status indicates the progress of the investigation into the finding. </p>
|
|
1543
1765
|
*/
|
|
1544
1766
|
Workflow?: WorkflowUpdate;
|
|
1545
1767
|
/**
|
|
1768
|
+
* @public
|
|
1546
1769
|
* <p>A list of findings that are related to the updated findings.</p>
|
|
1547
1770
|
*/
|
|
1548
1771
|
RelatedFindings?: RelatedFinding[];
|
|
@@ -1554,10 +1777,12 @@ export interface BatchUpdateFindingsRequest {
|
|
|
1554
1777
|
*/
|
|
1555
1778
|
export interface BatchUpdateFindingsUnprocessedFinding {
|
|
1556
1779
|
/**
|
|
1780
|
+
* @public
|
|
1557
1781
|
* <p>The identifier of the finding that was not updated.</p>
|
|
1558
1782
|
*/
|
|
1559
1783
|
FindingIdentifier: AwsSecurityFindingIdentifier | undefined;
|
|
1560
1784
|
/**
|
|
1785
|
+
* @public
|
|
1561
1786
|
* <p>The code associated with the error. Possible values are:</p>
|
|
1562
1787
|
* <ul>
|
|
1563
1788
|
* <li>
|
|
@@ -1594,6 +1819,7 @@ export interface BatchUpdateFindingsUnprocessedFinding {
|
|
|
1594
1819
|
*/
|
|
1595
1820
|
ErrorCode: string | undefined;
|
|
1596
1821
|
/**
|
|
1822
|
+
* @public
|
|
1597
1823
|
* <p>The message associated with the error. Possible values are:</p>
|
|
1598
1824
|
* <ul>
|
|
1599
1825
|
* <li>
|
|
@@ -1635,10 +1861,12 @@ export interface BatchUpdateFindingsUnprocessedFinding {
|
|
|
1635
1861
|
*/
|
|
1636
1862
|
export interface BatchUpdateFindingsResponse {
|
|
1637
1863
|
/**
|
|
1864
|
+
* @public
|
|
1638
1865
|
* <p>The list of findings that were updated successfully.</p>
|
|
1639
1866
|
*/
|
|
1640
1867
|
ProcessedFindings: AwsSecurityFindingIdentifier[] | undefined;
|
|
1641
1868
|
/**
|
|
1869
|
+
* @public
|
|
1642
1870
|
* <p>The list of findings that were not updated.</p>
|
|
1643
1871
|
*/
|
|
1644
1872
|
UnprocessedFindings: BatchUpdateFindingsUnprocessedFinding[] | undefined;
|
|
@@ -1651,19 +1879,23 @@ export interface BatchUpdateFindingsResponse {
|
|
|
1651
1879
|
*/
|
|
1652
1880
|
export interface StandardsControlAssociationUpdate {
|
|
1653
1881
|
/**
|
|
1882
|
+
* @public
|
|
1654
1883
|
* <p>The Amazon Resource Name (ARN) of the standard in which you want to update the
|
|
1655
1884
|
* control's enablement status.</p>
|
|
1656
1885
|
*/
|
|
1657
1886
|
StandardsArn: string | undefined;
|
|
1658
1887
|
/**
|
|
1888
|
+
* @public
|
|
1659
1889
|
* <p>The unique identifier for the security control whose enablement status you want to update.</p>
|
|
1660
1890
|
*/
|
|
1661
1891
|
SecurityControlId: string | undefined;
|
|
1662
1892
|
/**
|
|
1893
|
+
* @public
|
|
1663
1894
|
* <p>The desired enablement status of the control in the standard.</p>
|
|
1664
1895
|
*/
|
|
1665
1896
|
AssociationStatus: AssociationStatus | string | undefined;
|
|
1666
1897
|
/**
|
|
1898
|
+
* @public
|
|
1667
1899
|
* <p>The reason for updating the control's enablement status in the standard.</p>
|
|
1668
1900
|
*/
|
|
1669
1901
|
UpdatedReason?: string;
|
|
@@ -1673,6 +1905,7 @@ export interface StandardsControlAssociationUpdate {
|
|
|
1673
1905
|
*/
|
|
1674
1906
|
export interface BatchUpdateStandardsControlAssociationsRequest {
|
|
1675
1907
|
/**
|
|
1908
|
+
* @public
|
|
1676
1909
|
* <p>
|
|
1677
1910
|
* Updates the enablement status of a security control in a specified standard.
|
|
1678
1911
|
* </p>
|
|
@@ -1687,17 +1920,20 @@ export interface BatchUpdateStandardsControlAssociationsRequest {
|
|
|
1687
1920
|
*/
|
|
1688
1921
|
export interface UnprocessedStandardsControlAssociationUpdate {
|
|
1689
1922
|
/**
|
|
1923
|
+
* @public
|
|
1690
1924
|
* <p>An array of control and standard associations for which an update failed when calling
|
|
1691
1925
|
* <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html">BatchUpdateStandardsControlAssociations</a>.
|
|
1692
1926
|
* </p>
|
|
1693
1927
|
*/
|
|
1694
1928
|
StandardsControlAssociationUpdate: StandardsControlAssociationUpdate | undefined;
|
|
1695
1929
|
/**
|
|
1930
|
+
* @public
|
|
1696
1931
|
* <p>The error code for the unprocessed update of the control's enablement status in the
|
|
1697
1932
|
* specified standard.</p>
|
|
1698
1933
|
*/
|
|
1699
1934
|
ErrorCode: UnprocessedErrorCode | string | undefined;
|
|
1700
1935
|
/**
|
|
1936
|
+
* @public
|
|
1701
1937
|
* <p>The reason why a control's enablement status in the specified standard couldn't be updated. </p>
|
|
1702
1938
|
*/
|
|
1703
1939
|
ErrorReason?: string;
|
|
@@ -1707,6 +1943,7 @@ export interface UnprocessedStandardsControlAssociationUpdate {
|
|
|
1707
1943
|
*/
|
|
1708
1944
|
export interface BatchUpdateStandardsControlAssociationsResponse {
|
|
1709
1945
|
/**
|
|
1946
|
+
* @public
|
|
1710
1947
|
* <p>
|
|
1711
1948
|
* A security control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) whose enablement status in a specified standard couldn't be updated.
|
|
1712
1949
|
* </p>
|
|
@@ -1730,14 +1967,17 @@ export type ControlFindingGenerator = (typeof ControlFindingGenerator)[keyof typ
|
|
|
1730
1967
|
*/
|
|
1731
1968
|
export interface CreateActionTargetRequest {
|
|
1732
1969
|
/**
|
|
1970
|
+
* @public
|
|
1733
1971
|
* <p>The name of the custom action target. Can contain up to 20 characters.</p>
|
|
1734
1972
|
*/
|
|
1735
1973
|
Name: string | undefined;
|
|
1736
1974
|
/**
|
|
1975
|
+
* @public
|
|
1737
1976
|
* <p>The description for the custom action target.</p>
|
|
1738
1977
|
*/
|
|
1739
1978
|
Description: string | undefined;
|
|
1740
1979
|
/**
|
|
1980
|
+
* @public
|
|
1741
1981
|
* <p>The ID for the custom action target. Can contain up to 20 alphanumeric characters.</p>
|
|
1742
1982
|
*/
|
|
1743
1983
|
Id: string | undefined;
|
|
@@ -1747,6 +1987,7 @@ export interface CreateActionTargetRequest {
|
|
|
1747
1987
|
*/
|
|
1748
1988
|
export interface CreateActionTargetResponse {
|
|
1749
1989
|
/**
|
|
1990
|
+
* @public
|
|
1750
1991
|
* <p>The Amazon Resource Name (ARN) for the custom action target.</p>
|
|
1751
1992
|
*/
|
|
1752
1993
|
ActionTargetArn: string | undefined;
|
|
@@ -1770,12 +2011,14 @@ export declare class ResourceConflictException extends __BaseException {
|
|
|
1770
2011
|
*/
|
|
1771
2012
|
export interface CreateAutomationRuleRequest {
|
|
1772
2013
|
/**
|
|
2014
|
+
* @public
|
|
1773
2015
|
* <p>
|
|
1774
2016
|
* User-defined tags that help you label the purpose of a rule.
|
|
1775
2017
|
* </p>
|
|
1776
2018
|
*/
|
|
1777
2019
|
Tags?: Record<string, string>;
|
|
1778
2020
|
/**
|
|
2021
|
+
* @public
|
|
1779
2022
|
* <p>
|
|
1780
2023
|
* Whether the rule is active after it is created. If
|
|
1781
2024
|
* this parameter is equal to <code>ENABLED</code>, Security Hub starts applying the rule to findings
|
|
@@ -1787,24 +2030,28 @@ export interface CreateAutomationRuleRequest {
|
|
|
1787
2030
|
*/
|
|
1788
2031
|
RuleStatus?: RuleStatus | string;
|
|
1789
2032
|
/**
|
|
2033
|
+
* @public
|
|
1790
2034
|
* <p>An integer ranging from 1 to 1000 that represents the order in which the rule action is
|
|
1791
2035
|
* applied to findings. Security Hub applies rules with lower values for this parameter
|
|
1792
2036
|
* first. </p>
|
|
1793
2037
|
*/
|
|
1794
2038
|
RuleOrder: number | undefined;
|
|
1795
2039
|
/**
|
|
2040
|
+
* @public
|
|
1796
2041
|
* <p>
|
|
1797
2042
|
* The name of the rule.
|
|
1798
2043
|
* </p>
|
|
1799
2044
|
*/
|
|
1800
2045
|
RuleName: string | undefined;
|
|
1801
2046
|
/**
|
|
2047
|
+
* @public
|
|
1802
2048
|
* <p>
|
|
1803
2049
|
* A description of the rule.
|
|
1804
2050
|
* </p>
|
|
1805
2051
|
*/
|
|
1806
2052
|
Description: string | undefined;
|
|
1807
2053
|
/**
|
|
2054
|
+
* @public
|
|
1808
2055
|
* <p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding
|
|
1809
2056
|
* matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
|
|
1810
2057
|
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
|
|
@@ -1812,6 +2059,7 @@ export interface CreateAutomationRuleRequest {
|
|
|
1812
2059
|
*/
|
|
1813
2060
|
IsTerminal?: boolean;
|
|
1814
2061
|
/**
|
|
2062
|
+
* @public
|
|
1815
2063
|
* <p>
|
|
1816
2064
|
* A set of ASFF finding field attributes and corresponding expected values that
|
|
1817
2065
|
* Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in
|
|
@@ -1820,6 +2068,7 @@ export interface CreateAutomationRuleRequest {
|
|
|
1820
2068
|
*/
|
|
1821
2069
|
Criteria: AutomationRulesFindingFilters | undefined;
|
|
1822
2070
|
/**
|
|
2071
|
+
* @public
|
|
1823
2072
|
* <p>
|
|
1824
2073
|
* One or more actions to update finding fields if a finding matches the conditions
|
|
1825
2074
|
* specified in <code>Criteria</code>.
|
|
@@ -1832,6 +2081,7 @@ export interface CreateAutomationRuleRequest {
|
|
|
1832
2081
|
*/
|
|
1833
2082
|
export interface CreateAutomationRuleResponse {
|
|
1834
2083
|
/**
|
|
2084
|
+
* @public
|
|
1835
2085
|
* <p>
|
|
1836
2086
|
* The Amazon Resource Name (ARN) of the automation rule that you created.
|
|
1837
2087
|
* </p>
|
|
@@ -1843,6 +2093,7 @@ export interface CreateAutomationRuleResponse {
|
|
|
1843
2093
|
*/
|
|
1844
2094
|
export interface CreateFindingAggregatorRequest {
|
|
1845
2095
|
/**
|
|
2096
|
+
* @public
|
|
1846
2097
|
* <p>Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.</p>
|
|
1847
2098
|
* <p>The selected option also determines how to use the Regions provided in the Regions list.</p>
|
|
1848
2099
|
* <p>The options are as follows:</p>
|
|
@@ -1866,6 +2117,7 @@ export interface CreateFindingAggregatorRequest {
|
|
|
1866
2117
|
*/
|
|
1867
2118
|
RegionLinkingMode: string | undefined;
|
|
1868
2119
|
/**
|
|
2120
|
+
* @public
|
|
1869
2121
|
* <p>If <code>RegionLinkingMode</code> is <code>ALL_REGIONS_EXCEPT_SPECIFIED</code>, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.</p>
|
|
1870
2122
|
* <p>If <code>RegionLinkingMode</code> is <code>SPECIFIED_REGIONS</code>, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
|
|
1871
2123
|
* </p>
|
|
@@ -1877,18 +2129,22 @@ export interface CreateFindingAggregatorRequest {
|
|
|
1877
2129
|
*/
|
|
1878
2130
|
export interface CreateFindingAggregatorResponse {
|
|
1879
2131
|
/**
|
|
2132
|
+
* @public
|
|
1880
2133
|
* <p>The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.</p>
|
|
1881
2134
|
*/
|
|
1882
2135
|
FindingAggregatorArn?: string;
|
|
1883
2136
|
/**
|
|
2137
|
+
* @public
|
|
1884
2138
|
* <p>The aggregation Region.</p>
|
|
1885
2139
|
*/
|
|
1886
2140
|
FindingAggregationRegion?: string;
|
|
1887
2141
|
/**
|
|
2142
|
+
* @public
|
|
1888
2143
|
* <p>Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.</p>
|
|
1889
2144
|
*/
|
|
1890
2145
|
RegionLinkingMode?: string;
|
|
1891
2146
|
/**
|
|
2147
|
+
* @public
|
|
1892
2148
|
* <p>The list of excluded Regions or included Regions.</p>
|
|
1893
2149
|
*/
|
|
1894
2150
|
Regions?: string[];
|
|
@@ -1898,15 +2154,18 @@ export interface CreateFindingAggregatorResponse {
|
|
|
1898
2154
|
*/
|
|
1899
2155
|
export interface CreateInsightRequest {
|
|
1900
2156
|
/**
|
|
2157
|
+
* @public
|
|
1901
2158
|
* <p>The name of the custom insight to create.</p>
|
|
1902
2159
|
*/
|
|
1903
2160
|
Name: string | undefined;
|
|
1904
2161
|
/**
|
|
2162
|
+
* @public
|
|
1905
2163
|
* <p>One or more attributes used to filter the findings included in the insight. The insight
|
|
1906
2164
|
* only includes findings that match the criteria defined in the filters.</p>
|
|
1907
2165
|
*/
|
|
1908
2166
|
Filters: AwsSecurityFindingFilters | undefined;
|
|
1909
2167
|
/**
|
|
2168
|
+
* @public
|
|
1910
2169
|
* <p>The attribute used to group the findings for the insight. The grouping attribute
|
|
1911
2170
|
* identifies the type of item that the insight applies to. For example, if an insight is
|
|
1912
2171
|
* grouped by resource identifier, then the insight produces a list of resource
|
|
@@ -1919,6 +2178,7 @@ export interface CreateInsightRequest {
|
|
|
1919
2178
|
*/
|
|
1920
2179
|
export interface CreateInsightResponse {
|
|
1921
2180
|
/**
|
|
2181
|
+
* @public
|
|
1922
2182
|
* <p>The ARN of the insight created.</p>
|
|
1923
2183
|
*/
|
|
1924
2184
|
InsightArn: string | undefined;
|
|
@@ -1928,6 +2188,7 @@ export interface CreateInsightResponse {
|
|
|
1928
2188
|
*/
|
|
1929
2189
|
export interface CreateMembersRequest {
|
|
1930
2190
|
/**
|
|
2191
|
+
* @public
|
|
1931
2192
|
* <p>The list of accounts to associate with the Security Hub administrator account. For each account, the
|
|
1932
2193
|
* list includes the account ID and optionally the email address.</p>
|
|
1933
2194
|
*/
|
|
@@ -1939,10 +2200,12 @@ export interface CreateMembersRequest {
|
|
|
1939
2200
|
*/
|
|
1940
2201
|
export interface Result {
|
|
1941
2202
|
/**
|
|
2203
|
+
* @public
|
|
1942
2204
|
* <p>An Amazon Web Services account ID of the account that was not processed.</p>
|
|
1943
2205
|
*/
|
|
1944
2206
|
AccountId?: string;
|
|
1945
2207
|
/**
|
|
2208
|
+
* @public
|
|
1946
2209
|
* <p>The reason that the account was not processed.</p>
|
|
1947
2210
|
*/
|
|
1948
2211
|
ProcessingResult?: string;
|
|
@@ -1952,6 +2215,7 @@ export interface Result {
|
|
|
1952
2215
|
*/
|
|
1953
2216
|
export interface CreateMembersResponse {
|
|
1954
2217
|
/**
|
|
2218
|
+
* @public
|
|
1955
2219
|
* <p>The list of Amazon Web Services accounts that were not processed. For each account, the list includes
|
|
1956
2220
|
* the account ID and the email address.</p>
|
|
1957
2221
|
*/
|
|
@@ -1962,6 +2226,7 @@ export interface CreateMembersResponse {
|
|
|
1962
2226
|
*/
|
|
1963
2227
|
export interface DeclineInvitationsRequest {
|
|
1964
2228
|
/**
|
|
2229
|
+
* @public
|
|
1965
2230
|
* <p>The list of prospective member account IDs for which to decline an invitation.</p>
|
|
1966
2231
|
*/
|
|
1967
2232
|
AccountIds: string[] | undefined;
|
|
@@ -1971,6 +2236,7 @@ export interface DeclineInvitationsRequest {
|
|
|
1971
2236
|
*/
|
|
1972
2237
|
export interface DeclineInvitationsResponse {
|
|
1973
2238
|
/**
|
|
2239
|
+
* @public
|
|
1974
2240
|
* <p>The list of Amazon Web Services accounts that were not processed. For each account, the list includes
|
|
1975
2241
|
* the account ID and the email address.</p>
|
|
1976
2242
|
*/
|
|
@@ -1981,6 +2247,7 @@ export interface DeclineInvitationsResponse {
|
|
|
1981
2247
|
*/
|
|
1982
2248
|
export interface DeleteActionTargetRequest {
|
|
1983
2249
|
/**
|
|
2250
|
+
* @public
|
|
1984
2251
|
* <p>The Amazon Resource Name (ARN) of the custom action target to delete.</p>
|
|
1985
2252
|
*/
|
|
1986
2253
|
ActionTargetArn: string | undefined;
|
|
@@ -1990,6 +2257,7 @@ export interface DeleteActionTargetRequest {
|
|
|
1990
2257
|
*/
|
|
1991
2258
|
export interface DeleteActionTargetResponse {
|
|
1992
2259
|
/**
|
|
2260
|
+
* @public
|
|
1993
2261
|
* <p>The ARN of the custom action target that was deleted.</p>
|
|
1994
2262
|
*/
|
|
1995
2263
|
ActionTargetArn: string | undefined;
|
|
@@ -1999,6 +2267,7 @@ export interface DeleteActionTargetResponse {
|
|
|
1999
2267
|
*/
|
|
2000
2268
|
export interface DeleteFindingAggregatorRequest {
|
|
2001
2269
|
/**
|
|
2270
|
+
* @public
|
|
2002
2271
|
* <p>The ARN of the finding aggregator to delete. To obtain the ARN, use <code>ListFindingAggregators</code>.</p>
|
|
2003
2272
|
*/
|
|
2004
2273
|
FindingAggregatorArn: string | undefined;
|
|
@@ -2013,6 +2282,7 @@ export interface DeleteFindingAggregatorResponse {
|
|
|
2013
2282
|
*/
|
|
2014
2283
|
export interface DeleteInsightRequest {
|
|
2015
2284
|
/**
|
|
2285
|
+
* @public
|
|
2016
2286
|
* <p>The ARN of the insight to delete.</p>
|
|
2017
2287
|
*/
|
|
2018
2288
|
InsightArn: string | undefined;
|
|
@@ -2022,6 +2292,7 @@ export interface DeleteInsightRequest {
|
|
|
2022
2292
|
*/
|
|
2023
2293
|
export interface DeleteInsightResponse {
|
|
2024
2294
|
/**
|
|
2295
|
+
* @public
|
|
2025
2296
|
* <p>The ARN of the insight that was deleted.</p>
|
|
2026
2297
|
*/
|
|
2027
2298
|
InsightArn: string | undefined;
|
|
@@ -2031,6 +2302,7 @@ export interface DeleteInsightResponse {
|
|
|
2031
2302
|
*/
|
|
2032
2303
|
export interface DeleteInvitationsRequest {
|
|
2033
2304
|
/**
|
|
2305
|
+
* @public
|
|
2034
2306
|
* <p>The list of member account IDs that received the invitations you want to delete.</p>
|
|
2035
2307
|
*/
|
|
2036
2308
|
AccountIds: string[] | undefined;
|
|
@@ -2040,6 +2312,7 @@ export interface DeleteInvitationsRequest {
|
|
|
2040
2312
|
*/
|
|
2041
2313
|
export interface DeleteInvitationsResponse {
|
|
2042
2314
|
/**
|
|
2315
|
+
* @public
|
|
2043
2316
|
* <p>The list of Amazon Web Services accounts for which the invitations were not deleted. For each account,
|
|
2044
2317
|
* the list includes the account ID and the email address.</p>
|
|
2045
2318
|
*/
|
|
@@ -2050,6 +2323,7 @@ export interface DeleteInvitationsResponse {
|
|
|
2050
2323
|
*/
|
|
2051
2324
|
export interface DeleteMembersRequest {
|
|
2052
2325
|
/**
|
|
2326
|
+
* @public
|
|
2053
2327
|
* <p>The list of account IDs for the member accounts to delete.</p>
|
|
2054
2328
|
*/
|
|
2055
2329
|
AccountIds: string[] | undefined;
|
|
@@ -2059,6 +2333,7 @@ export interface DeleteMembersRequest {
|
|
|
2059
2333
|
*/
|
|
2060
2334
|
export interface DeleteMembersResponse {
|
|
2061
2335
|
/**
|
|
2336
|
+
* @public
|
|
2062
2337
|
* <p>The list of Amazon Web Services accounts that were not deleted. For each account, the list includes the
|
|
2063
2338
|
* account ID and the email address.</p>
|
|
2064
2339
|
*/
|
|
@@ -2069,10 +2344,12 @@ export interface DeleteMembersResponse {
|
|
|
2069
2344
|
*/
|
|
2070
2345
|
export interface DescribeActionTargetsRequest {
|
|
2071
2346
|
/**
|
|
2347
|
+
* @public
|
|
2072
2348
|
* <p>A list of custom action target ARNs for the custom action targets to retrieve.</p>
|
|
2073
2349
|
*/
|
|
2074
2350
|
ActionTargetArns?: string[];
|
|
2075
2351
|
/**
|
|
2352
|
+
* @public
|
|
2076
2353
|
* <p>The token that is required for pagination. On your first call to the
|
|
2077
2354
|
* <code>DescribeActionTargets</code> operation, set the value of this parameter to
|
|
2078
2355
|
* <code>NULL</code>.</p>
|
|
@@ -2081,6 +2358,7 @@ export interface DescribeActionTargetsRequest {
|
|
|
2081
2358
|
*/
|
|
2082
2359
|
NextToken?: string;
|
|
2083
2360
|
/**
|
|
2361
|
+
* @public
|
|
2084
2362
|
* <p>The maximum number of results to return.</p>
|
|
2085
2363
|
*/
|
|
2086
2364
|
MaxResults?: number;
|
|
@@ -2090,12 +2368,14 @@ export interface DescribeActionTargetsRequest {
|
|
|
2090
2368
|
*/
|
|
2091
2369
|
export interface DescribeActionTargetsResponse {
|
|
2092
2370
|
/**
|
|
2371
|
+
* @public
|
|
2093
2372
|
* <p>A list of <code>ActionTarget</code> objects. Each object includes the <code>ActionTargetArn</code>,
|
|
2094
2373
|
* <code>Description</code>, and <code>Name</code> of a custom action target available in
|
|
2095
2374
|
* Security Hub.</p>
|
|
2096
2375
|
*/
|
|
2097
2376
|
ActionTargets: ActionTarget[] | undefined;
|
|
2098
2377
|
/**
|
|
2378
|
+
* @public
|
|
2099
2379
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
2100
2380
|
*/
|
|
2101
2381
|
NextToken?: string;
|
|
@@ -2105,6 +2385,7 @@ export interface DescribeActionTargetsResponse {
|
|
|
2105
2385
|
*/
|
|
2106
2386
|
export interface DescribeHubRequest {
|
|
2107
2387
|
/**
|
|
2388
|
+
* @public
|
|
2108
2389
|
* <p>The ARN of the Hub resource to retrieve.</p>
|
|
2109
2390
|
*/
|
|
2110
2391
|
HubArn?: string;
|
|
@@ -2114,14 +2395,17 @@ export interface DescribeHubRequest {
|
|
|
2114
2395
|
*/
|
|
2115
2396
|
export interface DescribeHubResponse {
|
|
2116
2397
|
/**
|
|
2398
|
+
* @public
|
|
2117
2399
|
* <p>The ARN of the Hub resource that was retrieved.</p>
|
|
2118
2400
|
*/
|
|
2119
2401
|
HubArn?: string;
|
|
2120
2402
|
/**
|
|
2403
|
+
* @public
|
|
2121
2404
|
* <p>The date and time when Security Hub was enabled in the account.</p>
|
|
2122
2405
|
*/
|
|
2123
2406
|
SubscribedAt?: string;
|
|
2124
2407
|
/**
|
|
2408
|
+
* @public
|
|
2125
2409
|
* <p>Whether to automatically enable new controls when they are added to standards that are
|
|
2126
2410
|
* enabled.</p>
|
|
2127
2411
|
* <p>If set to <code>true</code>, then new controls for enabled standards are enabled
|
|
@@ -2129,6 +2413,7 @@ export interface DescribeHubResponse {
|
|
|
2129
2413
|
*/
|
|
2130
2414
|
AutoEnableControls?: boolean;
|
|
2131
2415
|
/**
|
|
2416
|
+
* @public
|
|
2132
2417
|
* <p>Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to
|
|
2133
2418
|
* <code>SECURITY_CONTROL</code>, Security Hub generates a single finding for a control check even when the check
|
|
2134
2419
|
* applies to multiple enabled standards.</p>
|
|
@@ -2151,17 +2436,20 @@ export interface DescribeOrganizationConfigurationRequest {
|
|
|
2151
2436
|
*/
|
|
2152
2437
|
export interface DescribeOrganizationConfigurationResponse {
|
|
2153
2438
|
/**
|
|
2439
|
+
* @public
|
|
2154
2440
|
* <p>Whether to automatically enable Security Hub for new accounts in the organization.</p>
|
|
2155
2441
|
* <p>If set to <code>true</code>, then Security Hub is enabled for new accounts. If set to false,
|
|
2156
2442
|
* then new accounts are not added automatically.</p>
|
|
2157
2443
|
*/
|
|
2158
2444
|
AutoEnable?: boolean;
|
|
2159
2445
|
/**
|
|
2446
|
+
* @public
|
|
2160
2447
|
* <p>Whether the maximum number of allowed member accounts are already associated with the
|
|
2161
2448
|
* Security Hub administrator account.</p>
|
|
2162
2449
|
*/
|
|
2163
2450
|
MemberAccountLimitReached?: boolean;
|
|
2164
2451
|
/**
|
|
2452
|
+
* @public
|
|
2165
2453
|
* <p>Whether to automatically enable Security Hub <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html">default standards</a>
|
|
2166
2454
|
* for new member accounts in the organization.</p>
|
|
2167
2455
|
* <p>The default value of this parameter is equal to <code>DEFAULT</code>.</p>
|
|
@@ -2176,6 +2464,7 @@ export interface DescribeOrganizationConfigurationResponse {
|
|
|
2176
2464
|
*/
|
|
2177
2465
|
export interface DescribeProductsRequest {
|
|
2178
2466
|
/**
|
|
2467
|
+
* @public
|
|
2179
2468
|
* <p>The token that is required for pagination. On your first call to the
|
|
2180
2469
|
* <code>DescribeProducts</code> operation, set the value of this parameter to
|
|
2181
2470
|
* <code>NULL</code>.</p>
|
|
@@ -2184,10 +2473,12 @@ export interface DescribeProductsRequest {
|
|
|
2184
2473
|
*/
|
|
2185
2474
|
NextToken?: string;
|
|
2186
2475
|
/**
|
|
2476
|
+
* @public
|
|
2187
2477
|
* <p>The maximum number of results to return.</p>
|
|
2188
2478
|
*/
|
|
2189
2479
|
MaxResults?: number;
|
|
2190
2480
|
/**
|
|
2481
|
+
* @public
|
|
2191
2482
|
* <p>The ARN of the integration to return.</p>
|
|
2192
2483
|
*/
|
|
2193
2484
|
ProductArn?: string;
|
|
@@ -2211,26 +2502,32 @@ export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationT
|
|
|
2211
2502
|
*/
|
|
2212
2503
|
export interface Product {
|
|
2213
2504
|
/**
|
|
2505
|
+
* @public
|
|
2214
2506
|
* <p>The ARN assigned to the product.</p>
|
|
2215
2507
|
*/
|
|
2216
2508
|
ProductArn: string | undefined;
|
|
2217
2509
|
/**
|
|
2510
|
+
* @public
|
|
2218
2511
|
* <p>The name of the product.</p>
|
|
2219
2512
|
*/
|
|
2220
2513
|
ProductName?: string;
|
|
2221
2514
|
/**
|
|
2515
|
+
* @public
|
|
2222
2516
|
* <p>The name of the company that provides the product.</p>
|
|
2223
2517
|
*/
|
|
2224
2518
|
CompanyName?: string;
|
|
2225
2519
|
/**
|
|
2520
|
+
* @public
|
|
2226
2521
|
* <p>A description of the product.</p>
|
|
2227
2522
|
*/
|
|
2228
2523
|
Description?: string;
|
|
2229
2524
|
/**
|
|
2525
|
+
* @public
|
|
2230
2526
|
* <p>The categories assigned to the product.</p>
|
|
2231
2527
|
*/
|
|
2232
2528
|
Categories?: string[];
|
|
2233
2529
|
/**
|
|
2530
|
+
* @public
|
|
2234
2531
|
* <p>The types of integration that the product supports. Available values are the
|
|
2235
2532
|
* following.</p>
|
|
2236
2533
|
* <ul>
|
|
@@ -2252,15 +2549,18 @@ export interface Product {
|
|
|
2252
2549
|
*/
|
|
2253
2550
|
IntegrationTypes?: (IntegrationType | string)[];
|
|
2254
2551
|
/**
|
|
2552
|
+
* @public
|
|
2255
2553
|
* <p>For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service.</p>
|
|
2256
2554
|
* <p>For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.</p>
|
|
2257
2555
|
*/
|
|
2258
2556
|
MarketplaceUrl?: string;
|
|
2259
2557
|
/**
|
|
2558
|
+
* @public
|
|
2260
2559
|
* <p>The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.</p>
|
|
2261
2560
|
*/
|
|
2262
2561
|
ActivationUrl?: string;
|
|
2263
2562
|
/**
|
|
2563
|
+
* @public
|
|
2264
2564
|
* <p>The resource policy associated with the product.</p>
|
|
2265
2565
|
*/
|
|
2266
2566
|
ProductSubscriptionResourcePolicy?: string;
|
|
@@ -2270,10 +2570,12 @@ export interface Product {
|
|
|
2270
2570
|
*/
|
|
2271
2571
|
export interface DescribeProductsResponse {
|
|
2272
2572
|
/**
|
|
2573
|
+
* @public
|
|
2273
2574
|
* <p>A list of products, including details for each product.</p>
|
|
2274
2575
|
*/
|
|
2275
2576
|
Products: Product[] | undefined;
|
|
2276
2577
|
/**
|
|
2578
|
+
* @public
|
|
2277
2579
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
2278
2580
|
*/
|
|
2279
2581
|
NextToken?: string;
|
|
@@ -2283,6 +2585,7 @@ export interface DescribeProductsResponse {
|
|
|
2283
2585
|
*/
|
|
2284
2586
|
export interface DescribeStandardsRequest {
|
|
2285
2587
|
/**
|
|
2588
|
+
* @public
|
|
2286
2589
|
* <p>The token that is required for pagination. On your first call to the
|
|
2287
2590
|
* <code>DescribeStandards</code> operation, set the value of this parameter to
|
|
2288
2591
|
* <code>NULL</code>.</p>
|
|
@@ -2291,6 +2594,7 @@ export interface DescribeStandardsRequest {
|
|
|
2291
2594
|
*/
|
|
2292
2595
|
NextToken?: string;
|
|
2293
2596
|
/**
|
|
2597
|
+
* @public
|
|
2294
2598
|
* <p>The maximum number of standards to return.</p>
|
|
2295
2599
|
*/
|
|
2296
2600
|
MaxResults?: number;
|
|
@@ -2301,11 +2605,13 @@ export interface DescribeStandardsRequest {
|
|
|
2301
2605
|
*/
|
|
2302
2606
|
export interface StandardsManagedBy {
|
|
2303
2607
|
/**
|
|
2608
|
+
* @public
|
|
2304
2609
|
* <p>An identifier for the company that manages a specific security standard. For existing
|
|
2305
2610
|
* standards, the value is equal to <code>Amazon Web Services</code>.</p>
|
|
2306
2611
|
*/
|
|
2307
2612
|
Company?: string;
|
|
2308
2613
|
/**
|
|
2614
|
+
* @public
|
|
2309
2615
|
* <p>An identifier for the product that manages a specific security standard. For existing
|
|
2310
2616
|
* standards, the value is equal to the Amazon Web Services service that manages the
|
|
2311
2617
|
* standard.</p>
|
|
@@ -2318,18 +2624,22 @@ export interface StandardsManagedBy {
|
|
|
2318
2624
|
*/
|
|
2319
2625
|
export interface Standard {
|
|
2320
2626
|
/**
|
|
2627
|
+
* @public
|
|
2321
2628
|
* <p>The ARN of a standard.</p>
|
|
2322
2629
|
*/
|
|
2323
2630
|
StandardsArn?: string;
|
|
2324
2631
|
/**
|
|
2632
|
+
* @public
|
|
2325
2633
|
* <p>The name of the standard.</p>
|
|
2326
2634
|
*/
|
|
2327
2635
|
Name?: string;
|
|
2328
2636
|
/**
|
|
2637
|
+
* @public
|
|
2329
2638
|
* <p>A description of the standard.</p>
|
|
2330
2639
|
*/
|
|
2331
2640
|
Description?: string;
|
|
2332
2641
|
/**
|
|
2642
|
+
* @public
|
|
2333
2643
|
* <p>Whether the standard is enabled by default. When Security Hub is enabled from the console, if a
|
|
2334
2644
|
* standard is enabled by default, the check box for that standard is selected by
|
|
2335
2645
|
* default.</p>
|
|
@@ -2339,6 +2649,7 @@ export interface Standard {
|
|
|
2339
2649
|
*/
|
|
2340
2650
|
EnabledByDefault?: boolean;
|
|
2341
2651
|
/**
|
|
2652
|
+
* @public
|
|
2342
2653
|
* <p>Provides details about the management of a standard.
|
|
2343
2654
|
* </p>
|
|
2344
2655
|
*/
|
|
@@ -2349,10 +2660,12 @@ export interface Standard {
|
|
|
2349
2660
|
*/
|
|
2350
2661
|
export interface DescribeStandardsResponse {
|
|
2351
2662
|
/**
|
|
2663
|
+
* @public
|
|
2352
2664
|
* <p>A list of available standards.</p>
|
|
2353
2665
|
*/
|
|
2354
2666
|
Standards?: Standard[];
|
|
2355
2667
|
/**
|
|
2668
|
+
* @public
|
|
2356
2669
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
2357
2670
|
*/
|
|
2358
2671
|
NextToken?: string;
|
|
@@ -2362,11 +2675,13 @@ export interface DescribeStandardsResponse {
|
|
|
2362
2675
|
*/
|
|
2363
2676
|
export interface DescribeStandardsControlsRequest {
|
|
2364
2677
|
/**
|
|
2678
|
+
* @public
|
|
2365
2679
|
* <p>The ARN of a resource that represents your subscription to a supported standard. To get
|
|
2366
2680
|
* the subscription ARNs of the standards you have enabled, use the <code>GetEnabledStandards</code> operation.</p>
|
|
2367
2681
|
*/
|
|
2368
2682
|
StandardsSubscriptionArn: string | undefined;
|
|
2369
2683
|
/**
|
|
2684
|
+
* @public
|
|
2370
2685
|
* <p>The token that is required for pagination. On your first call to the
|
|
2371
2686
|
* <code>DescribeStandardsControls</code> operation, set the value of this parameter to
|
|
2372
2687
|
* <code>NULL</code>.</p>
|
|
@@ -2375,6 +2690,7 @@ export interface DescribeStandardsControlsRequest {
|
|
|
2375
2690
|
*/
|
|
2376
2691
|
NextToken?: string;
|
|
2377
2692
|
/**
|
|
2693
|
+
* @public
|
|
2378
2694
|
* <p>The maximum number of security standard controls to return.</p>
|
|
2379
2695
|
*/
|
|
2380
2696
|
MaxResults?: number;
|
|
@@ -2385,48 +2701,58 @@ export interface DescribeStandardsControlsRequest {
|
|
|
2385
2701
|
*/
|
|
2386
2702
|
export interface StandardsControl {
|
|
2387
2703
|
/**
|
|
2704
|
+
* @public
|
|
2388
2705
|
* <p>The ARN of the security standard control.</p>
|
|
2389
2706
|
*/
|
|
2390
2707
|
StandardsControlArn?: string;
|
|
2391
2708
|
/**
|
|
2709
|
+
* @public
|
|
2392
2710
|
* <p>The current status of the security standard control. Indicates whether the control is
|
|
2393
2711
|
* enabled or disabled. Security Hub does not check against disabled controls.</p>
|
|
2394
2712
|
*/
|
|
2395
2713
|
ControlStatus?: ControlStatus | string;
|
|
2396
2714
|
/**
|
|
2715
|
+
* @public
|
|
2397
2716
|
* <p>The reason provided for the most recent change in status for the control.</p>
|
|
2398
2717
|
*/
|
|
2399
2718
|
DisabledReason?: string;
|
|
2400
2719
|
/**
|
|
2720
|
+
* @public
|
|
2401
2721
|
* <p>The date and time that the status of the security standard control was most recently
|
|
2402
2722
|
* updated.</p>
|
|
2403
2723
|
*/
|
|
2404
2724
|
ControlStatusUpdatedAt?: Date;
|
|
2405
2725
|
/**
|
|
2726
|
+
* @public
|
|
2406
2727
|
* <p>The identifier of the security standard control.</p>
|
|
2407
2728
|
*/
|
|
2408
2729
|
ControlId?: string;
|
|
2409
2730
|
/**
|
|
2731
|
+
* @public
|
|
2410
2732
|
* <p>The title of the security standard control.</p>
|
|
2411
2733
|
*/
|
|
2412
2734
|
Title?: string;
|
|
2413
2735
|
/**
|
|
2736
|
+
* @public
|
|
2414
2737
|
* <p>The longer description of the security standard control. Provides information about what
|
|
2415
2738
|
* the control is checking for.</p>
|
|
2416
2739
|
*/
|
|
2417
2740
|
Description?: string;
|
|
2418
2741
|
/**
|
|
2742
|
+
* @public
|
|
2419
2743
|
* <p>A link to remediation information for the control in the Security Hub user
|
|
2420
2744
|
* documentation.</p>
|
|
2421
2745
|
*/
|
|
2422
2746
|
RemediationUrl?: string;
|
|
2423
2747
|
/**
|
|
2748
|
+
* @public
|
|
2424
2749
|
* <p>The severity of findings generated from this security standard control.</p>
|
|
2425
2750
|
* <p>The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services
|
|
2426
2751
|
* resources if the issue is detected.</p>
|
|
2427
2752
|
*/
|
|
2428
2753
|
SeverityRating?: SeverityRating | string;
|
|
2429
2754
|
/**
|
|
2755
|
+
* @public
|
|
2430
2756
|
* <p>The list of requirements that are related to this control.</p>
|
|
2431
2757
|
*/
|
|
2432
2758
|
RelatedRequirements?: string[];
|
|
@@ -2436,10 +2762,12 @@ export interface StandardsControl {
|
|
|
2436
2762
|
*/
|
|
2437
2763
|
export interface DescribeStandardsControlsResponse {
|
|
2438
2764
|
/**
|
|
2765
|
+
* @public
|
|
2439
2766
|
* <p>A list of security standards controls.</p>
|
|
2440
2767
|
*/
|
|
2441
2768
|
Controls?: StandardsControl[];
|
|
2442
2769
|
/**
|
|
2770
|
+
* @public
|
|
2443
2771
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
2444
2772
|
*/
|
|
2445
2773
|
NextToken?: string;
|
|
@@ -2449,6 +2777,7 @@ export interface DescribeStandardsControlsResponse {
|
|
|
2449
2777
|
*/
|
|
2450
2778
|
export interface DisableImportFindingsForProductRequest {
|
|
2451
2779
|
/**
|
|
2780
|
+
* @public
|
|
2452
2781
|
* <p>The ARN of the integrated product to disable the integration for.</p>
|
|
2453
2782
|
*/
|
|
2454
2783
|
ProductSubscriptionArn: string | undefined;
|
|
@@ -2463,6 +2792,7 @@ export interface DisableImportFindingsForProductResponse {
|
|
|
2463
2792
|
*/
|
|
2464
2793
|
export interface DisableOrganizationAdminAccountRequest {
|
|
2465
2794
|
/**
|
|
2795
|
+
* @public
|
|
2466
2796
|
* <p>The Amazon Web Services account identifier of the Security Hub administrator account.</p>
|
|
2467
2797
|
*/
|
|
2468
2798
|
AdminAccountId: string | undefined;
|
|
@@ -2507,6 +2837,7 @@ export interface DisassociateFromMasterAccountResponse {
|
|
|
2507
2837
|
*/
|
|
2508
2838
|
export interface DisassociateMembersRequest {
|
|
2509
2839
|
/**
|
|
2840
|
+
* @public
|
|
2510
2841
|
* <p>The account IDs of the member accounts to disassociate from the administrator account.</p>
|
|
2511
2842
|
*/
|
|
2512
2843
|
AccountIds: string[] | undefined;
|
|
@@ -2521,6 +2852,7 @@ export interface DisassociateMembersResponse {
|
|
|
2521
2852
|
*/
|
|
2522
2853
|
export interface EnableImportFindingsForProductRequest {
|
|
2523
2854
|
/**
|
|
2855
|
+
* @public
|
|
2524
2856
|
* <p>The ARN of the product to enable the integration for.</p>
|
|
2525
2857
|
*/
|
|
2526
2858
|
ProductArn: string | undefined;
|
|
@@ -2530,6 +2862,7 @@ export interface EnableImportFindingsForProductRequest {
|
|
|
2530
2862
|
*/
|
|
2531
2863
|
export interface EnableImportFindingsForProductResponse {
|
|
2532
2864
|
/**
|
|
2865
|
+
* @public
|
|
2533
2866
|
* <p>The ARN of your subscription to the product to enable integrations for.</p>
|
|
2534
2867
|
*/
|
|
2535
2868
|
ProductSubscriptionArn?: string;
|
|
@@ -2539,6 +2872,7 @@ export interface EnableImportFindingsForProductResponse {
|
|
|
2539
2872
|
*/
|
|
2540
2873
|
export interface EnableOrganizationAdminAccountRequest {
|
|
2541
2874
|
/**
|
|
2875
|
+
* @public
|
|
2542
2876
|
* <p>The Amazon Web Services account identifier of the account to designate as the Security Hub administrator
|
|
2543
2877
|
* account.</p>
|
|
2544
2878
|
*/
|
|
@@ -2554,10 +2888,12 @@ export interface EnableOrganizationAdminAccountResponse {
|
|
|
2554
2888
|
*/
|
|
2555
2889
|
export interface EnableSecurityHubRequest {
|
|
2556
2890
|
/**
|
|
2891
|
+
* @public
|
|
2557
2892
|
* <p>The tags to add to the hub resource when you enable Security Hub.</p>
|
|
2558
2893
|
*/
|
|
2559
2894
|
Tags?: Record<string, string>;
|
|
2560
2895
|
/**
|
|
2896
|
+
* @public
|
|
2561
2897
|
* <p>Whether to enable the security standards that Security Hub has designated as automatically
|
|
2562
2898
|
* enabled. If you do not provide a value for <code>EnableDefaultStandards</code>, it is set
|
|
2563
2899
|
* to <code>true</code>. To not enable the automatically enabled standards, set
|
|
@@ -2565,6 +2901,7 @@ export interface EnableSecurityHubRequest {
|
|
|
2565
2901
|
*/
|
|
2566
2902
|
EnableDefaultStandards?: boolean;
|
|
2567
2903
|
/**
|
|
2904
|
+
* @public
|
|
2568
2905
|
* <p>This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on.
|
|
2569
2906
|
* If the value for this field is set to
|
|
2570
2907
|
* <code>SECURITY_CONTROL</code>, Security Hub generates a single finding for a control check even when the check
|
|
@@ -2589,6 +2926,7 @@ export interface EnableSecurityHubResponse {
|
|
|
2589
2926
|
*/
|
|
2590
2927
|
export interface FindingAggregator {
|
|
2591
2928
|
/**
|
|
2929
|
+
* @public
|
|
2592
2930
|
* <p>The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.</p>
|
|
2593
2931
|
*/
|
|
2594
2932
|
FindingAggregatorArn?: string;
|
|
@@ -2601,18 +2939,21 @@ export interface FindingAggregator {
|
|
|
2601
2939
|
*/
|
|
2602
2940
|
export interface FindingHistoryUpdate {
|
|
2603
2941
|
/**
|
|
2942
|
+
* @public
|
|
2604
2943
|
* <p>
|
|
2605
2944
|
* The ASFF field that changed during the finding change event.
|
|
2606
2945
|
* </p>
|
|
2607
2946
|
*/
|
|
2608
2947
|
UpdatedField?: string;
|
|
2609
2948
|
/**
|
|
2949
|
+
* @public
|
|
2610
2950
|
* <p>
|
|
2611
2951
|
* The value of the ASFF field before the finding change event.
|
|
2612
2952
|
* </p>
|
|
2613
2953
|
*/
|
|
2614
2954
|
OldValue?: string;
|
|
2615
2955
|
/**
|
|
2956
|
+
* @public
|
|
2616
2957
|
* <p>
|
|
2617
2958
|
* The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub omits this value
|
|
2618
2959
|
* if <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_FindingHistoryRecord.html">
|
|
@@ -2642,6 +2983,7 @@ export type FindingHistoryUpdateSourceType = (typeof FindingHistoryUpdateSourceT
|
|
|
2642
2983
|
*/
|
|
2643
2984
|
export interface FindingHistoryUpdateSource {
|
|
2644
2985
|
/**
|
|
2986
|
+
* @public
|
|
2645
2987
|
* <p>
|
|
2646
2988
|
* Describes the type of finding change event, such as a call to <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
|
|
2647
2989
|
* <code>BatchImportFindings</code>
|
|
@@ -2652,6 +2994,7 @@ export interface FindingHistoryUpdateSource {
|
|
|
2652
2994
|
*/
|
|
2653
2995
|
Type?: FindingHistoryUpdateSourceType | string;
|
|
2654
2996
|
/**
|
|
2997
|
+
* @public
|
|
2655
2998
|
* <p>
|
|
2656
2999
|
* The identity of the source that initiated the finding change event. For example, the Amazon Resource Name (ARN) of a partner that calls BatchImportFindings or of a customer that calls BatchUpdateFindings.
|
|
2657
3000
|
* </p>
|
|
@@ -2667,10 +3010,12 @@ export interface FindingHistoryUpdateSource {
|
|
|
2667
3010
|
*/
|
|
2668
3011
|
export interface FindingHistoryRecord {
|
|
2669
3012
|
/**
|
|
3013
|
+
* @public
|
|
2670
3014
|
* <p>Identifies which finding to get the finding history for.</p>
|
|
2671
3015
|
*/
|
|
2672
3016
|
FindingIdentifier?: AwsSecurityFindingIdentifier;
|
|
2673
3017
|
/**
|
|
3018
|
+
* @public
|
|
2674
3019
|
* <p> An ISO 8601-formatted timestamp that indicates when Security Hub
|
|
2675
3020
|
* processed the updated finding record.</p>
|
|
2676
3021
|
* <p>A correctly formatted example is
|
|
@@ -2680,6 +3025,7 @@ export interface FindingHistoryRecord {
|
|
|
2680
3025
|
*/
|
|
2681
3026
|
UpdateTime?: Date;
|
|
2682
3027
|
/**
|
|
3028
|
+
* @public
|
|
2683
3029
|
* <p>
|
|
2684
3030
|
* Identifies whether the event marks the creation of a new finding. A value of <code>True</code> means that the finding is
|
|
2685
3031
|
* newly created. A value of <code>False</code> means that the finding isn’t newly created.
|
|
@@ -2687,6 +3033,7 @@ export interface FindingHistoryRecord {
|
|
|
2687
3033
|
*/
|
|
2688
3034
|
FindingCreated?: boolean;
|
|
2689
3035
|
/**
|
|
3036
|
+
* @public
|
|
2690
3037
|
* <p> Identifies the source of the event that changed the finding. For example, an integrated
|
|
2691
3038
|
* Amazon Web Service or third-party partner integration may call <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
|
|
2692
3039
|
* <code>BatchImportFindings</code>
|
|
@@ -2697,6 +3044,7 @@ export interface FindingHistoryRecord {
|
|
|
2697
3044
|
*/
|
|
2698
3045
|
UpdateSource?: FindingHistoryUpdateSource;
|
|
2699
3046
|
/**
|
|
3047
|
+
* @public
|
|
2700
3048
|
* <p>
|
|
2701
3049
|
* An array of objects that provides details about the finding change event, including the Amazon Web Services Security
|
|
2702
3050
|
* Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after
|
|
@@ -2705,6 +3053,7 @@ export interface FindingHistoryRecord {
|
|
|
2705
3053
|
*/
|
|
2706
3054
|
Updates?: FindingHistoryUpdate[];
|
|
2707
3055
|
/**
|
|
3056
|
+
* @public
|
|
2708
3057
|
* <p>
|
|
2709
3058
|
* A token for pagination purposes. Provide this token in the subsequent request to <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_GetFindingsHistory.html">
|
|
2710
3059
|
* <code>GetFindingsHistory</code>
|
|
@@ -2725,18 +3074,22 @@ export interface GetAdministratorAccountRequest {
|
|
|
2725
3074
|
*/
|
|
2726
3075
|
export interface Invitation {
|
|
2727
3076
|
/**
|
|
3077
|
+
* @public
|
|
2728
3078
|
* <p>The account ID of the Security Hub administrator account that the invitation was sent from.</p>
|
|
2729
3079
|
*/
|
|
2730
3080
|
AccountId?: string;
|
|
2731
3081
|
/**
|
|
3082
|
+
* @public
|
|
2732
3083
|
* <p>The ID of the invitation sent to the member account.</p>
|
|
2733
3084
|
*/
|
|
2734
3085
|
InvitationId?: string;
|
|
2735
3086
|
/**
|
|
3087
|
+
* @public
|
|
2736
3088
|
* <p>The timestamp of when the invitation was sent.</p>
|
|
2737
3089
|
*/
|
|
2738
3090
|
InvitedAt?: Date;
|
|
2739
3091
|
/**
|
|
3092
|
+
* @public
|
|
2740
3093
|
* <p>The current status of the association between the member and administrator accounts.</p>
|
|
2741
3094
|
*/
|
|
2742
3095
|
MemberStatus?: string;
|
|
@@ -2746,6 +3099,7 @@ export interface Invitation {
|
|
|
2746
3099
|
*/
|
|
2747
3100
|
export interface GetAdministratorAccountResponse {
|
|
2748
3101
|
/**
|
|
3102
|
+
* @public
|
|
2749
3103
|
* <p>Details about an invitation.</p>
|
|
2750
3104
|
*/
|
|
2751
3105
|
Administrator?: Invitation;
|
|
@@ -2755,10 +3109,12 @@ export interface GetAdministratorAccountResponse {
|
|
|
2755
3109
|
*/
|
|
2756
3110
|
export interface GetEnabledStandardsRequest {
|
|
2757
3111
|
/**
|
|
3112
|
+
* @public
|
|
2758
3113
|
* <p>The list of the standards subscription ARNs for the standards to retrieve.</p>
|
|
2759
3114
|
*/
|
|
2760
3115
|
StandardsSubscriptionArns?: string[];
|
|
2761
3116
|
/**
|
|
3117
|
+
* @public
|
|
2762
3118
|
* <p>The token that is required for pagination. On your first call to the
|
|
2763
3119
|
* <code>GetEnabledStandards</code> operation, set the value of this parameter to
|
|
2764
3120
|
* <code>NULL</code>.</p>
|
|
@@ -2767,6 +3123,7 @@ export interface GetEnabledStandardsRequest {
|
|
|
2767
3123
|
*/
|
|
2768
3124
|
NextToken?: string;
|
|
2769
3125
|
/**
|
|
3126
|
+
* @public
|
|
2770
3127
|
* <p>The maximum number of results to return in the response.</p>
|
|
2771
3128
|
*/
|
|
2772
3129
|
MaxResults?: number;
|
|
@@ -2776,11 +3133,13 @@ export interface GetEnabledStandardsRequest {
|
|
|
2776
3133
|
*/
|
|
2777
3134
|
export interface GetEnabledStandardsResponse {
|
|
2778
3135
|
/**
|
|
3136
|
+
* @public
|
|
2779
3137
|
* <p>The list of <code>StandardsSubscriptions</code> objects that include information about
|
|
2780
3138
|
* the enabled standards.</p>
|
|
2781
3139
|
*/
|
|
2782
3140
|
StandardsSubscriptions?: StandardsSubscription[];
|
|
2783
3141
|
/**
|
|
3142
|
+
* @public
|
|
2784
3143
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
2785
3144
|
*/
|
|
2786
3145
|
NextToken?: string;
|
|
@@ -2790,6 +3149,7 @@ export interface GetEnabledStandardsResponse {
|
|
|
2790
3149
|
*/
|
|
2791
3150
|
export interface GetFindingAggregatorRequest {
|
|
2792
3151
|
/**
|
|
3152
|
+
* @public
|
|
2793
3153
|
* <p>The ARN of the finding aggregator to return details for. To obtain the ARN, use <code>ListFindingAggregators</code>.</p>
|
|
2794
3154
|
*/
|
|
2795
3155
|
FindingAggregatorArn: string | undefined;
|
|
@@ -2799,18 +3159,22 @@ export interface GetFindingAggregatorRequest {
|
|
|
2799
3159
|
*/
|
|
2800
3160
|
export interface GetFindingAggregatorResponse {
|
|
2801
3161
|
/**
|
|
3162
|
+
* @public
|
|
2802
3163
|
* <p>The ARN of the finding aggregator.</p>
|
|
2803
3164
|
*/
|
|
2804
3165
|
FindingAggregatorArn?: string;
|
|
2805
3166
|
/**
|
|
3167
|
+
* @public
|
|
2806
3168
|
* <p>The aggregation Region.</p>
|
|
2807
3169
|
*/
|
|
2808
3170
|
FindingAggregationRegion?: string;
|
|
2809
3171
|
/**
|
|
3172
|
+
* @public
|
|
2810
3173
|
* <p>Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.</p>
|
|
2811
3174
|
*/
|
|
2812
3175
|
RegionLinkingMode?: string;
|
|
2813
3176
|
/**
|
|
3177
|
+
* @public
|
|
2814
3178
|
* <p>The list of excluded Regions or included Regions.</p>
|
|
2815
3179
|
*/
|
|
2816
3180
|
Regions?: string[];
|
|
@@ -2820,10 +3184,12 @@ export interface GetFindingAggregatorResponse {
|
|
|
2820
3184
|
*/
|
|
2821
3185
|
export interface GetFindingHistoryRequest {
|
|
2822
3186
|
/**
|
|
3187
|
+
* @public
|
|
2823
3188
|
* <p>Identifies which finding to get the finding history for.</p>
|
|
2824
3189
|
*/
|
|
2825
3190
|
FindingIdentifier: AwsSecurityFindingIdentifier | undefined;
|
|
2826
3191
|
/**
|
|
3192
|
+
* @public
|
|
2827
3193
|
* <p>
|
|
2828
3194
|
* An ISO 8601-formatted timestamp that indicates the start time of the requested finding history. A correctly formatted
|
|
2829
3195
|
* example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated
|
|
@@ -2841,6 +3207,7 @@ export interface GetFindingHistoryRequest {
|
|
|
2841
3207
|
*/
|
|
2842
3208
|
StartTime?: Date;
|
|
2843
3209
|
/**
|
|
3210
|
+
* @public
|
|
2844
3211
|
* <p>
|
|
2845
3212
|
* An ISO 8601-formatted timestamp that indicates the end time of the requested finding history. A correctly formatted
|
|
2846
3213
|
* example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated
|
|
@@ -2858,6 +3225,7 @@ export interface GetFindingHistoryRequest {
|
|
|
2858
3225
|
*/
|
|
2859
3226
|
EndTime?: Date;
|
|
2860
3227
|
/**
|
|
3228
|
+
* @public
|
|
2861
3229
|
* <p>
|
|
2862
3230
|
* A token for pagination purposes. Provide <code>NULL</code> as the initial value. In subsequent requests, provide the
|
|
2863
3231
|
* token included in the response to get up to an additional 100 results of finding history. If you don’t provide
|
|
@@ -2866,6 +3234,7 @@ export interface GetFindingHistoryRequest {
|
|
|
2866
3234
|
*/
|
|
2867
3235
|
NextToken?: string;
|
|
2868
3236
|
/**
|
|
3237
|
+
* @public
|
|
2869
3238
|
* <p>
|
|
2870
3239
|
* The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.
|
|
2871
3240
|
* </p>
|
|
@@ -2877,12 +3246,14 @@ export interface GetFindingHistoryRequest {
|
|
|
2877
3246
|
*/
|
|
2878
3247
|
export interface GetFindingHistoryResponse {
|
|
2879
3248
|
/**
|
|
3249
|
+
* @public
|
|
2880
3250
|
* <p>
|
|
2881
3251
|
* A list of events that altered the specified finding during the specified time period.
|
|
2882
3252
|
* </p>
|
|
2883
3253
|
*/
|
|
2884
3254
|
Records?: FindingHistoryRecord[];
|
|
2885
3255
|
/**
|
|
3256
|
+
* @public
|
|
2886
3257
|
* <p>
|
|
2887
3258
|
* A token for pagination purposes. Provide this token in the subsequent request to <code>GetFindingsHistory</code> to
|
|
2888
3259
|
* get up to an additional 100 results of history for the same finding that you specified in your initial request.
|
|
@@ -2908,10 +3279,12 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
2908
3279
|
*/
|
|
2909
3280
|
export interface SortCriterion {
|
|
2910
3281
|
/**
|
|
3282
|
+
* @public
|
|
2911
3283
|
* <p>The finding attribute used to sort findings.</p>
|
|
2912
3284
|
*/
|
|
2913
3285
|
Field?: string;
|
|
2914
3286
|
/**
|
|
3287
|
+
* @public
|
|
2915
3288
|
* <p>The order used to sort findings.</p>
|
|
2916
3289
|
*/
|
|
2917
3290
|
SortOrder?: SortOrder | string;
|
|
@@ -2921,6 +3294,7 @@ export interface SortCriterion {
|
|
|
2921
3294
|
*/
|
|
2922
3295
|
export interface GetFindingsRequest {
|
|
2923
3296
|
/**
|
|
3297
|
+
* @public
|
|
2924
3298
|
* <p>The finding attributes used to define a condition to filter the returned
|
|
2925
3299
|
* findings.</p>
|
|
2926
3300
|
* <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to
|
|
@@ -2930,10 +3304,12 @@ export interface GetFindingsRequest {
|
|
|
2930
3304
|
*/
|
|
2931
3305
|
Filters?: AwsSecurityFindingFilters;
|
|
2932
3306
|
/**
|
|
3307
|
+
* @public
|
|
2933
3308
|
* <p>The finding attributes used to sort the list of returned findings.</p>
|
|
2934
3309
|
*/
|
|
2935
3310
|
SortCriteria?: SortCriterion[];
|
|
2936
3311
|
/**
|
|
3312
|
+
* @public
|
|
2937
3313
|
* <p>The token that is required for pagination. On your first call to the
|
|
2938
3314
|
* <code>GetFindings</code> operation, set the value of this parameter to
|
|
2939
3315
|
* <code>NULL</code>.</p>
|
|
@@ -2942,6 +3318,7 @@ export interface GetFindingsRequest {
|
|
|
2942
3318
|
*/
|
|
2943
3319
|
NextToken?: string;
|
|
2944
3320
|
/**
|
|
3321
|
+
* @public
|
|
2945
3322
|
* <p>The maximum number of findings to return.</p>
|
|
2946
3323
|
*/
|
|
2947
3324
|
MaxResults?: number;
|
|
@@ -2951,10 +3328,12 @@ export interface GetFindingsRequest {
|
|
|
2951
3328
|
*/
|
|
2952
3329
|
export interface GetFindingsResponse {
|
|
2953
3330
|
/**
|
|
3331
|
+
* @public
|
|
2954
3332
|
* <p>The findings that matched the filters specified in the request.</p>
|
|
2955
3333
|
*/
|
|
2956
3334
|
Findings: AwsSecurityFinding[] | undefined;
|
|
2957
3335
|
/**
|
|
3336
|
+
* @public
|
|
2958
3337
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
2959
3338
|
*/
|
|
2960
3339
|
NextToken?: string;
|
|
@@ -2964,6 +3343,7 @@ export interface GetFindingsResponse {
|
|
|
2964
3343
|
*/
|
|
2965
3344
|
export interface GetInsightResultsRequest {
|
|
2966
3345
|
/**
|
|
3346
|
+
* @public
|
|
2967
3347
|
* <p>The ARN of the insight for which to return results.</p>
|
|
2968
3348
|
*/
|
|
2969
3349
|
InsightArn: string | undefined;
|
|
@@ -2975,11 +3355,13 @@ export interface GetInsightResultsRequest {
|
|
|
2975
3355
|
*/
|
|
2976
3356
|
export interface InsightResultValue {
|
|
2977
3357
|
/**
|
|
3358
|
+
* @public
|
|
2978
3359
|
* <p>The value of the attribute that the findings are grouped by for the insight whose
|
|
2979
3360
|
* results are returned by the <code>GetInsightResults</code> operation.</p>
|
|
2980
3361
|
*/
|
|
2981
3362
|
GroupByAttributeValue: string | undefined;
|
|
2982
3363
|
/**
|
|
3364
|
+
* @public
|
|
2983
3365
|
* <p>The number of findings returned for each <code>GroupByAttributeValue</code>.</p>
|
|
2984
3366
|
*/
|
|
2985
3367
|
Count: number | undefined;
|
|
@@ -2990,16 +3372,19 @@ export interface InsightResultValue {
|
|
|
2990
3372
|
*/
|
|
2991
3373
|
export interface InsightResults {
|
|
2992
3374
|
/**
|
|
3375
|
+
* @public
|
|
2993
3376
|
* <p>The ARN of the insight whose results are returned by the <code>GetInsightResults</code>
|
|
2994
3377
|
* operation.</p>
|
|
2995
3378
|
*/
|
|
2996
3379
|
InsightArn: string | undefined;
|
|
2997
3380
|
/**
|
|
3381
|
+
* @public
|
|
2998
3382
|
* <p>The attribute that the findings are grouped by for the insight whose results are
|
|
2999
3383
|
* returned by the <code>GetInsightResults</code> operation.</p>
|
|
3000
3384
|
*/
|
|
3001
3385
|
GroupByAttribute: string | undefined;
|
|
3002
3386
|
/**
|
|
3387
|
+
* @public
|
|
3003
3388
|
* <p>The list of insight result values returned by the <code>GetInsightResults</code>
|
|
3004
3389
|
* operation.</p>
|
|
3005
3390
|
*/
|
|
@@ -3010,6 +3395,7 @@ export interface InsightResults {
|
|
|
3010
3395
|
*/
|
|
3011
3396
|
export interface GetInsightResultsResponse {
|
|
3012
3397
|
/**
|
|
3398
|
+
* @public
|
|
3013
3399
|
* <p>The insight results returned by the operation.</p>
|
|
3014
3400
|
*/
|
|
3015
3401
|
InsightResults: InsightResults | undefined;
|
|
@@ -3019,12 +3405,14 @@ export interface GetInsightResultsResponse {
|
|
|
3019
3405
|
*/
|
|
3020
3406
|
export interface GetInsightsRequest {
|
|
3021
3407
|
/**
|
|
3408
|
+
* @public
|
|
3022
3409
|
* <p>The ARNs of the insights to describe. If you do not provide any insight ARNs, then
|
|
3023
3410
|
* <code>GetInsights</code> returns all of your custom insights. It does not return any
|
|
3024
3411
|
* managed insights.</p>
|
|
3025
3412
|
*/
|
|
3026
3413
|
InsightArns?: string[];
|
|
3027
3414
|
/**
|
|
3415
|
+
* @public
|
|
3028
3416
|
* <p>The token that is required for pagination. On your first call to the
|
|
3029
3417
|
* <code>GetInsights</code> operation, set the value of this parameter to
|
|
3030
3418
|
* <code>NULL</code>.</p>
|
|
@@ -3033,6 +3421,7 @@ export interface GetInsightsRequest {
|
|
|
3033
3421
|
*/
|
|
3034
3422
|
NextToken?: string;
|
|
3035
3423
|
/**
|
|
3424
|
+
* @public
|
|
3036
3425
|
* <p>The maximum number of items to return in the response.</p>
|
|
3037
3426
|
*/
|
|
3038
3427
|
MaxResults?: number;
|
|
@@ -3043,19 +3432,23 @@ export interface GetInsightsRequest {
|
|
|
3043
3432
|
*/
|
|
3044
3433
|
export interface Insight {
|
|
3045
3434
|
/**
|
|
3435
|
+
* @public
|
|
3046
3436
|
* <p>The ARN of a Security Hub insight.</p>
|
|
3047
3437
|
*/
|
|
3048
3438
|
InsightArn: string | undefined;
|
|
3049
3439
|
/**
|
|
3440
|
+
* @public
|
|
3050
3441
|
* <p>The name of a Security Hub insight.</p>
|
|
3051
3442
|
*/
|
|
3052
3443
|
Name: string | undefined;
|
|
3053
3444
|
/**
|
|
3445
|
+
* @public
|
|
3054
3446
|
* <p>One or more attributes used to filter the findings included in the insight. The insight
|
|
3055
3447
|
* only includes findings that match the criteria defined in the filters.</p>
|
|
3056
3448
|
*/
|
|
3057
3449
|
Filters: AwsSecurityFindingFilters | undefined;
|
|
3058
3450
|
/**
|
|
3451
|
+
* @public
|
|
3059
3452
|
* <p>The grouping attribute for the insight's findings. Indicates how to group the matching
|
|
3060
3453
|
* findings, and identifies the type of item that the insight applies to. For example, if an
|
|
3061
3454
|
* insight is grouped by resource identifier, then the insight produces a list of resource
|
|
@@ -3068,10 +3461,12 @@ export interface Insight {
|
|
|
3068
3461
|
*/
|
|
3069
3462
|
export interface GetInsightsResponse {
|
|
3070
3463
|
/**
|
|
3464
|
+
* @public
|
|
3071
3465
|
* <p>The insights returned by the operation.</p>
|
|
3072
3466
|
*/
|
|
3073
3467
|
Insights: Insight[] | undefined;
|
|
3074
3468
|
/**
|
|
3469
|
+
* @public
|
|
3075
3470
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
3076
3471
|
*/
|
|
3077
3472
|
NextToken?: string;
|
|
@@ -3086,6 +3481,7 @@ export interface GetInvitationsCountRequest {
|
|
|
3086
3481
|
*/
|
|
3087
3482
|
export interface GetInvitationsCountResponse {
|
|
3088
3483
|
/**
|
|
3484
|
+
* @public
|
|
3089
3485
|
* <p>The number of all membership invitations sent to this Security Hub member account, not
|
|
3090
3486
|
* including the currently accepted invitation.</p>
|
|
3091
3487
|
*/
|
|
@@ -3101,6 +3497,7 @@ export interface GetMasterAccountRequest {
|
|
|
3101
3497
|
*/
|
|
3102
3498
|
export interface GetMasterAccountResponse {
|
|
3103
3499
|
/**
|
|
3500
|
+
* @public
|
|
3104
3501
|
* <p>A list of details about the Security Hub administrator account for the current member account.
|
|
3105
3502
|
* </p>
|
|
3106
3503
|
*/
|
|
@@ -3111,6 +3508,7 @@ export interface GetMasterAccountResponse {
|
|
|
3111
3508
|
*/
|
|
3112
3509
|
export interface GetMembersRequest {
|
|
3113
3510
|
/**
|
|
3511
|
+
* @public
|
|
3114
3512
|
* <p>The list of account IDs for the Security Hub member accounts to return the details for. </p>
|
|
3115
3513
|
*/
|
|
3116
3514
|
AccountIds: string[] | undefined;
|
|
@@ -3121,14 +3519,17 @@ export interface GetMembersRequest {
|
|
|
3121
3519
|
*/
|
|
3122
3520
|
export interface Member {
|
|
3123
3521
|
/**
|
|
3522
|
+
* @public
|
|
3124
3523
|
* <p>The Amazon Web Services account ID of the member account.</p>
|
|
3125
3524
|
*/
|
|
3126
3525
|
AccountId?: string;
|
|
3127
3526
|
/**
|
|
3527
|
+
* @public
|
|
3128
3528
|
* <p>The email address of the member account.</p>
|
|
3129
3529
|
*/
|
|
3130
3530
|
Email?: string;
|
|
3131
3531
|
/**
|
|
3532
|
+
* @public
|
|
3132
3533
|
* @deprecated
|
|
3133
3534
|
*
|
|
3134
3535
|
* <p>This is replaced by <code>AdministratorID</code>.</p>
|
|
@@ -3136,10 +3537,12 @@ export interface Member {
|
|
|
3136
3537
|
*/
|
|
3137
3538
|
MasterId?: string;
|
|
3138
3539
|
/**
|
|
3540
|
+
* @public
|
|
3139
3541
|
* <p>The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.</p>
|
|
3140
3542
|
*/
|
|
3141
3543
|
AdministratorId?: string;
|
|
3142
3544
|
/**
|
|
3545
|
+
* @public
|
|
3143
3546
|
* <p>The status of the relationship between the member account and its administrator account.
|
|
3144
3547
|
* </p>
|
|
3145
3548
|
* <p>The status can have one of the following values:</p>
|
|
@@ -3183,11 +3586,13 @@ export interface Member {
|
|
|
3183
3586
|
*/
|
|
3184
3587
|
MemberStatus?: string;
|
|
3185
3588
|
/**
|
|
3589
|
+
* @public
|
|
3186
3590
|
* <p>A timestamp for the date and time when the invitation was sent to the member
|
|
3187
3591
|
* account.</p>
|
|
3188
3592
|
*/
|
|
3189
3593
|
InvitedAt?: Date;
|
|
3190
3594
|
/**
|
|
3595
|
+
* @public
|
|
3191
3596
|
* <p>The timestamp for the date and time when the member account was updated.</p>
|
|
3192
3597
|
*/
|
|
3193
3598
|
UpdatedAt?: Date;
|
|
@@ -3197,10 +3602,12 @@ export interface Member {
|
|
|
3197
3602
|
*/
|
|
3198
3603
|
export interface GetMembersResponse {
|
|
3199
3604
|
/**
|
|
3605
|
+
* @public
|
|
3200
3606
|
* <p>The list of details about the Security Hub member accounts.</p>
|
|
3201
3607
|
*/
|
|
3202
3608
|
Members?: Member[];
|
|
3203
3609
|
/**
|
|
3610
|
+
* @public
|
|
3204
3611
|
* <p>The list of Amazon Web Services accounts that could not be processed. For each account, the list
|
|
3205
3612
|
* includes the account ID and the email address.</p>
|
|
3206
3613
|
*/
|
|
@@ -3211,6 +3618,7 @@ export interface GetMembersResponse {
|
|
|
3211
3618
|
*/
|
|
3212
3619
|
export interface InviteMembersRequest {
|
|
3213
3620
|
/**
|
|
3621
|
+
* @public
|
|
3214
3622
|
* <p>The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members. </p>
|
|
3215
3623
|
*/
|
|
3216
3624
|
AccountIds: string[] | undefined;
|
|
@@ -3220,6 +3628,7 @@ export interface InviteMembersRequest {
|
|
|
3220
3628
|
*/
|
|
3221
3629
|
export interface InviteMembersResponse {
|
|
3222
3630
|
/**
|
|
3631
|
+
* @public
|
|
3223
3632
|
* <p>The list of Amazon Web Services accounts that could not be processed. For each account, the list
|
|
3224
3633
|
* includes the account ID and the email address.</p>
|
|
3225
3634
|
*/
|
|
@@ -3230,6 +3639,7 @@ export interface InviteMembersResponse {
|
|
|
3230
3639
|
*/
|
|
3231
3640
|
export interface ListAutomationRulesRequest {
|
|
3232
3641
|
/**
|
|
3642
|
+
* @public
|
|
3233
3643
|
* <p>
|
|
3234
3644
|
* A token to specify where to start paginating the response. This is the <code>NextToken</code>
|
|
3235
3645
|
* from a previously truncated response. On your first call to the <code>ListAutomationRules</code>
|
|
@@ -3238,6 +3648,7 @@ export interface ListAutomationRulesRequest {
|
|
|
3238
3648
|
*/
|
|
3239
3649
|
NextToken?: string;
|
|
3240
3650
|
/**
|
|
3651
|
+
* @public
|
|
3241
3652
|
* <p> The maximum number of rules to return in the response. This currently ranges from 1 to
|
|
3242
3653
|
* 100. </p>
|
|
3243
3654
|
*/
|
|
@@ -3248,6 +3659,7 @@ export interface ListAutomationRulesRequest {
|
|
|
3248
3659
|
*/
|
|
3249
3660
|
export interface ListAutomationRulesResponse {
|
|
3250
3661
|
/**
|
|
3662
|
+
* @public
|
|
3251
3663
|
* <p>
|
|
3252
3664
|
* Metadata for rules in the calling account. The response includes rules with a
|
|
3253
3665
|
* <code>RuleStatus</code> of <code>ENABLED</code> and <code>DISABLED</code>.
|
|
@@ -3255,6 +3667,7 @@ export interface ListAutomationRulesResponse {
|
|
|
3255
3667
|
*/
|
|
3256
3668
|
AutomationRulesMetadata?: AutomationRulesMetadata[];
|
|
3257
3669
|
/**
|
|
3670
|
+
* @public
|
|
3258
3671
|
* <p>
|
|
3259
3672
|
* A pagination token for the response.
|
|
3260
3673
|
* </p>
|
|
@@ -3266,6 +3679,7 @@ export interface ListAutomationRulesResponse {
|
|
|
3266
3679
|
*/
|
|
3267
3680
|
export interface ListEnabledProductsForImportRequest {
|
|
3268
3681
|
/**
|
|
3682
|
+
* @public
|
|
3269
3683
|
* <p>The token that is required for pagination. On your first call to the
|
|
3270
3684
|
* <code>ListEnabledProductsForImport</code> operation, set the value of this parameter to
|
|
3271
3685
|
* <code>NULL</code>.</p>
|
|
@@ -3274,6 +3688,7 @@ export interface ListEnabledProductsForImportRequest {
|
|
|
3274
3688
|
*/
|
|
3275
3689
|
NextToken?: string;
|
|
3276
3690
|
/**
|
|
3691
|
+
* @public
|
|
3277
3692
|
* <p>The maximum number of items to return in the response.</p>
|
|
3278
3693
|
*/
|
|
3279
3694
|
MaxResults?: number;
|
|
@@ -3283,10 +3698,12 @@ export interface ListEnabledProductsForImportRequest {
|
|
|
3283
3698
|
*/
|
|
3284
3699
|
export interface ListEnabledProductsForImportResponse {
|
|
3285
3700
|
/**
|
|
3701
|
+
* @public
|
|
3286
3702
|
* <p>The list of ARNs for the resources that represent your subscriptions to products. </p>
|
|
3287
3703
|
*/
|
|
3288
3704
|
ProductSubscriptions?: string[];
|
|
3289
3705
|
/**
|
|
3706
|
+
* @public
|
|
3290
3707
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
3291
3708
|
*/
|
|
3292
3709
|
NextToken?: string;
|
|
@@ -3296,10 +3713,12 @@ export interface ListEnabledProductsForImportResponse {
|
|
|
3296
3713
|
*/
|
|
3297
3714
|
export interface ListFindingAggregatorsRequest {
|
|
3298
3715
|
/**
|
|
3716
|
+
* @public
|
|
3299
3717
|
* <p>The token returned with the previous set of results. Identifies the next set of results to return.</p>
|
|
3300
3718
|
*/
|
|
3301
3719
|
NextToken?: string;
|
|
3302
3720
|
/**
|
|
3721
|
+
* @public
|
|
3303
3722
|
* <p>The maximum number of results to return. This operation currently only returns a single result.</p>
|
|
3304
3723
|
*/
|
|
3305
3724
|
MaxResults?: number;
|
|
@@ -3309,10 +3728,12 @@ export interface ListFindingAggregatorsRequest {
|
|
|
3309
3728
|
*/
|
|
3310
3729
|
export interface ListFindingAggregatorsResponse {
|
|
3311
3730
|
/**
|
|
3731
|
+
* @public
|
|
3312
3732
|
* <p>The list of finding aggregators. This operation currently only returns a single result.</p>
|
|
3313
3733
|
*/
|
|
3314
3734
|
FindingAggregators?: FindingAggregator[];
|
|
3315
3735
|
/**
|
|
3736
|
+
* @public
|
|
3316
3737
|
* <p>If there are more results, this is the token to provide in the next call to <code>ListFindingAggregators</code>.</p>
|
|
3317
3738
|
* <p>This operation currently only returns a single result.
|
|
3318
3739
|
* </p>
|
|
@@ -3324,10 +3745,12 @@ export interface ListFindingAggregatorsResponse {
|
|
|
3324
3745
|
*/
|
|
3325
3746
|
export interface ListInvitationsRequest {
|
|
3326
3747
|
/**
|
|
3748
|
+
* @public
|
|
3327
3749
|
* <p>The maximum number of items to return in the response. </p>
|
|
3328
3750
|
*/
|
|
3329
3751
|
MaxResults?: number;
|
|
3330
3752
|
/**
|
|
3753
|
+
* @public
|
|
3331
3754
|
* <p>The token that is required for pagination. On your first call to the
|
|
3332
3755
|
* <code>ListInvitations</code> operation, set the value of this parameter to
|
|
3333
3756
|
* <code>NULL</code>.</p>
|
|
@@ -3341,10 +3764,12 @@ export interface ListInvitationsRequest {
|
|
|
3341
3764
|
*/
|
|
3342
3765
|
export interface ListInvitationsResponse {
|
|
3343
3766
|
/**
|
|
3767
|
+
* @public
|
|
3344
3768
|
* <p>The details of the invitations returned by the operation.</p>
|
|
3345
3769
|
*/
|
|
3346
3770
|
Invitations?: Invitation[];
|
|
3347
3771
|
/**
|
|
3772
|
+
* @public
|
|
3348
3773
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
3349
3774
|
*/
|
|
3350
3775
|
NextToken?: string;
|
|
@@ -3354,6 +3779,7 @@ export interface ListInvitationsResponse {
|
|
|
3354
3779
|
*/
|
|
3355
3780
|
export interface ListMembersRequest {
|
|
3356
3781
|
/**
|
|
3782
|
+
* @public
|
|
3357
3783
|
* <p>Specifies which member accounts to include in the response based on their relationship
|
|
3358
3784
|
* status with the administrator account. The default value is <code>TRUE</code>.</p>
|
|
3359
3785
|
* <p>If <code>OnlyAssociated</code> is set to <code>TRUE</code>, the response includes member
|
|
@@ -3363,10 +3789,12 @@ export interface ListMembersRequest {
|
|
|
3363
3789
|
*/
|
|
3364
3790
|
OnlyAssociated?: boolean;
|
|
3365
3791
|
/**
|
|
3792
|
+
* @public
|
|
3366
3793
|
* <p>The maximum number of items to return in the response. </p>
|
|
3367
3794
|
*/
|
|
3368
3795
|
MaxResults?: number;
|
|
3369
3796
|
/**
|
|
3797
|
+
* @public
|
|
3370
3798
|
* <p>The token that is required for pagination. On your first call to the
|
|
3371
3799
|
* <code>ListMembers</code> operation, set the value of this parameter to
|
|
3372
3800
|
* <code>NULL</code>.</p>
|
|
@@ -3380,10 +3808,12 @@ export interface ListMembersRequest {
|
|
|
3380
3808
|
*/
|
|
3381
3809
|
export interface ListMembersResponse {
|
|
3382
3810
|
/**
|
|
3811
|
+
* @public
|
|
3383
3812
|
* <p>Member details returned by the operation.</p>
|
|
3384
3813
|
*/
|
|
3385
3814
|
Members?: Member[];
|
|
3386
3815
|
/**
|
|
3816
|
+
* @public
|
|
3387
3817
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
3388
3818
|
*/
|
|
3389
3819
|
NextToken?: string;
|
|
@@ -3393,10 +3823,12 @@ export interface ListMembersResponse {
|
|
|
3393
3823
|
*/
|
|
3394
3824
|
export interface ListOrganizationAdminAccountsRequest {
|
|
3395
3825
|
/**
|
|
3826
|
+
* @public
|
|
3396
3827
|
* <p>The maximum number of items to return in the response.</p>
|
|
3397
3828
|
*/
|
|
3398
3829
|
MaxResults?: number;
|
|
3399
3830
|
/**
|
|
3831
|
+
* @public
|
|
3400
3832
|
* <p>The token that is required for pagination. On your first call to the
|
|
3401
3833
|
* <code>ListOrganizationAdminAccounts</code> operation, set the value of this parameter to
|
|
3402
3834
|
* <code>NULL</code>. For subsequent calls to the operation, to continue listing data, set
|
|
@@ -3409,10 +3841,12 @@ export interface ListOrganizationAdminAccountsRequest {
|
|
|
3409
3841
|
*/
|
|
3410
3842
|
export interface ListOrganizationAdminAccountsResponse {
|
|
3411
3843
|
/**
|
|
3844
|
+
* @public
|
|
3412
3845
|
* <p>The list of Security Hub administrator accounts.</p>
|
|
3413
3846
|
*/
|
|
3414
3847
|
AdminAccounts?: AdminAccount[];
|
|
3415
3848
|
/**
|
|
3849
|
+
* @public
|
|
3416
3850
|
* <p>The pagination token to use to request the next page of results.</p>
|
|
3417
3851
|
*/
|
|
3418
3852
|
NextToken?: string;
|
|
@@ -3422,18 +3856,21 @@ export interface ListOrganizationAdminAccountsResponse {
|
|
|
3422
3856
|
*/
|
|
3423
3857
|
export interface ListSecurityControlDefinitionsRequest {
|
|
3424
3858
|
/**
|
|
3859
|
+
* @public
|
|
3425
3860
|
* <p>
|
|
3426
3861
|
* The Amazon Resource Name (ARN) of the standard that you want to view controls for.
|
|
3427
3862
|
* </p>
|
|
3428
3863
|
*/
|
|
3429
3864
|
StandardsArn?: string;
|
|
3430
3865
|
/**
|
|
3866
|
+
* @public
|
|
3431
3867
|
* <p>
|
|
3432
3868
|
* Optional pagination parameter.
|
|
3433
3869
|
* </p>
|
|
3434
3870
|
*/
|
|
3435
3871
|
NextToken?: string;
|
|
3436
3872
|
/**
|
|
3873
|
+
* @public
|
|
3437
3874
|
* <p> An optional parameter that limits the total results of the API response to the
|
|
3438
3875
|
* specified number. If this parameter isn't provided in the request, the results include the
|
|
3439
3876
|
* first 25 security controls that apply to the specified standard. The results also include a
|
|
@@ -3463,6 +3900,7 @@ export type RegionAvailabilityStatus = (typeof RegionAvailabilityStatus)[keyof t
|
|
|
3463
3900
|
*/
|
|
3464
3901
|
export interface SecurityControlDefinition {
|
|
3465
3902
|
/**
|
|
3903
|
+
* @public
|
|
3466
3904
|
* <p>
|
|
3467
3905
|
* The unique identifier of a security control across standards. Values for this field typically consist of an
|
|
3468
3906
|
* Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from
|
|
@@ -3472,24 +3910,28 @@ export interface SecurityControlDefinition {
|
|
|
3472
3910
|
*/
|
|
3473
3911
|
SecurityControlId: string | undefined;
|
|
3474
3912
|
/**
|
|
3913
|
+
* @public
|
|
3475
3914
|
* <p>
|
|
3476
3915
|
* The title of a security control.
|
|
3477
3916
|
* </p>
|
|
3478
3917
|
*/
|
|
3479
3918
|
Title: string | undefined;
|
|
3480
3919
|
/**
|
|
3920
|
+
* @public
|
|
3481
3921
|
* <p> The description of a security control across standards. This typically summarizes how
|
|
3482
3922
|
* Security Hub evaluates the control and the conditions under which it produces a
|
|
3483
3923
|
* failed finding. This parameter doesn't reference a specific standard. </p>
|
|
3484
3924
|
*/
|
|
3485
3925
|
Description: string | undefined;
|
|
3486
3926
|
/**
|
|
3927
|
+
* @public
|
|
3487
3928
|
* <p>
|
|
3488
3929
|
* A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
|
|
3489
3930
|
* </p>
|
|
3490
3931
|
*/
|
|
3491
3932
|
RemediationUrl: string | undefined;
|
|
3492
3933
|
/**
|
|
3934
|
+
* @public
|
|
3493
3935
|
* <p>
|
|
3494
3936
|
* The severity of a security control. For more information about how Security Hub determines control severity,
|
|
3495
3937
|
* see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity">Assigning severity to control findings</a> in the
|
|
@@ -3498,6 +3940,7 @@ export interface SecurityControlDefinition {
|
|
|
3498
3940
|
*/
|
|
3499
3941
|
SeverityRating: SeverityRating | string | undefined;
|
|
3500
3942
|
/**
|
|
3943
|
+
* @public
|
|
3501
3944
|
* <p>
|
|
3502
3945
|
* Specifies whether a security control is available in the current Amazon Web Services Region.
|
|
3503
3946
|
* </p>
|
|
@@ -3509,12 +3952,14 @@ export interface SecurityControlDefinition {
|
|
|
3509
3952
|
*/
|
|
3510
3953
|
export interface ListSecurityControlDefinitionsResponse {
|
|
3511
3954
|
/**
|
|
3955
|
+
* @public
|
|
3512
3956
|
* <p>
|
|
3513
3957
|
* An array of controls that apply to the specified standard.
|
|
3514
3958
|
* </p>
|
|
3515
3959
|
*/
|
|
3516
3960
|
SecurityControlDefinitions: SecurityControlDefinition[] | undefined;
|
|
3517
3961
|
/**
|
|
3962
|
+
* @public
|
|
3518
3963
|
* <p> A pagination parameter that's included in the response only if it was included in the
|
|
3519
3964
|
* request. </p>
|
|
3520
3965
|
*/
|
|
@@ -3525,6 +3970,7 @@ export interface ListSecurityControlDefinitionsResponse {
|
|
|
3525
3970
|
*/
|
|
3526
3971
|
export interface ListStandardsControlAssociationsRequest {
|
|
3527
3972
|
/**
|
|
3973
|
+
* @public
|
|
3528
3974
|
* <p>
|
|
3529
3975
|
* The identifier of the control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) that you
|
|
3530
3976
|
* want to determine the enablement status of in each enabled standard.
|
|
@@ -3532,12 +3978,14 @@ export interface ListStandardsControlAssociationsRequest {
|
|
|
3532
3978
|
*/
|
|
3533
3979
|
SecurityControlId: string | undefined;
|
|
3534
3980
|
/**
|
|
3981
|
+
* @public
|
|
3535
3982
|
* <p>
|
|
3536
3983
|
* Optional pagination parameter.
|
|
3537
3984
|
* </p>
|
|
3538
3985
|
*/
|
|
3539
3986
|
NextToken?: string;
|
|
3540
3987
|
/**
|
|
3988
|
+
* @public
|
|
3541
3989
|
* <p> An optional parameter that limits the total results of the API response to the
|
|
3542
3990
|
* specified number. If this parameter isn't provided in the request, the results include the
|
|
3543
3991
|
* first 25 standard and control associations. The results also include a
|
|
@@ -3555,12 +4003,14 @@ export interface ListStandardsControlAssociationsRequest {
|
|
|
3555
4003
|
*/
|
|
3556
4004
|
export interface StandardsControlAssociationSummary {
|
|
3557
4005
|
/**
|
|
4006
|
+
* @public
|
|
3558
4007
|
* <p>
|
|
3559
4008
|
* The Amazon Resource Name (ARN) of a standard.
|
|
3560
4009
|
* </p>
|
|
3561
4010
|
*/
|
|
3562
4011
|
StandardsArn: string | undefined;
|
|
3563
4012
|
/**
|
|
4013
|
+
* @public
|
|
3564
4014
|
* <p>
|
|
3565
4015
|
* A unique standard-agnostic identifier for a control. Values for this field typically consist of an
|
|
3566
4016
|
* Amazon Web Service and a number, such as APIGateway.5. This field doesn't reference a specific standard.
|
|
@@ -3568,38 +4018,45 @@ export interface StandardsControlAssociationSummary {
|
|
|
3568
4018
|
*/
|
|
3569
4019
|
SecurityControlId: string | undefined;
|
|
3570
4020
|
/**
|
|
4021
|
+
* @public
|
|
3571
4022
|
* <p> The ARN of a control, such as
|
|
3572
4023
|
* <code>arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1</code>. This
|
|
3573
4024
|
* parameter doesn't mention a specific standard. </p>
|
|
3574
4025
|
*/
|
|
3575
4026
|
SecurityControlArn: string | undefined;
|
|
3576
4027
|
/**
|
|
4028
|
+
* @public
|
|
3577
4029
|
* <p>
|
|
3578
4030
|
* The enablement status of a control in a specific standard.
|
|
3579
4031
|
* </p>
|
|
3580
4032
|
*/
|
|
3581
4033
|
AssociationStatus: AssociationStatus | string | undefined;
|
|
3582
4034
|
/**
|
|
4035
|
+
* @public
|
|
3583
4036
|
* <p>
|
|
3584
4037
|
* The requirement that underlies this control in the compliance framework related to the standard.
|
|
3585
4038
|
* </p>
|
|
3586
4039
|
*/
|
|
3587
4040
|
RelatedRequirements?: string[];
|
|
3588
4041
|
/**
|
|
4042
|
+
* @public
|
|
3589
4043
|
* <p> The last time that a control's enablement status in a specified standard was updated. </p>
|
|
3590
4044
|
*/
|
|
3591
4045
|
UpdatedAt?: Date;
|
|
3592
4046
|
/**
|
|
4047
|
+
* @public
|
|
3593
4048
|
* <p> The reason for updating the control's enablement status in a specified standard. </p>
|
|
3594
4049
|
*/
|
|
3595
4050
|
UpdatedReason?: string;
|
|
3596
4051
|
/**
|
|
4052
|
+
* @public
|
|
3597
4053
|
* <p>
|
|
3598
4054
|
* The title of a control.
|
|
3599
4055
|
* </p>
|
|
3600
4056
|
*/
|
|
3601
4057
|
StandardsControlTitle?: string;
|
|
3602
4058
|
/**
|
|
4059
|
+
* @public
|
|
3603
4060
|
* <p>
|
|
3604
4061
|
* The description of a control. This typically summarizes how Security Hub evaluates the control and the
|
|
3605
4062
|
* conditions under which it produces a failed finding. The parameter may reference a specific standard.
|
|
@@ -3612,11 +4069,13 @@ export interface StandardsControlAssociationSummary {
|
|
|
3612
4069
|
*/
|
|
3613
4070
|
export interface ListStandardsControlAssociationsResponse {
|
|
3614
4071
|
/**
|
|
4072
|
+
* @public
|
|
3615
4073
|
* <p> An array that provides the enablement status and other details for each security
|
|
3616
4074
|
* control that applies to each enabled standard. </p>
|
|
3617
4075
|
*/
|
|
3618
4076
|
StandardsControlAssociationSummaries: StandardsControlAssociationSummary[] | undefined;
|
|
3619
4077
|
/**
|
|
4078
|
+
* @public
|
|
3620
4079
|
* <p> A pagination parameter that's included in the response only if it was included in the
|
|
3621
4080
|
* request. </p>
|
|
3622
4081
|
*/
|
|
@@ -3627,6 +4086,7 @@ export interface ListStandardsControlAssociationsResponse {
|
|
|
3627
4086
|
*/
|
|
3628
4087
|
export interface ListTagsForResourceRequest {
|
|
3629
4088
|
/**
|
|
4089
|
+
* @public
|
|
3630
4090
|
* <p>The ARN of the resource to retrieve tags for.</p>
|
|
3631
4091
|
*/
|
|
3632
4092
|
ResourceArn: string | undefined;
|
|
@@ -3636,6 +4096,7 @@ export interface ListTagsForResourceRequest {
|
|
|
3636
4096
|
*/
|
|
3637
4097
|
export interface ListTagsForResourceResponse {
|
|
3638
4098
|
/**
|
|
4099
|
+
* @public
|
|
3639
4100
|
* <p>The tags associated with a resource.</p>
|
|
3640
4101
|
*/
|
|
3641
4102
|
Tags?: Record<string, string>;
|
|
@@ -3645,10 +4106,12 @@ export interface ListTagsForResourceResponse {
|
|
|
3645
4106
|
*/
|
|
3646
4107
|
export interface TagResourceRequest {
|
|
3647
4108
|
/**
|
|
4109
|
+
* @public
|
|
3648
4110
|
* <p>The ARN of the resource to apply the tags to.</p>
|
|
3649
4111
|
*/
|
|
3650
4112
|
ResourceArn: string | undefined;
|
|
3651
4113
|
/**
|
|
4114
|
+
* @public
|
|
3652
4115
|
* <p>The tags to add to the resource. You can add up to 50 tags at a time. The tag keys can be no longer than 128 characters. The tag values can be no longer than 256 characters.</p>
|
|
3653
4116
|
*/
|
|
3654
4117
|
Tags: Record<string, string> | undefined;
|
|
@@ -3663,10 +4126,12 @@ export interface TagResourceResponse {
|
|
|
3663
4126
|
*/
|
|
3664
4127
|
export interface UntagResourceRequest {
|
|
3665
4128
|
/**
|
|
4129
|
+
* @public
|
|
3666
4130
|
* <p>The ARN of the resource to remove the tags from.</p>
|
|
3667
4131
|
*/
|
|
3668
4132
|
ResourceArn: string | undefined;
|
|
3669
4133
|
/**
|
|
4134
|
+
* @public
|
|
3670
4135
|
* <p>The tag keys associated with the tags to remove from the resource. You can remove up to 50 tags at a time.</p>
|
|
3671
4136
|
*/
|
|
3672
4137
|
TagKeys: string[] | undefined;
|
|
@@ -3681,14 +4146,17 @@ export interface UntagResourceResponse {
|
|
|
3681
4146
|
*/
|
|
3682
4147
|
export interface UpdateActionTargetRequest {
|
|
3683
4148
|
/**
|
|
4149
|
+
* @public
|
|
3684
4150
|
* <p>The ARN of the custom action target to update.</p>
|
|
3685
4151
|
*/
|
|
3686
4152
|
ActionTargetArn: string | undefined;
|
|
3687
4153
|
/**
|
|
4154
|
+
* @public
|
|
3688
4155
|
* <p>The updated name of the custom action target.</p>
|
|
3689
4156
|
*/
|
|
3690
4157
|
Name?: string;
|
|
3691
4158
|
/**
|
|
4159
|
+
* @public
|
|
3692
4160
|
* <p>The updated description for the custom action target.</p>
|
|
3693
4161
|
*/
|
|
3694
4162
|
Description?: string;
|
|
@@ -3703,10 +4171,12 @@ export interface UpdateActionTargetResponse {
|
|
|
3703
4171
|
*/
|
|
3704
4172
|
export interface UpdateFindingAggregatorRequest {
|
|
3705
4173
|
/**
|
|
4174
|
+
* @public
|
|
3706
4175
|
* <p>The ARN of the finding aggregator. To obtain the ARN, use <code>ListFindingAggregators</code>.</p>
|
|
3707
4176
|
*/
|
|
3708
4177
|
FindingAggregatorArn: string | undefined;
|
|
3709
4178
|
/**
|
|
4179
|
+
* @public
|
|
3710
4180
|
* <p>Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.</p>
|
|
3711
4181
|
* <p>The selected option also determines how to use the Regions provided in the Regions list.</p>
|
|
3712
4182
|
* <p>The options are as follows:</p>
|
|
@@ -3730,6 +4200,7 @@ export interface UpdateFindingAggregatorRequest {
|
|
|
3730
4200
|
*/
|
|
3731
4201
|
RegionLinkingMode: string | undefined;
|
|
3732
4202
|
/**
|
|
4203
|
+
* @public
|
|
3733
4204
|
* <p>If <code>RegionLinkingMode</code> is <code>ALL_REGIONS_EXCEPT_SPECIFIED</code>, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.</p>
|
|
3734
4205
|
* <p>If <code>RegionLinkingMode</code> is <code>SPECIFIED_REGIONS</code>, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.</p>
|
|
3735
4206
|
*/
|
|
@@ -3740,18 +4211,22 @@ export interface UpdateFindingAggregatorRequest {
|
|
|
3740
4211
|
*/
|
|
3741
4212
|
export interface UpdateFindingAggregatorResponse {
|
|
3742
4213
|
/**
|
|
4214
|
+
* @public
|
|
3743
4215
|
* <p>The ARN of the finding aggregator.</p>
|
|
3744
4216
|
*/
|
|
3745
4217
|
FindingAggregatorArn?: string;
|
|
3746
4218
|
/**
|
|
4219
|
+
* @public
|
|
3747
4220
|
* <p>The aggregation Region.</p>
|
|
3748
4221
|
*/
|
|
3749
4222
|
FindingAggregationRegion?: string;
|
|
3750
4223
|
/**
|
|
4224
|
+
* @public
|
|
3751
4225
|
* <p>Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.</p>
|
|
3752
4226
|
*/
|
|
3753
4227
|
RegionLinkingMode?: string;
|
|
3754
4228
|
/**
|
|
4229
|
+
* @public
|
|
3755
4230
|
* <p>The list of excluded Regions or included Regions.</p>
|
|
3756
4231
|
*/
|
|
3757
4232
|
Regions?: string[];
|
|
@@ -3761,14 +4236,17 @@ export interface UpdateFindingAggregatorResponse {
|
|
|
3761
4236
|
*/
|
|
3762
4237
|
export interface UpdateFindingsRequest {
|
|
3763
4238
|
/**
|
|
4239
|
+
* @public
|
|
3764
4240
|
* <p>A collection of attributes that specify which findings you want to update.</p>
|
|
3765
4241
|
*/
|
|
3766
4242
|
Filters: AwsSecurityFindingFilters | undefined;
|
|
3767
4243
|
/**
|
|
4244
|
+
* @public
|
|
3768
4245
|
* <p>The updated note for the finding.</p>
|
|
3769
4246
|
*/
|
|
3770
4247
|
Note?: NoteUpdate;
|
|
3771
4248
|
/**
|
|
4249
|
+
* @public
|
|
3772
4250
|
* <p>The updated record state for the finding.</p>
|
|
3773
4251
|
*/
|
|
3774
4252
|
RecordState?: RecordState | string;
|
|
@@ -3783,18 +4261,22 @@ export interface UpdateFindingsResponse {
|
|
|
3783
4261
|
*/
|
|
3784
4262
|
export interface UpdateInsightRequest {
|
|
3785
4263
|
/**
|
|
4264
|
+
* @public
|
|
3786
4265
|
* <p>The ARN of the insight that you want to update.</p>
|
|
3787
4266
|
*/
|
|
3788
4267
|
InsightArn: string | undefined;
|
|
3789
4268
|
/**
|
|
4269
|
+
* @public
|
|
3790
4270
|
* <p>The updated name for the insight.</p>
|
|
3791
4271
|
*/
|
|
3792
4272
|
Name?: string;
|
|
3793
4273
|
/**
|
|
4274
|
+
* @public
|
|
3794
4275
|
* <p>The updated filters that define this insight.</p>
|
|
3795
4276
|
*/
|
|
3796
4277
|
Filters?: AwsSecurityFindingFilters;
|
|
3797
4278
|
/**
|
|
4279
|
+
* @public
|
|
3798
4280
|
* <p>The updated <code>GroupBy</code> attribute that defines this insight.</p>
|
|
3799
4281
|
*/
|
|
3800
4282
|
GroupByAttribute?: string;
|
|
@@ -3809,6 +4291,7 @@ export interface UpdateInsightResponse {
|
|
|
3809
4291
|
*/
|
|
3810
4292
|
export interface UpdateOrganizationConfigurationRequest {
|
|
3811
4293
|
/**
|
|
4294
|
+
* @public
|
|
3812
4295
|
* <p>Whether to automatically enable Security Hub for new accounts in the organization.</p>
|
|
3813
4296
|
* <p>By default, this is <code>false</code>, and new accounts are not added
|
|
3814
4297
|
* automatically.</p>
|
|
@@ -3816,6 +4299,7 @@ export interface UpdateOrganizationConfigurationRequest {
|
|
|
3816
4299
|
*/
|
|
3817
4300
|
AutoEnable: boolean | undefined;
|
|
3818
4301
|
/**
|
|
4302
|
+
* @public
|
|
3819
4303
|
* <p>Whether to automatically enable Security Hub <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html">default standards</a>
|
|
3820
4304
|
* for new member accounts in the organization.</p>
|
|
3821
4305
|
* <p>By default, this parameter is equal to <code>DEFAULT</code>, and new member accounts are automatically enabled with default Security Hub standards.</p>
|
|
@@ -3833,6 +4317,7 @@ export interface UpdateOrganizationConfigurationResponse {
|
|
|
3833
4317
|
*/
|
|
3834
4318
|
export interface UpdateSecurityHubConfigurationRequest {
|
|
3835
4319
|
/**
|
|
4320
|
+
* @public
|
|
3836
4321
|
* <p>Whether to automatically enable new controls when they are added to standards that are
|
|
3837
4322
|
* enabled.</p>
|
|
3838
4323
|
* <p>By default, this is set to <code>true</code>, and new controls are enabled
|
|
@@ -3841,6 +4326,7 @@ export interface UpdateSecurityHubConfigurationRequest {
|
|
|
3841
4326
|
*/
|
|
3842
4327
|
AutoEnableControls?: boolean;
|
|
3843
4328
|
/**
|
|
4329
|
+
* @public
|
|
3844
4330
|
* <p>Updates whether the calling account has consolidated control findings turned on.
|
|
3845
4331
|
* If the value for this field is set to
|
|
3846
4332
|
* <code>SECURITY_CONTROL</code>, Security Hub generates a single finding for a control check even when the check
|
|
@@ -3861,14 +4347,17 @@ export interface UpdateSecurityHubConfigurationResponse {
|
|
|
3861
4347
|
*/
|
|
3862
4348
|
export interface UpdateStandardsControlRequest {
|
|
3863
4349
|
/**
|
|
4350
|
+
* @public
|
|
3864
4351
|
* <p>The ARN of the security standard control to enable or disable.</p>
|
|
3865
4352
|
*/
|
|
3866
4353
|
StandardsControlArn: string | undefined;
|
|
3867
4354
|
/**
|
|
4355
|
+
* @public
|
|
3868
4356
|
* <p>The updated status of the security standard control.</p>
|
|
3869
4357
|
*/
|
|
3870
4358
|
ControlStatus?: ControlStatus | string;
|
|
3871
4359
|
/**
|
|
4360
|
+
* @public
|
|
3872
4361
|
* <p>A description of the reason why you are disabling a security standard control. If you
|
|
3873
4362
|
* are disabling a control, then this is required.</p>
|
|
3874
4363
|
*/
|