software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminRespondToAuthChallengeResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>

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

Responds to the authentication challenge, as an administrator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdminRespondToAuthChallengeResponse.Builder

Method Summary

Modifier and Type	Method and Description
AuthenticationResultType	authenticationResult() The result returned by the server in response to the authentication request.
static AdminRespondToAuthChallengeResponse.Builder	builder()
ChallengeNameType	challengeName() The name of the challenge.
String	challengeNameAsString() The name of the challenge.
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() Returns true if the ChallengeParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AdminRespondToAuthChallengeResponse.Builder>	serializableBuilderClass()
String	session() The session which should be passed both ways in challenge-response calls to the service.
AdminRespondToAuthChallengeResponse.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 name of the challenge. For more information, see AdminInitiateAuth.

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 name of the challenge. For more information, see AdminInitiateAuth.

See Also:

ChallengeNameType

challengeNameAsString

public final String challengeNameAsString()

The name of the challenge. For more information, see AdminInitiateAuth.

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 name of the challenge. For more information, see AdminInitiateAuth.

See Also:

ChallengeNameType

session

public final String session()

The session which should be passed both ways in challenge-response calls to the service. If 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 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.

hasChallengeParameters

public final boolean hasChallengeParameters()

Returns true if the ChallengeParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

challengeParameters

public final Map<String,String> challengeParameters()

The challenge parameters. For more information, see AdminInitiateAuth.

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

You can use hasChallengeParameters() to see if a value was sent in this field.

Returns:

The challenge parameters. For more information, see AdminInitiateAuth.

authenticationResult

public final AuthenticationResultType authenticationResult()

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

Returns:

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

toBuilder

public AdminRespondToAuthChallengeResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static AdminRespondToAuthChallengeResponse.Builder builder()

serializableBuilderClass

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