Class Evaluation

java.lang.Object
software.amazon.awssdk.services.iamtoolbox.model.Evaluation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Evaluation.Builder,Evaluation>
@Generated("software.amazon.awssdk:codegen") public final class Evaluation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Evaluation.Builder,Evaluation>

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

See Also:

  • Method Details

    • action

      public final String action()

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

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

    • resource

      public final String 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.

      Returns:
      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.

    • hasContext

      public final boolean hasContext()
      For responses, this returns true if the service returned a value for the Context property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • context

      public final Map<String,Document> context()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContext() method.

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

    • evaluatedEffect

      public final EvaluatedEffect 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.

      If the service returns an enum value that is not available in the current SDK version, evaluatedEffect will return EvaluatedEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluatedEffectAsString().

      Returns:
      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.

      See Also:

    • evaluatedEffectAsString

      public final String evaluatedEffectAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, evaluatedEffect will return EvaluatedEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluatedEffectAsString().

      Returns:
      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.

      See Also:

    • hasMatchedPolicies

      public final boolean hasMatchedPolicies()
      For responses, this returns true if the service returned a value for the MatchedPolicies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • matchedPolicies

      public final List<MatchedPolicy> matchedPolicies()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMatchedPolicies() method.

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

    • toBuilder

      public Evaluation.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Evaluation.Builder,Evaluation>
      Returns:
      a builder for type T

    • builder

      public static Evaluation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Evaluation.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.