com.amazonaws.services.identitymanagement.model

Class EvaluationResult

java.lang.Object

com.amazonaws.services.identitymanagement.model.EvaluationResult

All Implemented Interfaces:

Serializable, Cloneable

public class EvaluationResult
extends Object
implements Serializable, Cloneable

Contains the results of a simulation.

This data type is used by the return parameter of SimulatePolicy .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EvaluationResult()

Method Summary

Methods

Modifier and Type	Method and Description
EvaluationResult	addEvalDecisionDetailsEntry(String key, String value) Additional details about the results of the evaluation decision.
EvaluationResult	clearEvalDecisionDetailsEntries() Removes all the entries added into EvalDecisionDetails.
EvaluationResult	clone()
boolean	equals(Object obj)
String	getEvalActionName() The name of the API action tested on the indicated resource.
String	getEvalDecision() The result of the simulation.
Map<String,String>	getEvalDecisionDetails() Additional details about the results of the evaluation decision.
String	getEvalResourceName() The ARN of the resource that the indicated API action was tested on.
List<Statement>	getMatchedStatements() A list of the statements in the input policies that determine the result for this scenario.
List<String>	getMissingContextValues() A list of context keys that are required by the included input policies but that were not provided by one of the input parameters.
List<ResourceSpecificResult>	getResourceSpecificResults() The individual results of the simulation of the API action specified in EvalActionName on each resource.
int	hashCode()
void	setEvalActionName(String evalActionName) The name of the API action tested on the indicated resource.
void	setEvalDecision(PolicyEvaluationDecisionType evalDecision) The result of the simulation.
void	setEvalDecision(String evalDecision) The result of the simulation.
void	setEvalDecisionDetails(Map<String,String> evalDecisionDetails) Additional details about the results of the evaluation decision.
void	setEvalResourceName(String evalResourceName) The ARN of the resource that the indicated API action was tested on.
void	setMatchedStatements(Collection<Statement> matchedStatements) A list of the statements in the input policies that determine the result for this scenario.
void	setMissingContextValues(Collection<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.
void	setResourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults) The individual results of the simulation of the API action specified in EvalActionName on each resource.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EvaluationResult	withEvalActionName(String evalActionName) The name of the API action tested on the indicated resource.
EvaluationResult	withEvalDecision(PolicyEvaluationDecisionType evalDecision) The result of the simulation.
EvaluationResult	withEvalDecision(String evalDecision) The result of the simulation.
EvaluationResult	withEvalDecisionDetails(Map<String,String> evalDecisionDetails) Additional details about the results of the evaluation decision.
EvaluationResult	withEvalResourceName(String evalResourceName) The ARN of the resource that the indicated API action was tested on.
EvaluationResult	withMatchedStatements(Collection<Statement> matchedStatements) A list of the statements in the input policies that determine the result for this scenario.
EvaluationResult	withMatchedStatements(Statement... matchedStatements) A list of the statements in the input policies that determine the result for this scenario.
EvaluationResult	withMissingContextValues(Collection<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.
EvaluationResult	withMissingContextValues(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.
EvaluationResult	withResourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults) The individual results of the simulation of the API action specified in EvalActionName on each resource.
EvaluationResult	withResourceSpecificResults(ResourceSpecificResult... resourceSpecificResults) The individual results of the simulation of the API action specified in EvalActionName on each resource.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EvaluationResult

public EvaluationResult()

Method Detail

getEvalActionName

public String getEvalActionName()

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

Constraints:
Length: 3 - 128

Returns:

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

setEvalActionName

public void setEvalActionName(String evalActionName)

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

Constraints:
Length: 3 - 128

Parameters:

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

withEvalActionName

public EvaluationResult withEvalActionName(String evalActionName)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 128

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getEvalResourceName

public String getEvalResourceName()

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

Constraints:
Length: 1 - 2048

Returns:

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

setEvalResourceName

public void setEvalResourceName(String evalResourceName)

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

Constraints:
Length: 1 - 2048

Parameters:

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

withEvalResourceName

public EvaluationResult withEvalResourceName(String evalResourceName)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2048

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getEvalDecision

public String getEvalDecision()

The result of the simulation.

Constraints:
Allowed Values: allowed, explicitDeny, implicitDeny

Returns:

The result of the simulation.

See Also:

PolicyEvaluationDecisionType

setEvalDecision

public void setEvalDecision(String evalDecision)

The result of the simulation.

Constraints:
Allowed Values: allowed, explicitDeny, implicitDeny

Parameters:

evalDecision - The result of the simulation.

See Also:

PolicyEvaluationDecisionType

withEvalDecision

public EvaluationResult withEvalDecision(String evalDecision)

The result of the simulation.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: allowed, explicitDeny, implicitDeny

Parameters:

evalDecision - The result of the simulation.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PolicyEvaluationDecisionType

setEvalDecision

public void setEvalDecision(PolicyEvaluationDecisionType evalDecision)

The result of the simulation.

Constraints:
Allowed Values: allowed, explicitDeny, implicitDeny

Parameters:

evalDecision - The result of the simulation.

See Also:

PolicyEvaluationDecisionType

withEvalDecision

public EvaluationResult withEvalDecision(PolicyEvaluationDecisionType evalDecision)

The result of the simulation.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: allowed, explicitDeny, implicitDeny

Parameters:

evalDecision - The result of the simulation.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PolicyEvaluationDecisionType

getMatchedStatements

public List<Statement> getMatchedStatements()

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:

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.

setMatchedStatements

public void setMatchedStatements(Collection<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.

Parameters:

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.

withMatchedStatements

public EvaluationResult withMatchedStatements(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.

NOTE: This method appends the values to the existing list (if any). Use setMatchedStatements(java.util.Collection) or withMatchedStatements(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withMatchedStatements

public EvaluationResult withMatchedStatements(Collection<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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getMissingContextValues

public List<String> getMissingContextValues()

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.

Returns:

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.

setMissingContextValues

public void setMissingContextValues(Collection<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. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.

Parameters:

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. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.

withMissingContextValues

public EvaluationResult withMissingContextValues(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. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.

NOTE: This method appends the values to the existing list (if any). Use setMissingContextValues(java.util.Collection) or withMissingContextValues(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.

Returns:

A reference to this updated object so that method calls can be chained together.

withMissingContextValues

public EvaluationResult withMissingContextValues(Collection<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. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.

Returns:

A reference to this updated object so that method calls can be chained together.

getEvalDecisionDetails

public Map<String,String> getEvalDecisionDetails()

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:

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

setEvalDecisionDetails

public void setEvalDecisionDetails(Map<String,String> 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

Parameters:

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

withEvalDecisionDetails

public EvaluationResult withEvalDecisionDetails(Map<String,String> 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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

addEvalDecisionDetailsEntry

public EvaluationResult addEvalDecisionDetailsEntry(String key,
                                           String 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

The method adds a new key-value pair into EvalDecisionDetails parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into EvalDecisionDetails.

value - The corresponding value of the entry to be added into EvalDecisionDetails.

clearEvalDecisionDetailsEntries

public EvaluationResult clearEvalDecisionDetailsEntries()

Removes all the entries added into EvalDecisionDetails.

Returns a reference to this object so that method calls can be chained together.

getResourceSpecificResults

public List<ResourceSpecificResult> getResourceSpecificResults()

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

Returns:

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

setResourceSpecificResults

public void setResourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults)

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

Parameters:

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

withResourceSpecificResults

public EvaluationResult withResourceSpecificResults(ResourceSpecificResult... resourceSpecificResults)

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

NOTE: This method appends the values to the existing list (if any). Use setResourceSpecificResults(java.util.Collection) or withResourceSpecificResults(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withResourceSpecificResults

public EvaluationResult withResourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public EvaluationResult clone()

Overrides:

clone in class Object