Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class ConfirmForgotPasswordRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.ConfirmForgotPasswordRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>

@Generated("software.amazon.awssdk:codegen")
public class ConfirmForgotPasswordRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>

The request representing the confirmation for a password reset.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfirmForgotPasswordRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static ConfirmForgotPasswordRequest.Builder	builder()
String	clientId()	The ID of the client associated with the user pool.
String	confirmationCode()	The confirmation code sent by a user's request to retrieve a forgotten password.
boolean	equals(Object obj)
int	hashCode()
String	password()	The password sent by a user's request to retrieve a forgotten password.
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.
static Class<? extends ConfirmForgotPasswordRequest.Builder>	serializableBuilderClass()
ConfirmForgotPasswordRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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 software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

clientId

public String clientId()

The ID of the client associated with the user pool.

Returns:

The ID of the client associated with the user pool.

secretHash

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

username

public String username()

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.

confirmationCode

public String confirmationCode()

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

Returns:

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

password

public String password()

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.

toBuilder

public ConfirmForgotPasswordRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>

Returns:

a builder for type T

builder

public static ConfirmForgotPasswordRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ConfirmForgotPasswordRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object