ListRecommendations
Note
Starting November 7, 2025, you will not be able to create new repository associations in Amazon CodeGuru Reviewer. If you would like to use the service, create repository associations prior to November 7, 2025. To learn about services with capabilities similar to CodeGuru Reviewer, see Amazon CodeGuru Reviewer availability change.
Returns the list of all recommendations for a completed code review.
Request Syntax
GET /codereviews/CodeReviewArn
/Recommendations?MaxResults=MaxResults
&NextToken=NextToken
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:codeguru-reviewer:[^:\s]+:[\d]{12}:([a-z-]+|[a-z-]+:[\w-]+:[a-z-]+):[\w-]+$
Required: Yes
- MaxResults
-
The maximum number of results that are returned per call. The default is 100.
Valid Range: Minimum value of 1. Maximum value of 300.
- NextToken
-
Pagination token.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
\S+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"RecommendationSummaries": [
{
"ConfidenceScore": number,
"Description": "string",
"EndLine": number,
"FilePath": "string",
"RecommendationCategory": "string",
"RecommendationId": "string",
"RecommendationType": "string",
"RecommenderId": "string",
"RuleMetadata": {
"LongDescription": "string",
"RuleId": "string",
"RuleName": "string",
"RuleTags": [ "string" ],
"ShortDescription": "string"
},
"Severity": "string",
"StartLine": number
}
]
}
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.
- NextToken
-
Pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
\S+
- RecommendationSummaries
-
List of recommendations for the requested code review.
Type: Array of RecommendationSummary objects
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: