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

ListCodeReviews

Lists all the code reviews that the customer has created in the past 90 days.

Request Syntax


GET /codereviews?MaxResults=MaxResults&NextToken=NextToken&ProviderTypes=ProviderTypes&RepositoryNames=RepositoryNames&States=States&Type=Type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results that are returned per call. The default is 100.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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

ProviderTypes

List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Valid Values: CodeCommit | GitHub | Bitbucket | GitHubEnterpriseServer | S3Bucket

RepositoryNames

List of repository names for filtering that needs to be applied before displaying the result.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

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

Pattern: ^\S[\w.-]*$

States

List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.

The valid code review states are:

Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Valid Values: Completed | Pending | Failed | Deleting

Type

The type of code reviews to list in the response.

Valid Values: PullRequest | RepositoryAnalysis

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CodeReviewSummaries": [ 
      { 
         "CodeReviewArn": "string",
         "CreatedTimeStamp": number,
         "LastUpdatedTimeStamp": number,
         "MetricsSummary": { 
            "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",
         "Type": "string"
      }
   ],
   "NextToken": "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.

CodeReviewSummaries

A list of code reviews that meet the criteria of the request.

Type: Array of CodeReviewSummary objects

NextToken

Pagination token.

Type: String

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

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

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