software.amazon.awssdk.services.cognitoidentityprovider.model

Class RespondToAuthChallengeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.RespondToAuthChallengeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RespondToAuthChallengeRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>

The request to respond to an authentication challenge.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RespondToAuthChallengeRequest.Builder

Method Summary

Modifier and Type	Method and Description
AnalyticsMetadataType	analyticsMetadata() The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
static RespondToAuthChallengeRequest.Builder	builder()
ChallengeNameType	challengeName() The challenge name.
String	challengeNameAsString() The challenge name.
Map<String,String>	challengeResponses() The challenge responses.
String	clientId() The app client ID.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends RespondToAuthChallengeRequest.Builder>	serializableBuilderClass()
String	session() The session which should be passed both ways in challenge-response calls to the service.
RespondToAuthChallengeRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
UserContextDataType	userContextData() Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clientId

public String clientId()

The app client ID.

Returns:

The app client ID.

challengeName

public ChallengeNameType challengeName()

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

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

Returns:

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

See Also:

ChallengeNameType

challengeNameAsString

public String challengeNameAsString()

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

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

Returns:

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

See Also:

ChallengeNameType

session

public String session()

The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Returns:

The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

challengeResponses

public Map<String,String> challengeResponses()

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

• SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

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

Returns:

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

• SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

analyticsMetadata

public AnalyticsMetadataType analyticsMetadata()

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Returns:

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

userContextData

public UserContextDataType userContextData()

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

toBuilder

public RespondToAuthChallengeRequest.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<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

Returns:

a builder for type T

builder

public static RespondToAuthChallengeRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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