Skip to content

Create Pull Request Approval Rule

codecommit_create_pull_request_approval_rule R Documentation

Creates an approval rule for a pull request

Description

Creates an approval rule for a pull request.

Usage

codecommit_create_pull_request_approval_rule(pullRequestId,
  approvalRuleName, approvalRuleContent)

Arguments

pullRequestId

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

approvalRuleName

[required] The name for the approval rule.

approvalRuleContent

[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 CodeCommit User Guide.

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

Value

A list with the following syntax: 

list(
  approvalRule = list(
    approvalRuleId = "string",
    approvalRuleName = "string",
    approvalRuleContent = "string",
    ruleContentSha256 = "string",
    lastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    creationDate = as.POSIXct(
      "2015-01-01"
    ),
    lastModifiedUser = "string",
    originApprovalRuleTemplate = list(
      approvalRuleTemplateId = "string",
      approvalRuleTemplateName = "string"
    )
  )
)

Request syntax

svc$create_pull_request_approval_rule(
  pullRequestId = "string",
  approvalRuleName = "string",
  approvalRuleContent = "string"
)