Package software.amazon.awssdk.services.frauddetector.model

Class AggregatedVariablesImpactExplanation

java.lang.Object

software.amazon.awssdk.services.frauddetector.model.AggregatedVariablesImpactExplanation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AggregatedVariablesImpactExplanation.Builder,AggregatedVariablesImpactExplanation>

@Generated("software.amazon.awssdk:codegen")
public final class AggregatedVariablesImpactExplanation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AggregatedVariablesImpactExplanation.Builder,AggregatedVariablesImpactExplanation>

The details of the impact of aggregated variables on the prediction score.

Account Takeover Insights (ATI) model uses the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, the model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AggregatedVariablesImpactExplanation.Builder

Method Summary

Modifier and Type	Method	Description
static AggregatedVariablesImpactExplanation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	eventVariableNames()	The names of all the event variables that were used to derive the aggregated variables.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventVariableNames()	For responses, this returns true if the service returned a value for the EventVariableNames property.
int	hashCode()
Float	logOddsImpact()	The raw, uninterpreted value represented as log-odds of the fraud.
String	relativeImpact()	The relative impact of the aggregated variables in terms of magnitude on the prediction scores.
List<SdkField<?>>	sdkFields()
static Class<? extends AggregatedVariablesImpactExplanation.Builder>	serializableBuilderClass()
AggregatedVariablesImpactExplanation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasEventVariableNames

public final boolean hasEventVariableNames()

For responses, this returns true if the service returned a value for the EventVariableNames 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.

eventVariableNames

public final List<String> eventVariableNames()

The names of all the event variables that were used to derive the aggregated variables.

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 hasEventVariableNames() method.

Returns:

The names of all the event variables that were used to derive the aggregated variables.

relativeImpact

public final String relativeImpact()

The relative impact of the aggregated variables in terms of magnitude on the prediction scores.

Returns:

The relative impact of the aggregated variables in terms of magnitude on the prediction scores.

logOddsImpact

public final Float logOddsImpact()

The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from -infinity to +infinity.

• A positive value indicates that the variables drove the risk score up.

• A negative value indicates that the variables drove the risk score down.

Returns:

The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from -infinity to +infinity.

• A positive value indicates that the variables drove the risk score up.

• A negative value indicates that the variables drove the risk score down.

toBuilder

public AggregatedVariablesImpactExplanation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AggregatedVariablesImpactExplanation.Builder,AggregatedVariablesImpactExplanation>

builder

public static AggregatedVariablesImpactExplanation.Builder builder()

serializableBuilderClass

public static Class<? extends AggregatedVariablesImpactExplanation.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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