Get Comments For Pull Request
codecommit_get_comments_for_pull_request | R Documentation |
Returns comments made on a pull request¶
Description¶
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.
Usage¶
codecommit_get_comments_for_pull_request(pullRequestId, repositoryName,
beforeCommitId, afterCommitId, nextToken, maxResults)
Arguments¶
pullRequestId
[required] The system-generated ID of the pull request. To get this ID, use
list_pull_requests
.repositoryName
The name of the repository that contains the pull request. Requirement is conditional:
repositoryName
must be specified whenbeforeCommitId
andafterCommitId
are included.beforeCommitId
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. Requirement is conditional:
beforeCommitId
must be specified whenrepositoryName
is included.afterCommitId
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. Requirement is conditional:
afterCommitId
must be specified whenrepositoryName
is included.nextToken
An enumeration token that, when provided in a request, returns the next batch of the results.
maxResults
A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.
Value¶
A list with the following syntax:
list(
commentsForPullRequestData = list(
list(
pullRequestId = "string",
repositoryName = "string",
beforeCommitId = "string",
afterCommitId = "string",
beforeBlobId = "string",
afterBlobId = "string",
location = list(
filePath = "string",
filePosition = 123,
relativeFileVersion = "BEFORE"|"AFTER"
),
comments = list(
list(
commentId = "string",
content = "string",
inReplyTo = "string",
creationDate = as.POSIXct(
"2015-01-01"
),
lastModifiedDate = as.POSIXct(
"2015-01-01"
),
authorArn = "string",
deleted = TRUE|FALSE,
clientRequestToken = "string",
callerReactions = list(
"string"
),
reactionCounts = list(
123
)
)
)
)
),
nextToken = "string"
)