get-approval-rule-template¶

Description¶

Returns information about a specified approval rule template.

Synopsis¶

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

Options¶

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

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

--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.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To get the content of an approval rule template

The following get-approval-rule-template example gets the content of an approval rule template named 1-approver-rule-for-all-pull-requests.

aws codecommit get-approval-rule-template \
    --approval-rule-template-name 1-approver-rule-for-all-pull-requests

Output:

{
    "approvalRuleTemplate": {
        "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"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."
    }
}

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

Output¶

approvalRuleTemplate -> (structure)

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