Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateCodeReview

Use to create a code review with a CodeReviewType of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. PullRequest code reviews are automatically triggered by a pull request.

Request Syntax


POST /codereviews HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "Name": "string",
   "RepositoryAssociationArn": "string",
   "Type": { 
      "AnalysisTypes": [ "string" ],
      "RepositoryAnalysis": { 
         "RepositoryHead": { 
            "BranchName": "string"
         },
         "SourceCodeType": { 
            "BranchDiff": { 
               "DestinationBranchName": "string",
               "SourceBranchName": "string"
            },
            "CommitDiff": { 
               "DestinationCommit": "string",
               "MergeBaseCommit": "string",
               "SourceCommit": "string"
            },
            "RepositoryHead": { 
               "BranchName": "string"
            },
            "RequestMetadata": { 
               "EventInfo": { 
                  "Name": "string",
                  "State": "string"
               },
               "Requester": "string",
               "RequestId": "string",
               "VendorName": "string"
            },
            "S3BucketRepository": { 
               "Details": { 
                  "BucketName": "string",
                  "CodeArtifacts": { 
                     "BuildArtifactsObjectKey": "string",
                     "SourceCodeArtifactsObjectKey": "string"
                  }
               },
               "Name": "string"
            }
         }
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w-]+$

Required: No

Name

The name of the code review. The name of each code review in your AWS account must be unique.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9-_]*

Required: Yes

RepositoryAssociationArn

The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.

A code review can only be created on an associated repository. This is the ARN of the associated repository.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:association:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

Type

The type of code review to create. This is specified using a CodeReviewType object. You can create a code review only of type RepositoryAnalysis.

Type: CodeReviewType object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CodeReview": { 
      "AnalysisTypes": [ "string" ],
      "AssociationArn": "string",
      "CodeReviewArn": "string",
      "ConfigFileState": "string",
      "CreatedTimeStamp": number,
      "LastUpdatedTimeStamp": number,
      "Metrics": { 
         "FindingsCount": number,
         "MeteredLinesOfCodeCount": number,
         "SuppressedLinesOfCodeCount": number
      },
      "Name": "string",
      "Owner": "string",
      "ProviderType": "string",
      "PullRequestId": "string",
      "RepositoryName": "string",
      "SourceCodeType": { 
         "BranchDiff": { 
            "DestinationBranchName": "string",
            "SourceBranchName": "string"
         },
         "CommitDiff": { 
            "DestinationCommit": "string",
            "MergeBaseCommit": "string",
            "SourceCommit": "string"
         },
         "RepositoryHead": { 
            "BranchName": "string"
         },
         "RequestMetadata": { 
            "EventInfo": { 
               "Name": "string",
               "State": "string"
            },
            "Requester": "string",
            "RequestId": "string",
            "VendorName": "string"
         },
         "S3BucketRepository": { 
            "Details": { 
               "BucketName": "string",
               "CodeArtifacts": { 
                  "BuildArtifactsObjectKey": "string",
                  "SourceCodeArtifactsObjectKey": "string"
               }
            },
            "Name": "string"
         }
      },
      "State": "string",
      "StateReason": "string",
      "Type": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CodeReview

Information about a code review. A code review belongs to the associated repository that contains the reviewed code.

Type: CodeReview object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 409

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400