@aws-sdk/client-securityhub 3.341.0 → 3.342.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.
Files changed (29) hide show
  1. package/dist-cjs/models/models_1.js +1 -37
  2. package/dist-cjs/models/models_2.js +37 -1
  3. package/dist-cjs/protocols/Aws_restJson1.js +12 -2
  4. package/dist-es/models/models_1.js +0 -35
  5. package/dist-es/models/models_2.js +35 -0
  6. package/dist-es/protocols/Aws_restJson1.js +11 -1
  7. package/dist-types/commands/BatchEnableStandardsCommand.d.ts +3 -3
  8. package/dist-types/commands/BatchGetSecurityControlsCommand.d.ts +39 -1
  9. package/dist-types/commands/BatchGetStandardsControlAssociationsCommand.d.ts +51 -1
  10. package/dist-types/commands/BatchImportFindingsCommand.d.ts +172 -1
  11. package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +1 -1
  12. package/dist-types/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +41 -1
  13. package/dist-types/commands/CreateActionTargetCommand.d.ts +1 -1
  14. package/dist-types/commands/CreateFindingAggregatorCommand.d.ts +1 -1
  15. package/dist-types/commands/GetFindingsCommand.d.ts +171 -0
  16. package/dist-types/models/models_0.d.ts +551 -367
  17. package/dist-types/models/models_1.d.ts +6083 -6124
  18. package/dist-types/models/models_2.d.ts +841 -3
  19. package/dist-types/ts3.4/commands/BatchGetSecurityControlsCommand.d.ts +1 -1
  20. package/dist-types/ts3.4/commands/BatchGetStandardsControlAssociationsCommand.d.ts +1 -1
  21. package/dist-types/ts3.4/commands/BatchImportFindingsCommand.d.ts +1 -1
  22. package/dist-types/ts3.4/commands/BatchUpdateFindingsCommand.d.ts +1 -1
  23. package/dist-types/ts3.4/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +1 -1
  24. package/dist-types/ts3.4/commands/CreateActionTargetCommand.d.ts +1 -1
  25. package/dist-types/ts3.4/commands/CreateFindingAggregatorCommand.d.ts +1 -1
  26. package/dist-types/ts3.4/models/models_0.d.ts +98 -84
  27. package/dist-types/ts3.4/models/models_1.d.ts +175 -177
  28. package/dist-types/ts3.4/models/models_2.d.ts +178 -4
  29. package/package.json +28 -28
@@ -1,5 +1,842 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
1
2
  import { AccountDetails, ActionTarget, AdminAccount, AssociationStatus, AutoEnableStandards } from "./models_0";
