com.amazonaws.services.cognitoidentityprovider.model

Class AdminSetUserPasswordRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserPasswordRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AdminSetUserPasswordRequest
extends AmazonWebServiceRequest
implements Serializable

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

The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator.

Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminSetUserPasswordRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getPassword() The password for the user.
Boolean	getPermanent() True if the password is permanent, False if it is temporary.
String	getUsername() The user name of the user whose password you wish to set.
String	getUserPoolId() The user pool ID for the user pool where you want to set the user's password.
int	hashCode()
Boolean	isPermanent() True if the password is permanent, False if it is temporary.
void	setPassword(String password) The password for the user.
void	setPermanent(Boolean permanent) True if the password is permanent, False if it is temporary.
void	setUsername(String username) The user name of the user whose password you wish to set.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool where you want to set the user's password.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminSetUserPasswordRequest	withPassword(String password) The password for the user.
AdminSetUserPasswordRequest	withPermanent(Boolean permanent) True if the password is permanent, False if it is temporary.
AdminSetUserPasswordRequest	withUsername(String username) The user name of the user whose password you wish to set.
AdminSetUserPasswordRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool where you want to set 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

AdminSetUserPasswordRequest

public AdminSetUserPasswordRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

The user pool ID for the user pool where you want to set 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 set the user's password.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool where you want to set 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 set the user's password.

withUserPoolId

public AdminSetUserPasswordRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool where you want to set 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 set 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 set.

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 set.

setUsername

public void setUsername(String username)

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

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 set.

withUsername

public AdminSetUserPasswordRequest withUsername(String username)

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

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 set.

Returns:

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

getPassword

public String getPassword()

The password for the user.

Constraints:
Length: 6 - 256
Pattern: [\S]+

Returns:

The password for the user.

setPassword

public void setPassword(String password)

The password for the user.

Constraints:
Length: 6 - 256
Pattern: [\S]+

Parameters:

password -

The password for the user.

withPassword

public AdminSetUserPasswordRequest withPassword(String password)

The password for the user.

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

Constraints:
Length: 6 - 256
Pattern: [\S]+

Parameters:

password -

The password for the user.

Returns:

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

isPermanent

public Boolean isPermanent()

True if the password is permanent, False if it is temporary.

Returns:

True if the password is permanent, False if it is temporary.

getPermanent

public Boolean getPermanent()

True if the password is permanent, False if it is temporary.

Returns:

True if the password is permanent, False if it is temporary.

setPermanent

public void setPermanent(Boolean permanent)

True if the password is permanent, False if it is temporary.

Parameters:

permanent -

True if the password is permanent, False if it is temporary.

withPermanent

public AdminSetUserPasswordRequest withPermanent(Boolean permanent)

True if the password is permanent, False if it is temporary.

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

Parameters:

permanent -

True if the password is permanent, False if it is temporary.

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