Patch findingsbatchupdate — securityhub

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1461972964.4 KB

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.

patch/findings/batchupdate

Request body

VerificationState'UNKNOWN' | 'TRUE_POSITIVE' | 'FALSE_POSITIVE' | 'BENIGN_POSITIVE'

Indicates the veracity of a finding. The available values for <code>VerificationState</code> are as follows. <ul> <li> <code>UNKNOWN</code> – The default disposition of a security finding </li> <li> <code>TRUE_POSITIVE</code> – The security finding is confirmed </li> <li> <code>FALSE_POSITIVE</code> – The security finding was determined to be a false alarm </li> <li> <code>BENIGN_POSITIVE</code> – A special case of <code>TRUE_POSITIVE</code> where the finding doesn't pose any threat, is expected, or both </li> </ul>

Confidenceinteger

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.

Criticalityinteger

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.

TypesNonEmptyString[]

One or more finding types in the format of namespace/category/classifier that classify a finding. Valid namespace values are as follows. <ul> <li> Software and Configuration Checks </li> <li> TTPs </li> <li> Effects </li> <li> Unusual Behaviors </li> <li> Sensitive Data Identifications </li> </ul>

UserDefinedFieldsobject

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

Response

Success

Example response

{
  "ProcessedFindings": [
    {
      "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
      "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub"
    },
    {
      "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
      "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub"
    }
  ],
  "UnprocessedFindings": []
}