Evaluation - IAM Toolbox
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

Evaluation

Represents an individual evaluation for a single action and resource pair. This includes the context, the resulting effect, and any policies that matched.

Contents

action

The action evaluated for this request (for example, iam:PassRole).

Type: String

Required: Yes

resource

The resource that the action targeted. This is typically a resource ARN, but can be a wildcard ARN that matches multiple resources, or empty for actions that are not resource-specific.

Type: String

Required: Yes

checks

checks contains the authorization checks that explain an evaluation result. Each check is one authorization requirement and reports its result and policies from the top-level policies list with matching statements. The output lists RCP checks from the organization root to the account, then SCP checks from the organization root to the account. It then lists VPC endpoint, resource, principal, permissions boundary, and session checks. When checks is present, an EXPLICIT_DENY evaluation includes an EXPLICIT_DENY check. When checks is present for an IMPLICIT_DENY evaluation, it includes an IMPLICIT_DENY check and no EXPLICIT_DENY check. For more information about how IAM evaluates policies, see Policy evaluation logic.

PRINCIPAL, PERMISSIONS_BOUNDARY, and SESSION checks appear when they apply to the principal that made the request, even if none of their policies matched. A missing allow produces IMPLICIT_DENY, or NO_IMPACT when another path already allowed the request.

Returned when the caller is in the request principal's account or organization. The absence of checks does not mean no authorization checks applied.

Type: Array of Check objects

Required: No

context

The context keys and values specific to this evaluation. These are applied on top of the request context.

Type: String to JSON value map

Required: No

evaluatedEffect

The result of the evaluation. Valid values:

  • ALLOW - The action was allowed.

  • EXPLICIT_DENY - The action was explicitly denied by a policy.

  • IMPLICIT_DENY - The action was denied because at least one required authorization check had no matching allow statement.

Type: String

Valid Values: ALLOW | EXPLICIT_DENY | IMPLICIT_DENY

Required: No

matchedPolicies

matchedPolicies is deprecated. Use checks instead. This value contains the policies that matched during evaluation of this action and resource.

Type: Array of MatchedPolicy objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: