BatchGetFindingsError

Contains information about the error that caused a finding to fail to be retrieved.

AmazonSecuritySASTCode AnalysisDevSecOpsDeveloper Tools

Properties

Name Type Description
errorCode object
findingId object
message object
scanName object
View JSON Schema on GitHub

JSON Schema

amazon-codeguru-security-batch-get-findings-error-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-security/refs/heads/main/json-schema/amazon-codeguru-security-batch-get-findings-error-schema.json",
  "title": "BatchGetFindingsError",
  "description": "Contains information about the error that caused a finding to fail to be retrieved.",
  "type": "object",
  "properties": {
    "errorCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorCode"
        },
        {
          "description": "A code associated with the type of error."
        }
      ]
    },
    "findingId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The finding ID of the finding that was not fetched."
        }
      ]
    },
    "message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Describes the error."
        }
      ]
    },
    "scanName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScanName"
        },
        {
          "description": "The name of the scan that generated the finding."
        }
      ]
    }
  },
  "required": [
    "errorCode",
    "findingId",
    "message",
    "scanName"
  ]
}