get-comment-reactions¶

Description¶

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

Synopsis¶

  get-comment-reactions
--comment-id <value>
[--reaction-user-arn <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--comment-id (string)

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

--reaction-user-arn (string)

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

--next-token (string)

An enumeration token that, when provided in a request, returns the next batch of the results.

--max-results (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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To view emoji reactions to a comment

The following get-comment-reactions example lists all emoji reactions to a comment with the ID of abcd1234EXAMPLEb5678efgh. If the font for your shell supports displaying Emoji Version 1.0, then in the output for emoji the emoji is displayed.

aws codecommit get-comment-reactions \
    --comment-id abcd1234EXAMPLEb5678efgh

Output:

{
    "reactionsForComment": {
        [
           {
               "reaction": {
                    "emoji:"??",
                    "shortCode": "thumbsup",
                    "unicode": "U+1F44D"
                },
                "users": [
                    "arn:aws:iam::123456789012:user/Li_Juan",
                    "arn:aws:iam::123456789012:user/Mary_Major",
                    "arn:aws:iam::123456789012:user/Jorge_Souza"
                ]
            },
            {
                "reaction": {
                    "emoji": "??",
                    "shortCode": "thumbsdown",
                    "unicode": "U+1F44E"
                },
                "users": [
                    "arn:aws:iam::123456789012:user/Nikhil_Jayashankar"
                ]
            },
            {
                "reaction": {
                    "emoji": "??",
                    "shortCode": "confused",
                    "unicode": "U+1F615"
                },
                "users": [
                    "arn:aws:iam::123456789012:user/Saanvi_Sarkar"
                ]
            }
        ]
    }
}

For more information, see Comment on a commit in AWS CodeCommit in the AWS CodeCommit User Guide.

Output¶

reactionsForComment -> (list)

An array of reactions to the specified comment.

(structure)

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

reaction -> (structure)

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.

Table of Contents

Feedback

User Guide