Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . codecommit ]

post-comment-for-pull-request

Description

Posts a comment on a pull request.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  post-comment-for-pull-request
--pull-request-id <value>
--repository-name <value>
--before-commit-id <value>
--after-commit-id <value>
[--location <value>]
--content <value>
[--client-request-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--pull-request-id (string)

The system-generated ID of the pull request. To get this ID, use ListPullRequests .

--repository-name (string)

The name of the repository where you want to post a comment on a pull request.

--before-commit-id (string)

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

--after-commit-id (string)

The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

--location (structure)

The location of the change where you want to post your comment. If no location is provided, the comment will be posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

Shorthand Syntax:

filePath=string,filePosition=long,relativeFileVersion=string

JSON Syntax:

{
  "filePath": "string",
  "filePosition": long,
  "relativeFileVersion": "BEFORE"|"AFTER"
}

--content (string)

The content of your comment on the change.

--client-request-token (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 will return information about the initial request that used that token.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To add a comment to a pull request

This example demonstrates how to add the comment '"These don't appear to be used anywhere. Can we remove them?"' on the change to the 'ahs_count.py' file in a pull request with the ID of '47' in a repository named 'MyDemoRepo':

aws codecommit post-comment-for-pull-request --pull-request-id "47" --repository-name MyDemoRepo --before-commit-id 317f8570EXAMPLE --after-commit-id 5d036259EXAMPLE --client-request-token 123Example --content ""These don't appear to be used anywhere. Can we remove them?"" --location filePath=ahs_count.py,filePosition=367,relativeFileVersion=AFTER

Output:

{
       "afterBlobId": "1f330709EXAMPLE",
       "afterCommitId": "5d036259EXAMPLE",
       "beforeBlobId": "80906a4cEXAMPLE",
       "beforeCommitId": "317f8570EXAMPLE",
       "comment": {
             "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar",
             "clientRequestToken": "123Example",
             "commentId": "abcd1234EXAMPLEb5678efgh",
             "content": "These don't appear to be used anywhere. Can we remove them?",
             "creationDate": 1508369622.123,
             "deleted": false,
             "CommentId": "",
             "lastModifiedDate": 1508369622.123
          }
           "location": {
             "filePath": "ahs_count.py",
             "filePosition": 367,
             "relativeFileVersion": "AFTER"
           },
       "repositoryName": "MyDemoRepo",
       "pullRequestId": "47"
}

Output

repositoryName -> (string)

The name of the repository where you posted a comment on a pull request.

pullRequestId -> (string)

The system-generated ID of the pull request.

beforeCommitId -> (string)

The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.

afterCommitId -> (string)

The full commit ID of the commit in the destination branch where the pull request will be merged.

beforeBlobId -> (string)

In the directionality of the pull request, the blob ID of the 'before' blob.

afterBlobId -> (string)

In the directionality of the pull request, the blob ID of the 'after' blob.

location -> (structure)

The location of the change where you posted your comment.

filePath -> (string)

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

filePosition -> (long)

The position of a change within 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.

comment -> (structure)

The content of the comment you posted.

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 will return information about the initial request that used that token.