Class: Aws::CognitoIdentityProvider::Types::ConfirmDeviceResponse

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::ConfirmDeviceResponse

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The confirm-device response.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #user_confirmation_necessary ⇒ Boolean

  When ‘true`, your user must confirm that they want to remember the device.

Instance Attribute Details

#user_confirmation_necessary ⇒ Boolean

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][1

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.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html#CognitoUserPools-CreateUserPool-request-DeviceConfiguration [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [4]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3191

class ConfirmDeviceResponse < Struct.new(
  :user_confirmation_necessary)
  SENSITIVE = []
  include Aws::Structure
end