@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to reset a user's password.
NOOP
Constructor and Description |
---|
ForgotPasswordRequest() |
Modifier and Type | Method and Description |
---|---|
ForgotPasswordRequest |
addClientMetadataEntry(String key,
String value)
Add a single ClientMetadata entry
|
ForgotPasswordRequest |
clearClientMetadataEntries()
Removes all the entries added into ClientMetadata.
|
ForgotPasswordRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
AnalyticsMetadataType |
getAnalyticsMetadata()
The Amazon Pinpoint analytics metadata that contributes to your metrics for
ForgotPassword calls. |
String |
getClientId()
The ID of the client associated with the user pool.
|
Map<String,String> |
getClientMetadata()
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
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.
|
String |
getUsername()
The username of the user that you want to query or modify.
|
int |
hashCode() |
void |
setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata that contributes to your metrics for
ForgotPassword calls. |
void |
setClientId(String clientId)
The ID of the client associated with the user pool.
|
void |
setClientMetadata(Map<String,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(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(String username)
The username of the user that you want to query or modify.
|
String |
toString()
Returns a string representation of this object.
|
ForgotPasswordRequest |
withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata that contributes to your metrics for
ForgotPassword calls. |
ForgotPasswordRequest |
withClientId(String clientId)
The ID of the client associated with the user pool.
|
ForgotPasswordRequest |
withClientMetadata(Map<String,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(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(String username)
The username of the user that you want to query or modify.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setClientId(String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.public String getClientId()
The ID of the client associated with the user pool.
public ForgotPasswordRequest withClientId(String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.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.
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.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.
public ForgotPasswordRequest 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.
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.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 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.
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.
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 void setUsername(String username)
The username of the user that you want to query or modify. The value of this parameter is typically your user's
username, but it can be any of their alias attributes. If username
isn't an alias attribute in your
user pool, this value must be the sub
of a local user or the username of a user from a third-party
IdP.
username
- The username of the user that you want to query or modify. The value of this parameter is typically your
user's username, but it can be any of their alias attributes. If username
isn't an alias
attribute in your user pool, this value must be the sub
of a local user or the username of a
user from a third-party IdP.public String getUsername()
The username of the user that you want to query or modify. The value of this parameter is typically your user's
username, but it can be any of their alias attributes. If username
isn't an alias attribute in your
user pool, this value must be the sub
of a local user or the username of a user from a third-party
IdP.
username
isn't an alias
attribute in your user pool, this value must be the sub
of a local user or the username of a
user from a third-party IdP.public ForgotPasswordRequest withUsername(String username)
The username of the user that you want to query or modify. The value of this parameter is typically your user's
username, but it can be any of their alias attributes. If username
isn't an alias attribute in your
user pool, this value must be the sub
of a local user or the username of a user from a third-party
IdP.
username
- The username of the user that you want to query or modify. The value of this parameter is typically your
user's username, but it can be any of their alias attributes. If username
isn't an alias
attribute in your user pool, this value must be the sub
of a local user or the username of a
user from a third-party IdP.public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword
calls.
analyticsMetadata
- The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword
calls.public AnalyticsMetadataType getAnalyticsMetadata()
The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword
calls.
ForgotPassword
calls.public ForgotPasswordRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword
calls.
analyticsMetadata
- The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword
calls.public Map<String,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.
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.
public void setClientMetadata(Map<String,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.
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.
public ForgotPasswordRequest withClientMetadata(Map<String,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.
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.
public ForgotPasswordRequest addClientMetadataEntry(String key, String value)
public ForgotPasswordRequest clearClientMetadataEntries()
public String toString()
toString
in class Object
Object.toString()
public ForgotPasswordRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()