You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

The response to respond to the authentication challenge.

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_resultTypes::AuthenticationResultType

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



4459
4460
4461
4462
4463
4464
4465
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4459

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

#challenge_nameString

The challenge name. For more information, see InitiateAuth.

Returns:

  • (String)


4459
4460
4461
4462
4463
4464
4465
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4459

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

#challenge_parametersHash<String,String>

The challenge parameters. For more information, see InitiateAuth.

Returns:

  • (Hash<String,String>)


4459
4460
4461
4462
4463
4464
4465
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4459

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

#sessionString

The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through 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)


4459
4460
4461
4462
4463
4464
4465
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4459

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