« blib/lib/Paws/IAM/EvalDecisionDetailsType.pm
↑ Summary
blib/lib/Paws/IAM/GenerateCredentialReport.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IAM::EvaluationResult; | ||
| 3 | use Moose; | ||
| 4 | has EvalActionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has EvalDecision => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has EvalDecisionDetails => (is => 'ro', isa => 'Paws::IAM::EvalDecisionDetailsType'); | ||
| 7 | has EvalResourceName => (is => 'ro', isa => 'Str'); | ||
| 8 | has MatchedStatements => (is => 'ro', isa => 'ArrayRef[Paws::IAM::Statement]'); | ||
| 9 | has MissingContextValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has OrganizationsDecisionDetail => (is => 'ro', isa => 'Paws::IAM::OrganizationsDecisionDetail'); | ||
| 11 | has PermissionsBoundaryDecisionDetail => (is => 'ro', isa => 'Paws::IAM::PermissionsBoundaryDecisionDetail'); | ||
| 12 | has ResourceSpecificResults => (is => 'ro', isa => 'ArrayRef[Paws::IAM::ResourceSpecificResult]'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::IAM::EvaluationResult | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::IAM::EvaluationResult object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { EvalActionName => $value, ..., ResourceSpecificResults => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::IAM::EvaluationResult object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->EvalActionName | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Contains the results of a simulation. | ||
| 45 | |||
| 46 | This data type is used by the return parameter of C< | ||
| 47 | SimulateCustomPolicy > and C< SimulatePrincipalPolicy >. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> EvalActionName => Str | ||
| 53 | |||
| 54 | The name of the API operation tested on the indicated resource. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> EvalDecision => Str | ||
| 58 | |||
| 59 | The result of the simulation. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 EvalDecisionDetails => L<Paws::IAM::EvalDecisionDetailsType> | ||
| 63 | |||
| 64 | Additional details about the results of the cross-account evaluation | ||
| 65 | decision. This parameter is populated for only cross-account | ||
| 66 | simulations. It contains a brief summary of how each policy type | ||
| 67 | contributes to the final evaluation decision. | ||
| 68 | |||
| 69 | If the simulation evaluates policies within the same account and | ||
| 70 | includes a resource ARN, then the parameter is present but the response | ||
| 71 | is empty. If the simulation evaluates policies within the same account | ||
| 72 | and specifies all resources (C<*>), then the parameter is not returned. | ||
| 73 | |||
| 74 | When you make a cross-account request, AWS evaluates the request in the | ||
| 75 | trusting account and the trusted account. The request is allowed only | ||
| 76 | if both evaluations return C<true>. For more information about how | ||
| 77 | policies are evaluated, see Evaluating policies within a single account | ||
| 78 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics). | ||
| 79 | |||
| 80 | If an AWS Organizations SCP included in the evaluation denies access, | ||
| 81 | the simulation ends. In this case, policy evaluation does not proceed | ||
| 82 | any further and this parameter is not returned. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 EvalResourceName => Str | ||
| 86 | |||
| 87 | The ARN of the resource that the indicated API operation was tested on. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 MatchedStatements => ArrayRef[L<Paws::IAM::Statement>] | ||
| 91 | |||
| 92 | A list of the statements in the input policies that determine the | ||
| 93 | result for this scenario. Remember that even if multiple statements | ||
| 94 | allow the operation on the resource, if only one statement denies that | ||
| 95 | operation, then the explicit deny overrides any allow. In addition, the | ||
| 96 | deny statement is the only entry included in the result. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 MissingContextValues => ArrayRef[Str|Undef] | ||
| 100 | |||
| 101 | A list of context keys that are required by the included input policies | ||
| 102 | but that were not provided by one of the input parameters. This list is | ||
| 103 | used when the resource in a simulation is "*", either explicitly, or | ||
| 104 | when the C<ResourceArns> parameter blank. If you include a list of | ||
| 105 | resources, then any missing context values are instead included under | ||
| 106 | the C<ResourceSpecificResults> section. To discover the context keys | ||
| 107 | used by a set of policies, you can call GetContextKeysForCustomPolicy | ||
| 108 | or GetContextKeysForPrincipalPolicy. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 OrganizationsDecisionDetail => L<Paws::IAM::OrganizationsDecisionDetail> | ||
| 112 | |||
| 113 | A structure that details how Organizations and its service control | ||
| 114 | policies affect the results of the simulation. Only applies if the | ||
| 115 | simulated user's account is part of an organization. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 PermissionsBoundaryDecisionDetail => L<Paws::IAM::PermissionsBoundaryDecisionDetail> | ||
| 119 | |||
| 120 | Contains information about the effect that a permissions boundary has | ||
| 121 | on a policy simulation when the boundary is applied to an IAM entity. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 ResourceSpecificResults => ArrayRef[L<Paws::IAM::ResourceSpecificResult>] | ||
| 125 | |||
| 126 | The individual results of the simulation of the API operation specified | ||
| 127 | in EvalActionName on each resource. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, describing an object used in L<Paws::IAM> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |