Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class RespondToAuthChallengeResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.RespondToAuthChallengeResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RespondToAuthChallengeResponse.Builder,RespondToAuthChallengeResponse>

@Generated("software.amazon.awssdk:codegen")
public final class RespondToAuthChallengeResponse
extends CognitoIdentityProviderResponse
implements ToCopyableBuilder<RespondToAuthChallengeResponse.Builder,RespondToAuthChallengeResponse>

The response to respond to the authentication challenge.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RespondToAuthChallengeResponse.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationResultType	authenticationResult()	The result returned by the server in response to the request to respond to the authentication challenge.
static RespondToAuthChallengeResponse.Builder	builder()
ChallengeNameType	challengeName()	The challenge name.
String	challengeNameAsString()	The challenge name.
Map<String,String>	challengeParameters()	The challenge parameters.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChallengeParameters()	For responses, this returns true if the service returned a value for the ChallengeParameters property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends RespondToAuthChallengeResponse.Builder>	serializableBuilderClass()
String	session()	The session that should be passed both ways in challenge-response calls to the service.
RespondToAuthChallengeResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

challengeName

public final ChallengeNameType challengeName()

The challenge name. For more information, see InitiateAuth.

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

See Also:

ChallengeNameType

challengeNameAsString

public final String challengeNameAsString()

The challenge name. For more information, see InitiateAuth.

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

See Also:

ChallengeNameType

session

public final String session()

The session that should be passed both ways in challenge-response calls to the service. If the caller must pass 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 that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

hasChallengeParameters

public final boolean hasChallengeParameters()

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

challengeParameters

public final Map<String,String> challengeParameters()

The challenge parameters. For more information, see InitiateAuth.

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

Returns:

The challenge parameters. For more information, see InitiateAuth.

authenticationResult

public final AuthenticationResultType authenticationResult()

The result returned by the server in response to the request to respond to the authentication challenge.

Returns:

The result returned by the server in response to the request to respond to the authentication challenge.

toBuilder

public RespondToAuthChallengeResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RespondToAuthChallengeResponse.Builder,RespondToAuthChallengeResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static RespondToAuthChallengeResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo