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

DescribeCodeReview

Returns the metadata associated with the code review along with its status.

Request Syntax


GET /codereviews/CodeReviewArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CodeReviewArn

The Amazon Resource Name (ARN) of the CodeReview object.

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

Pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$

Required: Yes

Request Body

The request does not have a request body.

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 the code review.

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

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