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

Class VerifySoftwareTokenRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<VerifySoftwareTokenRequest.Builder,VerifySoftwareTokenRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VerifySoftwareTokenRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessToken()	A valid access token that Amazon Cognito issued to the currently signed-in user.
static VerifySoftwareTokenRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	friendlyDeviceName()	A friendly name for the device that's running the TOTP authenticator.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VerifySoftwareTokenRequest.Builder>	serializableBuilderClass()
String	session()	The session ID from an AssociateSoftwareToken request.
VerifySoftwareTokenRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userCode()	A TOTP that the user generated in their configured authenticator app.

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

overrideConfiguration

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

accessToken

public final String accessToken()

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Returns:

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

session

public final String session()

The session ID from an AssociateSoftwareToken request.

Returns:

The session ID from an AssociateSoftwareToken request.

userCode

public final String userCode()

A TOTP that the user generated in their configured authenticator app.

Returns:

A TOTP that the user generated in their configured authenticator app.

friendlyDeviceName

public final String friendlyDeviceName()

A friendly name for the device that's running the TOTP authenticator.

Returns:

A friendly name for the device that's running the TOTP authenticator.

toBuilder

public VerifySoftwareTokenRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VerifySoftwareTokenRequest.Builder,VerifySoftwareTokenRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static VerifySoftwareTokenRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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