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

Interface ConfirmDeviceResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<ConfirmDeviceResponse.Builder,ConfirmDeviceResponse>, SdkBuilder<ConfirmDeviceResponse.Builder,ConfirmDeviceResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ConfirmDeviceResponse

public static interface ConfirmDeviceResponse.Builder
extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<ConfirmDeviceResponse.Builder,ConfirmDeviceResponse>

Method Summary

Modifier and Type	Method	Description
ConfirmDeviceResponse.Builder	userConfirmationNecessary(Boolean userConfirmationNecessary)	When true, your user must confirm that they want to remember the device.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

userConfirmationNecessary

ConfirmDeviceResponse.Builder userConfirmationNecessary(Boolean userConfirmationNecessary)

When true, your user must confirm that they want to remember the device. Prompt the user for an answer. You must then make an UpdateUserDevice request that sets the device to remembered or not_remembered.

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. You can also configure this option with the DeviceConfiguration parameter of a CreateUserPool or UpdateUserPool request.

Parameters:

userConfirmationNecessary - When true, your user must confirm that they want to remember the device. Prompt the user for an answer. You must then make an UpdateUserDevice request that sets the device to remembered or not_remembered.

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. You can also configure this option with the DeviceConfiguration parameter of a CreateUserPool or UpdateUserPool request.

Returns:

Returns a reference to this object so that method calls can be chained together.