ForgotPasswordRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.ForgotPasswordRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ForgotPasswordRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. To use the confirmation code for resetting the password, call ConfirmForgotPassword.

If neither a verified phone number nor a verified email exists, this API returns InvalidParameterException. If your app client has a client secret and you don't provide a SECRET_HASH parameter, this API returns NotAuthorizedException.

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.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ForgotPasswordRequest()

Constructors
Constructor and Description
`ForgotPasswordRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ForgotPasswordRequest`	`addClientMetadataEntry(java.lang.String key, java.lang.String value)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`ForgotPasswordRequest`	`clearClientMetadataEntries()` Removes all the entries added into ClientMetadata.
`boolean`	`equals(java.lang.Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The Amazon Pinpoint analytics metadata that contributes to your metrics for `ForgotPassword` calls.
`java.lang.String`	`getClientId()` The ID of the client associated with the user pool.
`java.util.Map<java.lang.String,java.lang.String>`	`getClientMetadata()` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`java.lang.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.
`UserContextDataType`	`getUserContextData()` Contextual data about your user session, such as the device fingerprint, IP address, or location.
`java.lang.String`	`getUsername()` The user name of the user for whom you want to enter a code to reset a forgotten password.
`int`	`hashCode()`
`void`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The Amazon Pinpoint analytics metadata that contributes to your metrics for `ForgotPassword` calls.
`void`	`setClientId(java.lang.String clientId)` The ID of the client associated with the user pool.
`void`	`setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`void`	`setSecretHash(java.lang.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`	`setUserContextData(UserContextDataType userContextData)` Contextual data about your user session, such as the device fingerprint, IP address, or location.
`void`	`setUsername(java.lang.String username)` The user name of the user for whom you want to enter a code to reset a forgotten password.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ForgotPasswordRequest`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The Amazon Pinpoint analytics metadata that contributes to your metrics for `ForgotPassword` calls.
`ForgotPasswordRequest`	`withClientId(java.lang.String clientId)` The ID of the client associated with the user pool.
`ForgotPasswordRequest`	`withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`ForgotPasswordRequest`	`withSecretHash(java.lang.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.
`ForgotPasswordRequest`	`withUserContextData(UserContextDataType userContextData)` Contextual data about your user session, such as the device fingerprint, IP address, or location.
`ForgotPasswordRequest`	`withUsername(java.lang.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 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
  - ForgotPasswordRequest
```
public ForgotPasswordRequest()
```
- Method Detail
  - getClientId
```
public java.lang.String getClientId()
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The ID of the client associated with the user pool.
  - setClientId
```
public void setClientId(java.lang.String clientId)
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
  - withClientId
```
public ForgotPasswordRequest withClientId(java.lang.String clientId)
```
    The ID of the client associated with the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSecretHash
```
public java.lang.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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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.
  - setSecretHash
```
public void setSecretHash(java.lang.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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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.
  - withSecretHash
```
public ForgotPasswordRequest withSecretHash(java.lang.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 reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserContextData
```
public UserContextDataType getUserContextData()
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns:
    
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
  - setUserContextData
```
public void setUserContextData(UserContextDataType userContextData)
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Parameters:
    
    userContextData -
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
  - withUserContextData
```
public ForgotPasswordRequest withUserContextData(UserContextDataType userContextData)
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userContextData -
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsername
```
public java.lang.String getUsername()
```
    The user name of the user for whom you want to enter a code to reset a forgotten password.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The user name of the user for whom you want to enter a code to reset a forgotten password.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    The user name of the user for whom you want to enter a code to reset a forgotten password.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user for whom you want to enter a code to reset a forgotten password.
  - withUsername
```
public ForgotPasswordRequest withUsername(java.lang.String username)
```
    The user name of the user for whom you want to enter a code to reset a forgotten password.
    
    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 for whom you want to enter a code to reset a forgotten password.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
    
    Returns:
    
    The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
    
    Parameters:
    
    analyticsMetadata -
    The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
  - withAnalyticsMetadata
```
public ForgotPasswordRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getClientMetadata()
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - setClientMetadata
```
public void setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Parameters:
    clientMetadata -
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - withClientMetadata
```
public ForgotPasswordRequest withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    clientMetadata -
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addClientMetadataEntry
```
public ForgotPasswordRequest addClientMetadataEntry(java.lang.String key,
                                                    java.lang.String value)
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    The method adds a new key-value pair into ClientMetadata parameter, and returns a reference to this object so that method calls can be chained together.
    Parameters:
    
    key - The key of the entry to be added into ClientMetadata.
    
    value - The corresponding value of the entry to be added into ClientMetadata.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearClientMetadataEntries
```
public ForgotPasswordRequest clearClientMetadataEntries()
```
    Removes all the entries added into ClientMetadata.
    Returns a reference to this 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

Class ForgotPasswordRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ForgotPasswordRequest

Method Detail

getClientId

setClientId

withClientId

getSecretHash

setSecretHash

withSecretHash

getUserContextData

setUserContextData

withUserContextData

getUsername

setUsername

withUsername

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

getClientMetadata

setClientMetadata

withClientMetadata

addClientMetadataEntry

clearClientMetadataEntries

toString

hashCode

equals