@aws-sdk/client-securityhub 3.370.0 → 3.378.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.
@@ -1,7 +1,785 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { AccountDetails, ActionTarget, AdminAccount, AssociationStatus, AutoEnableStandards, AutomationRulesAction, AutomationRulesConfig, AutomationRulesFindingFilters, AutomationRulesMetadata, NoteUpdate, RelatedFinding, RuleStatus, SeverityUpdate, VerificationState, WorkflowUpdate } from "./models_0";
3
- import { AwsSecurityFinding, AwsSecurityFindingFilters, RecordState } from "./models_1";
2
+ import { AccountDetails, Action, ActionTarget, AdminAccount, AssociationStatus, AutoEnableStandards, AutomationRulesAction, AutomationRulesConfig, AutomationRulesFindingFilters, AutomationRulesMetadata, DateFilter, MapFilter, NoteUpdate, NumberFilter, RelatedFinding, RuleStatus, SeverityUpdate, StringFilter, VerificationState, WorkflowUpdate } from "./models_0";
3
+ import { Compliance, FindingProviderFields, Malware, Network, NetworkPathComponent, Note, PatchSummary, ProcessDetails, RecordState, Remediation, Resource, Severity, Threat, ThreatIntelIndicator, Vulnerability, Workflow, WorkflowState } from "./models_1";
4
4
  import { SecurityHubServiceException as __BaseException } from "./SecurityHubServiceException";
5
+ /**
6
+ * @public
7
+ * <p>Provides a consistent format for Security Hub findings.
8
+ * <code>AwsSecurityFinding</code> format allows you to share findings between Amazon Web Services
9
+ * security services and third-party solutions.</p>
10
+ * <note>
11
+ * <p>A finding is a potential security issue generated either by Amazon Web Services services or by the integrated third-party
12
+ * solutions and standards checks.</p>
13
+ * </note>
14
+ */
15
+ export interface AwsSecurityFinding {
16
+ /**
17
+ * <p>The schema version that a finding is formatted for.</p>
18
+ */
19
+ SchemaVersion: string | undefined;
20
+ /**
21
+ * <p>The security findings provider-specific identifier for a finding.</p>
22
+ */
23
+ Id: string | undefined;
24
+ /**
25
+ * <p>The ARN generated by Security Hub that uniquely identifies a product that generates findings.
26
+ * This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for
27
+ * a custom integration.</p>
28
+ */
29
+ ProductArn: string | undefined;
30
+ /**
31
+ * <p>The name of the product that generated the finding.</p>
32
+ * <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
+ * <p>When you use the Security Hub console or API to filter findings by product name, you use this attribute.</p>
34
+ */
35
+ ProductName?: string;
36
+ /**
37
+ * <p>The name of the company for the product that generated the finding.</p>
38
+ * <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
+ * <p>When you use the Security Hub console or API to filter findings by company name, you use this attribute.</p>
40
+ */
41
+ CompanyName?: string;
42
+ /**
43
+ * <p>The Region from which the finding was generated.</p>
44
+ * <p>Security Hub populates this attribute automatically for each finding. You cannot update it using <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>.</p>
45
+ */
46
+ Region?: string;
47
+ /**
48
+ * <p>The identifier for the solution-specific component (a discrete unit of logic) that
49
+ * generated a finding. In various security findings providers' solutions, this generator can
50
+ * be called a rule, a check, a detector, a plugin, etc. </p>
51
+ */
52
+ GeneratorId: string | undefined;
53
+ /**
54
+ * <p>The Amazon Web Services account ID that a finding is generated in.</p>
55
+ */
56
+ AwsAccountId: string | undefined;
57
+ /**
58
+ * <p>One or more finding types in the format of <code>namespace/category/classifier</code>
59
+ * that classify a finding.</p>
60
+ * <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual
61
+ * Behaviors | Sensitive Data Identifications</p>
62
+ */
63
+ Types?: string[];
64
+ /**
65
+ * <p>Indicates when the security findings provider first observed the potential security
66
+ * issue that a finding captured.</p>
67
+ * <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
68
+ * Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
69
+ * <code>2020-03-22T13:22:13.933Z</code>.</p>
70
+ */
71
+ FirstObservedAt?: string;
72
+ /**
73
+ * <p>Indicates when the security findings provider most recently observed the potential
74
+ * security issue that a finding captured.</p>
75
+ * <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
76
+ * Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
77
+ * <code>2020-03-22T13:22:13.933Z</code>.</p>
78
+ */
79
+ LastObservedAt?: string;
80
+ /**
81
+ * <p>Indicates when the security findings provider created the potential security issue that
82
+ * a finding captured.</p>
83
+ * <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
84
+ * Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
85
+ * <code>2020-03-22T13:22:13.933Z</code>.</p>
86
+ */
87
+ CreatedAt: string | undefined;
88
+ /**
89
+ * <p>Indicates when the security findings provider last updated the finding record.</p>
90
+ * <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
+ * Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
92
+ * <code>2020-03-22T13:22:13.933Z</code>.</p>
93
+ */
94
+ UpdatedAt: string | undefined;
95
+ /**
96
+ * <p>A finding's severity.</p>
97
+ */
98
+ Severity?: Severity;
99
+ /**
100
+ * <p>A finding's confidence. Confidence is defined as the likelihood that a finding
101
+ * accurately identifies the behavior or issue that it was intended to identify.</p>
102
+ * <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent
103
+ * confidence and 100 means 100 percent confidence.</p>
104
+ */
105
+ Confidence?: number;
106
+ /**
107
+ * <p>The level of importance assigned to the resources associated with the finding.</p>
108
+ * <p>A score of 0 means that the underlying resources have no criticality, and a score of 100
109
+ * is reserved for the most critical resources.</p>
110
+ */
111
+ Criticality?: number;
112
+ /**
113
+ * <p>A finding's title.</p>
114
+ * <note>
115
+ * <p>In this release, <code>Title</code> is a required property.</p>
116
+ * </note>
117
+ */
118
+ Title: string | undefined;
119
+ /**
120
+ * <p>A finding's description.</p>
121
+ * <note>
122
+ * <p>In this release, <code>Description</code> is a required property.</p>
123
+ * </note>
124
+ */
125
+ Description: string | undefined;
126
+ /**
127
+ * <p>A data type that describes the remediation options for a finding.</p>
128
+ */
129
+ Remediation?: Remediation;
130
+ /**
131
+ * <p>A URL that links to a page about the current finding in the security findings provider's
132
+ * solution.</p>
133
+ */
134
+ SourceUrl?: string;
135
+ /**
136
+ * <p>A data type where security findings providers can include additional solution-specific
137
+ * details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p>
138
+ * <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
+ */
140
+ ProductFields?: Record<string, string>;
141
+ /**
142
+ * <p>A list of name/value string pairs associated with the finding. These are custom,
143
+ * user-defined fields added to a finding. </p>
144
+ */
145
+ UserDefinedFields?: Record<string, string>;
146
+ /**
147
+ * <p>A list of malware related to a finding.</p>
148
+ */
149
+ Malware?: Malware[];
150
+ /**
151
+ * <p>The details of network-related information about a finding.</p>
152
+ */
153
+ Network?: Network;
154
+ /**
155
+ * <p>Provides information about a network path that is relevant to a finding. Each entry
156
+ * under <code>NetworkPath</code> represents a component of that path.</p>
157
+ */
158
+ NetworkPath?: NetworkPathComponent[];
159
+ /**
160
+ * <p>The details of process-related information about a finding.</p>
161
+ */
162
+ Process?: ProcessDetails;
163
+ /**
164
+ * <p>Details about the threat detected in a security finding and the file paths that were affected by the threat.
165
+ * </p>
166
+ */
167
+ Threats?: Threat[];
168
+ /**
169
+ * <p>Threat intelligence details related to a finding.</p>
170
+ */
171
+ ThreatIntelIndicators?: ThreatIntelIndicator[];
172
+ /**
173
+ * <p>A set of resource data types that describe the resources that the finding refers
174
+ * to.</p>
175
+ */
176
+ Resources: Resource[] | undefined;
177
+ /**
178
+ * <p>This data type is exclusive to findings that are generated as the result of a check run
179
+ * against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations.
180
+ * Contains security standard-related finding details.</p>
181
+ */
182
+ Compliance?: Compliance;
183
+ /**
184
+ * <p>Indicates the veracity of a finding. </p>
185
+ */
186
+ VerificationState?: VerificationState | string;
187
+ /**
188
+ * @deprecated
189
+ *
190
+ * <p>The workflow state of a finding. </p>
191
+ */
192
+ WorkflowState?: WorkflowState | string;
193
+ /**
194
+ * <p>Provides information about the status of the investigation into a finding.</p>
195
+ */
196
+ Workflow?: Workflow;
197
+ /**
198
+ * <p>The record state of a finding.</p>
199
+ */
200
+ RecordState?: RecordState | string;
201
+ /**
202
+ * <p>A list of related findings.</p>
203
+ */
204
+ RelatedFindings?: RelatedFinding[];
205
+ /**
206
+ * <p>A user-defined note added to a finding.</p>
207
+ */
208
+ Note?: Note;
209
+ /**
210
+ * <p>Provides a list of vulnerabilities associated with the findings.</p>
211
+ */
212
+ Vulnerabilities?: Vulnerability[];
213
+ /**
214
+ * <p>Provides an overview of the patch compliance status for an instance against a selected
215
+ * compliance standard.</p>
216
+ */
217
+ PatchSummary?: PatchSummary;
218
+ /**
219
+ * <p>Provides details about an action that affects or that was taken on a resource.</p>
220
+ */
221
+ Action?: Action;
222
+ /**
223
+ * <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
+ */
225
+ FindingProviderFields?: FindingProviderFields;
226
+ /**
227
+ * <p>Indicates whether the finding is a sample finding.</p>
228
+ */
229
+ Sample?: boolean;
230
+ }
231
+ /**
232
+ * @public
233
+ * <p>A keyword filter for querying findings.</p>
234
+ */
235
+ export interface KeywordFilter {
236
+ /**
237
+ * <p>A value for the keyword.</p>
238
+ */
239
+ Value?: string;
240
+ }
241
+ /**
242
+ * @public
243
+ * <p>The IP filter for querying findings.</p>
244
+ */
245
+ export interface IpFilter {
246
+ /**
247
+ * <p>A finding's CIDR value.</p>
248
+ */
249
+ Cidr?: string;
250
+ }
251
+ /**
252
+ * @public
253
+ * <p>Boolean filter for querying findings.</p>
254
+ */
255
+ export interface BooleanFilter {
256
+ /**
257
+ * <p>The value of the boolean.</p>
258
+ */
259
+ Value?: boolean;
260
+ }
261
+ /**
262
+ * @public
263
+ * <p>A collection of attributes that are applied to all active Security Hub-aggregated findings and
264
+ * that result in a subset of findings that are included in this insight.</p>
265
+ * <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to
266
+ * 20 filter values.</p>
267
+ */
268
+ export interface AwsSecurityFindingFilters {
269
+ /**
270
+ * <p>The ARN generated by Security Hub that uniquely identifies a third-party company
271
+ * (security findings provider) after this provider's product (solution that generates
272
+ * findings) is registered with Security Hub.</p>
273
+ */
274
+ ProductArn?: StringFilter[];
275
+ /**
276
+ * <p>The Amazon Web Services account ID that a finding is generated in.</p>
277
+ */
278
+ AwsAccountId?: StringFilter[];
279
+ /**
280
+ * <p>The security findings provider-specific identifier for a finding.</p>
281
+ */
282
+ Id?: StringFilter[];
283
+ /**
284
+ * <p>The identifier for the solution-specific component (a discrete unit of logic) that
285
+ * generated a finding. In various security findings providers' solutions, this generator can
286
+ * be called a rule, a check, a detector, a plugin, etc.</p>
287
+ */
288
+ GeneratorId?: StringFilter[];
289
+ /**
290
+ * <p>The Region from which the finding was generated.</p>
291
+ */
292
+ Region?: StringFilter[];
293
+ /**
294
+ * <p>A finding type in the format of <code>namespace/category/classifier</code> that
295
+ * classifies a finding.</p>
296
+ */
297
+ Type?: StringFilter[];
298
+ /**
299
+ * <p>An ISO8601-formatted timestamp that indicates when the security findings provider first
300
+ * observed the potential security issue that a finding captured.</p>
301
+ * <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
+ */
303
+ FirstObservedAt?: DateFilter[];
304
+ /**
305
+ * <p>An ISO8601-formatted timestamp that indicates when the security findings provider most
306
+ * recently observed the potential security issue that a finding captured.</p>
307
+ * <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
+ */
309
+ LastObservedAt?: DateFilter[];
310
+ /**
311
+ * <p>An ISO8601-formatted timestamp that indicates when the security findings provider
312
+ * captured the potential security issue that a finding captured.</p>
313
+ * <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
+ */
315
+ CreatedAt?: DateFilter[];
316
+ /**
317
+ * <p>An ISO8601-formatted timestamp that indicates when the security findings provider last
318
+ * updated the finding record. </p>
319
+ * <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
+ */
321
+ UpdatedAt?: DateFilter[];
322
+ /**
323
+ * @deprecated
324
+ *
325
+ * <p>The native severity as defined by the security findings provider's solution that
326
+ * generated the finding.</p>
327
+ */
328
+ SeverityProduct?: NumberFilter[];
329
+ /**
330
+ * @deprecated
331
+ *
332
+ * <p>The normalized severity of a finding.</p>
333
+ */
334
+ SeverityNormalized?: NumberFilter[];
335
+ /**
336
+ * <p>The label of a finding's severity.</p>
337
+ */
338
+ SeverityLabel?: StringFilter[];
339
+ /**
340
+ * <p>A finding's confidence. Confidence is defined as the likelihood that a finding
341
+ * accurately identifies the behavior or issue that it was intended to identify.</p>
342
+ * <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent
343
+ * confidence and 100 means 100 percent confidence.</p>
344
+ */
345
+ Confidence?: NumberFilter[];
346
+ /**
347
+ * <p>The level of importance assigned to the resources associated with the finding.</p>
348
+ * <p>A score of 0 means that the underlying resources have no criticality, and a score of 100
349
+ * is reserved for the most critical resources.</p>
350
+ */
351
+ Criticality?: NumberFilter[];
352
+ /**
353
+ * <p>A finding's title.</p>
354
+ */
355
+ Title?: StringFilter[];
356
+ /**
357
+ * <p>A finding's description.</p>
358
+ */
359
+ Description?: StringFilter[];
360
+ /**
361
+ * <p>The recommendation of what to do about the issue described in a finding.</p>
362
+ */
363
+ RecommendationText?: StringFilter[];
364
+ /**
365
+ * <p>A URL that links to a page about the current finding in the security findings provider's
366
+ * solution.</p>
367
+ */
368
+ SourceUrl?: StringFilter[];
369
+ /**
370
+ * <p>A data type where security findings providers can include additional solution-specific
371
+ * details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p>
372
+ */
373
+ ProductFields?: MapFilter[];
374
+ /**
375
+ * <p>The name of the solution (product) that generates findings.</p>
376
+ */
377
+ ProductName?: StringFilter[];
378
+ /**
379
+ * <p>The name of the findings provider (company) that owns the solution (product) that
380
+ * generates findings.</p>
381
+ */
382
+ CompanyName?: StringFilter[];
383
+ /**
384
+ * <p>A list of name/value string pairs associated with the finding. These are custom,
385
+ * user-defined fields added to a finding. </p>
386
+ */
387
+ UserDefinedFields?: MapFilter[];
388
+ /**
389
+ * <p>The name of the malware that was observed.</p>
390
+ */
391
+ MalwareName?: StringFilter[];
392
+ /**
393
+ * <p>The type of the malware that was observed.</p>
394
+ */
395
+ MalwareType?: StringFilter[];
396
+ /**
397
+ * <p>The filesystem path of the malware that was observed.</p>
398
+ */
399
+ MalwarePath?: StringFilter[];
400
+ /**
401
+ * <p>The state of the malware that was observed.</p>
402
+ */
403
+ MalwareState?: StringFilter[];
404
+ /**
405
+ * <p>Indicates the direction of network traffic associated with a finding.</p>
406
+ */
407
+ NetworkDirection?: StringFilter[];
408
+ /**
409
+ * <p>The protocol of network-related information about a finding.</p>
410
+ */
411
+ NetworkProtocol?: StringFilter[];
412
+ /**
413
+ * <p>The source IPv4 address of network-related information about a finding.</p>
414
+ */
415
+ NetworkSourceIpV4?: IpFilter[];
416
+ /**
417
+ * <p>The source IPv6 address of network-related information about a finding.</p>
418
+ */
419
+ NetworkSourceIpV6?: IpFilter[];
420
+ /**
421
+ * <p>The source port of network-related information about a finding.</p>
422
+ */
423
+ NetworkSourcePort?: NumberFilter[];
424
+ /**
425
+ * <p>The source domain of network-related information about a finding.</p>
426
+ */
427
+ NetworkSourceDomain?: StringFilter[];
428
+ /**
429
+ * <p>The source media access control (MAC) address of network-related information about a
430
+ * finding.</p>
431
+ */
432
+ NetworkSourceMac?: StringFilter[];
433
+ /**
434
+ * <p>The destination IPv4 address of network-related information about a finding.</p>
435
+ */
436
+ NetworkDestinationIpV4?: IpFilter[];
437
+ /**
438
+ * <p>The destination IPv6 address of network-related information about a finding.</p>
439
+ */
440
+ NetworkDestinationIpV6?: IpFilter[];
441
+ /**
442
+ * <p>The destination port of network-related information about a finding.</p>
443
+ */
444
+ NetworkDestinationPort?: NumberFilter[];
445
+ /**
446
+ * <p>The destination domain of network-related information about a finding.</p>
447
+ */
448
+ NetworkDestinationDomain?: StringFilter[];
449
+ /**
450
+ * <p>The name of the process.</p>
451
+ */
452
+ ProcessName?: StringFilter[];
453
+ /**
454
+ * <p>The path to the process executable.</p>
455
+ */
456
+ ProcessPath?: StringFilter[];
457
+ /**
458
+ * <p>The process ID.</p>
459
+ */
460
+ ProcessPid?: NumberFilter[];
461
+ /**
462
+ * <p>The parent process ID. This field accepts positive integers between <code>O</code> and <code>2147483647</code>.</p>
463
+ */
464
+ ProcessParentPid?: NumberFilter[];
465
+ /**
466
+ * <p>A timestamp that identifies when the process was launched.</p>
467
+ * <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
+ */
469
+ ProcessLaunchedAt?: DateFilter[];
470
+ /**
471
+ * <p>A timestamp that identifies when the process was terminated.</p>
472
+ * <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
+ */
474
+ ProcessTerminatedAt?: DateFilter[];
475
+ /**
476
+ * <p>The type of a threat intelligence indicator.</p>
477
+ */
478
+ ThreatIntelIndicatorType?: StringFilter[];
479
+ /**
480
+ * <p>The value of a threat intelligence indicator.</p>
481
+ */
482
+ ThreatIntelIndicatorValue?: StringFilter[];
483
+ /**
484
+ * <p>The category of a threat intelligence indicator.</p>
485
+ */
486
+ ThreatIntelIndicatorCategory?: StringFilter[];
487
+ /**
488
+ * <p>A timestamp that identifies the last observation of a threat intelligence indicator.</p>
489
+ */
490
+ ThreatIntelIndicatorLastObservedAt?: DateFilter[];
491
+ /**
492
+ * <p>The source of the threat intelligence.</p>
493
+ */
494
+ ThreatIntelIndicatorSource?: StringFilter[];
495
+ /**
496
+ * <p>The URL for more details from the source of the threat intelligence.</p>
497
+ */
498
+ ThreatIntelIndicatorSourceUrl?: StringFilter[];
499
+ /**
500
+ * <p>Specifies the type of the resource that details are provided for.</p>
501
+ */
502
+ ResourceType?: StringFilter[];
503
+ /**
504
+ * <p>The canonical identifier for the given resource type.</p>
505
+ */
506
+ ResourceId?: StringFilter[];
507
+ /**
508
+ * <p>The canonical Amazon Web Services partition name that the Region is assigned to.</p>
509
+ */
510
+ ResourcePartition?: StringFilter[];
511
+ /**
512
+ * <p>The canonical Amazon Web Services external Region name where this resource is located.</p>
513
+ */
514
+ ResourceRegion?: StringFilter[];
515
+ /**
516
+ * <p>A list of Amazon Web Services tags associated with a resource at the time the finding was
517
+ * processed.</p>
518
+ */
519
+ ResourceTags?: MapFilter[];
520
+ /**
521
+ * <p>The instance type of the instance.</p>
522
+ */
523
+ ResourceAwsEc2InstanceType?: StringFilter[];
524
+ /**
525
+ * <p>The Amazon Machine Image (AMI) ID of the instance.</p>
526
+ */
527
+ ResourceAwsEc2InstanceImageId?: StringFilter[];
528
+ /**
529
+ * <p>The IPv4 addresses associated with the instance.</p>
530
+ */
531
+ ResourceAwsEc2InstanceIpV4Addresses?: IpFilter[];
532
+ /**
533
+ * <p>The IPv6 addresses associated with the instance.</p>
534
+ */
535
+ ResourceAwsEc2InstanceIpV6Addresses?: IpFilter[];
536
+ /**
537
+ * <p>The key name associated with the instance.</p>
538
+ */
539
+ ResourceAwsEc2InstanceKeyName?: StringFilter[];
540
+ /**
541
+ * <p>The IAM profile ARN of the instance.</p>
542
+ */
543
+ ResourceAwsEc2InstanceIamInstanceProfileArn?: StringFilter[];
544
+ /**
545
+ * <p>The identifier of the VPC that the instance was launched in.</p>
546
+ */
547
+ ResourceAwsEc2InstanceVpcId?: StringFilter[];
548
+ /**
549
+ * <p>The identifier of the subnet that the instance was launched in.</p>
550
+ */
551
+ ResourceAwsEc2InstanceSubnetId?: StringFilter[];
552
+ /**
553
+ * <p>The date and time the instance was launched.</p>
554
+ */
555
+ ResourceAwsEc2InstanceLaunchedAt?: DateFilter[];
556
+ /**
557
+ * <p>The canonical user ID of the owner of the S3 bucket.</p>
558
+ */
559
+ ResourceAwsS3BucketOwnerId?: StringFilter[];
560
+ /**
561
+ * <p>The display name of the owner of the S3 bucket.</p>
562
+ */
563
+ ResourceAwsS3BucketOwnerName?: StringFilter[];
564
+ /**
565
+ * @deprecated
566
+ *
567
+ * <p>The user associated with the IAM access key related to a finding.</p>
568
+ */
569
+ ResourceAwsIamAccessKeyUserName?: StringFilter[];
570
+ /**
571
+ * <p>The name of the principal that is associated with an IAM access key.</p>
572
+ */
573
+ ResourceAwsIamAccessKeyPrincipalName?: StringFilter[];
574
+ /**
575
+ * <p>The status of the IAM access key related to a finding.</p>
576
+ */
577
+ ResourceAwsIamAccessKeyStatus?: StringFilter[];
578
+ /**
579
+ * <p>The creation date/time of the IAM access key related to a finding.</p>
580
+ */
581
+ ResourceAwsIamAccessKeyCreatedAt?: DateFilter[];
582
+ /**
583
+ * <p>The name of an IAM user.</p>
584
+ */
585
+ ResourceAwsIamUserUserName?: StringFilter[];
586
+ /**
587
+ * <p>The name of the container related to a finding.</p>
588
+ */
589
+ ResourceContainerName?: StringFilter[];
590
+ /**
591
+ * <p>The identifier of the image related to a finding.</p>
592
+ */
593
+ ResourceContainerImageId?: StringFilter[];
594
+ /**
595
+ * <p>The name of the image related to a finding.</p>
596
+ */
597
+ ResourceContainerImageName?: StringFilter[];
598
+ /**
599
+ * <p>A timestamp that identifies when the container was started.</p>
600
+ * <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
+ */
602
+ ResourceContainerLaunchedAt?: DateFilter[];
603
+ /**
604
+ * <p>The details of a resource that doesn't have a specific subfield for the resource type
605
+ * defined.</p>
606
+ */
607
+ ResourceDetailsOther?: MapFilter[];
608
+ /**
609
+ * <p>Exclusive to findings that are generated as the result of a check run against a specific
610
+ * rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security
611
+ * standard-related finding details.</p>
612
+ */
613
+ ComplianceStatus?: StringFilter[];
614
+ /**
615
+ * <p>The veracity of a finding.</p>
616
+ */
617
+ VerificationState?: StringFilter[];
618
+ /**
619
+ * <p>The workflow state of a finding.</p>
620
+ * <p>Note that this field is deprecated. To search for a finding based on its workflow
621
+ * status, use <code>WorkflowStatus</code>.</p>
622
+ */
623
+ WorkflowState?: StringFilter[];
624
+ /**
625
+ * <p>The status of the investigation into a finding. Allowed values are the following.</p>
626
+ * <ul>
627
+ * <li>
628
+ * <p>
629
+ * <code>NEW</code> - The initial state of a finding, before it is reviewed.</p>
630
+ * <p>Security Hub also resets the workflow status from <code>NOTIFIED</code> or
631
+ * <code>RESOLVED</code> to <code>NEW</code> in the following cases:</p>
632
+ * <ul>
633
+ * <li>
634
+ * <p>
635
+ * <code>RecordState</code> changes from <code>ARCHIVED</code> to <code>ACTIVE</code>.</p>
636
+ * </li>
637
+ * <li>
638
+ * <p>
639
+ * <code>Compliance.Status</code> changes from <code>PASSED</code> to either <code>WARNING</code>,
640
+ * <code>FAILED</code>, or <code>NOT_AVAILABLE</code>.</p>
641
+ * </li>
642
+ * </ul>
643
+ * </li>
644
+ * <li>
645
+ * <p>
646
+ * <code>NOTIFIED</code> - Indicates that the resource owner has been notified about
647
+ * the security issue. Used when the initial reviewer is not the resource owner, and
648
+ * needs intervention from the resource owner.</p>
649
+ * <p>If one of the following occurs, the workflow status is changed automatically from
650
+ * <code>NOTIFIED</code> to <code>NEW</code>:</p>
651
+ * <ul>
652
+ * <li>
653
+ * <p>
654
+ * <code>RecordState</code> changes from <code>ARCHIVED</code> to
655
+ * <code>ACTIVE</code>.</p>
656
+ * </li>
657
+ * <li>
658
+ * <p>
659
+ * <code>Compliance.Status</code> changes from <code>PASSED</code> to <code>FAILED</code>,
660
+ * <code>WARNING</code>, or <code>NOT_AVAILABLE</code>.</p>
661
+ * </li>
662
+ * </ul>
663
+ * </li>
664
+ * <li>
665
+ * <p>
666
+ * <code>SUPPRESSED</code> - Indicates that you reviewed the finding and do not believe that any action is
667
+ * needed.</p>
668
+ * <p>The workflow status of a <code>SUPPRESSED</code> finding does not change if
669
+ * <code>RecordState</code> changes from <code>ARCHIVED</code> to
670
+ * <code>ACTIVE</code>.</p>
671
+ * </li>
672
+ * <li>
673
+ * <p>
674
+ * <code>RESOLVED</code> - The finding was reviewed and remediated and is now
675
+ * considered resolved. </p>
676
+ * <p>The finding remains <code>RESOLVED</code> unless one of the following occurs:</p>
677
+ * <ul>
678
+ * <li>
679
+ * <p>
680
+ * <code>RecordState</code> changes from <code>ARCHIVED</code> to
681
+ * <code>ACTIVE</code>.</p>
682
+ * </li>
683
+ * <li>
684
+ * <p>
685
+ * <code>Compliance.Status</code> changes from <code>PASSED</code> to <code>FAILED</code>,
686
+ * <code>WARNING</code>, or <code>NOT_AVAILABLE</code>.</p>
687
+ * </li>
688
+ * </ul>
689
+ * <p>In those cases, the workflow status is automatically reset to <code>NEW</code>.</p>
690
+ * <p>For findings from controls, if <code>Compliance.Status</code> is <code>PASSED</code>,
691
+ * then Security Hub automatically sets the workflow status to <code>RESOLVED</code>.</p>
692
+ * </li>
693
+ * </ul>
694
+ */
695
+ WorkflowStatus?: StringFilter[];
696
+ /**
697
+ * <p>The updated record state for the finding.</p>
698
+ */
699
+ RecordState?: StringFilter[];
700
+ /**
701
+ * <p>The ARN of the solution that generated a related finding.</p>
702
+ */
703
+ RelatedFindingsProductArn?: StringFilter[];
704
+ /**
705
+ * <p>The solution-generated identifier for a related finding.</p>
706
+ */
707
+ RelatedFindingsId?: StringFilter[];
708
+ /**
709
+ * <p>The text of a note.</p>
710
+ */
711
+ NoteText?: StringFilter[];
712
+ /**
713
+ * <p>The timestamp of when the note was updated.</p>
714
+ */
715
+ NoteUpdatedAt?: DateFilter[];
716
+ /**
717
+ * <p>The principal that created a note.</p>
718
+ */
719
+ NoteUpdatedBy?: StringFilter[];
720
+ /**
721
+ * @deprecated
722
+ *
723
+ * <p>A keyword for a finding.</p>
724
+ */
725
+ Keyword?: KeywordFilter[];
726
+ /**
727
+ * <p>The finding provider value for the finding confidence. Confidence is defined as the likelihood
728
+ * that a finding accurately identifies the behavior or issue that it was intended to
729
+ * identify.</p>
730
+ * <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent
731
+ * confidence and 100 means 100 percent confidence.</p>
732
+ */
733
+ FindingProviderFieldsConfidence?: NumberFilter[];
734
+ /**
735
+ * <p>The finding provider value for the level of importance assigned to the resources associated with
736
+ * the findings.</p>
737
+ * <p>A score of 0 means that the underlying resources have no criticality, and a score of 100
738
+ * is reserved for the most critical resources. </p>
739
+ */
740
+ FindingProviderFieldsCriticality?: NumberFilter[];
741
+ /**
742
+ * <p>The finding identifier of a related finding that is identified by the finding provider.</p>
743
+ */
744
+ FindingProviderFieldsRelatedFindingsId?: StringFilter[];
745
+ /**
746
+ * <p>The ARN of the solution that generated a related finding that is identified by the finding provider.</p>
747
+ */
748
+ FindingProviderFieldsRelatedFindingsProductArn?: StringFilter[];
749
+ /**
750
+ * <p>The finding provider value for the severity label.</p>
751
+ */
752
+ FindingProviderFieldsSeverityLabel?: StringFilter[];
753
+ /**
754
+ * <p>The finding provider's original value for the severity.</p>
755
+ */
756
+ FindingProviderFieldsSeverityOriginal?: StringFilter[];
757
+ /**
758
+ * <p>One or more finding types that the finding provider assigned to the finding. Uses the format of <code>namespace/category/classifier</code>
759
+ * that classify a finding.</p>
760
+ * <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual
761
+ * Behaviors | Sensitive Data Identifications</p>
762
+ */
763
+ FindingProviderFieldsTypes?: StringFilter[];
764
+ /**
765
+ * <p>Indicates whether or not sample findings are included in the filter results.</p>
766
+ */
767
+ Sample?: BooleanFilter[];
768
+ /**
769
+ * <p>
770
+ * The unique identifier of a control across standards. Values for this field typically consist of an
771
+ * Amazon Web Service and a number, such as APIGateway.5.
772
+ * </p>
773
+ */
774
+ ComplianceSecurityControlId?: StringFilter[];
775
+ /**
776
+ * <p>
777
+ * The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the
778
+ * 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.
779
+ * </p>
780
+ */
781
+ ComplianceAssociatedStandardsId?: StringFilter[];
782
+ }
5
783
  /**
6
784
  * @public
7
785
  * <p>Identifies which finding to get the finding history for.</p>
@@ -620,11 +1398,9 @@ export interface UpdateAutomationRulesRequestItem {
620
1398
  */
621
1399
  RuleName?: string;
622
1400
  /**
623
- * <p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful
624
- * when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this
625
- * field is set to <code>true</code> for a rule, Security Hub applies the rule action to a finding that matches
626
- * the rule criteria and doesn't evaluate other rules for the finding.
627
- The default value of this field is <code>false</code>.
1401
+ * <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
+ * 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
+ * the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
628
1404
  * </p>
629
1405
  */
630
1406
  IsTerminal?: boolean;
@@ -1030,9 +1806,8 @@ export interface CreateAutomationRuleRequest {
1030
1806
  Description: string | undefined;
1031
1807
  /**
1032
1808
  * <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
1033
- * matches the criteria for multiple rules, and each rule has different actions. If the value of this field is
1034
- * set to <code>true</code> for a rule, Security Hub applies the rule action to a finding that matches
1035
- * the rule criteria and doesn't evaluate other rules for the finding. The default value of this field is <code>false</code>.
1809
+ * 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
+ * the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
1036
1811
  * </p>
1037
1812
  */
1038
1813
  IsTerminal?: boolean;