You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::Types::EvaluationResult

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Contains the results of a simulation.

This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy.

Instance Attribute Summary collapse

Instance Attribute Details

#eval_action_nameString

The name of the API action tested on the indicated resource.

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2339

class EvaluationResult < Struct.new(
  :eval_action_name,
  :eval_resource_name,
  :eval_decision,
  :matched_statements,
  :missing_context_values,
  :organizations_decision_detail,
  :eval_decision_details,
  :resource_specific_results)
  include Aws::Structure
end

#eval_decisionString

The result of the simulation.

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2339

class EvaluationResult < Struct.new(
  :eval_action_name,
  :eval_resource_name,
  :eval_decision,
  :matched_statements,
  :missing_context_values,
  :organizations_decision_detail,
  :eval_decision_details,
  :resource_specific_results)
  include Aws::Structure
end

#eval_decision_detailsHash<String,String>

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

Returns:

  • (Hash<String,String>)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2339

class EvaluationResult < Struct.new(
  :eval_action_name,
  :eval_resource_name,
  :eval_decision,
  :matched_statements,
  :missing_context_values,
  :organizations_decision_detail,
  :eval_decision_details,
  :resource_specific_results)
  include Aws::Structure
end

#eval_resource_nameString

The ARN of the resource that the indicated API action was tested on.

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2339

class EvaluationResult < Struct.new(
  :eval_action_name,
  :eval_resource_name,
  :eval_decision,
  :matched_statements,
  :missing_context_values,
  :organizations_decision_detail,
  :eval_decision_details,
  :resource_specific_results)
  include Aws::Structure
end

#matched_statementsArray<Types::Statement>

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.

Returns:



2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2339

class EvaluationResult < Struct.new(
  :eval_action_name,
  :eval_resource_name,
  :eval_decision,
  :matched_statements,
  :missing_context_values,
  :organizations_decision_detail,
  :eval_decision_details,
  :resource_specific_results)
  include Aws::Structure
end

#missing_context_valuesArray<String>

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.

Returns:

  • (Array<String>)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2339

class EvaluationResult < Struct.new(
  :eval_action_name,
  :eval_resource_name,
  :eval_decision,
  :matched_statements,
  :missing_context_values,
  :organizations_decision_detail,
  :eval_decision_details,
  :resource_specific_results)
  include Aws::Structure
end

#organizations_decision_detailTypes::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.



2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2339

class EvaluationResult < Struct.new(
  :eval_action_name,
  :eval_resource_name,
  :eval_decision,
  :matched_statements,
  :missing_context_values,
  :organizations_decision_detail,
  :eval_decision_details,
  :resource_specific_results)
  include Aws::Structure
end

#resource_specific_resultsArray<Types::ResourceSpecificResult>

The individual results of the simulation of the API action specified in EvalActionName on each resource.

Returns:



2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2339

class EvaluationResult < Struct.new(
  :eval_action_name,
  :eval_resource_name,
  :eval_decision,
  :matched_statements,
  :missing_context_values,
  :organizations_decision_detail,
  :eval_decision_details,
  :resource_specific_results)
  include Aws::Structure
end