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

Class VerifySoftwareTokenResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<VerifySoftwareTokenResponse.Builder,VerifySoftwareTokenResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VerifySoftwareTokenResponse.Builder

Method Summary

Modifier and Type	Method	Description
static VerifySoftwareTokenResponse.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends VerifySoftwareTokenResponse.Builder>	serializableBuilderClass()
final String	session()	This session ID satisfies an MFA_SETUP challenge.
final VerifySoftwareTokenResponseType	status()	Amazon Cognito can accept or reject the code that you provide.
final String	statusAsString()	Amazon Cognito can accept or reject the code that you provide.
VerifySoftwareTokenResponse.Builder	toBuilder()
final 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 Details

status

public final VerifySoftwareTokenResponseType status()

Amazon Cognito can accept or reject the code that you provide. This response parameter indicates the success of TOTP verification. Some reasons that this operation might return an error are clock skew on the user's device and excessive retries.

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

Returns:

Amazon Cognito can accept or reject the code that you provide. This response parameter indicates the success of TOTP verification. Some reasons that this operation might return an error are clock skew on the user's device and excessive retries.

See Also:

• VerifySoftwareTokenResponseType

statusAsString

public final String statusAsString()

Amazon Cognito can accept or reject the code that you provide. This response parameter indicates the success of TOTP verification. Some reasons that this operation might return an error are clock skew on the user's device and excessive retries.

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

Returns:

Amazon Cognito can accept or reject the code that you provide. This response parameter indicates the success of TOTP verification. Some reasons that this operation might return an error are clock skew on the user's device and excessive retries.

See Also:

• VerifySoftwareTokenResponseType

session

public final String session()

This session ID satisfies an MFA_SETUP challenge. Supply the session ID in your challenge response.

Returns:

This session ID satisfies an MFA_SETUP challenge. Supply the session ID in your challenge response.

toBuilder

public VerifySoftwareTokenResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VerifySoftwareTokenResponse.Builder,VerifySoftwareTokenResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static VerifySoftwareTokenResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo