Amazon CodeGuru Reviewer · JSON Structure

Amazon Codeguru Reviewer Code Artifacts Structure

Code artifacts are source code artifacts and build artifacts used in a repository analysis or a pull request review.

Type: object Properties: 2 Required: 1
AmazonCode ReviewSecurityDevOpsMachine LearningDeveloper Tools

CodeArtifacts is a JSON Structure definition published by Amazon CodeGuru Reviewer, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

SourceCodeArtifactsObjectKey BuildArtifactsObjectKey

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-reviewer/refs/heads/main/json-structure/amazon-codeguru-reviewer-code-artifacts-structure.json",
  "name": "CodeArtifacts",
  "description": "<p>Code artifacts are source code artifacts and build artifacts used in a repository analysis or a pull request review.</p> <ul> <li> <p>Source code artifacts are source code files in a Git repository that are compressed into a .zip file.</p> </li> <li> <p>Build artifacts are .jar or .class files that are compressed in a .zip file.</p> </li> </ul>",
  "type": "object",
  "properties": {
    "SourceCodeArtifactsObjectKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SourceCodeArtifactsObjectKey"
        },
        {
          "description": "The S3 object key for a source code .zip file. This is required for all code reviews."
        }
      ]
    },
    "BuildArtifactsObjectKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildArtifactsObjectKey"
        },
        {
          "description": "The S3 object key for a build artifacts .zip file that contains .jar or .class files. This is required for a code review with security analysis. For more information, see <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/working-with-cicd.html\">Create code reviews with GitHub Actions</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>."
        }
      ]
    }
  },
  "required": [
    "SourceCodeArtifactsObjectKey"
  ]
}