CodeCommit / Client / describe_pull_request_events

describe_pull_request_events#

CodeCommit.Client.describe_pull_request_events(**kwargs)#

Returns information about one or more pull request events.

See also: AWS API Documentation

Request Syntax

response = client.describe_pull_request_events(
    pullRequestId='string',
    pullRequestEventType='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',
    actorArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • pullRequestId (string) –

    [REQUIRED]

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

  • pullRequestEventType (string) – Optional. The pull request event type about which you want to return information.

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

  • nextToken (string) – An enumeration token that, when provided in a request, returns the next batch of the results.

  • maxResults (integer) – A non-zero, 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.

Return type:

dict

Returns:

Response Syntax

{
    'pullRequestEvents': [
        {
            'pullRequestId': 'string',
            'eventDate': datetime(2015, 1, 1),
            'pullRequestEventType': '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',
            'actorArn': 'string',
            'pullRequestCreatedEventMetadata': {
                'repositoryName': 'string',
                'sourceCommitId': 'string',
                'destinationCommitId': 'string',
                'mergeBase': 'string'
            },
            'pullRequestStatusChangedEventMetadata': {
                'pullRequestStatus': 'OPEN'|'CLOSED'
            },
            'pullRequestSourceReferenceUpdatedEventMetadata': {
                'repositoryName': 'string',
                'beforeCommitId': 'string',
                'afterCommitId': 'string',
                'mergeBase': 'string'
            },
            'pullRequestMergedStateChangedEventMetadata': {
                'repositoryName': 'string',
                'destinationReference': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string',
                    'mergeCommitId': 'string',
                    'mergeOption': 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE'
                }
            },
            'approvalRuleEventMetadata': {
                'approvalRuleName': 'string',
                'approvalRuleId': 'string',
                'approvalRuleContent': 'string'
            },
            'approvalStateChangedEventMetadata': {
                'revisionId': 'string',
                'approvalStatus': 'APPROVE'|'REVOKE'
            },
            'approvalRuleOverriddenEventMetadata': {
                'revisionId': 'string',
                'overrideStatus': 'OVERRIDE'|'REVOKE'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • pullRequestEvents (list) –

      Information about the pull request events.

      • (dict) –

        Returns information about a pull request event.

        • pullRequestId (string) –

          The system-generated ID of the pull request.

        • eventDate (datetime) –

          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 (dict) –

          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 (dict) –

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

          • pullRequestStatus (string) –

            The changed status of the pull request.

        • pullRequestSourceReferenceUpdatedEventMetadata (dict) –

          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 (dict) –

          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 (dict) –

            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 (dict) –

          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 (dict) –

          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 (dict) –

          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.

Exceptions