2
- import { AwsSecurityFinding, AwsSecurityFindingFilters, AwsSecurityFindingIdentifier, ControlFindingGenerator, ControlStatus, NoteUpdate, RecordState, SeverityRating, StandardsSubscription } from "./models_1";
3
+ import { AwsSecurityFinding, AwsSecurityFindingFilters, AwsSecurityFindingIdentifier, RecordState, RelatedFinding, SeverityLabel, StandardsSubscription, VerificationState, WorkflowStatus } from "./models_1";
4
+ import { SecurityHubServiceException as __BaseException } from "./SecurityHubServiceException";
5
+ /**
6
+ * @public
7
+ */
8
+ export interface BatchGetSecurityControlsRequest {
9
+ /**
10
+ * <p> A list of security controls (identified with <code>SecurityControlId</code>,
11
+ * <code>SecurityControlArn</code>, or a mix of both parameters). The security control ID
12
+ * or Amazon Resource Name (ARN) is the same across standards. </p>
13
+ */
14
+ SecurityControlIds: string[] | undefined;
15
+ }
16
+ /**
17
+ * @public
18
+ * @enum
19
+ */
20
+ export declare const ControlStatus: {
21
+ readonly DISABLED: "DISABLED";
22
+ readonly ENABLED: "ENABLED";
23
+ };
24
+ /**
25
+ * @public
26
+ */
27
+ export type ControlStatus = (typeof ControlStatus)[keyof typeof ControlStatus];
28
+ /**
29
+ * @public
30
+ * @enum
31
+ */
32
+ export declare const SeverityRating: {
33
+ readonly CRITICAL: "CRITICAL";
34
+ readonly HIGH: "HIGH";
35
+ readonly LOW: "LOW";
36
+ readonly MEDIUM: "MEDIUM";
37
+ };
38
+ /**
39
+ * @public
40
+ */
41
+ export type SeverityRating = (typeof SeverityRating)[keyof typeof SeverityRating];
42
+ /**
43
+ * @public
44
+ * <p>
45
+ * A security control in Security Hub describes a security best practice related to a specific resource.
46
+ * </p>
47
+ */
48
+ export interface SecurityControl {
49
+ /**
50
+ * <p>
51
+ * The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a
52
+ * number, such as APIGateway.3.
53
+ * </p>
54
+ */
55
+ SecurityControlId: string | undefined;
56
+ /**
57
+ * <p> The Amazon Resource Name (ARN) for a security control across standards, such as
58
+ * <code>arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1</code>. This
59
+ * parameter doesn't mention a specific standard. </p>
60
+ */
61
+ SecurityControlArn: string | undefined;
62
+ /**
63
+ * <p>The title of a security control.
64
+ * </p>
65
+ */
66
+ Title: string | undefined;
67
+ /**
68
+ * <p> The description of a security control across standards. This typically summarizes how
69
+ * Security Hub evaluates the control and the conditions under which it produces a
70
+ * failed finding. This parameter doesn't reference a specific standard. </p>
71
+ */
72
+ Description: string | undefined;
73
+ /**
74
+ * <p>
75
+ * A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
76
+ * </p>
77
+ */
78
+ RemediationUrl: string | undefined;
79
+ /**
80
+ * <p>
81
+ * The severity of a security control. For more information about how Security Hub determines control severity, see
82
+ * <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
83
+ * <i>Security Hub User Guide</i>.
84
+ * </p>
85
+ */
86
+ SeverityRating: SeverityRating | string | undefined;
87
+ /**
88
+ * <p>
89
+ * The status of a security control based on the compliance status of its findings. For more information about how control
90
+ * status is determined, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/controls-overall-status.html">Determining the overall status of a control from its findings</a> in the
91
+ * <i>Security Hub User Guide</i>.
92
+ * </p>
93
+ */
94
+ SecurityControlStatus: ControlStatus | string | undefined;
95
+ }
96
+ /**
97
+ * @public
98
+ * @enum
99
+ */
100
+ export declare const UnprocessedErrorCode: {
101
+ readonly ACCESS_DENIED: "ACCESS_DENIED";
102
+ readonly INVALID_INPUT: "INVALID_INPUT";
103
+ readonly LIMIT_EXCEEDED: "LIMIT_EXCEEDED";
104
+ readonly NOT_FOUND: "NOT_FOUND";
105
+ };
106
+ /**
107
+ * @public
108
+ */
109
+ export type UnprocessedErrorCode = (typeof UnprocessedErrorCode)[keyof typeof UnprocessedErrorCode];
110
+ /**
111
+ * @public
112
+ * <p> Provides details about a security control for which a response couldn't be returned. </p>
113
+ */
114
+ export interface UnprocessedSecurityControl {
115
+ /**
116
+ * <p> The control (identified with <code>SecurityControlId</code>,
117
+ * <code>SecurityControlArn</code>, or a mix of both parameters) for which a response
118
+ * couldn't be returned. </p>
119
+ */
120
+ SecurityControlId: string | undefined;
121
+ /**
122
+ * <p>
123
+ * The error code for the unprocessed security control.
124
+ * </p>
125
+ */
126
+ ErrorCode: UnprocessedErrorCode | string | undefined;
127
+ /**
128
+ * <p>
129
+ * The reason why the security control was unprocessed.
130
+ * </p>
131
+ */
132
+ ErrorReason?: string;
133
+ }
134
+ /**
135
+ * @public
136
+ */
137
+ export interface BatchGetSecurityControlsResponse {
138
+ /**
139
+ * <p>
140
+ * An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control.
141
+ * The same information is returned whether the request includes <code>SecurityControlId</code> or <code>SecurityControlArn</code>.
142
+ * </p>
143
+ */
144
+ SecurityControls: SecurityControl[] | undefined;
145
+ /**
146
+ * <p>
147
+ * A security control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) for which
148
+ * details cannot be returned.
149
+ * </p>
150
+ */
151
+ UnprocessedIds?: UnprocessedSecurityControl[];
152
+ }
153
+ /**
154
+ * @public
155
+ * <p>
156
+ * 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)
157
+ * and the Amazon Resource Name (ARN) of a standard. The security control ID or ARN is the same across standards.
158
+ * </p>
159
+ */
160
+ export interface StandardsControlAssociationId {
161
+ /**
162
+ * <p>
163
+ * The unique identifier (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) of a security
164
+ * control across standards.
165
+ * </p>
166
+ */
167
+ SecurityControlId: string | undefined;
168
+ /**
169
+ * <p>
170
+ * The ARN of a standard.
171
+ * </p>
172
+ */
173
+ StandardsArn: string | undefined;
174
+ }
175
+ /**
176
+ * @public
177
+ */
178
+ export interface BatchGetStandardsControlAssociationsRequest {
179
+ /**
180
+ * <p>
181
+ * 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.
182
+ * 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.
183
+ * </p>
184
+ */
185
+ StandardsControlAssociationIds: StandardsControlAssociationId[] | undefined;
186
+ }
187
+ /**
188
+ * @public
189
+ * <p> Provides details about a control's enablement status in a specified standard. </p>
190
+ */
191
+ export interface StandardsControlAssociationDetail {
192
+ /**
193
+ * <p>
194
+ * The Amazon Resource Name (ARN) of a security standard.
195
+ * </p>
196
+ */
197
+ StandardsArn: string | undefined;
198
+ /**
199
+ * <p>
200
+ * The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service
201
+ * name and a number, such as APIGateway.3.
202
+ * </p>
203
+ */
204
+ SecurityControlId: string | undefined;
205
+ /**
206
+ * <p> The ARN of a security control across standards, such as
207
+ * <code>arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1</code>. This
208
+ * parameter doesn't mention a specific standard. </p>
209
+ */
210
+ SecurityControlArn: string | undefined;
211
+ /**
212
+ * <p>
213
+ * Specifies whether a control is enabled or disabled in a specified standard.
214
+ * </p>
215
+ */
216
+ AssociationStatus: AssociationStatus | string | undefined;
217
+ /**
218
+ * <p>
219
+ * The requirement that underlies a control in the compliance framework related to the standard.
220
+ * </p>
221
+ */
222
+ RelatedRequirements?: string[];
223
+ /**
224
+ * <p>
225
+ * The time at which the enablement status of the control in the specified standard was last updated.
226
+ * </p>
227
+ */
228
+ UpdatedAt?: Date;
229
+ /**
230
+ * <p>
231
+ * The reason for updating the enablement status of a control in a specified standard.
232
+ * </p>
233
+ */
234
+ UpdatedReason?: string;
235
+ /**
236
+ * <p>
237
+ * The title of a control. This field may reference a specific standard.
238
+ * </p>
239
+ */
240
+ StandardsControlTitle?: string;
241
+ /**
242
+ * <p>
243
+ * The description of a control. This typically summarizes how Security Hub evaluates the control and the
244
+ * conditions under which it produces a failed finding. This parameter may reference a specific standard.
245
+ * </p>
246
+ */
247
+ StandardsControlDescription?: string;
248
+ /**
249
+ * <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
250
+ * in a specified standard. </p>
251
+ */
252
+ StandardsControlArns?: string[];
253
+ }
254
+ /**
255
+ * @public
256
+ * <p> Provides details about which
257
+ * control's enablement status couldn't be retrieved in a specified standard when calling <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html">BatchUpdateStandardsControlAssociations</a>. This parameter also provides details
258
+ * about why the request was unprocessed. </p>
259
+ */
260
+ export interface UnprocessedStandardsControlAssociation {
261
+ /**
262
+ * <p> An array with one or more objects that includes a security control (identified with
263
+ * <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both
264
+ * parameters) and the Amazon Resource Name (ARN) of a standard. This parameter shows the
265
+ * specific controls for which the enablement status couldn't be retrieved in specified standards when
266
+ * calling <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html">BatchUpdateStandardsControlAssociations</a>. </p>
267
+ */
268
+ StandardsControlAssociationId: StandardsControlAssociationId | undefined;
269
+ /**
270
+ * <p>The error code for the unprocessed standard and control association.
271
+ * </p>
272
+ */
273
+ ErrorCode: UnprocessedErrorCode | string | undefined;
274
+ /**
275
+ * <p>The reason why the standard and control association was unprocessed. </p>
276
+ */
277
+ ErrorReason?: string;
278
+ }
279
+ /**
280
+ * @public
281
+ */
282
+ export interface BatchGetStandardsControlAssociationsResponse {
283
+ /**
284
+ * <p>Provides the enablement status of a security control in a specified standard and other details for the control in relation to
285
+ * the specified standard.
286
+ * </p>
287
+ */
288
+ StandardsControlAssociationDetails: StandardsControlAssociationDetail[] | undefined;
289
+ /**
290
+ * <p>
291
+ * A security control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) whose enablement
292
+ * status in a specified standard cannot be returned.
293
+ * </p>
294
+ */
295
+ UnprocessedAssociations?: UnprocessedStandardsControlAssociation[];
296
+ }
297
+ /**
298
+ * @public
299
+ */
300
+ export interface BatchImportFindingsRequest {
301
+ /**
302
+ * <p>A list of findings to import. To successfully import a finding, it must follow the
303
+ * <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>
304
+ */
305
+ Findings: AwsSecurityFinding[] | undefined;
306
+ }
307
+ /**
308
+ * @public
309
+ * <p>The list of the findings that cannot be imported. For each finding, the list provides
310
+ * the error.</p>
311
+ */
312
+ export interface ImportFindingsError {
313
+ /**
314
+ * <p>The identifier of the finding that could not be updated.</p>
315
+ */
316
+ Id: string | undefined;
317
+ /**
318
+ * <p>The code of the error returned by the <code>BatchImportFindings</code> operation.</p>
319
+ */
320
+ ErrorCode: string | undefined;
321
+ /**
322
+ * <p>The message of the error returned by the <code>BatchImportFindings</code>
323
+ * operation.</p>
324
+ */
325
+ ErrorMessage: string | undefined;
326
+ }
327
+ /**
328
+ * @public
329
+ */
330
+ export interface BatchImportFindingsResponse {
331
+ /**
332
+ * <p>The number of findings that failed to import.</p>
333
+ */
334
+ FailedCount: number | undefined;
335
+ /**
336
+ * <p>The number of findings that were successfully imported.</p>
337
+ */
338
+ SuccessCount: number | undefined;
339
+ /**
340
+ * <p>The list of findings that failed to import.</p>
341
+ */
342
+ FailedFindings?: ImportFindingsError[];
343
+ }
344
+ /**
345
+ * @public
346
+ * <p>The updated note.</p>
347
+ */
348
+ export interface NoteUpdate {
349
+ /**
350
+ * <p>The updated note text.</p>
351
+ */
352
+ Text: string | undefined;
353
+ /**
354
+ * <p>The principal that updated the note.</p>
355
+ */
356
+ UpdatedBy: string | undefined;
357
+ }
358
+ /**
359
+ * @public
360
+ * <p>Updates to the severity information for a finding.</p>
361
+ */
362
+ export interface SeverityUpdate {
363
+ /**
364
+ * <p>The normalized severity for the finding. This attribute is to be deprecated in favor of
365
+ * <code>Label</code>.</p>
366
+ * <p>If you provide <code>Normalized</code> and do not provide <code>Label</code>,
367
+ * <code>Label</code> is set automatically as follows.</p>
368
+ * <ul>
369
+ * <li>
370
+ * <p>0 - <code>INFORMATIONAL</code>
371
+ * </p>
372
+ * </li>
373
+ * <li>
374
+ * <p>1–39 - <code>LOW</code>
375
+ * </p>
376
+ * </li>
377
+ * <li>
378
+ * <p>40–69 - <code>MEDIUM</code>
379
+ * </p>
380
+ * </li>
381
+ * <li>
382
+ * <p>70–89 - <code>HIGH</code>
383
+ * </p>
384
+ * </li>
385
+ * <li>
386
+ * <p>90–100 - <code>CRITICAL</code>
387
+ * </p>
388
+ * </li>
389
+ * </ul>
390
+ */
391
+ Normalized?: number;
392
+ /**
393
+ * <p>The native severity as defined by the Amazon Web Services service or integrated partner product that
394
+ * generated the finding.</p>
395
+ */
396
+ Product?: number;
397
+ /**
398
+ * <p>The severity value of the finding. The allowed values are the following.</p>
399
+ * <ul>
400
+ * <li>
401
+ * <p>
402
+ * <code>INFORMATIONAL</code> - No issue was found.</p>
403
+ * </li>
404
+ * <li>
405
+ * <p>
406
+ * <code>LOW</code> - The issue does not require action on its own.</p>
407
+ * </li>
408
+ * <li>
409
+ * <p>
410
+ * <code>MEDIUM</code> - The issue must be addressed but not urgently.</p>
411
+ * </li>
412
+ * <li>
413
+ * <p>
414
+ * <code>HIGH</code> - The issue must be addressed as a priority.</p>
415
+ * </li>
416
+ * <li>
417
+ * <p>
418
+ * <code>CRITICAL</code> - The issue must be remediated immediately to avoid it
419
+ * escalating.</p>
420
+ * </li>
421
+ * </ul>
422
+ */
423
+ Label?: SeverityLabel | string;
424
+ }
425
+ /**
426
+ * @public
427
+ * <p>Used to update information about the investigation into the finding.</p>
428
+ */
429
+ export interface WorkflowUpdate {
430
+ /**
431
+ * <p>The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to <code>SUPPRESSED</code> or <code>RESOLVED</code> does not prevent a new finding for the same issue.</p>
432
+ * <p>The allowed values are the following.</p>
433
+ * <ul>
434
+ * <li>
435
+ * <p>
436
+ * <code>NEW</code> - The initial state of a finding, before it is reviewed.</p>
437
+ * <p>Security Hub also resets <code>WorkFlowStatus</code> from <code>NOTIFIED</code> or
438
+ * <code>RESOLVED</code> to <code>NEW</code> in the following cases:</p>
439
+ * <ul>
440
+ * <li>
441
+ * <p>The record state changes from <code>ARCHIVED</code> to
442
+ * <code>ACTIVE</code>.</p>
443
+ * </li>
444
+ * <li>
445
+ * <p>The compliance status changes from <code>PASSED</code> to either
446
+ * <code>WARNING</code>, <code>FAILED</code>, or
447
+ * <code>NOT_AVAILABLE</code>.</p>
448
+ * </li>
449
+ * </ul>
450
+ * </li>
451
+ * <li>
452
+ * <p>
453
+ * <code>NOTIFIED</code> - Indicates that you notified the resource owner about the
454
+ * security issue. Used when the initial reviewer is not the resource owner, and needs
455
+ * intervention from the resource owner.</p>
456
+ * </li>
457
+ * <li>
458
+ * <p>
459
+ * <code>RESOLVED</code> - The finding was reviewed and remediated and is now
460
+ * considered resolved.</p>
461
+ * </li>
462
+ * <li>
463
+ * <p>
464
+ * <code>SUPPRESSED</code> - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.</p>
465
+ * </li>
466
+ * </ul>
467
+ */
468
+ Status?: WorkflowStatus | string;
469
+ }
470
+ /**
471
+ * @public
472
+ */
473
+ export interface BatchUpdateFindingsRequest {
474
+ /**
475
+ * <p>The list of findings to update. <code>BatchUpdateFindings</code> can be used to update
476
+ * up to 100 findings at a time.</p>
477
+ * <p>For each finding, the list provides the finding identifier and the ARN of the finding
478
+ * provider.</p>
479
+ */
480
+ FindingIdentifiers: AwsSecurityFindingIdentifier[] | undefined;
481
+ /**
482
+ * <p>The updated note.</p>
483
+ */
484
+ Note?: NoteUpdate;
485
+ /**
486
+ * <p>Used to update the finding severity.</p>
487
+ */
488
+ Severity?: SeverityUpdate;
489
+ /**
490
+ * <p>Indicates the veracity of a finding.</p>
491
+ * <p>The available values for <code>VerificationState</code> are as follows.</p>
492
+ * <ul>
493
+ * <li>
494
+ * <p>
495
+ * <code>UNKNOWN</code> – The default disposition of a security finding</p>
496
+ * </li>
497
+ * <li>
498
+ * <p>
499
+ * <code>TRUE_POSITIVE</code> – The security finding is confirmed</p>
500
+ * </li>
501
+ * <li>
502
+ * <p>
503
+ * <code>FALSE_POSITIVE</code> – The security finding was determined to be a false
504
+ * alarm</p>
505
+ * </li>
506
+ * <li>
507
+ * <p>
508
+ * <code>BENIGN_POSITIVE</code> – A special case of <code>TRUE_POSITIVE</code> where
509
+ * the finding doesn't pose any threat, is expected, or both</p>
510
+ * </li>
511
+ * </ul>
512
+ */
513
+ VerificationState?: VerificationState | string;
514
+ /**
515
+ * <p>The updated value for the finding confidence. Confidence is defined as the likelihood
516
+ * that a finding accurately identifies the behavior or issue that it was intended to
517
+ * identify.</p>
518
+ * <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent
519
+ * confidence and 100 means 100 percent confidence.</p>
520
+ */
521
+ Confidence?: number;
522
+ /**
523
+ * <p>The updated value for the level of importance assigned to the resources associated with
524
+ * the findings.</p>
525
+ * <p>A score of 0 means that the underlying resources have no criticality, and a score of 100
526
+ * is reserved for the most critical resources. </p>
527
+ */
528
+ Criticality?: number;
529
+ /**
530
+ * <p>One or more finding types in the format of namespace/category/classifier that classify a
531
+ * finding.</p>
532
+ * <p>Valid namespace values are as follows.</p>
533
+ * <ul>
534
+ * <li>
535
+ * <p>Software and Configuration Checks</p>
536
+ * </li>
537
+ * <li>
538
+ * <p>TTPs</p>
539
+ * </li>
540
+ * <li>
541
+ * <p>Effects</p>
542
+ * </li>
543
+ * <li>
544
+ * <p>Unusual Behaviors</p>
545
+ * </li>
546
+ * <li>
547
+ * <p>Sensitive Data Identifications </p>
548
+ * </li>
549
+ * </ul>
550
+ */
551
+ Types?: string[];
552
+ /**
553
+ * <p>A list of name/value string pairs associated with the finding. These are custom,
554
+ * user-defined fields added to a finding.</p>
555
+ */
556
+ UserDefinedFields?: Record<string, string>;
557
+ /**
558
+ * <p>Used to update the workflow status of a finding.</p>
559
+ * <p>The workflow status indicates the progress of the investigation into the finding. </p>
560
+ */
561
+ Workflow?: WorkflowUpdate;
562
+ /**
563
+ * <p>A list of findings that are related to the updated findings.</p>
564
+ */
565
+ RelatedFindings?: RelatedFinding[];
566
+ }
567
+ /**
568
+ * @public
569
+ * <p>A finding from a <code>BatchUpdateFindings</code> request that Security Hub was unable to
570
+ * update.</p>
571
+ */
572
+ export interface BatchUpdateFindingsUnprocessedFinding {
573
+ /**
574
+ * <p>The identifier of the finding that was not updated.</p>
575
+ */
576
+ FindingIdentifier: AwsSecurityFindingIdentifier | undefined;
577
+ /**
578
+ * <p>The code associated with the error. Possible values are:</p>
579
+ * <ul>
580
+ * <li>
581
+ * <p>
582
+ * <code>ConcurrentUpdateError</code> - Another request attempted to update the finding while this request was being processed.
583
+ * This error may also occur if you call <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html">
584
+ * <code>BatchUpdateFindings</code>
585
+ * </a>
586
+ * and <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
587
+ * <code>BatchImportFindings</code>
588
+ * </a> at the same time.</p>
589
+ * </li>
590
+ * <li>
591
+ * <p>
592
+ * <code>DuplicatedFindingIdentifier</code> - The request included two or more findings with the same <code>FindingIdentifier</code>.</p>
593
+ * </li>
594
+ * <li>
595
+ * <p>
596
+ * <code>FindingNotFound</code> - The <code>FindingIdentifier</code> included in the request did not match an existing finding.</p>
597
+ * </li>
598
+ * <li>
599
+ * <p>
600
+ * <code>FindingSizeExceeded</code> - The finding size was greater than the permissible value of 240 KB.</p>
601
+ * </li>
602
+ * <li>
603
+ * <p>
604
+ * <code>InternalFailure</code> - An internal service failure occurred when updating the finding.</p>
605
+ * </li>
606
+ * <li>
607
+ * <p>
608
+ * <code>InvalidInput</code> - The finding update contained an invalid value that did not satisfy the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html">Amazon Web Services Security Finding Format</a> syntax.</p>
609
+ * </li>
610
+ * </ul>
611
+ */
612
+ ErrorCode: string | undefined;
613
+ /**
614
+ * <p>The message associated with the error. Possible values are:</p>
615
+ * <ul>
616
+ * <li>
617
+ * <p>
618
+ * <code>Concurrent finding updates detected</code>
619
+ * </p>
620
+ * </li>
621
+ * <li>
622
+ * <p>
623
+ * <code>Finding Identifier is duplicated</code>
624
+ * </p>
625
+ * </li>
626
+ * <li>
627
+ * <p>
628
+ * <code>Finding Not Found</code>
629
+ * </p>
630
+ * </li>
631
+ * <li>
632
+ * <p>
633
+ * <code>Finding size exceeded 240 KB</code>
634
+ * </p>
635
+ * </li>
636
+ * <li>
637
+ * <p>
638
+ * <code>Internal service failure</code>
639
+ * </p>
640
+ * </li>
641
+ * <li>
642
+ * <p>
643
+ * <code>Invalid Input</code>
644
+ * </p>
645
+ * </li>
646
+ * </ul>
647
+ */
648
+ ErrorMessage: string | undefined;
649
+ }
650
+ /**
651
+ * @public
652
+ */
653
+ export interface BatchUpdateFindingsResponse {
654
+ /**
655
+ * <p>The list of findings that were updated successfully.</p>
656
+ */
657
+ ProcessedFindings: AwsSecurityFindingIdentifier[] | undefined;
658
+ /**
659
+ * <p>The list of findings that were not updated.</p>
660
+ */
661
+ UnprocessedFindings: BatchUpdateFindingsUnprocessedFinding[] | undefined;
662
+ }
663
+ /**
664
+ * @public
665
+ * <p>An array of requested updates to the enablement status of controls in specified
666
+ * standards. The objects in the array include a security control ID, the Amazon Resource Name (ARN) of the standard, the requested
667
+ * enablement status, and the reason for updating the enablement status.</p>
668
+ */
669
+ export interface StandardsControlAssociationUpdate {
670
+ /**
671
+ * <p>The Amazon Resource Name (ARN) of the standard in which you want to update the
672
+ * control's enablement status.</p>
673
+ */
674
+ StandardsArn: string | undefined;
675
+ /**
676
+ * <p>The unique identifier for the security control whose enablement status you want to update.</p>
677
+ */
678
+ SecurityControlId: string | undefined;
679
+ /**
680
+ * <p>The desired enablement status of the control in the standard.</p>
681
+ */
682
+ AssociationStatus: AssociationStatus | string | undefined;
683
+ /**
684
+ * <p>The reason for updating the control's enablement status in the standard.</p>
685
+ */
686
+ UpdatedReason?: string;
687
+ }
688
+ /**
689
+ * @public
690
+ */
691
+ export interface BatchUpdateStandardsControlAssociationsRequest {
692
+ /**
693
+ * <p>
694
+ * Updates the enablement status of a security control in a specified standard.
695
+ * </p>
696
+ */
697
+ StandardsControlAssociationUpdates: StandardsControlAssociationUpdate[] | undefined;
698
+ }
699
+ /**
700
+ * @public
701
+ * <p>Provides details about which control's enablement status could not be updated in a
702
+ * specified standard when calling the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html">BatchUpdateStandardsControlAssociations</a> API. This parameter also provides
703
+ * details about why the request was unprocessed. </p>
704
+ */
705
+ export interface UnprocessedStandardsControlAssociationUpdate {
706
+ /**
707
+ * <p>An array of control and standard associations for which an update failed when calling
708
+ * <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html">BatchUpdateStandardsControlAssociations</a>.
709
+ * </p>
710
+ */
711
+ StandardsControlAssociationUpdate: StandardsControlAssociationUpdate | undefined;
712
+ /**
713
+ * <p>The error code for the unprocessed update of the control's enablement status in the
714
+ * specified standard.</p>
715
+ */
716
+ ErrorCode: UnprocessedErrorCode | string | undefined;
717
+ /**
718
+ * <p>The reason why a control's enablement status in the specified standard couldn't be updated. </p>
719
+ */
720
+ ErrorReason?: string;
721
+ }
722
+ /**
723
+ * @public
724
+ */
725
+ export interface BatchUpdateStandardsControlAssociationsResponse {
726
+ /**
727
+ * <p>
728
+ * 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.
729
+ * </p>
730
+ */
731
+ UnprocessedAssociationUpdates?: UnprocessedStandardsControlAssociationUpdate[];
732
+ }
733
+ /**
734
+ * @public
735
+ * @enum
736
+ */
737
+ export declare const ControlFindingGenerator: {
738
+ readonly SECURITY_CONTROL: "SECURITY_CONTROL";
739
+ readonly STANDARD_CONTROL: "STANDARD_CONTROL";
740
+ };
741
+ /**
742
+ * @public
743
+ */
744
+ export type ControlFindingGenerator = (typeof ControlFindingGenerator)[keyof typeof ControlFindingGenerator];
745
+ /**
746
+ * @public
747
+ */
748
+ export interface CreateActionTargetRequest {
749
+ /**
750
+ * <p>The name of the custom action target. Can contain up to 20 characters.</p>
751
+ */
752
+ Name: string | undefined;
753
+ /**
754
+ * <p>The description for the custom action target.</p>
755
+ */
756
+ Description: string | undefined;
757
+ /**
758
+ * <p>The ID for the custom action target. Can contain up to 20 alphanumeric characters.</p>
759
+ */
760
+ Id: string | undefined;
761
+ }
762
+ /**
763
+ * @public
764
+ */
765
+ export interface CreateActionTargetResponse {
766
+ /**
767
+ * <p>The Amazon Resource Name (ARN) for the custom action target.</p>
768
+ */
769
+ ActionTargetArn: string | undefined;
770
+ }
771
+ /**
772
+ * @public
773
+ * <p>The resource specified in the request conflicts with an existing resource.</p>
774
+ */
775
+ export declare class ResourceConflictException extends __BaseException {
776
+ readonly name: "ResourceConflictException";
777
+ readonly $fault: "client";
778
+ Message?: string;
779
+ Code?: string;
780
+ /**
781
+ * @internal
782
+ */
783
+ constructor(opts: __ExceptionOptionType<ResourceConflictException, __BaseException>);
784
+ }
785
+ /**
786
+ * @public
787
+ */
788
+ export interface CreateFindingAggregatorRequest {
789
+ /**
790
+ * <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>
791
+ * <p>The selected option also determines how to use the Regions provided in the Regions list.</p>
792
+ * <p>The options are as follows:</p>
793
+ * <ul>
794
+ * <li>
795
+ * <p>
796
+ * <code>ALL_REGIONS</code> - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
797
+ * </p>
798
+ * </li>
799
+ * <li>
800
+ * <p>
801
+ * <code>ALL_REGIONS_EXCEPT_SPECIFIED</code> - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the <code>Regions</code> parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
802
+ * </p>
803
+ * </li>
804
+ * <li>
805
+ * <p>
806
+ * <code>SPECIFIED_REGIONS</code> - Indicates to aggregate findings only from the Regions listed in the <code>Regions</code> parameter. Security Hub does not automatically aggregate findings from new Regions.
807
+ * </p>
808
+ * </li>
809
+ * </ul>
810
+ */
811
+ RegionLinkingMode: string | undefined;
812
+ /**
813
+ * <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>
814
+ * <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.
815
+ * </p>
816
+ */
817
+ Regions?: string[];
818
+ }
819
+ /**
820
+ * @public
821
+ */
822
+ export interface CreateFindingAggregatorResponse {
823
+ /**
824
+ * <p>The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.</p>
825
+ */
826
+ FindingAggregatorArn?: string;
827
+ /**
828
+ * <p>The aggregation Region.</p>
829
+ */
830
+ FindingAggregationRegion?: string;
831
+ /**
832
+ * <p>Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.</p>
833
+ */
834
+ RegionLinkingMode?: string;
835
+ /**
836
+ * <p>The list of excluded Regions or included Regions.</p>
837
+ */
838
+ Regions?: string[];
839
+ }
3
840
  /**
4
841
  * @public
5
842
  */
@@ -778,8 +1615,9 @@ export interface FindingHistoryRecord {
778
1615
  */
779
1616
  FindingIdentifier?: AwsSecurityFindingIdentifier;
780
1617
  /**
781
- * <p> An ISO 8601-formatted timestamp that indicates when the security findings provider last
782
- * updated the finding record. A correctly formatted example is
1618
+ * <p> An ISO 8601-formatted timestamp that indicates when Security Hub
1619
+ * processed the updated finding record.</p>
1620
+ * <p>A correctly formatted example is
783
1621
  * <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and
784
1622
  * 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,
785
1623
  * Internet Date/Time Format</a>. </p>