java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.ConfirmForgotPasswordRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>

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

The request representing the confirmation for a password reset.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ConfirmForgotPasswordRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AnalyticsMetadataType`	`analyticsMetadata()`	The Amazon Pinpoint analytics metadata for collecting metrics for `ConfirmForgotPassword` calls.
`static ConfirmForgotPasswordRequest.Builder`	`builder()`
`String`	`clientId()`	The ID of the app client where the user wants to reset their password.
`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.
`String`	`confirmationCode()`	The confirmation code that your user pool sent in response to an AdminResetUserPassword or a ForgotPassword request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasClientMetadata()`	For responses, this returns true if the service returned a value for the ClientMetadata property.
`int`	`hashCode()`
`String`	`password()`	The new password that your user wants to set.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`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 ConfirmForgotPasswordRequest.Builder>`	`serializableBuilderClass()`
`ConfirmForgotPasswordRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`UserContextDataType`	`userContextData()`	Contextual data about your user session, such as the device fingerprint, IP address, or location.
`String`	`username()`	The username of the user that you want to query or modify.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientId
```
public final String clientId()
```
    The ID of the app client where the user wants to reset their password. This parameter is an identifier of the client application that users are resetting their password from, but this operation resets users' passwords for all app clients in the user pool.
    
    Returns:
    
    The ID of the app client where the user wants to reset their password. This parameter is an identifier of the client application that users are resetting their password from, but this operation resets users' passwords for all app clients in the user pool.
  - secretHash
```
public final 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 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.
  - username
```
public final 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.
    
    Returns:
    
    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.
  - confirmationCode
```
public final String confirmationCode()
```
    The confirmation code that your user pool sent in response to an AdminResetUserPassword or a ForgotPassword request.
    
    Returns:
    
    The confirmation code that your user pool sent in response to an AdminResetUserPassword or a ForgotPassword request.
  - password
```
public final String password()
```
    The new password that your user wants to set.
    
    Returns:
    
    The new password that your user wants to set.
  - analyticsMetadata
```
public final AnalyticsMetadataType analyticsMetadata()
```
    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
    
    Returns:
    
    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
  - userContextData
```
public final 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.
    
    For more information, see Collecting data for threat protection in applications.
    
    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.
    
    For more information, see Collecting data for threat protection in applications.
  - hasClientMetadata
```
public final boolean hasClientMetadata()
```
    For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - clientMetadata
```
public final 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 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, note 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 send sensitive information in this parameter.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientMetadata() method.
    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 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, note 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 send sensitive information in this parameter.
  - toBuilder
```
public ConfirmForgotPasswordRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static ConfirmForgotPasswordRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ConfirmForgotPasswordRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ConfirmForgotPasswordRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientId

secretHash

username

confirmationCode

password

analyticsMetadata

userContextData

hasClientMetadata

clientMetadata

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField