com.amazonaws.services.cognitoidentityprovider.model

Class AdminInitiateAuthResult

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.AdminInitiateAuthResult

All Implemented Interfaces:

Serializable

public class AdminInitiateAuthResult
extends Object
implements Serializable

Initiates the authentication response, as an administrator.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminInitiateAuthResult()

Method Summary

Modifier and Type	Method and Description
AdminInitiateAuthResult	addChallengeParametersEntry(String key, String value) The challenge parameters.
AdminInitiateAuthResult	clearChallengeParametersEntries() Removes all the entries added into ChallengeParameters.
boolean	equals(Object obj)
AuthenticationResultType	getAuthenticationResult() The result type of the authentication result.
String	getChallengeName() The name of the challenge.
Map<String,String>	getChallengeParameters() The challenge parameters.
String	getSession() The session.
int	hashCode()
void	setAuthenticationResult(AuthenticationResultType authenticationResult) The result type of the authentication result.
void	setChallengeName(ChallengeNameType challengeName) The name of the challenge.
void	setChallengeName(String challengeName) The name of the challenge.
void	setChallengeParameters(Map<String,String> challengeParameters) The challenge parameters.
void	setSession(String session) The session.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminInitiateAuthResult	withAuthenticationResult(AuthenticationResultType authenticationResult) The result type of the authentication result.
AdminInitiateAuthResult	withChallengeName(ChallengeNameType challengeName) The name of the challenge.
AdminInitiateAuthResult	withChallengeName(String challengeName) The name of the challenge.
AdminInitiateAuthResult	withChallengeParameters(Map<String,String> challengeParameters) The challenge parameters.
AdminInitiateAuthResult	withSession(String session) The session.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminInitiateAuthResult

public AdminInitiateAuthResult()

Method Detail

getChallengeName

public String getChallengeName()

The name of the challenge.

Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Returns:

The name of the challenge.

See Also:

ChallengeNameType

setChallengeName

public void setChallengeName(String challengeName)

The name of the challenge.

Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Parameters:

challengeName -

The name of the challenge.

See Also:

ChallengeNameType

withChallengeName

public AdminInitiateAuthResult withChallengeName(String challengeName)

The name of the challenge.

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

Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Parameters:

challengeName -

The name of the challenge.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ChallengeNameType

setChallengeName

public void setChallengeName(ChallengeNameType challengeName)

The name of the challenge.

Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Parameters:

challengeName -

The name of the challenge.

See Also:

ChallengeNameType

withChallengeName

public AdminInitiateAuthResult withChallengeName(ChallengeNameType challengeName)

The name of the challenge.

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

Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Parameters:

challengeName -

The name of the challenge.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ChallengeNameType

getSession

public String getSession()

The session.

Constraints:
Length: 20 - 2048

Returns:

The session.

setSession

public void setSession(String session)

The session.

Constraints:
Length: 20 - 2048

Parameters:

session -

The session.

withSession

public AdminInitiateAuthResult withSession(String session)

The session.

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

Constraints:
Length: 20 - 2048

Parameters:

session -

The session.

Returns:

A reference to this updated object so that method calls can be chained together.

getChallengeParameters

public Map<String,String> getChallengeParameters()

The challenge parameters.

Returns:

The challenge parameters.

setChallengeParameters

public void setChallengeParameters(Map<String,String> challengeParameters)

The challenge parameters.

Parameters:

challengeParameters -

The challenge parameters.

withChallengeParameters

public AdminInitiateAuthResult withChallengeParameters(Map<String,String> challengeParameters)

The challenge parameters.

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

Parameters:

challengeParameters -

The challenge parameters.

Returns:

A reference to this updated object so that method calls can be chained together.

addChallengeParametersEntry

public AdminInitiateAuthResult addChallengeParametersEntry(String key,
                                                           String value)

The challenge parameters.

The method adds a new key-value pair into ChallengeParameters parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into ChallengeParameters.

value - The corresponding value of the entry to be added into ChallengeParameters.

Returns:

A reference to this updated object so that method calls can be chained together.

clearChallengeParametersEntries

public AdminInitiateAuthResult clearChallengeParametersEntries()

Removes all the entries added into ChallengeParameters.

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

getAuthenticationResult

public AuthenticationResultType getAuthenticationResult()

The result type of the authentication result.

Returns:

The result type of the authentication result.

setAuthenticationResult

public void setAuthenticationResult(AuthenticationResultType authenticationResult)

The result type of the authentication result.

Parameters:

authenticationResult -

The result type of the authentication result.

withAuthenticationResult

public AdminInitiateAuthResult withAuthenticationResult(AuthenticationResultType authenticationResult)

The result type of the authentication result.

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

Parameters:

authenticationResult -

The result type of the authentication result.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object