Class: Aws::CognitoIdentityProvider::Types::RespondToAuthChallengeResponse

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::RespondToAuthChallengeResponse

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The response to respond to the authentication challenge.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:session]

Instance Attribute Summary

• #authentication_result ⇒ Types::AuthenticationResultType

  The result returned by the server in response to the request to respond to the authentication challenge.

• #challenge_name ⇒ String

  The challenge name.

• #challenge_parameters ⇒ Hash<String,String>

  The challenge parameters.

• #session ⇒ String

  The session that should be passed both ways in challenge-response calls to the service.

Instance Attribute Details

#authentication_result ⇒ Types::AuthenticationResultType

The result returned by the server in response to the request to respond to the authentication challenge.

Returns:

• (Types::AuthenticationResultType)

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

class RespondToAuthChallengeResponse < Struct.new(
  :challenge_name,
  :session,
  :challenge_parameters,
  :authentication_result)
  SENSITIVE = [:session]
  include Aws::Structure
end

#challenge_name ⇒ String

The challenge name. For more information, see [InitiateAuth].

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

Returns:

• (String)

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

class RespondToAuthChallengeResponse < Struct.new(
  :challenge_name,
  :session,
  :challenge_parameters,
  :authentication_result)
  SENSITIVE = [:session]
  include Aws::Structure
end

#challenge_parameters ⇒ Hash<String,String>

The challenge parameters. For more information, see [InitiateAuth].

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

Returns:

• (Hash<String,String>)

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

class RespondToAuthChallengeResponse < Struct.new(
  :challenge_name,
  :session,
  :challenge_parameters,
  :authentication_result)
  SENSITIVE = [:session]
  include Aws::Structure
end

#session ⇒ String

The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next ‘RespondToAuthChallenge` API call.

Returns:

• (String)

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

class RespondToAuthChallengeResponse < Struct.new(
  :challenge_name,
  :session,
  :challenge_parameters,
  :authentication_result)
  SENSITIVE = [:session]
  include Aws::Structure
end