CodeGuruReviewer / Client / describe_recommendation_feedback

describe_recommendation_feedback#

CodeGuruReviewer.Client.describe_recommendation_feedback(**kwargs)#

Describes the customer feedback for a CodeGuru Reviewer recommendation.

See also: AWS API Documentation

Request Syntax

response = client.describe_recommendation_feedback(
    CodeReviewArn='string',
    RecommendationId='string',
    UserId='string'
)
Parameters:

  • CodeReviewArn (string) –

    [REQUIRED]

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

  • RecommendationId (string) –

    [REQUIRED]

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

  • UserId (string) –

    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 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.

Return type:

dict

Returns:

Response Syntax

{
    'RecommendationFeedback': {
        'CodeReviewArn': 'string',
        'RecommendationId': 'string',
        'Reactions': [
            'ThumbsUp'|'ThumbsDown',
        ],
        'UserId': 'string',
        'CreatedTimeStamp': datetime(2015, 1, 1),
        'LastUpdatedTimeStamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • RecommendationFeedback (dict) –

      The recommendation feedback given by the user.

      • CodeReviewArn (string) –

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

      • 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. You can send an empty list to clear off all your feedback.

        • (string) –

      • UserId (string) –

        The ID of the user that made the API call.

        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.

      • CreatedTimeStamp (datetime) –

        The time at which the feedback was created.

      • LastUpdatedTimeStamp (datetime) –

        The time at which the feedback was last updated.

Exceptions

  • CodeGuruReviewer.Client.exceptions.ResourceNotFoundException

  • CodeGuruReviewer.Client.exceptions.InternalServerException

  • CodeGuruReviewer.Client.exceptions.ValidationException

  • CodeGuruReviewer.Client.exceptions.AccessDeniedException

  • CodeGuruReviewer.Client.exceptions.ThrottlingException