Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

UpdateApprovalRuleTemplateName

Updates the name of a specified approval rule template.

Request Syntax


{
   "newApprovalRuleTemplateName": "string",
   "oldApprovalRuleTemplateName": "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.

newApprovalRuleTemplateName

The new name you want to apply to the approval rule template.

Type: String

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

Required: Yes

oldApprovalRuleTemplateName

The current name of the approval rule template.

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.

approvalRuleTemplate

The structure and content of the updated approval rule template.

Type: ApprovalRuleTemplate object

Errors

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

ApprovalRuleTemplateDoesNotExistException

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

HTTP Status Code: 400

ApprovalRuleTemplateNameAlreadyExistsException

You cannot create an approval rule template with that name because a template with that name already exists in this AWS Region for your AWS account. Approval rule template names must be unique.

HTTP Status Code: 400

ApprovalRuleTemplateNameRequiredException

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

HTTP Status Code: 400

InvalidApprovalRuleTemplateNameException

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 AWS CodeCommit, see Quotas in the AWS CodeCommit User Guide.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of UpdateApprovalRuleTemplateName.

Sample Request


>POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 350
X-Amz-Target: CodeCommit_20150413.UpdateApprovalRuleTemplateName
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

{
   "oldApprovalRuleTemplateName": "1-approver-rule",
   "newApprovalRuleTemplateName": "1-approver-rule-for-all-pull-requests"
}

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

{
    "approvalRuleTemplate": {
        "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
        "lastModifiedDate": 1571358241.619,
        "approvalRuleTemplateId": "41de97b7-EXAMPLE",
        "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
        "creationDate": 1571352720.773,
        "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
        "approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team.",
        "ruleContentSha256": "2f6c21a5cEXAMPLE"
    }
}