GetPullRequestOverrideState - AWS CodeCommit

GetPullRequestOverrideState

Returns information about whether approval rules have been set aside (overridden) for a pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

Request Syntax

{ "pullRequestId": "string", "revisionId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

pullRequestId

The ID of the pull request for which you want to get information about whether approval rules have been set aside (overridden).

Type: String

Required: Yes

revisionId

The system-generated ID of the revision for the pull request. To retrieve the most recent revision ID, use GetPullRequest.

Type: String

Required: Yes

Response Syntax

{ "overridden": boolean, "overrider": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

overridden

A Boolean value that indicates whether a pull request has had its rules set aside (TRUE) or whether all approval rules still apply (FALSE).

Type: Boolean

overrider

The Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

EncryptionIntegrityChecksFailedException

An encryption integrity check failed.

HTTP Status Code: 500

EncryptionKeyAccessDeniedException

An encryption key could not be accessed.

HTTP Status Code: 400

EncryptionKeyDisabledException

The encryption key is disabled.

HTTP Status Code: 400

EncryptionKeyNotFoundException

No encryption key was found.

HTTP Status Code: 400

EncryptionKeyUnavailableException

The encryption key is not available.

HTTP Status Code: 400

InvalidPullRequestIdException

The pull request ID is not valid. Make sure that you have provided the full ID and that the pull request is in the specified repository, and then try again.

HTTP Status Code: 400

InvalidRevisionIdException

The revision ID is not valid. Use GetPullRequest to determine the value.

HTTP Status Code: 400

PullRequestDoesNotExistException

The pull request ID could not be found. Make sure that you have specified the correct repository name and pull request ID, and then try again.

HTTP Status Code: 400

PullRequestIdRequiredException

A pull request ID is required, but none was provided.

HTTP Status Code: 400

RevisionIdRequiredException

A revision ID is required, but was not provided.

HTTP Status Code: 400

Example

Sample Request

>>POST / HTTP/1.1 Host: codecommit.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 350 X-Amz-Target: CodeCommit_20150413.GetPullRequestOverrideState X-Amz-Date: 20191021T132023Z User-Agent: aws-cli/1.11.187 Python/2.7.9 Windows/10 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20171025/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE { "pullRequestId": "34", "revisionId": "9f29d1673EXAMPLE" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 0728aaa8-EXAMPLE Content-Type: application/x-amz-json-1.1 Content-Length: 847 Date: Mon, 21 Oct 2019 20:20:13 GMT { "overridden": true, "overrider": "arn:aws:iam::123456789012:user/Mary_Major" }

See Also

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