com.amazonaws.services.cognitoidentityprovider.model

Class ChangePasswordRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.ChangePasswordRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ChangePasswordRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Changes the password for a specified user in a user pool.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChangePasswordRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccessToken() A valid access token that Amazon Cognito issued to the user whose password you want to change.
java.lang.String	getPreviousPassword() The old password.
java.lang.String	getProposedPassword() The new password.
int	hashCode()
void	setAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose password you want to change.
void	setPreviousPassword(java.lang.String previousPassword) The old password.
void	setProposedPassword(java.lang.String proposedPassword) The new password.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ChangePasswordRequest	withAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose password you want to change.
ChangePasswordRequest	withPreviousPassword(java.lang.String previousPassword) The old password.
ChangePasswordRequest	withProposedPassword(java.lang.String proposedPassword) The new 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

ChangePasswordRequest

public ChangePasswordRequest()

Method Detail

getPreviousPassword

public java.lang.String getPreviousPassword()

The old password.

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

Returns:

The old password.

setPreviousPassword

public void setPreviousPassword(java.lang.String previousPassword)

The old password.

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

Parameters:

previousPassword -

The old password.

withPreviousPassword

public ChangePasswordRequest withPreviousPassword(java.lang.String previousPassword)

The old password.

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

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

Parameters:

previousPassword -

The old password.

Returns:

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

getProposedPassword

public java.lang.String getProposedPassword()

The new password.

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

Returns:

The new password.

setProposedPassword

public void setProposedPassword(java.lang.String proposedPassword)

The new password.

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

Parameters:

proposedPassword -

The new password.

withProposedPassword

public ChangePasswordRequest withProposedPassword(java.lang.String proposedPassword)

The new password.

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

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

Parameters:

proposedPassword -

The new password.

Returns:

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

getAccessToken

public java.lang.String getAccessToken()

A valid access token that Amazon Cognito issued to the user whose password you want to change.

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

Returns:

A valid access token that Amazon Cognito issued to the user whose password you want to change.

setAccessToken

public void setAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose password you want to change.

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

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose password you want to change.

withAccessToken

public ChangePasswordRequest withAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose password you want to change.

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

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

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose password you want to change.

Returns:

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

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object