com.amazonaws.services.cognitoidp.model

Class ConfirmForgotPasswordRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConfirmForgotPasswordRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The request representing the confirmation for a password reset.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ConfirmForgotPasswordRequest()

Method Summary

Modifier and Type	Method and Description
ConfirmForgotPasswordRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AnalyticsMetadataType	getAnalyticsMetadata() The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
String	getClientId() The app client ID of the app associated with the user pool.
String	getConfirmationCode() The confirmation code sent by a user's request to retrieve a forgotten password.
String	getPassword() The password sent by a user's request to retrieve a forgotten password.
String	getSecretHash() A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
UserContextDataType	getUserContextData() Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
String	getUsername() The user name of the user for whom you want to enter a code to retrieve a forgotten password.
int	hashCode()
void	setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
void	setClientId(String clientId) The app client ID of the app associated with the user pool.
void	setConfirmationCode(String confirmationCode) The confirmation code sent by a user's request to retrieve a forgotten password.
void	setPassword(String password) The password sent by a user's request to retrieve a forgotten password.
void	setSecretHash(String secretHash) A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
void	setUserContextData(UserContextDataType userContextData) Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
void	setUsername(String username) The user name of the user for whom you want to enter a code to retrieve a forgotten password.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ConfirmForgotPasswordRequest	withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
ConfirmForgotPasswordRequest	withClientId(String clientId) The app client ID of the app associated with the user pool.
ConfirmForgotPasswordRequest	withConfirmationCode(String confirmationCode) The confirmation code sent by a user's request to retrieve a forgotten password.
ConfirmForgotPasswordRequest	withPassword(String password) The password sent by a user's request to retrieve a forgotten password.
ConfirmForgotPasswordRequest	withSecretHash(String secretHash) A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
ConfirmForgotPasswordRequest	withUserContextData(UserContextDataType userContextData) Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
ConfirmForgotPasswordRequest	withUsername(String username) The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfirmForgotPasswordRequest

public ConfirmForgotPasswordRequest()

Method Detail

setClientId

public void setClientId(String clientId)

The app client ID of the app associated with the user pool.

Parameters:

clientId - The app client ID of the app associated with the user pool.

getClientId

public String getClientId()

The app client ID of the app associated with the user pool.

Returns:

The app client ID of the app associated with the user pool.

withClientId

public ConfirmForgotPasswordRequest withClientId(String clientId)

The app client ID of the app associated with the user pool.

Parameters:

clientId - The app client ID of the app associated with the user pool.

Returns:

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

setSecretHash

public void setSecretHash(String secretHash)

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Parameters:

secretHash - A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

getSecretHash

public String getSecretHash()

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Returns:

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

withSecretHash

public ConfirmForgotPasswordRequest withSecretHash(String secretHash)

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Parameters:

secretHash - A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Returns:

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

setUsername

public void setUsername(String username)

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Parameters:

username - The user name of the user for whom you want to enter a code to retrieve a forgotten password.

getUsername

public String getUsername()

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Returns:

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

withUsername

public ConfirmForgotPasswordRequest withUsername(String username)

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Parameters:

username - The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Returns:

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

setConfirmationCode

public void setConfirmationCode(String confirmationCode)

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

Parameters:

confirmationCode - The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

getConfirmationCode

public String getConfirmationCode()

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

Returns:

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

withConfirmationCode

public ConfirmForgotPasswordRequest withConfirmationCode(String confirmationCode)

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

Parameters:

confirmationCode - The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

Returns:

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

setPassword

public void setPassword(String password)

The password sent by a user's request to retrieve a forgotten password.

Parameters:

password - The password sent by a user's request to retrieve a forgotten password.

getPassword

public String getPassword()

The password sent by a user's request to retrieve a forgotten password.

Returns:

The password sent by a user's request to retrieve a forgotten password.

withPassword

public ConfirmForgotPasswordRequest withPassword(String password)

The password sent by a user's request to retrieve a forgotten password.

Parameters:

password - The password sent by a user's request to retrieve a forgotten password.

Returns:

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

setAnalyticsMetadata

public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

Parameters:

analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

getAnalyticsMetadata

public AnalyticsMetadataType getAnalyticsMetadata()

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

Returns:

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

withAnalyticsMetadata

public ConfirmForgotPasswordRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

Parameters:

analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

Returns:

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

setUserContextData

public void setUserContextData(UserContextDataType userContextData)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Parameters:

userContextData - Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

getUserContextData

public UserContextDataType getUserContextData()

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

withUserContextData

public ConfirmForgotPasswordRequest withUserContextData(UserContextDataType userContextData)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Parameters:

userContextData - Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ConfirmForgotPasswordRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()