com.amazonaws.services.cognitoidentityprovider.model

Class AdminResetUserPasswordRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminResetUserPasswordRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AdminResetUserPasswordRequest
extends AmazonWebServiceRequest
implements Serializable

Resets the specified user's password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Requires developer credentials.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminResetUserPasswordRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getUsername() The user name of the user whose password you wish to reset.
String	getUserPoolId() The user pool ID for the user pool where you want to reset the user's password.
int	hashCode()
void	setUsername(String username) The user name of the user whose password you wish to reset.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool where you want to reset the user's password.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminResetUserPasswordRequest	withUsername(String username) The user name of the user whose password you wish to reset.
AdminResetUserPasswordRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool where you want to reset the user's 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

AdminResetUserPasswordRequest

public AdminResetUserPasswordRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

The user pool ID for the user pool where you want to reset the user's password.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID for the user pool where you want to reset the user's password.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool where you want to reset the user's password.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool where you want to reset the user's password.

withUserPoolId

public AdminResetUserPasswordRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool where you want to reset the user's password.

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool where you want to reset the user's password.

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 whose password you wish to reset.

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

Returns:

The user name of the user whose password you wish to reset.

setUsername

public void setUsername(String username)

The user name of the user whose password you wish to reset.

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

Parameters:

username -

The user name of the user whose password you wish to reset.

withUsername

public AdminResetUserPasswordRequest withUsername(String username)

The user name of the user whose password you wish to reset.

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 whose password you wish to reset.

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