comments_for_pull_requests
Creates, updates, deletes, gets or lists a comments_for_pull_requests resource.
Overview
| Name | comments_for_pull_requests |
| Type | Resource |
| Id | aws.codecommit.comments_for_pull_requests |
Fields
The following fields are returned by SELECT queries:
- get_comments_for_pull_request
| Name | Datatype | Description |
|---|---|---|
after_blob_id | string | The full blob ID of the file on which you want to comment on the source commit. |
after_commit_id | string | The full commit ID of the commit that was the tip of the source branch at the time the comment was made. |
before_blob_id | string | The full blob ID of the file on which you want to comment on the destination commit. |
before_commit_id | string | The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit is superceded by the after commit in the source branch when and if you merge the source branch into the destination branch. |
comments | array | An array of comment objects. Each comment object contains information about a comment on the pull request. |
location | object | 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). |
pull_request_id | string | The system-generated ID of the pull request. |
repository_name | string | The name of the repository that contains the pull request. (pattern: <code>[\w.-]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_comments_for_pull_request | select | region | Returns comments made on a pull request. 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_comments_for_pull_request
Returns comments made on a pull request. 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.
SELECT
after_blob_id,
after_commit_id,
before_blob_id,
before_commit_id,
comments,
location,
pull_request_id,
repository_name
FROM aws.codecommit.comments_for_pull_requests
WHERE region = '{{ region }}' -- required
;