CodeCommit / Client / create_approval_rule_template

create_approval_rule_template#

CodeCommit.Client.create_approval_rule_template(**kwargs)#

Creates a template for approval rules that can then be associated with one or more repositories in your Amazon Web Services account. When you associate a template with a repository, CodeCommit creates an approval rule that matches the conditions of the template for all pull requests that meet the conditions of the template. For more information, see AssociateApprovalRuleTemplateWithRepository.

See also: AWS API Documentation

Request Syntax

response = client.create_approval_rule_template(
    approvalRuleTemplateName='string',
    approvalRuleTemplateContent='string',
    approvalRuleTemplateDescription='string'
)
Parameters:

  • approvalRuleTemplateName (string) –

    [REQUIRED]

    The name of the approval rule template. Provide descriptive names, because this name is applied to the approval rules created automatically in associated repositories.

  • approvalRuleTemplateContent (string) –

    [REQUIRED]

    The content of the approval rule that is created on pull requests in associated repositories. If you specify one or more destination references (branches), approval rules are created in an associated repository only if their destination references (branches) match those specified in the template.

    Note

    When you create the content of the approval rule template, you can specify approvers in an approval pool in one of two ways:

    • CodeCommitApprovers: This option only requires an Amazon Web Services account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the Amazon Web Services account 123456789012 and Mary_Major, all of the following are counted as approvals coming from that user:

      • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

      • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

    • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

    For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

  • approvalRuleTemplateDescription (string) – The description of the approval rule template. Consider providing a description that explains what this template does and when it might be appropriate to associate it with repositories.

Return type:

dict

Returns:

Response Syntax

{
    'approvalRuleTemplate': {
        'approvalRuleTemplateId': 'string',
        'approvalRuleTemplateName': 'string',
        'approvalRuleTemplateDescription': 'string',
        'approvalRuleTemplateContent': 'string',
        'ruleContentSha256': 'string',
        'lastModifiedDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'lastModifiedUser': 'string'
    }
}

Response Structure

  • (dict) –

    • approvalRuleTemplate (dict) –

      The content and structure of the created 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 (datetime) –

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

      • creationDate (datetime) –

        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.

Exceptions

  • CodeCommit.Client.exceptions.ApprovalRuleTemplateNameRequiredException

  • CodeCommit.Client.exceptions.InvalidApprovalRuleTemplateNameException

  • CodeCommit.Client.exceptions.ApprovalRuleTemplateNameAlreadyExistsException

  • CodeCommit.Client.exceptions.ApprovalRuleTemplateContentRequiredException

  • CodeCommit.Client.exceptions.InvalidApprovalRuleTemplateContentException

  • CodeCommit.Client.exceptions.InvalidApprovalRuleTemplateDescriptionException

  • CodeCommit.Client.exceptions.NumberOfRuleTemplatesExceededException