com.amazonaws.services.cognitoidentityprovider.model

Class VerifySoftwareTokenRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.VerifySoftwareTokenRequest

All Implemented Interfaces:

Serializable, Cloneable

public class VerifySoftwareTokenRequest
extends AmazonWebServiceRequest
implements Serializable

Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VerifySoftwareTokenRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccessToken() The access token.
String	getFriendlyDeviceName() The friendly device name.
String	getSession() The session which should be passed both ways in challenge-response calls to the service.
String	getUserCode() The one time password computed using the secret code returned by
int	hashCode()
void	setAccessToken(String accessToken) The access token.
void	setFriendlyDeviceName(String friendlyDeviceName) The friendly device name.
void	setSession(String session) The session which should be passed both ways in challenge-response calls to the service.
void	setUserCode(String userCode) The one time password computed using the secret code returned by
String	toString() Returns a string representation of this object; useful for testing and debugging.
VerifySoftwareTokenRequest	withAccessToken(String accessToken) The access token.
VerifySoftwareTokenRequest	withFriendlyDeviceName(String friendlyDeviceName) The friendly device name.
VerifySoftwareTokenRequest	withSession(String session) The session which should be passed both ways in challenge-response calls to the service.
VerifySoftwareTokenRequest	withUserCode(String userCode) The one time password computed using the secret code returned by

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

VerifySoftwareTokenRequest

public VerifySoftwareTokenRequest()

Method Detail

getAccessToken

public String getAccessToken()

The access token.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Returns:

The access token.

setAccessToken

public void setAccessToken(String accessToken)

The access token.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

The access token.

withAccessToken

public VerifySoftwareTokenRequest withAccessToken(String accessToken)

The access token.

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

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

The access token.

Returns:

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

getSession

public String getSession()

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

Constraints:
Length: 20 - 2048

Returns:

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

setSession

public void setSession(String session)

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

Constraints:
Length: 20 - 2048

Parameters:

session -

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

withSession

public VerifySoftwareTokenRequest withSession(String session)

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

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

Constraints:
Length: 20 - 2048

Parameters:

session -

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

Returns:

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

getUserCode

public String getUserCode()

The one time password computed using the secret code returned by

Constraints:
Length: 6 - 6
Pattern: [0-9]+

Returns:

The one time password computed using the secret code returned by

setUserCode

public void setUserCode(String userCode)

The one time password computed using the secret code returned by

Constraints:
Length: 6 - 6
Pattern: [0-9]+

Parameters:

userCode -

The one time password computed using the secret code returned by

withUserCode

public VerifySoftwareTokenRequest withUserCode(String userCode)

The one time password computed using the secret code returned by

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

Constraints:
Length: 6 - 6
Pattern: [0-9]+

Parameters:

userCode -

The one time password computed using the secret code returned by

Returns:

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

getFriendlyDeviceName

public String getFriendlyDeviceName()

The friendly device name.

Returns:

The friendly device name.

setFriendlyDeviceName

public void setFriendlyDeviceName(String friendlyDeviceName)

The friendly device name.

Parameters:

friendlyDeviceName -

The friendly device name.

withFriendlyDeviceName

public VerifySoftwareTokenRequest withFriendlyDeviceName(String friendlyDeviceName)

The friendly device name.

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

Parameters:

friendlyDeviceName -

The friendly device name.

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