View a markdown version of this page

Evaluation - IAM Toolbox

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

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 no policy allowed it.

Type: String

Valid Values: ALLOW | EXPLICIT_DENY | IMPLICIT_DENY

Required: No

matchedPolicies

The policies that matched during evaluation of this action and resource. An implicit denial produces no matched policies.

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: