{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aws-security-hub/json-schema/aws-security-hub-batch-update-findings-request-schema.json",
  "title": "BatchUpdateFindingsRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aws-security-hub-findings-api-openapi.yml#/components/schemas/BatchUpdateFindingsRequest",
  "type": "object",
  "properties": {
    "FindingIdentifiers": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AwsSecurityFindingIdentifier"
      },
      "description": "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."
    },
    "Note": {
      "$ref": "#/$defs/NoteUpdate"
    },
    "Severity": {
      "$ref": "#/$defs/SeverityUpdate"
    },
    "VerificationState": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "TRUE_POSITIVE",
        "FALSE_POSITIVE",
        "BENIGN_POSITIVE"
      ],
      "description": "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 of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both"
    },
    "Confidence": {
      "type": "integer",
      "description": "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."
    },
    "Criticality": {
      "type": "integer",
      "description": "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."
    },
    "Types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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"
    },
    "UserDefinedFields": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding."
    },
    "Workflow": {
      "$ref": "#/$defs/WorkflowUpdate"
    },
    "RelatedFindings": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/RelatedFinding"
      },
      "description": "A list of findings that are related to the updated findings."
    }
  },
  "required": [
    "FindingIdentifiers"
  ],
  "$defs": {
    "AwsSecurityFindingIdentifier": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "The identifier of the finding that was specified by the finding provider."
        },
        "ProductArn": {
          "type": "string",
          "description": "The ARN generated by Security Hub CSPM that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub CSPM, or the ARN for a custom integration."
        }
      },
      "required": [
        "Id",
        "ProductArn"
      ]
    },
    "NoteUpdate": {
      "type": "object",
      "properties": {
        "Text": {
          "type": "string",
          "description": "The updated note text."
        },
        "UpdatedBy": {
          "type": "string",
          "description": "The principal that updated the note."
        }
      },
      "required": [
        "Text",
        "UpdatedBy"
      ]
    },
    "RelatedFinding": {
      "type": "object",
      "properties": {
        "ProductArn": {
          "type": "string",
          "description": "The ARN of the product that generated a related finding."
        },
        "Id": {
          "type": "string",
          "description": "The product-generated identifier for a related finding."
        }
      },
      "required": [
        "ProductArn",
        "Id"
      ]
    },
    "SeverityUpdate": {
      "type": "object",
      "properties": {
        "Normalized": {
          "type": "integer",
          "description": "The normalized severity for the finding. This attribute is to be deprecated in favor of Label. If you provide Normalized and don't provide Label, Label is set automatically as follows. 0 - INFORMATIONAL 1–39 - LOW 40–69 - MEDIUM 70–89 - HIGH 90–100 - CRITICAL"
        },
        "Product": {
          "type": "number",
          "description": "The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding."
        },
        "Label": {
          "type": "string",
          "enum": [
            "INFORMATIONAL",
            "LOW",
            "MEDIUM",
            "HIGH",
            "CRITICAL"
          ],
          "description": "The severity value of the finding. The allowed values are the following. INFORMATIONAL - No issue was found. LOW - The issue does not require action on its own. MEDIUM - The issue must be addressed but not urgently. HIGH - The issue must be addressed as a priority. CRITICAL - The issue must be remediated immediately to avoid it escalating."
        }
      }
    },
    "WorkflowUpdate": {
      "type": "object",
      "properties": {
        "Status": {
          "type": "string",
          "enum": [
            "NEW",
            "NOTIFIED",
            "RESOLVED",
            "SUPPRESSED"
          ],
          "description": "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 SUPPRESSED or RESOLVED does not prevent a new finding for the same issue. The allowed values are the following. NEW - The initial state of a finding, before it is reviewed. Security Hub CSPM also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following cases: The record state changes from ARCHIVED to ACTIVE. The compliance status changes from PASSED to either WARNING, FAILED, or "
        }
      }
    }
  }
}