Menu
AWS Identity and Access Management
API Reference (API Version 2010-05-08)

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 action 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 | implicitDeny

Required: Yes

EvalDecisionDetails
EvalDecisionDetails.entry.N.key (key)
EvalDecisionDetailsentry.N.value (value)

Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies

Type: String to string map

Key Length Constraints: Minimum length of 3. Maximum length of 256.

Valid Values: allowed | explicitDeny | implicitDeny

Required: No

EvalResourceName

The ARN of the resource that the indicated API action 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 action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and 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 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.

Type: Array of strings

Length Constraints: Minimum length of 5. Maximum length of 256.

Required: No

OrganizationsDecisionDetail

A structure that details how AWS 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

ResourceSpecificResults.member.N

The individual results of the simulation of the API action 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:

On this page: