Amazon CodeGuru Security · JSON Structure

Amazon Codeguru Security File Path Structure

Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.

Type: object Properties: 5
AmazonSecuritySASTCode AnalysisDevSecOpsDeveloper Tools

FilePath is a JSON Structure definition published by Amazon CodeGuru Security, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

codeSnippet endLine name path startLine

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-file-path-structure.json",
  "name": "FilePath",
  "description": "Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.",
  "type": "object",
  "properties": {
    "codeSnippet": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CodeSnippet"
        },
        {
          "description": "A list of <code>CodeLine</code> objects that describe where the security vulnerability appears in your code."
        }
      ]
    },
    "endLine": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The last line number of the code snippet where the security vulnerability appears in your code."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the file."
        }
      ]
    },
    "path": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The path to the resource with the security vulnerability."
        }
      ]
    },
    "startLine": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The first line number of the code snippet where the security vulnerability appears in your code."
        }
      ]
    }
  }
}