EvaluatePullRequestApprovalRules
Evaluates whether a pull request has met all the conditions specified in its associated approval rules.
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 system-generated ID of the pull request you want to evaluate.
Type: String
Required: Yes
- revisionId
-
The system-generated ID for the pull request revision. To retrieve the most recent revision ID for a pull request, use GetPullRequest.
Type: String
Required: Yes
Response Syntax
{
"evaluation": {
"approvalRulesNotSatisfied": [ "string" ],
"approvalRulesSatisfied": [ "string" ],
"approved": boolean,
"overridden": boolean
}
}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.
- evaluation
-
The result of the evaluation, including the names of the rules whose conditions have been met (if any), the names of the rules whose conditions have not been met (if any), whether the pull request is in the approved state, and whether the pull request approval rule has been set aside by an override.
Type: Evaluation object
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
- RevisionNotCurrentException
-
The revision ID provided in the request does not match the current revision ID. Use GetPullRequest to retrieve the current revision ID.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of EvaluatePullRequestApprovalRules.
Sample Request
POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 124
X-Amz-Target: CodeCommit_20150413.EvaluatePullRequestApprovalRules
X-Amz-Date: 20191021T223055Z
User-Agent: aws-cli/1.15.9 Python/2.7.11 Darwin/16.7.0 botocore/1.10.9
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAEXAMPLE/20180914/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature==8d9b5998EXAMPLE
{
"pullRequestId": "27",
"revisionId": "9f29d167EXAMPLE"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: d8ad1d21-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 2267
Date: Mon, 21 Oct 2019 22:30:56 GMT
Connection: keep-alive
{
"evaluation": {
"approved": false,
"approvalRulesNotSatisfied": [
"Require two approved approvers"
],
"overridden": false,
"approvalRulesSatisfied": []
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
