[ aws . codecommit ]

update-approval-rule-template-content

Description

Updates the content of an approval rule template. You can change the number of required approvals, the membership of the approval rule, and whether an approval pool is defined.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-approval-rule-template-content
--approval-rule-template-name <value>
--new-rule-content <value>
[--existing-rule-content-sha256 <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--approval-rule-template-name (string)

The name of the approval rule template where you want to update the content of the rule.

--new-rule-content (string)

The content that replaces the existing content of the rule. Content statements must be complete. You cannot provide only the changes.

--existing-rule-content-sha256 (string)

The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using GetPullRequest .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To update the content of an approval rule template

The following update-approval-rule-template-content example changes the content of the specified approval rule template to redefine the approval pool to users who assume the role of CodeCommitReview.

aws codecommit update-approval-rule-template-content \
    --approval-rule-template-name 1-approver-rule  \
    --new-rule-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/master\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"

Output:

{
    "approvalRuleTemplate": {
        "creationDate": 1571352720.773,
        "approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool",
        "lastModifiedDate": 1571358728.41,
        "approvalRuleTemplateId": "41de97b7-EXAMPLE",
        "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
        "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
        "ruleContentSha256": "2f6c21a5EXAMPLE",
        "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan"
    }
}

For more information, see Manage Approval Rule Templates in the AWS CodeCommit User Guide.

Output

approvalRuleTemplate -> (structure)

Returns information about an approval rule template.

approvalRuleTemplateId -> (string)

The system-generated ID of the approval rule template.

approvalRuleTemplateName -> (string)

The name of the approval rule template.

approvalRuleTemplateDescription -> (string)

The description of the approval rule template.

approvalRuleTemplateContent -> (string)

The content of the approval rule template.

ruleContentSha256 -> (string)

The SHA-256 hash signature for the content of the approval rule template.

lastModifiedDate -> (timestamp)

The date the approval rule template was most recently changed, in timestamp format.

creationDate -> (timestamp)

The date the approval rule template was created, in timestamp format.

lastModifiedUser -> (string)

The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule template.