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

DescribeRecommendationFeedback

Describes the customer feedback for a CodeGuru Reviewer recommendation.

Request Syntax


GET /feedback/CodeReviewArn?RecommendationId=RecommendationId&UserId=UserId 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

RecommendationId

The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.

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

Required: Yes

UserId

Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.

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.

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

{
   "RecommendationFeedback": { 
      "CodeReviewArn": "string",
      "CreatedTimeStamp": number,
      "LastUpdatedTimeStamp": number,
      "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.

RecommendationFeedback

The recommendation feedback given by the user.

Type: RecommendationFeedback 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