Table Of Contents

Feedback

User Guide

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

[ aws . codecommit ]

get-comments-for-pull-request

Description

Returns comments made on a pull request.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

get-comments-for-pull-request is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: commentsForPullRequestData

Synopsis

  get-comments-for-pull-request
--pull-request-id <value>
[--repository-name <value>]
[--before-commit-id <value>]
[--after-commit-id <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--pull-request-id (string)

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

--repository-name (string)

The name of the repository that contains the 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 was the tip of the branch at the time the comment was made.

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

--starting-token (string)

A token to specify where to start paginating. This is the next-token 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 next-token is provided in the command's output. To resume pagination, provide the next-token value in the starting-token argument of a subsequent command. Do not use the next-token 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. 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.

Output

commentsForPullRequestData -> (list)

An array of comment objects on the pull request.

(structure)

Returns information about comments on a pull request.

pullRequestId -> (string)

The system-generated ID of the pull request.

repositoryName -> (string)

The name of the repository that contains the pull request.

beforeCommitId -> (string)

The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit will be superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.

afterCommitId -> (string)

he full commit ID of the commit that was the tip of the source branch at the time the comment was made.

beforeBlobId -> (string)

The full blob ID of the file on which you want to comment on the destination commit.

afterBlobId -> (string)

The full blob ID of the file on which you want to comment on the source commit.

location -> (structure)

Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is 'BEFORE' (destination branch) or 'AFTER' (source branch).

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.

comments -> (list)

An array of comment objects. Each comment object contains information about a comment on the pull request.

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

nextToken -> (string)

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