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

PullRequest

Returns information about a pull request.

Contents

authorArn

The Amazon Resource Name (ARN) of the user who created the pull request.

Type: String

Required: No

clientRequestToken

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.

Type: String

Required: No

creationDate

The date and time the pull request was originally created, in timestamp format.

Type: Timestamp

Required: No

description

The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

Type: String

Length Constraints: Maximum length of 10240.

Required: No

lastActivityDate

The day and time of the last user or system activity on the pull request, in timestamp format.

Type: Timestamp

Required: No

pullRequestId

The system-generated ID of the pull request.

Type: String

Required: No

pullRequestStatus

The status of the pull request. Pull request status can only change from OPEN to CLOSED.

Type: String

Valid Values: OPEN | CLOSED

Required: No

pullRequestTargets

The targets of the pull request, including the source branch and destination branch for the pull request.

Type: Array of PullRequestTarget objects

Required: No

title

The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

Type: String

Length Constraints: Maximum length of 150.

Required: No

See Also

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

On this page: