Amazon CodeGuru Reviewer · JSON Structure

Amazon Codeguru Reviewer Create Code Review Request Structure

CreateCodeReviewRequest schema from Amazon CodeGuru Reviewer

Type: object Properties: 4 Required: 3
AmazonCode ReviewSecurityDevOpsMachine LearningDeveloper Tools

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

Properties

Name RepositoryAssociationArn Type ClientRequestToken

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-create-code-review-request-structure.json",
  "name": "CreateCodeReviewRequest",
  "description": "CreateCodeReviewRequest schema from Amazon CodeGuru Reviewer",
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CodeReviewName"
        },
        {
          "description": "The name of the code review. The name of each code review in your Amazon Web Services account must be unique."
        }
      ]
    },
    "RepositoryAssociationArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssociationArn"
        },
        {
          "description": "<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html\">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html\">ListRepositoryAssociations</a>.</p> <p>A code review can only be created on an associated repository. This is the ARN of the associated repository.</p>"
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CodeReviewType"
        },
        {
          "description": "The type of code review to create. This is specified using a <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html\">CodeReviewType</a> object. You can create a code review only of type <code>RepositoryAnalysis</code>."
        }
      ]
    },
    "ClientRequestToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientRequestToken"
        },
        {
          "description": "Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries."
        }
      ]
    }
  },
  "required": [
    "Name",
    "RepositoryAssociationArn",
    "Type"
  ]
}