EvaluationResult
Contains the results of a simulation.
This data type is used by the return parameter of <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_SimulateCustomPolicy.html">SimulateCustomPolicy</a> and <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_SimulatePrincipalPolicy.html">SimulatePrincipalPolicy</a> .
The simulator now returns a single EvaluationResult per action, regardless of how many resource ARNs are provided. Previously, simulating one action against N resources returned N evaluation results, each containing the same aggregate decision. The top-level fields (EvalDecision, MatchedStatements, MissingContextValues, EvalDecisionDetails) now represent the aggregate decision across all requested resources. The top-level EvalDecision reflects the most restrictive decision across all resources (for example, if any resource produces explicitDeny, the top-level decision is explicitDeny).
To see the decision for each individual resource, use ResourceSpecificResults. If your application parses evaluation results per resource ARN, update your code to read per-resource decisions from ResourceSpecificResults rather than from the top-level result.
Types
Properties
The name of the API operation tested on the indicated resource.
The result of the simulation.
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.
The ARN template for the simulated resource type (for example, arn:${Partition}:s3:::${BucketName}/${KeyName}), or * if no ARN format is defined for the action. This is not a specific customer-provided resource ARN. To find the decision for a specific resource, use ResourceSpecificResults.
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.
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 ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
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.
Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
The individual results of the simulation of the API operation specified in EvalActionName on each resource.