update-approval-rule-template-description¶

Description¶

Updates the description for a specified approval rule template.

Synopsis¶

  update-approval-rule-template-description
--approval-rule-template-name <value>
--approval-rule-template-description <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

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

The name of the template for which you want to update the description.

--approval-rule-template-description (string)

The updated description of the approval rule template.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update the description of an approval rule template

The following update-approval-rule-template-description example changes the description of the specified approval rule template to Requires 1 approval for all pull requests from the CodeCommitReview pool.:

aws codecommit update-approval-rule-template-description \
    --approval-rule-template-name 1-approver-rule-for-all-pull-requests  \
    --approval-rule-template-description "Requires 1 approval for all pull requests from the CodeCommitReview pool"

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)

The structure and content of the updated 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.

Table of Contents

Feedback

User Guide