| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CodeCommit.UpdatePullRequestApprovalRuleContent
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.
Synopsis
- data UpdatePullRequestApprovalRuleContent = UpdatePullRequestApprovalRuleContent' {}
- newUpdatePullRequestApprovalRuleContent :: Text -> Text -> Text -> UpdatePullRequestApprovalRuleContent
- updatePullRequestApprovalRuleContent_existingRuleContentSha256 :: Lens' UpdatePullRequestApprovalRuleContent (Maybe Text)
- updatePullRequestApprovalRuleContent_pullRequestId :: Lens' UpdatePullRequestApprovalRuleContent Text
- updatePullRequestApprovalRuleContent_approvalRuleName :: Lens' UpdatePullRequestApprovalRuleContent Text
- updatePullRequestApprovalRuleContent_newRuleContent :: Lens' UpdatePullRequestApprovalRuleContent Text
- data UpdatePullRequestApprovalRuleContentResponse = UpdatePullRequestApprovalRuleContentResponse' {}
- newUpdatePullRequestApprovalRuleContentResponse :: Int -> ApprovalRule -> UpdatePullRequestApprovalRuleContentResponse
- updatePullRequestApprovalRuleContentResponse_httpStatus :: Lens' UpdatePullRequestApprovalRuleContentResponse Int
- updatePullRequestApprovalRuleContentResponse_approvalRule :: Lens' UpdatePullRequestApprovalRuleContentResponse ApprovalRule
Creating a Request
data UpdatePullRequestApprovalRuleContent Source #
See: newUpdatePullRequestApprovalRuleContent smart constructor.
Constructors
| UpdatePullRequestApprovalRuleContent' | |
Fields
| |
Instances
newUpdatePullRequestApprovalRuleContent Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdatePullRequestApprovalRuleContent |
Create a value of UpdatePullRequestApprovalRuleContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:existingRuleContentSha256:UpdatePullRequestApprovalRuleContent', updatePullRequestApprovalRuleContent_existingRuleContentSha256 - The SHA-256 hash signature for the content of the approval rule. You can
retrieve this information by using GetPullRequest.
$sel:pullRequestId:UpdatePullRequestApprovalRuleContent', updatePullRequestApprovalRuleContent_pullRequestId - The system-generated ID of the pull request.
$sel:approvalRuleName:UpdatePullRequestApprovalRuleContent', updatePullRequestApprovalRuleContent_approvalRuleName - The name of the approval rule you want to update.
$sel:newRuleContent':UpdatePullRequestApprovalRuleContent', updatePullRequestApprovalRuleContent_newRuleContent - 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 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 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.
Request Lenses
updatePullRequestApprovalRuleContent_existingRuleContentSha256 :: Lens' UpdatePullRequestApprovalRuleContent (Maybe Text) Source #
The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using GetPullRequest.
updatePullRequestApprovalRuleContent_pullRequestId :: Lens' UpdatePullRequestApprovalRuleContent Text Source #
The system-generated ID of the pull request.
updatePullRequestApprovalRuleContent_approvalRuleName :: Lens' UpdatePullRequestApprovalRuleContent Text Source #
The name of the approval rule you want to update.
updatePullRequestApprovalRuleContent_newRuleContent :: Lens' UpdatePullRequestApprovalRuleContent Text Source #
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 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 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.
Destructuring the Response
data UpdatePullRequestApprovalRuleContentResponse Source #
See: newUpdatePullRequestApprovalRuleContentResponse smart constructor.
Constructors
| UpdatePullRequestApprovalRuleContentResponse' | |
Fields
| |
Instances
newUpdatePullRequestApprovalRuleContentResponse Source #
Arguments
| :: Int |
|
| -> ApprovalRule |
|
| -> UpdatePullRequestApprovalRuleContentResponse |
Create a value of UpdatePullRequestApprovalRuleContentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdatePullRequestApprovalRuleContentResponse', updatePullRequestApprovalRuleContentResponse_httpStatus - The response's http status code.
$sel:approvalRule:UpdatePullRequestApprovalRuleContentResponse', updatePullRequestApprovalRuleContentResponse_approvalRule - Information about the updated approval rule.
Response Lenses
updatePullRequestApprovalRuleContentResponse_httpStatus :: Lens' UpdatePullRequestApprovalRuleContentResponse Int Source #
The response's http status code.
updatePullRequestApprovalRuleContentResponse_approvalRule :: Lens' UpdatePullRequestApprovalRuleContentResponse ApprovalRule Source #
Information about the updated approval rule.