Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codecommit ]

get-pull-request-approval-states

Description

Gets information about the approval states for a specified pull request. Approval states only apply to pull requests that have one or more approval rules applied to them.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-pull-request-approval-states
--pull-request-id <value>
--revision-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--pull-request-id (string)

The system-generated ID for the pull request.

--revision-id (string)

The system-generated ID for the pull request revision.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--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 view approvals on a pull request

The following get-pull-request-approval-states example returns approvals for the specified pull request.

aws codecommit get-pull-request-approval-states \
    --pull-request-id 8 \
    --revision-id 9f29d167EXAMPLE

Output:

{
    "approvals": [
        {
            "userArn": "arn:aws:iam::123456789012:user/Mary_Major",
            "approvalState": "APPROVE"
        }
    ]
}

For more information, see View Pull Requests in the AWS CodeCommit User Guide.

Output

approvals -> (list)

Information about users who have approved the pull request.

(structure)

Returns information about a specific approval on a pull request.

userArn -> (string)

The Amazon Resource Name (ARN) of the user.

approvalState -> (string)

The state of the approval, APPROVE or REVOKE. REVOKE states are not stored.