AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest Class Reference

#include <ForgotPasswordRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest:

Public Member Functions

 ForgotPasswordRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetClientId () const
 
bool ClientIdHasBeenSet () const
 
void SetClientId (const Aws::String &value)
 
void SetClientId (Aws::String &&value)
 
void SetClientId (const char *value)
 
ForgotPasswordRequestWithClientId (const Aws::String &value)
 
ForgotPasswordRequestWithClientId (Aws::String &&value)
 
ForgotPasswordRequestWithClientId (const char *value)
 
const Aws::StringGetSecretHash () const
 
bool SecretHashHasBeenSet () const
 
void SetSecretHash (const Aws::String &value)
 
void SetSecretHash (Aws::String &&value)
 
void SetSecretHash (const char *value)
 
ForgotPasswordRequestWithSecretHash (const Aws::String &value)
 
ForgotPasswordRequestWithSecretHash (Aws::String &&value)
 
ForgotPasswordRequestWithSecretHash (const char *value)
 
const UserContextDataTypeGetUserContextData () const
 
bool UserContextDataHasBeenSet () const
 
void SetUserContextData (const UserContextDataType &value)
 
void SetUserContextData (UserContextDataType &&value)
 
ForgotPasswordRequestWithUserContextData (const UserContextDataType &value)
 
ForgotPasswordRequestWithUserContextData (UserContextDataType &&value)
 
const Aws::StringGetUsername () const
 
bool UsernameHasBeenSet () const
 
void SetUsername (const Aws::String &value)
 
void SetUsername (Aws::String &&value)
 
void SetUsername (const char *value)
 
ForgotPasswordRequestWithUsername (const Aws::String &value)
 
ForgotPasswordRequestWithUsername (Aws::String &&value)
 
ForgotPasswordRequestWithUsername (const char *value)
 
const AnalyticsMetadataTypeGetAnalyticsMetadata () const
 
bool AnalyticsMetadataHasBeenSet () const
 
void SetAnalyticsMetadata (const AnalyticsMetadataType &value)
 
void SetAnalyticsMetadata (AnalyticsMetadataType &&value)
 
ForgotPasswordRequestWithAnalyticsMetadata (const AnalyticsMetadataType &value)
 
ForgotPasswordRequestWithAnalyticsMetadata (AnalyticsMetadataType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetClientMetadata () const
 
bool ClientMetadataHasBeenSet () const
 
void SetClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
ForgotPasswordRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
ForgotPasswordRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
ForgotPasswordRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
ForgotPasswordRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
ForgotPasswordRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
ForgotPasswordRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
ForgotPasswordRequestAddClientMetadata (const char *key, Aws::String &&value)
 
ForgotPasswordRequestAddClientMetadata (Aws::String &&key, const char *value)
 
ForgotPasswordRequestAddClientMetadata (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the request to reset a user's password.

See Also:


AWS API Reference

Definition at line 28 of file ForgotPasswordRequest.h.

Constructor & Destructor Documentation

◆ ForgotPasswordRequest()

Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::ForgotPasswordRequest ( )

Member Function Documentation

◆ AddClientMetadata() [1/7]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::AddClientMetadata ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 531 of file ForgotPasswordRequest.h.

◆ AddClientMetadata() [2/7]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::AddClientMetadata ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 477 of file ForgotPasswordRequest.h.

◆ AddClientMetadata() [3/7]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::AddClientMetadata ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 585 of file ForgotPasswordRequest.h.

◆ AddClientMetadata() [4/7]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::AddClientMetadata ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 504 of file ForgotPasswordRequest.h.

◆ AddClientMetadata() [5/7]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::AddClientMetadata ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 450 of file ForgotPasswordRequest.h.

◆ AddClientMetadata() [6/7]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::AddClientMetadata ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 558 of file ForgotPasswordRequest.h.

◆ AddClientMetadata() [7/7]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::AddClientMetadata ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 612 of file ForgotPasswordRequest.h.

◆ AnalyticsMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::AnalyticsMetadataHasBeenSet ( ) const
inline

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

Definition at line 236 of file ForgotPasswordRequest.h.

◆ ClientIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::ClientIdHasBeenSet ( ) const
inline

The ID of the client associated with the user pool.

Definition at line 52 of file ForgotPasswordRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::ClientMetadataHasBeenSet ( ) const
inline

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.

Definition at line 315 of file ForgotPasswordRequest.h.

◆ GetAnalyticsMetadata()

const AnalyticsMetadataType& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::GetAnalyticsMetadata ( ) const
inline

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

Definition at line 230 of file ForgotPasswordRequest.h.

◆ GetClientId()

const Aws::String& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::GetClientId ( ) const
inline

The ID of the client associated with the user pool.

Definition at line 47 of file ForgotPasswordRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::GetClientMetadata ( ) const
inline

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.

Definition at line 288 of file ForgotPasswordRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetSecretHash()

const Aws::String& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::GetSecretHash ( ) const
inline

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.

Definition at line 89 of file ForgotPasswordRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ForgotPasswordRequest.h.

◆ GetUserContextData()

const UserContextDataType& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::GetUserContextData ( ) const
inline

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.

Definition at line 139 of file ForgotPasswordRequest.h.

◆ GetUsername()

const Aws::String& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::GetUsername ( ) const
inline

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

Definition at line 181 of file ForgotPasswordRequest.h.

◆ SecretHashHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SecretHashHasBeenSet ( ) const
inline

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.

Definition at line 95 of file ForgotPasswordRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAnalyticsMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetAnalyticsMetadata ( AnalyticsMetadataType &&  value)
inline

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

Definition at line 248 of file ForgotPasswordRequest.h.

◆ SetAnalyticsMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetAnalyticsMetadata ( const AnalyticsMetadataType value)
inline

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

Definition at line 242 of file ForgotPasswordRequest.h.

◆ SetClientId() [1/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetClientId ( Aws::String &&  value)
inline

The ID of the client associated with the user pool.

Definition at line 62 of file ForgotPasswordRequest.h.

◆ SetClientId() [2/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetClientId ( const Aws::String value)
inline

The ID of the client associated with the user pool.

Definition at line 57 of file ForgotPasswordRequest.h.

◆ SetClientId() [3/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetClientId ( const char *  value)
inline

The ID of the client associated with the user pool.

Definition at line 67 of file ForgotPasswordRequest.h.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetClientMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 369 of file ForgotPasswordRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetClientMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 342 of file ForgotPasswordRequest.h.

◆ SetSecretHash() [1/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetSecretHash ( Aws::String &&  value)
inline

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.

Definition at line 107 of file ForgotPasswordRequest.h.

◆ SetSecretHash() [2/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetSecretHash ( const Aws::String value)
inline

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.

Definition at line 101 of file ForgotPasswordRequest.h.

◆ SetSecretHash() [3/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetSecretHash ( const char *  value)
inline

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.

Definition at line 113 of file ForgotPasswordRequest.h.

◆ SetUserContextData() [1/2]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetUserContextData ( const UserContextDataType value)
inline

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.

Definition at line 153 of file ForgotPasswordRequest.h.

◆ SetUserContextData() [2/2]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetUserContextData ( UserContextDataType &&  value)
inline

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.

Definition at line 160 of file ForgotPasswordRequest.h.

◆ SetUsername() [1/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetUsername ( Aws::String &&  value)
inline

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

Definition at line 199 of file ForgotPasswordRequest.h.

◆ SetUsername() [2/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetUsername ( const Aws::String value)
inline

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

Definition at line 193 of file ForgotPasswordRequest.h.

◆ SetUsername() [3/3]

void Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::SetUsername ( const char *  value)
inline

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

Definition at line 205 of file ForgotPasswordRequest.h.

◆ UserContextDataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::UserContextDataHasBeenSet ( ) const
inline

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.

Definition at line 146 of file ForgotPasswordRequest.h.

◆ UsernameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::UsernameHasBeenSet ( ) const
inline

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

Definition at line 187 of file ForgotPasswordRequest.h.

◆ WithAnalyticsMetadata() [1/2]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithAnalyticsMetadata ( AnalyticsMetadataType &&  value)
inline

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

Definition at line 260 of file ForgotPasswordRequest.h.

◆ WithAnalyticsMetadata() [2/2]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithAnalyticsMetadata ( const AnalyticsMetadataType value)
inline

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

Definition at line 254 of file ForgotPasswordRequest.h.

◆ WithClientId() [1/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithClientId ( Aws::String &&  value)
inline

The ID of the client associated with the user pool.

Definition at line 77 of file ForgotPasswordRequest.h.

◆ WithClientId() [2/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithClientId ( const Aws::String value)
inline

The ID of the client associated with the user pool.

Definition at line 72 of file ForgotPasswordRequest.h.

◆ WithClientId() [3/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithClientId ( const char *  value)
inline

The ID of the client associated with the user pool.

Definition at line 82 of file ForgotPasswordRequest.h.

◆ WithClientMetadata() [1/2]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithClientMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 423 of file ForgotPasswordRequest.h.

◆ WithClientMetadata() [2/2]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithClientMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 396 of file ForgotPasswordRequest.h.

◆ WithSecretHash() [1/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithSecretHash ( Aws::String &&  value)
inline

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.

Definition at line 125 of file ForgotPasswordRequest.h.

◆ WithSecretHash() [2/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithSecretHash ( const Aws::String value)
inline

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.

Definition at line 119 of file ForgotPasswordRequest.h.

◆ WithSecretHash() [3/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithSecretHash ( const char *  value)
inline

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.

Definition at line 131 of file ForgotPasswordRequest.h.

◆ WithUserContextData() [1/2]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithUserContextData ( const UserContextDataType value)
inline

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.

Definition at line 167 of file ForgotPasswordRequest.h.

◆ WithUserContextData() [2/2]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithUserContextData ( UserContextDataType &&  value)
inline

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.

Definition at line 174 of file ForgotPasswordRequest.h.

◆ WithUsername() [1/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithUsername ( Aws::String &&  value)
inline

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

Definition at line 217 of file ForgotPasswordRequest.h.

◆ WithUsername() [2/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithUsername ( const Aws::String value)
inline

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

Definition at line 211 of file ForgotPasswordRequest.h.

◆ WithUsername() [3/3]

ForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ForgotPasswordRequest::WithUsername ( const char *  value)
inline

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

Definition at line 223 of file ForgotPasswordRequest.h.


The documentation for this class was generated from the following file: