EvaluationResult
Contains the results of a simulation.
This data type is used by the return parameter of
SimulateCustomPolicy
and
SimulatePrincipalPolicy
.
Contents
- EvalActionName
-
The name of the API operation tested on the indicated resource.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Required: Yes
- EvalDecision
-
The result of the simulation.
Type: String
Valid Values:
allowed | explicitDeny | implicitDenyRequired: Yes
- EvalDecisionDetails
- EvalDecisionDetails.entry.N.key (key)
- EvalDecisionDetails.entry.N.value (value)
-
Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.
If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (
*), then the parameter is not returned.When you make a cross-account request, AWS evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return
true. For more information about how policies are evaluated, see Evaluating policies within a single account.If an AWS Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.
Type: String to string map
Key Length Constraints: Minimum length of 3. Maximum length of 256.
Valid Values:
allowed | explicitDeny | implicitDenyRequired: No
- EvalResourceName
-
The ARN of the resource that the indicated API operation was tested on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- MatchedStatements.member.N
-
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.
Type: Array of Statement objects
Required: No
- MissingContextValues.member.N
-
A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the
ResourceArnsparameter blank. If you include a list of resources, then any missing context values are instead included under theResourceSpecificResultssection. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.Type: Array of strings
Length Constraints: Minimum length of 5. Maximum length of 256.
Required: No
- OrganizationsDecisionDetail
-
A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.
Type: OrganizationsDecisionDetail object
Required: No
- PermissionsBoundaryDecisionDetail
-
Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
Type: PermissionsBoundaryDecisionDetail object
Required: No
- ResourceSpecificResults.member.N
-
The individual results of the simulation of the API operation specified in EvalActionName on each resource.
Type: Array of ResourceSpecificResult objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
