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

Class ForgotPasswordRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.ForgotPasswordRequest

All Implemented Interfaces:

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

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

Represents the request to reset a user's password.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForgotPasswordRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static ForgotPasswordRequest.Builder	builder()
String	clientId()	The ID of the client associated with the user pool.
boolean	equals(Object obj)
int	hashCode()
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 ForgotPasswordRequest.Builder>	serializableBuilderClass()
ForgotPasswordRequest.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 reset 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 reset a forgotten password.

Returns:

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

toBuilder

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

Returns:

a builder for type T

builder

public static ForgotPasswordRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ForgotPasswordRequest.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