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

Class ConfirmDeviceResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ConfirmDeviceResponse.Builder,ConfirmDeviceResponse>

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

The confirm-device response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfirmDeviceResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ConfirmDeviceResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ConfirmDeviceResponse.Builder>	serializableBuilderClass()
ConfirmDeviceResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	userConfirmationNecessary()	When true, your user must confirm that they want to remember the device.

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

userConfirmationNecessary

public final Boolean userConfirmationNecessary()

When true, your user must confirm that they want to remember the device. Prompt the user for an answer.

When false, immediately sets the device as remembered and eligible for device authentication.

You can configure your user pool to always remember devices, in which case this response is false, or to allow users to opt in, in which case this response is true. Configure this option under Device tracking in the Sign-in menu of your user pool.

Returns:

When true, your user must confirm that they want to remember the device. Prompt the user for an answer.

When false, immediately sets the device as remembered and eligible for device authentication.

You can configure your user pool to always remember devices, in which case this response is false, or to allow users to opt in, in which case this response is true. Configure this option under Device tracking in the Sign-in menu of your user pool.

toBuilder

public ConfirmDeviceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfirmDeviceResponse.Builder,ConfirmDeviceResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ConfirmDeviceResponse.Builder builder()

serializableBuilderClass

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