get-comments-for-compared-commit¶

Description¶

Returns information about comments made on the comparison between two commits.

Note

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.

Synopsis¶

  get-comments-for-compared-commit
--repository-name <value>
[--before-commit-id <value>]
--after-commit-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--repository-name (string)

The name of the repository where you want to compare commits.

--before-commit-id (string)

To establish the directionality of the comparison, the full commit ID of the before commit.

--after-commit-id (string)

To establish the directionality of the comparison, the full commit ID of the after commit.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To view comments on a commit

This example demonstrates how to view view comments made on the comparison between two commits in a repository named ‘MyDemoRepo’:

aws codecommit get-comments-for-compared-commit --repository-name MyDemoRepo --before-commit-ID 6e147360EXAMPLE --after-commit-id 317f8570EXAMPLE

Output:

{
 "commentsForComparedCommitData": [
    {
       "afterBlobId": "1f330709EXAMPLE",
       "afterCommitId": "317f8570EXAMPLE",
       "beforeBlobId": "80906a4cEXAMPLE",
       "beforeCommitId": "6e147360EXAMPLE",
       "comments": [
          {
             "authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
             "clientRequestToken": "123Example",
             "commentId": "ff30b348EXAMPLEb9aa670f",
             "content": "Whoops - I meant to add this comment to the line, not the file, but I don't see how to delete it.",
             "creationDate": 1508369768.142,
             "deleted": false,
             "CommentId": "123abc-EXAMPLE",
             "lastModifiedDate": 1508369842.278
          },
          {
             "authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
             "clientRequestToken": "123Example",
             "commentId": "553b509bEXAMPLE56198325",
             "content": "Can you add a test case for this?",
             "creationDate": 1508369612.240,
             "deleted": false,
             "commentId": "456def-EXAMPLE",
             "lastModifiedDate": 1508369612.240
           }
       ],
       "location": {
          "filePath": "cl_sample.js",
          "filePosition": 1232,
          "relativeFileVersion": "after"
       },
       "repositoryName": "MyDemoRepo"
    }
 ],
 "nextToken": "exampleToken"
}

Output¶

commentsForComparedCommitData -> (list)

A list of comment objects on the compared commit.

(structure)

Returns information about comments on the comparison between two commits.

repositoryName -> (string)

The name of the repository that contains the compared commits.

beforeCommitId -> (string)

The full commit ID of the commit used to establish the before of the comparison.

afterCommitId -> (string)

The full commit ID of the commit used to establish the after of the comparison.

beforeBlobId -> (string)

The full blob ID of the commit used to establish the before of the comparison.

afterBlobId -> (string)

The full blob ID of the commit used to establish the after of the comparison.

location -> (structure)

Location information about the comment on the comparison, including the file name, line number, and whether the version of the file where the comment was made is BEFORE or AFTER.

filePath -> (string)

The name of the file being compared, including its extension and subdirectory, if any.

filePosition -> (long)

The position of a change in a compared file, in line number format.

relativeFileVersion -> (string)

In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

comments -> (list)

An array of comment objects. Each comment object contains information about a comment on the comparison between commits.

(structure)

Returns information about a specific comment.

commentId -> (string)

The system-generated comment ID.

content -> (string)

The content of the comment.

inReplyTo -> (string)

The ID of the comment for which this comment is a reply, if any.

creationDate -> (timestamp)

The date and time the comment was created, in timestamp format.

lastModifiedDate -> (timestamp)

The date and time the comment was most recently modified, in timestamp format.

authorArn -> (string)

The Amazon Resource Name (ARN) of the person who posted the comment.

deleted -> (boolean)

A Boolean value indicating whether the comment has been deleted.

clientRequestToken -> (string)

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.

callerReactions -> (list)

The emoji reactions to a comment, if any, submitted by the user whose credentials are associated with the call to the API.

(string)

reactionCounts -> (map)

A string to integer map that represents the number of individual users who have responded to a comment with the specified reactions.

key -> (string)

value -> (integer)

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