GetApprovalRuleTemplate - Amazon CodeCommit
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Returns information about a specified approval rule template.

Request Syntax

{ "approvalRuleTemplateName": "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.


The name of the approval rule template for which you want to get information.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Response Syntax

{ "approvalRuleTemplate": { "approvalRuleTemplateContent": "string", "approvalRuleTemplateDescription": "string", "approvalRuleTemplateId": "string", "approvalRuleTemplateName": "string", "creationDate": number, "lastModifiedDate": number, "lastModifiedUser": "string", "ruleContentSha256": "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.


The content and structure of the approval rule template.

Type: ApprovalRuleTemplate object


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


The specified approval rule template does not exist. Verify that the name is correct and that you are signed in to the Amazon Web Services Region where the template was created, and then try again.

HTTP Status Code: 400


An approval rule template name is required, but was not specified.

HTTP Status Code: 400


The name of the approval rule template is not valid. Template names must be between 1 and 100 valid characters in length. For more information about limits in Amazon CodeCommit, see Quotas in the Amazon CodeCommit User Guide.

HTTP Status Code: 400



This example illustrates one usage of GetApprovalRuleTemplate.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 124 X-Amz-Target: CodeCommit_20150413.GetApprovalRuleTemplate 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 { "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests" }

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 { "approvalRuleTemplate": { "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "ruleContentSha256": "621181bbEXAMPLE", "lastModifiedDate": 1571356106.936, "creationDate": 1571356106.936, "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan", "approvalRuleTemplateId": "a29abb15-EXAMPLE", "approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team." } }

See Also

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