CodeGuruReviewer / Client / list_recommendation_feedback

list_recommendation_feedback#

CodeGuruReviewer.Client.list_recommendation_feedback(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_recommendation_feedback(
    NextToken='string',
    MaxResults=123,
    CodeReviewArn='string',
    UserIds=[
        'string',
    ],
    RecommendationIds=[
        'string',
    ]
)
Parameters:
  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of results that are returned per call. The default is 100.

  • CodeReviewArn (string) –

    [REQUIRED]

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

  • UserIds (list) –

    An Amazon Web Services 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 Amazon Web Services account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the Amazon Web Services Identity and Access Management User Guide.

    • (string) –

  • RecommendationIds (list) –

    Used to query the recommendation feedback for a given recommendation.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RecommendationFeedbackSummaries': [
        {
            'RecommendationId': 'string',
            'Reactions': [
                'ThumbsUp'|'ThumbsDown',
            ],
            'UserId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RecommendationFeedbackSummaries (list) –

      Recommendation feedback summaries corresponding to the code review ARN.

      • (dict) –

        Information about recommendation feedback summaries.

        • RecommendationId (string) –

          The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

        • Reactions (list) –

          List for storing reactions. Reactions are utf-8 text code for emojis.

          • (string) –

        • UserId (string) –

          The ID of the user that gave the feedback.

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

    • NextToken (string) –

      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.

Exceptions

  • CodeGuruReviewer.Client.exceptions.ResourceNotFoundException

  • CodeGuruReviewer.Client.exceptions.InternalServerException

  • CodeGuruReviewer.Client.exceptions.ValidationException

  • CodeGuruReviewer.Client.exceptions.AccessDeniedException

  • CodeGuruReviewer.Client.exceptions.ThrottlingException