describe-pull-request-events¶

Description¶

Returns information about one or more pull request events.

Synopsis¶

  describe-pull-request-events
--pull-request-id <value>
[--pull-request-event-type <value>]
[--actor-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--pull-request-id (string)

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

--pull-request-event-type (string)

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

Possible values:

PULL_REQUEST_CREATED

PULL_REQUEST_STATUS_CHANGED

PULL_REQUEST_SOURCE_REFERENCE_UPDATED

PULL_REQUEST_MERGE_STATE_CHANGED

PULL_REQUEST_APPROVAL_RULE_CREATED

PULL_REQUEST_APPROVAL_RULE_UPDATED

PULL_REQUEST_APPROVAL_RULE_DELETED

PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN

PULL_REQUEST_APPROVAL_STATE_CHANGED

--actor-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To view events in a pull request

The following describe-pull-request-events example retrieves the events for a pull request with the ID of ‘8’.

aws codecommit describe-pull-request-events --pull-request-id 8

Output:

{
    "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"
        }
    ]
}

Output¶

pullRequestEvents -> (list)

Information about the pull request events.

(structure)

Returns information about a pull request event.

pullRequestId -> (string)

The system-generated ID of the pull request.

eventDate -> (timestamp)

The day and time of the pull request event, in timestamp format.

pullRequestEventType -> (string)

The type of the pull request event (for example, a status change event (PULL_REQUEST_STATUS_CHANGED) or update event (PULL_REQUEST_SOURCE_REFERENCE_UPDATED)).

actorArn -> (string)

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

pullRequestCreatedEventMetadata -> (structure)

Information about the source and destination branches for the pull request.

repositoryName -> (string)

The name of the repository where the pull request was created.

sourceCommitId -> (string)

The commit ID on the source branch used when the pull request was created.

destinationCommitId -> (string)

The commit ID of the tip of the branch specified as the destination branch when the pull request was created.

mergeBase -> (string)

The commit ID of the most recent commit that the source branch and the destination branch have in common.

pullRequestStatusChangedEventMetadata -> (structure)

Information about the change in status for the pull request event.

pullRequestStatus -> (string)

The changed status of the pull request.

pullRequestSourceReferenceUpdatedEventMetadata -> (structure)

Information about the updated source branch for the pull request event.

repositoryName -> (string)

The name of the repository where the pull request was updated.

beforeCommitId -> (string)

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 updated.

afterCommitId -> (string)

The full commit ID of the commit in the source branch that was the tip of the branch at the time the pull request was updated.

mergeBase -> (string)

The commit ID of the most recent commit that the source branch and the destination branch have in common.

pullRequestMergedStateChangedEventMetadata -> (structure)

Information about the change in mergability state for the pull request event.

repositoryName -> (string)

The name of the repository where the pull request was created.

destinationReference -> (string)

The name of the branch that the pull request is merged into.

mergeMetadata -> (structure)

Information about the merge state change event.

isMerged -> (boolean)

A Boolean value indicating whether the merge has been made.

mergedBy -> (string)

The Amazon Resource Name (ARN) of the user who merged the branches.

mergeCommitId -> (string)

The commit ID for the merge commit, if any.

mergeOption -> (string)

The merge strategy used in the merge.

approvalRuleEventMetadata -> (structure)

Information about a pull request event.

approvalRuleName -> (string)

The name of the approval rule.

approvalRuleId -> (string)

The system-generated ID of the approval rule.

approvalRuleContent -> (string)

The content of the approval rule.

approvalStateChangedEventMetadata -> (structure)

Information about an approval state change for a pull request.

revisionId -> (string)

The revision ID of the pull request when the approval state changed.

approvalStatus -> (string)

The approval status for the pull request.

approvalRuleOverriddenEventMetadata -> (structure)

Information about an approval rule override event for a pull request.

revisionId -> (string)

The revision ID of the pull request when the override event occurred.

overrideStatus -> (string)

The status of the override event.

nextToken -> (string)

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

Table of Contents

Feedback

User Guide