ForgotPasswordRequest Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    analyticsMetadata

The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.

Declaration

Swift

public let analyticsMetadata: AnalyticsMetadataType?


                    
                    
                    clientId

The ID of the client associated with the user pool.

Declaration

Swift

public let clientId: 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 AWS 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 AWS 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. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don’t use it to provide sensitive information.

Declaration

Swift

public let clientMetadata: [String : 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.

Declaration

Swift

public let secretHash: String?


                    
                    
                    userContextData

Contextual data such as the user’s device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Declaration

Swift

public let userContextData: UserContextDataType?


                    
                    
                    username

The user name of the user for whom you want to enter a code to reset a forgotten password.

Declaration

Swift

public let username: String


                    
                    
                    init(analyticsMetadata:clientId:clientMetadata:secretHash:userContextData:username:)

Undocumented

Declaration

Swift

public init(analyticsMetadata: AnalyticsMetadataType? = nil, clientId: String, clientMetadata: [String : String]? = nil, secretHash: String? = nil, userContextData: UserContextDataType? = nil, username: String)


                    
                    
                    validate(name:)

Declaration

Swift

public func validate(name: String) throws