Used by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from
batch_update_findings do not
affect the value of UpdatedAt for a finding.
Master and member accounts can use
batch_update_findings to update
the following finding fields and objects.
Confidence
Criticality
Note
RelatedFindings
Severity
Types
UserDefinedFields
VerificationState
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the AWS Security Hub User Guide.
securityhub_batch_update_findings(FindingIdentifiers, Note, Severity,
VerificationState, Confidence, Criticality, Types, UserDefinedFields,
Workflow, RelatedFindings)[required] The list of findings to update.
batch_update_findings can be used
to update up to 100 findings at a time.
For each finding, the list provides the finding identifier and the ARN of the finding provider.
Used to update the finding severity.
Indicates the veracity of a finding.
The available values for VerificationState are as follows.
UNKNOWN <U+2013> The default disposition of a security finding
TRUE_POSITIVE <U+2013> The security finding is confirmed
FALSE_POSITIVE <U+2013> The security finding was determined to be a false
alarm
BENIGN_POSITIVE <U+2013> A special case of TRUE_POSITIVE where the
finding doesn't pose any threat, is expected, or both
The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.
Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
The updated value for the level of importance assigned to the resources associated with the findings.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
One or more finding types in the format of namespace/category/classifier that classify a finding.
Valid namespace values are as follows.
Software and Configuration Checks
TTPs
Effects
Unusual Behaviors
Sensitive Data Identifications
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
Used to update the workflow status of a finding.
The workflow status indicates the progress of the investigation into the finding.
A list of findings that are related to the updated findings.
A list with the following syntax:
list(
ProcessedFindings = list(
list(
Id = "string",
ProductArn = "string"
)
),
UnprocessedFindings = list(
list(
FindingIdentifier = list(
Id = "string",
ProductArn = "string"
),
ErrorCode = "string",
ErrorMessage = "string"
)
)
)
svc$batch_update_findings(
FindingIdentifiers = list(
list(
Id = "string",
ProductArn = "string"
)
),
Note = list(
Text = "string",
UpdatedBy = "string"
),
Severity = list(
Normalized = 123,
Product = 123.0,
Label = "INFORMATIONAL"|"LOW"|"MEDIUM"|"HIGH"|"CRITICAL"
),
VerificationState = "UNKNOWN"|"TRUE_POSITIVE"|"FALSE_POSITIVE"|"BENIGN_POSITIVE",
Confidence = 123,
Criticality = 123,
Types = list(
"string"
),
UserDefinedFields = list(
"string"
),
Workflow = list(
Status = "NEW"|"NOTIFIED"|"RESOLVED"|"SUPPRESSED"
),
RelatedFindings = list(
list(
ProductArn = "string",
Id = "string"
)
)
)