AWS CodeCommit
API Reference (API Version 2015-04-13)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribePullRequestEvents

Returns information about one or more pull request events.

Request Syntax

{ "actorArn": "string", "maxResults": number, "nextToken": "string", "pullRequestEventType": "string", "pullRequestId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

actorArn

The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.

Type: String

Required: No

maxResults

A non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.

Type: Integer

Required: No

nextToken

An enumeration token that when provided in a request, returns the next batch of the results.

Type: String

Required: No

pullRequestEventType

Optional. The pull request event type about which you want to return information.

Type: String

Valid Values: PULL_REQUEST_CREATED | PULL_REQUEST_STATUS_CHANGED | PULL_REQUEST_SOURCE_REFERENCE_UPDATED | PULL_REQUEST_MERGE_STATE_CHANGED

Required: No

pullRequestId

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

Type: String

Required: Yes

Response Syntax

{ "nextToken": "string", "pullRequestEvents": [ { "actorArn": "string", "eventDate": number, "pullRequestCreatedEventMetadata": { "destinationCommitId": "string", "mergeBase": "string", "repositoryName": "string", "sourceCommitId": "string" }, "pullRequestEventType": "string", "pullRequestId": "string", "pullRequestMergedStateChangedEventMetadata": { "destinationReference": "string", "mergeMetadata": { "isMerged": boolean, "mergeCommitId": "string", "mergedBy": "string", "mergeOption": "string" }, "repositoryName": "string" }, "pullRequestSourceReferenceUpdatedEventMetadata": { "afterCommitId": "string", "beforeCommitId": "string", "mergeBase": "string", "repositoryName": "string" }, "pullRequestStatusChangedEventMetadata": { "pullRequestStatus": "string" } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

pullRequestEvents

Information about the pull request events.

Type: Array of PullRequestEvent objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ActorDoesNotExistException

The specified Amazon Resource Name (ARN) does not exist in the AWS account.

HTTP Status Code: 400

EncryptionIntegrityChecksFailedException

An encryption integrity check failed.

HTTP Status Code: 500

EncryptionKeyAccessDeniedException

An encryption key could not be accessed.

HTTP Status Code: 400

EncryptionKeyDisabledException

The encryption key is disabled.

HTTP Status Code: 400

EncryptionKeyNotFoundException

No encryption key was found.

HTTP Status Code: 400

EncryptionKeyUnavailableException

The encryption key is not available.

HTTP Status Code: 400

InvalidActorArnException

The Amazon Resource Name (ARN) is not valid. Make sure that you have provided the full ARN for the user who initiated the change for the pull request, and then try again.

HTTP Status Code: 400

InvalidContinuationTokenException

The specified continuation token is not valid.

HTTP Status Code: 400

InvalidMaxResultsException

The specified number of maximum results is not valid.

HTTP Status Code: 400

InvalidPullRequestEventTypeException

The pull request event type is not valid.

HTTP Status Code: 400

InvalidPullRequestIdException

The pull request ID is not valid. Make sure that you have provided the full ID and that the pull request is in the specified repository, and then try again.

HTTP Status Code: 400

PullRequestDoesNotExistException

The pull request ID could not be found. Make sure that you have specified the correct repository name and pull request ID, and then try again.

HTTP Status Code: 400

PullRequestIdRequiredException

A pull request ID is required, but none was provided.

HTTP Status Code: 400

Example

Sample Request

>>POST / HTTP/1.1 Host: codecommit.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 350 X-Amz-Target: CodeCommit_20150413.DescribePullRequestEvents X-Amz-Date: 20171110T235323Z User-Agent: aws-cli/1.11.187 Python/2.7.9 Windows/8 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20171025/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE { "pullRequestId": "8" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 0728aaa8-EXAMPLE Content-Type: application/x-amz-json-1.1 Content-Length: 660 Date: Fri, 10 Nov 2017 11:53:59 GMT { "pullRequestEvents": [ { "pullRequestId": "8", "pullRequestEventType": "PULL_REQUEST_CREATED", "eventDate": 1510341779.53, "actor": "arn:aws:iam::111111111111:user/Zhang_Wei" }, { "pullRequestStatusChangedEventMetadata": { "pullRequestStatus": "CLOSED" }, "pullRequestId": "8", "pullRequestEventType": "PULL_REQUEST_STATUS_CHANGED", "eventDate": 1510341930.72, "actor": "arn:aws:iam::111111111111:user/Jane_Doe" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: