Amazon CodeGuru Security · JSON Structure

Amazon Codeguru Security Scan Summary Structure

Information about a scan.

Type: object Properties: 6 Required: 4
AmazonSecuritySASTCode AnalysisDevSecOpsDeveloper Tools

ScanSummary is a JSON Structure definition published by Amazon CodeGuru Security, describing 6 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

createdAt runId scanName scanNameArn scanState updatedAt

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-security/refs/heads/main/json-structure/amazon-codeguru-security-scan-summary-structure.json",
  "name": "ScanSummary",
  "description": "Information about a scan. ",
  "type": "object",
  "properties": {
    "createdAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " The time when the scan was created. "
        }
      ]
    },
    "runId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Uuid"
        },
        {
          "description": "The identifier for the scan run. "
        }
      ]
    },
    "scanName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScanName"
        },
        {
          "description": "The name of the scan. "
        }
      ]
    },
    "scanNameArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScanNameArn"
        },
        {
          "description": "The ARN for the scan name."
        }
      ]
    },
    "scanState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScanState"
        },
        {
          "description": "The state of the scan. A scan can be <code>In Progress</code>, <code>Complete</code>, or <code>Failed</code>. "
        }
      ]
    },
    "updatedAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time the scan was last updated. A scan is updated when it is re-run."
        }
      ]
    }
  },
  "required": [
    "createdAt",
    "runId",
    "scanName",
    "scanState"
  ]
}