com.amazonaws.services.cognitoidentityprovider.model

Class ForgotPasswordRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.ForgotPasswordRequest

All Implemented Interfaces:

Serializable, Cloneable

public class ForgotPasswordRequest
extends AmazonWebServiceRequest
implements Serializable

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ForgotPasswordRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AnalyticsMetadataType	getAnalyticsMetadata() The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
String	getClientId() The ID of the client associated with the user pool.
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 reset a forgotten password.
int	hashCode()
void	setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
void	setClientId(String clientId) The ID of the client associated with the user pool.
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 reset a forgotten password.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ForgotPasswordRequest	withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
ForgotPasswordRequest	withClientId(String clientId) The ID of the client associated with the user pool.
ForgotPasswordRequest	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.
ForgotPasswordRequest	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.
ForgotPasswordRequest	withUsername(String username) The user name of the user for whom you want to enter a code to reset a forgotten password.

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

ForgotPasswordRequest

public ForgotPasswordRequest()

Method Detail

getClientId

public String getClientId()

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Returns:

The ID of the client associated with the user pool.

setClientId

public void setClientId(String clientId)

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The ID of the client associated with the user pool.

withClientId

public ForgotPasswordRequest withClientId(String clientId)

The ID of the client associated with the user pool.

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

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The ID of the client associated with the user pool.

Returns:

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

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.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

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.

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.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

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.

withSecretHash

public ForgotPasswordRequest 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.

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

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

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:

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

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.

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.

withUserContextData

public ForgotPasswordRequest 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.

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

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:

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

getUsername

public String getUsername()

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

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

setUsername

public void setUsername(String username)

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

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

withUsername

public ForgotPasswordRequest withUsername(String username)

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

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

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

Returns:

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

getAnalyticsMetadata

public AnalyticsMetadataType getAnalyticsMetadata()

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

Returns:

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

setAnalyticsMetadata

public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

Parameters:

analyticsMetadata -

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

withAnalyticsMetadata

public ForgotPasswordRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

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

Parameters:

analyticsMetadata -

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

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