Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . codecommit ]

update-pull-request-status

Description

Updates the status of a pull request.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-pull-request-status
--pull-request-id <value>
--pull-request-status <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--pull-request-id (string)

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

--pull-request-status (string)

The status of the pull request. The only valid operations are to update the status from OPEN to OPEN , OPEN to CLOSED or from from CLOSED to CLOSED .

Possible values:

  • OPEN
  • CLOSED

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--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. 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 change the status of a pull request

This example demonstrates how to to change the status of a pull request with the ID of '42' to a status of 'CLOSED' in an AWS CodeCommit repository named 'MyDemoRepo':

aws codecommit update-pull-request-status --pull-request-id 42 --pull-request-status CLOSED

Output:

{
 "pullRequest": {
    "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe",
    "clientRequestToken": "123Example",
    "creationDate": 1508962823.165,
    "description": "A code review of the new feature I just added to the service.",
    "lastActivityDate": 1508442444.12,
    "pullRequestId": "42",
    "pullRequestStatus": "CLOSED",
    "pullRequestTargets": [
       {
          "destinationCommit": "5d036259EXAMPLE",
          "destinationReference": "refs/heads/master",
          "mergeMetadata": {
             "isMerged": false,
          },
          "repositoryName": "MyDemoRepo",
          "sourceCommit": "317f8570EXAMPLE",
          "sourceReference": "refs/heads/jane-branch"
       }
    ],
    "title": "Pronunciation difficulty analyzer"
  }
}

Output

pullRequest -> (structure)

Information about the pull request.

pullRequestId -> (string)

The system-generated ID of the pull request.

title -> (string)

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

description -> (string)

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.

lastActivityDate -> (timestamp)

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

creationDate -> (timestamp)

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

pullRequestStatus -> (string)

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

authorArn -> (string)

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

pullRequestTargets -> (list)

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

(structure)

Returns information about a pull request target.

repositoryName -> (string)

The name of the repository that contains the pull request source and destination branches.

sourceReference -> (string)

The branch of the repository that contains the changes for the pull request. Also known as the source branch.

destinationReference -> (string)

The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

destinationCommit -> (string)

The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

sourceCommit -> (string)

The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch.

mergeMetadata -> (structure)

Returns metadata about the state of the merge, including whether the merge has been made.

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.

clientRequestToken -> (string)

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.