CodeCommit / Client / get_comment_reactions

get_comment_reactions#

CodeCommit.Client.get_comment_reactions(**kwargs)#

Returns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count.

See also: AWS API Documentation

Request Syntax

response = client.get_comment_reactions(
    commentId='string',
    reactionUserArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • commentId (string) –

    [REQUIRED]

    The ID of the comment for which you want to get reactions information.

  • reactionUserArn (string) – Optional. The Amazon Resource Name (ARN) of the user or identity for which you want to get reaction information.

  • nextToken (string) – An enumeration token that, when provided in a request, returns the next batch of the results.

  • maxResults (integer) – A non-zero, non-negative integer used to limit the number of returned results. The default is the same as the allowed maximum, 1,000.

Return type:

dict

Returns:

Response Syntax

{
    'reactionsForComment': [
        {
            'reaction': {
                'emoji': 'string',
                'shortCode': 'string',
                'unicode': 'string'
            },
            'reactionUsers': [
                'string',
            ],
            'reactionsFromDeletedUsersCount': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • reactionsForComment (list) –

      An array of reactions to the specified comment.

      • (dict) –

        Information about the reaction values provided by users on a comment.

        • reaction (dict) –

          The reaction for a specified comment.

          • emoji (string) –

            The Emoji Version 1.0 graphic of the reaction. These graphics are interpreted slightly differently on different operating systems.

          • shortCode (string) –

            The emoji short code for the reaction. Short codes are interpreted slightly differently on different operating systems.

          • unicode (string) –

            The Unicode codepoint for the reaction.

        • reactionUsers (list) –

          The Amazon Resource Names (ARNs) of users who have provided reactions to the comment.

          • (string) –

        • reactionsFromDeletedUsersCount (integer) –

          A numerical count of users who reacted with the specified emoji whose identities have been subsequently deleted from IAM. While these IAM users or roles no longer exist, the reactions might still appear in total reaction counts.

    • nextToken (string) –

      An enumeration token that can be used in a request to return the next batch of the results.

Exceptions

  • CodeCommit.Client.exceptions.CommentDoesNotExistException

  • CodeCommit.Client.exceptions.CommentIdRequiredException

  • CodeCommit.Client.exceptions.InvalidCommentIdException

  • CodeCommit.Client.exceptions.InvalidReactionUserArnException

  • CodeCommit.Client.exceptions.InvalidMaxResultsException

  • CodeCommit.Client.exceptions.InvalidContinuationTokenException

  • CodeCommit.Client.exceptions.CommentDeletedException