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

GetPullRequest

Gets information about a pull request in a specified repository.

Request Syntax

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

pullRequestId

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

Type: String

Required: Yes

Response Syntax

{ "pullRequest": { "authorArn": "string", "clientRequestToken": "string", "creationDate": number, "description": "string", "lastActivityDate": number, "pullRequestId": "string", "pullRequestStatus": "string", "pullRequestTargets": [ { "destinationCommit": "string", "destinationReference": "string", "mergeBase": "string", "mergeMetadata": { "isMerged": boolean, "mergedBy": "string" }, "repositoryName": "string", "sourceCommit": "string", "sourceReference": "string" } ], "title": "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.

pullRequest

Information about the specified pull request.

Type: PullRequest object

Errors

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

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

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.GetPullRequest X-Amz-Date: 20171025T132023Z 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": "42" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 0728aaa8-EXAMPLE Content-Type: application/x-amz-json-1.1 Content-Length: 847 Date: Wed, 25 Oct 2017 20:20:13 GMT { "pullRequest": { "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe", "title": "Pronunciation difficulty analyzer" "pullRequestTargets": [ { "destinationReference": "refs/heads/master", "destinationCommit": "5d036259EXAMPLE", "sourceReference": "refs/heads/jane-branch" "sourceCommit": "317f8570EXAMPLE", "repositoryName": "MyDemoRepo", "mergeMetadata": { "isMerged": false, }, } ], "lastActivityDate": 1508442444.711, "pullRequestId": "42", "clientRequestToken": "123Example", "pullRequestStatus": "OPEN", "creationDate": 1508962823.522, "description": "A code review of the new feature I just added to the service.", } }

See Also

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