« blib/lib/Paws/CodeCommit/UpdateDefaultBranch.pm
↑ Summary
blib/lib/Paws/CodeCommit/UpdatePullRequestApprovalRuleContentOutput.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::UpdatePullRequestApprovalRuleContent; | ||
| 3 | use Moose; | ||
| 4 | has ApprovalRuleName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'approvalRuleName' , required => 1); | ||
| 5 | has ExistingRuleContentSha256 => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'existingRuleContentSha256' ); | ||
| 6 | has NewRuleContent => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'newRuleContent' , required => 1); | ||
| 7 | has PullRequestId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pullRequestId' , required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdatePullRequestApprovalRuleContent'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::UpdatePullRequestApprovalRuleContentOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CodeCommit::UpdatePullRequestApprovalRuleContent - Arguments for method UpdatePullRequestApprovalRuleContent on L<Paws::CodeCommit> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdatePullRequestApprovalRuleContent on the | ||
| 25 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdatePullRequestApprovalRuleContent. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdatePullRequestApprovalRuleContent. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $codecommit = Paws->service('CodeCommit'); | ||
| 33 | my $UpdatePullRequestApprovalRuleContentOutput = | ||
| 34 | $codecommit->UpdatePullRequestApprovalRuleContent( | ||
| 35 | ApprovalRuleName => 'MyApprovalRuleName', | ||
| 36 | NewRuleContent => 'MyApprovalRuleContent', | ||
| 37 | PullRequestId => 'MyPullRequestId', | ||
| 38 | ExistingRuleContentSha256 => 'MyRuleContentSha256', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $ApprovalRule = | ||
| 43 | $UpdatePullRequestApprovalRuleContentOutput->ApprovalRule; | ||
| 44 | |||
| 45 | # Returns a L<Paws::CodeCommit::UpdatePullRequestApprovalRuleContentOutput> object. | ||
| 46 | |||
| 47 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codecommit/UpdatePullRequestApprovalRuleContent> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ApprovalRuleName => Str | ||
| 54 | |||
| 55 | The name of the approval rule you want to update. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 ExistingRuleContentSha256 => Str | ||
| 60 | |||
| 61 | The SHA-256 hash signature for the content of the approval rule. You | ||
| 62 | can retrieve this information by using GetPullRequest. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> NewRuleContent => Str | ||
| 67 | |||
| 68 | The updated content for the approval rule. | ||
| 69 | |||
| 70 | When you update the content of the approval rule, you can specify | ||
| 71 | approvers in an approval pool in one of two ways: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | B<CodeCommitApprovers>: This option only requires an AWS account and a | ||
| 78 | resource. It can be used for both IAM users and federated access users | ||
| 79 | whose name matches the provided resource name. This is a very powerful | ||
| 80 | option that offers a great deal of flexibility. For example, if you | ||
| 81 | specify the AWS account I<123456789012> and I<Mary_Major>, all of the | ||
| 82 | following are counted as approvals coming from that user: | ||
| 83 | |||
| 84 | =over | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | An IAM user in the account | ||
| 89 | (arn:aws:iam::I<123456789012>:user/I<Mary_Major>) | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | A federated user identified in IAM as Mary_Major | ||
| 94 | (arn:aws:sts::I<123456789012>:federated-user/I<Mary_Major>) | ||
| 95 | |||
| 96 | =back | ||
| 97 | |||
| 98 | This option does not recognize an active session of someone assuming | ||
| 99 | the role of CodeCommitReview with a role session name of I<Mary_Major> | ||
| 100 | (arn:aws:sts::I<123456789012>:assumed-role/CodeCommitReview/I<Mary_Major>) | ||
| 101 | unless you include a wildcard (*Mary_Major). | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | B<Fully qualified ARN>: This option allows you to specify the fully | ||
| 106 | qualified Amazon Resource Name (ARN) of the IAM user or role. | ||
| 107 | |||
| 108 | =back | ||
| 109 | |||
| 110 | For more information about IAM ARNs, wildcards, and formats, see IAM | ||
| 111 | Identifiers | ||
| 112 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) | ||
| 113 | in the I<IAM User Guide>. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 B<REQUIRED> PullRequestId => Str | ||
| 118 | |||
| 119 | The system-generated ID of the pull request. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, documenting arguments for method UpdatePullRequestApprovalRuleContent in L<Paws::CodeCommit> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |