public class ConfirmForgotPasswordRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
Allows a user to enter a confirmation code to reset a forgotten password.
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.
| Constructor and Description |
|---|
ConfirmForgotPasswordRequest() |
| Modifier and Type | Method and Description |
|---|---|
ConfirmForgotPasswordRequest |
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.
|
ConfirmForgotPasswordRequest |
clearClientMetadataEntries()
Removes all the entries added into ClientMetadata.
|
boolean |
equals(java.lang.Object obj) |
AnalyticsMetadataType |
getAnalyticsMetadata()
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls. |
java.lang.String |
getClientId()
The app client ID of the app 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 |
getConfirmationCode()
The confirmation code from your user's request to reset their password.
|
java.lang.String |
getPassword()
The new password that your user wants to set.
|
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 retrieve a
forgotten password.
|
int |
hashCode() |
void |
setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls. |
void |
setClientId(java.lang.String clientId)
The app client ID of the app 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 |
setConfirmationCode(java.lang.String confirmationCode)
The confirmation code from your user's request to reset their password.
|
void |
setPassword(java.lang.String password)
The new password that your user wants to set.
|
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 retrieve a
forgotten password.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ConfirmForgotPasswordRequest |
withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls. |
ConfirmForgotPasswordRequest |
withClientId(java.lang.String clientId)
The app client ID of the app associated with the user pool.
|
ConfirmForgotPasswordRequest |
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.
|
ConfirmForgotPasswordRequest |
withConfirmationCode(java.lang.String confirmationCode)
The confirmation code from your user's request to reset their password.
|
ConfirmForgotPasswordRequest |
withPassword(java.lang.String password)
The new password that your user wants to set.
|
ConfirmForgotPasswordRequest |
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.
|
ConfirmForgotPasswordRequest |
withUserContextData(UserContextDataType userContextData)
Contextual data about your user session, such as the device fingerprint,
IP address, or location.
|
ConfirmForgotPasswordRequest |
withUsername(java.lang.String username)
The user name of the user for whom you want to enter a code to retrieve a
forgotten password.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic java.lang.String getClientId()
The app client ID of the app associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
The app client ID of the app associated with the user pool.
public void setClientId(java.lang.String clientId)
The app client ID of the app associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
clientId - The app client ID of the app associated with the user pool.
public ConfirmForgotPasswordRequest withClientId(java.lang.String clientId)
The app client ID of the app 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+]+
clientId - The app client ID of the app associated with the user pool.
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. For more information about SecretHash, see Computing secret hash values.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
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. For more information about
SecretHash, see Computing secret hash values.
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. For more information about SecretHash, see Computing secret hash values.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
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. For more information about
SecretHash, see Computing secret hash values.
public ConfirmForgotPasswordRequest 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. For more information about SecretHash, see Computing secret hash values.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
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. For more information about
SecretHash, see Computing secret hash values.
public java.lang.String getUsername()
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
public void setUsername(java.lang.String username)
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
username - The user name of the user for whom you want to enter a code to retrieve a forgotten password.
public ConfirmForgotPasswordRequest withUsername(java.lang.String username)
The user name of the user for whom you want to enter a code to retrieve 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}]+
username - The user name of the user for whom you want to enter a code to retrieve a forgotten password.
public java.lang.String getConfirmationCode()
The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
Constraints:
Length: 1 - 2048
Pattern: [\S]+
The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
public void setConfirmationCode(java.lang.String confirmationCode)
The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
Constraints:
Length: 1 - 2048
Pattern: [\S]+
confirmationCode - The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
public ConfirmForgotPasswordRequest withConfirmationCode(java.lang.String confirmationCode)
The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2048
Pattern: [\S]+
confirmationCode - The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
public java.lang.String getPassword()
The new password that your user wants to set.
Constraints:
Length: - 256
Pattern: [\S]+
The new password that your user wants to set.
public void setPassword(java.lang.String password)
The new password that your user wants to set.
Constraints:
Length: - 256
Pattern: [\S]+
password - The new password that your user wants to set.
public ConfirmForgotPasswordRequest withPassword(java.lang.String password)
The new password that your user wants to set.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 256
Pattern: [\S]+
password - The new password that your user wants to set.
public AnalyticsMetadataType getAnalyticsMetadata()
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls.
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls.
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls.
analyticsMetadata -
The Amazon Pinpoint analytics metadata for collecting metrics
for ConfirmForgotPassword calls.
public ConfirmForgotPasswordRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls.
Returns a reference to this object so that method calls can be chained together.
analyticsMetadata -
The Amazon Pinpoint analytics metadata for collecting metrics
for ConfirmForgotPassword calls.
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.
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.
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.
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.
public ConfirmForgotPasswordRequest 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.
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.
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 ConfirmForgotPassword API action, Amazon
Cognito invokes the function that is assigned to the post
confirmation trigger. When Amazon Cognito invokes this function, 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
ConfirmForgotPassword 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.
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 ConfirmForgotPassword API action,
Amazon Cognito invokes the function that is assigned to the
post confirmation trigger. When Amazon Cognito invokes
this function, 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
ConfirmForgotPassword 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.
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 ConfirmForgotPassword API action, Amazon
Cognito invokes the function that is assigned to the post
confirmation trigger. When Amazon Cognito invokes this function, 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
ConfirmForgotPassword 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.
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 ConfirmForgotPassword API
action, Amazon Cognito invokes the function that is assigned
to the post confirmation trigger. When Amazon Cognito
invokes this function, 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
ConfirmForgotPassword 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.
public ConfirmForgotPasswordRequest 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 ConfirmForgotPassword API action, Amazon
Cognito invokes the function that is assigned to the post
confirmation trigger. When Amazon Cognito invokes this function, 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
ConfirmForgotPassword 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.
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 ConfirmForgotPassword API
action, Amazon Cognito invokes the function that is assigned
to the post confirmation trigger. When Amazon Cognito
invokes this function, 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
ConfirmForgotPassword 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.
public ConfirmForgotPasswordRequest 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 ConfirmForgotPassword API action, Amazon
Cognito invokes the function that is assigned to the post
confirmation trigger. When Amazon Cognito invokes this function, 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
ConfirmForgotPassword 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.
key - The key of the entry to be added into ClientMetadata.value - The corresponding value of the entry to be added into
ClientMetadata.public ConfirmForgotPasswordRequest clearClientMetadataEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object