/AWS1/CL_SHB=>BATCHUPDATEFINDINGS()
¶
About BatchUpdateFindings¶
Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from BatchUpdateFindings
do not affect the value of
UpdatedAt
for a finding.
Administrator and member accounts can use BatchUpdateFindings
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 Security Hub User Guide.
Method Signature¶
IMPORTING¶
Required arguments:¶
IT_FINDINGIDENTIFIERS
TYPE /AWS1/CL_SHBAWSSECFINDINGID=>TT_AWSSECURITYFINDINGIDLIST
TT_AWSSECURITYFINDINGIDLIST
¶
The list of findings to update.
BatchUpdateFindings
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.
Optional arguments:¶
IO_NOTE
TYPE REF TO /AWS1/CL_SHBNOTEUPDATE
/AWS1/CL_SHBNOTEUPDATE
¶
Note
IO_SEVERITY
TYPE REF TO /AWS1/CL_SHBSEVERITYUPDATE
/AWS1/CL_SHBSEVERITYUPDATE
¶
Used to update the finding severity.
IV_VERIFICATIONSTATE
TYPE /AWS1/SHBVERIFICATIONSTATE
/AWS1/SHBVERIFICATIONSTATE
¶
Indicates the veracity of a finding.
The available values for
VerificationState
are as follows.
UNKNOWN
– The default disposition of a security finding
TRUE_POSITIVE
– The security finding is confirmed
FALSE_POSITIVE
– The security finding was determined to be a false alarm
BENIGN_POSITIVE
– A special case ofTRUE_POSITIVE
where the finding doesn't pose any threat, is expected, or both
IV_CONFIDENCE
TYPE /AWS1/SHBRATIOSCALE
/AWS1/SHBRATIOSCALE
¶
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.
IV_CRITICALITY
TYPE /AWS1/SHBRATIOSCALE
/AWS1/SHBRATIOSCALE
¶
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.
IT_TYPES
TYPE /AWS1/CL_SHBTYPELIST_W=>TT_TYPELIST
TT_TYPELIST
¶
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
IT_USERDEFINEDFIELDS
TYPE /AWS1/CL_SHBFIELDMAP_W=>TT_FIELDMAP
TT_FIELDMAP
¶
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
IO_WORKFLOW
TYPE REF TO /AWS1/CL_SHBWORKFLOWUPDATE
/AWS1/CL_SHBWORKFLOWUPDATE
¶
Used to update the workflow status of a finding.
The workflow status indicates the progress of the investigation into the finding.
IT_RELATEDFINDINGS
TYPE /AWS1/CL_SHBRELATEDFINDING=>TT_RELATEDFINDINGLIST
TT_RELATEDFINDINGLIST
¶
A list of findings that are related to the updated findings.