@Generated(value="software.amazon.awssdk:codegen") public class EvaluationResult extends Object implements ToCopyableBuilder<EvaluationResult.Builder,EvaluationResult>
Contains the results of a simulation.
This data type is used by the return parameter of SimulateCustomPolicy
and
SimulatePrincipalPolicy
.
Modifier and Type | Class and Description |
---|---|
static interface |
EvaluationResult.Builder |
Modifier and Type | Method and Description |
---|---|
static EvaluationResult.Builder |
builder() |
boolean |
equals(Object obj) |
String |
evalActionName()
The name of the API action tested on the indicated resource.
|
PolicyEvaluationDecisionType |
evalDecision()
The result of the simulation.
|
Map<String,PolicyEvaluationDecisionType> |
evalDecisionDetails()
Additional details about the results of the evaluation decision.
|
Map<String,String> |
evalDecisionDetailsStrings()
Additional details about the results of the evaluation decision.
|
String |
evalDecisionString()
The result of the simulation.
|
String |
evalResourceName()
The ARN of the resource that the indicated API action was tested on.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<Statement> |
matchedStatements()
A list of the statements in the input policies that determine the result for this scenario.
|
List<String> |
missingContextValues()
A list of context keys that are required by the included input policies but that were not provided by one of the
input parameters.
|
OrganizationsDecisionDetail |
organizationsDecisionDetail()
A structure that details how AWS Organizations and its service control policies affect the results of the
simulation.
|
List<ResourceSpecificResult> |
resourceSpecificResults()
The individual results of the simulation of the API action specified in EvalActionName on each resource.
|
static Class<? extends EvaluationResult.Builder> |
serializableBuilderClass() |
EvaluationResult.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String evalActionName()
The name of the API action tested on the indicated resource.
public String evalResourceName()
The ARN of the resource that the indicated API action was tested on.
public PolicyEvaluationDecisionType evalDecision()
The result of the simulation.
If the service returns an enum value that is not available in the current SDK version, evalDecision
will
return PolicyEvaluationDecisionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from evalDecisionString()
.
PolicyEvaluationDecisionType
public String evalDecisionString()
The result of the simulation.
If the service returns an enum value that is not available in the current SDK version, evalDecision
will
return PolicyEvaluationDecisionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from evalDecisionString()
.
PolicyEvaluationDecisionType
public List<Statement> matchedStatements()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> missingContextValues()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.public OrganizationsDecisionDetail 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.
public Map<String,PolicyEvaluationDecisionType> evalDecisionDetails()
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
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Map<String,String> evalDecisionDetailsStrings()
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
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<ResourceSpecificResult> resourceSpecificResults()
The individual results of the simulation of the API action specified in EvalActionName on each resource.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public EvaluationResult.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<EvaluationResult.Builder,EvaluationResult>
public static EvaluationResult.Builder builder()
public static Class<? extends EvaluationResult.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.