Skip to content

Update Pull Request Approval Rule Content

codecommit_update_pull_request_approval_rule_content R Documentation

Updates the structure of an approval rule created specifically for a pull request

Description

Updates the structure of an approval rule created specifically for a pull request. For example, you can change the number of required approvers and the approval pool for approvers.

Usage

codecommit_update_pull_request_approval_rule_content(pullRequestId,
  approvalRuleName, existingRuleContentSha256, newRuleContent)

Arguments

pullRequestId

[required] The system-generated ID of the pull request.

approvalRuleName

[required] The name of the approval rule you want to update.

existingRuleContentSha256

The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using get_pull_request.

newRuleContent

[required] The updated content for the approval rule.

When you update 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 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.

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$update_pull_request_approval_rule_content(
  pullRequestId = "string",
  approvalRuleName = "string",
  existingRuleContentSha256 = "string",
  newRuleContent = "string"
)