ConfirmForgotPasswordRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class ConfirmForgotPasswordRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
The request representing the confirmation for a password reset.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ConfirmForgotPasswordRequest()

Constructors
Constructor and Description
`ConfirmForgotPasswordRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfirmForgotPasswordRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`String`	`getClientId()` The ID of the client associated with the user pool.
`String`	`getConfirmationCode()` The confirmation code sent by a user's request to retrieve a forgotten password.
`String`	`getPassword()` The password sent by sent by a user's request to retrieve a forgotten password.
`String`	`getSecretHash()` 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.
`String`	`getUsername()` The user name of the user for whom you want to enter a code to retrieve a forgotten password.
`int`	`hashCode()`
`void`	`setClientId(String clientId)` The ID of the client associated with the user pool.
`void`	`setConfirmationCode(String confirmationCode)` The confirmation code sent by a user's request to retrieve a forgotten password.
`void`	`setPassword(String password)` The password sent by sent by a user's request to retrieve a forgotten password.
`void`	`setSecretHash(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.
`void`	`setUsername(String username)` The user name of the user for whom you want to enter a code to retrieve a forgotten password.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ConfirmForgotPasswordRequest`	`withClientId(String clientId)` The ID of the client associated with the user pool.
`ConfirmForgotPasswordRequest`	`withConfirmationCode(String confirmationCode)` The confirmation code sent by a user's request to retrieve a forgotten password.
`ConfirmForgotPasswordRequest`	`withPassword(String password)` The password sent by sent by a user's request to retrieve a forgotten password.
`ConfirmForgotPasswordRequest`	`withSecretHash(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.
`ConfirmForgotPasswordRequest`	`withUsername(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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConfirmForgotPasswordRequest
```
public ConfirmForgotPasswordRequest()
```
- Method Detail
  - setClientId
```
public void setClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Parameters:
    
    clientId - The ID of the client associated with the user pool.
  - getClientId
```
public String getClientId()
```
    The ID of the client associated with the user pool.
    
    Returns:
    
    The ID of the client associated with the user pool.
  - withClientId
```
public ConfirmForgotPasswordRequest withClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Parameters:
    
    clientId - The ID of the client associated with the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretHash
```
public void setSecretHash(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.
    
    Parameters:
    
    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.
  - getSecretHash
```
public String getSecretHash()
```
    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.
  - withSecretHash
```
public ConfirmForgotPasswordRequest withSecretHash(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    The user name of the user for whom you want to enter a code to retrieve a forgotten password.
    
    Parameters:
    
    username - The user name of the user for whom you want to enter a code to retrieve a forgotten password.
  - getUsername
```
public String getUsername()
```
    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.
  - withUsername
```
public ConfirmForgotPasswordRequest withUsername(String username)
```
    The user name of the user for whom you want to enter a code to retrieve a forgotten password.
    
    Parameters:
    
    username - The user name of the user for whom you want to enter a code to retrieve a forgotten password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfirmationCode
```
public void setConfirmationCode(String confirmationCode)
```
    The confirmation code sent by a user's request to retrieve a forgotten password.
    
    Parameters:
    
    confirmationCode - The confirmation code sent by a user's request to retrieve a forgotten password.
  - getConfirmationCode
```
public String getConfirmationCode()
```
    The confirmation code sent by a user's request to retrieve a forgotten password.
    
    Returns:
    
    The confirmation code sent by a user's request to retrieve a forgotten password.
  - withConfirmationCode
```
public ConfirmForgotPasswordRequest withConfirmationCode(String confirmationCode)
```
    The confirmation code sent by a user's request to retrieve a forgotten password.
    
    Parameters:
    
    confirmationCode - The confirmation code sent by a user's request to retrieve a forgotten password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassword
```
public void setPassword(String password)
```
    The password sent by sent by a user's request to retrieve a forgotten password.
    
    Parameters:
    
    password - The password sent by sent by a user's request to retrieve a forgotten password.
  - getPassword
```
public String getPassword()
```
    The password sent by sent by a user's request to retrieve a forgotten password.
    
    Returns:
    
    The password sent by sent by a user's request to retrieve a forgotten password.
  - withPassword
```
public ConfirmForgotPasswordRequest withPassword(String password)
```
    The password sent by sent by a user's request to retrieve a forgotten password.
    
    Parameters:
    
    password - The password sent by sent by a user's request to retrieve a forgotten password.
    
    Returns:
    
    Returns a reference to this 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConfirmForgotPasswordRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class ConfirmForgotPasswordRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ConfirmForgotPasswordRequest

Method Detail

setClientId

getClientId

withClientId

setSecretHash

getSecretHash

withSecretHash

setUsername

getUsername

withUsername

setConfirmationCode

getConfirmationCode

withConfirmationCode

setPassword

getPassword

withPassword

toString

equals

hashCode

clone