CodeCommit / Client / create_pull_request_approval_rule

create_pull_request_approval_rule

CodeCommit.Client.create_pull_request_approval_rule(**kwargs)

Creates an approval rule for a pull request.

See also: AWS API Documentation

Request Syntax

response = client.create_pull_request_approval_rule(
    pullRequestId='string',
    approvalRuleName='string',
    approvalRuleContent='string'
)

Parameters:

• pullRequestId (string) –

  [REQUIRED]

  The system-generated ID of the pull request for which you want to create the approval rule.

• approvalRuleName (string) –

  [REQUIRED]

  The name for the approval rule.

• approvalRuleContent (string) –

  [REQUIRED]

  The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

  Note

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

  • CodeCommitApprovers: This option only requires an AWS 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 AWS account 123456789012 and Mary_Major, all of the following would be 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.

Return type:

dict

Returns:

Response Syntax

{
    'approvalRule': {
        'approvalRuleId': 'string',
        'approvalRuleName': 'string',
        'approvalRuleContent': 'string',
        'ruleContentSha256': 'string',
        'lastModifiedDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'lastModifiedUser': 'string',
        'originApprovalRuleTemplate': {
            'approvalRuleTemplateId': 'string',
            'approvalRuleTemplateName': 'string'
        }
    }
}

Response Structure

• (dict) –

  • approvalRule (dict) –

    Information about the created approval rule.

    • approvalRuleId (string) –

      The system-generated ID of the approval rule.

    • approvalRuleName (string) –

      The name of the approval rule.

    • approvalRuleContent (string) –

      The content of the approval rule.

    • ruleContentSha256 (string) –

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

    • lastModifiedDate (datetime) –

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

    • creationDate (datetime) –

      The date the approval rule 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.

    • originApprovalRuleTemplate (dict) –

      The approval rule template used to create the rule.

      • approvalRuleTemplateId (string) –

        The ID of the template that created the approval rule.

      • approvalRuleTemplateName (string) –

        The name of the template that created the approval rule.

Exceptions

• CodeCommit.Client.exceptions.ApprovalRuleNameRequiredException

• CodeCommit.Client.exceptions.InvalidApprovalRuleNameException

• CodeCommit.Client.exceptions.ApprovalRuleNameAlreadyExistsException

• CodeCommit.Client.exceptions.ApprovalRuleContentRequiredException

• CodeCommit.Client.exceptions.InvalidApprovalRuleContentException

• CodeCommit.Client.exceptions.NumberOfRulesExceededException

• CodeCommit.Client.exceptions.PullRequestDoesNotExistException

• CodeCommit.Client.exceptions.InvalidPullRequestIdException

• CodeCommit.Client.exceptions.PullRequestIdRequiredException

• CodeCommit.Client.exceptions.PullRequestAlreadyClosedException

• CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException

• CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException

• CodeCommit.Client.exceptions.EncryptionKeyDisabledException

• CodeCommit.Client.exceptions.EncryptionKeyNotFoundException

• CodeCommit.Client.exceptions.EncryptionKeyUnavailableException