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

ListRecommendationFeedback

Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.

Request Syntax


GET /feedback/CodeReviewArn/RecommendationFeedback?MaxResults=MaxResults&NextToken=NextToken&RecommendationIds=RecommendationIds&UserIds=UserIds 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

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.

RecommendationIds

Used to query the recommendation feedback for a given recommendation.

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

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

UserIds

An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user.

The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.

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

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RecommendationFeedbackSummaries": [ 
      { 
         "Reactions": [ "string" ],
         "RecommendationId": "string",
         "UserId": "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.

NextToken

Type: String

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

RecommendationFeedbackSummaries

Recommendation feedback summaries corresponding to the code review ARN.

Type: Array of RecommendationFeedbackSummary 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