Class: Aws::CognitoIdentityProvider::Types::ConfirmSignUpResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the response from the server for the registration confirmation.

See Also:

Constant Summary collapse

SENSITIVE = 
[:session]

Instance Attribute Summary collapse

Instance Attribute Details

#session ⇒ String

A session identifier that you can use to immediately sign in the confirmed user. You can automatically sign users in with the one-time password that they provided in a successful ‘ConfirmSignUp` request. To do this, pass the `Session` parameter from this response in the `Session` parameter of an [InitiateAuth] or

AdminInitiateAuth][2

request.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html

Returns:

  • (String) 


3472
3473
3474
3475
3476
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3472

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