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

#include <ConfirmForgotPasswordRequest.h>

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

Public Member Functions

 ConfirmForgotPasswordRequest ()
 
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)
 
ConfirmForgotPasswordRequestWithClientId (const Aws::String &value)
 
ConfirmForgotPasswordRequestWithClientId (Aws::String &&value)
 
ConfirmForgotPasswordRequestWithClientId (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)
 
ConfirmForgotPasswordRequestWithSecretHash (const Aws::String &value)
 
ConfirmForgotPasswordRequestWithSecretHash (Aws::String &&value)
 
ConfirmForgotPasswordRequestWithSecretHash (const char *value)
 
const Aws::StringGetUsername () const
 
bool UsernameHasBeenSet () const
 
void SetUsername (const Aws::String &value)
 
void SetUsername (Aws::String &&value)
 
void SetUsername (const char *value)
 
ConfirmForgotPasswordRequestWithUsername (const Aws::String &value)
 
ConfirmForgotPasswordRequestWithUsername (Aws::String &&value)
 
ConfirmForgotPasswordRequestWithUsername (const char *value)
 
const Aws::StringGetConfirmationCode () const
 
bool ConfirmationCodeHasBeenSet () const
 
void SetConfirmationCode (const Aws::String &value)
 
void SetConfirmationCode (Aws::String &&value)
 
void SetConfirmationCode (const char *value)
 
ConfirmForgotPasswordRequestWithConfirmationCode (const Aws::String &value)
 
ConfirmForgotPasswordRequestWithConfirmationCode (Aws::String &&value)
 
ConfirmForgotPasswordRequestWithConfirmationCode (const char *value)
 
const Aws::StringGetPassword () const
 
bool PasswordHasBeenSet () const
 
void SetPassword (const Aws::String &value)
 
void SetPassword (Aws::String &&value)
 
void SetPassword (const char *value)
 
ConfirmForgotPasswordRequestWithPassword (const Aws::String &value)
 
ConfirmForgotPasswordRequestWithPassword (Aws::String &&value)
 
ConfirmForgotPasswordRequestWithPassword (const char *value)
 
const AnalyticsMetadataTypeGetAnalyticsMetadata () const
 
bool AnalyticsMetadataHasBeenSet () const
 
void SetAnalyticsMetadata (const AnalyticsMetadataType &value)
 
void SetAnalyticsMetadata (AnalyticsMetadataType &&value)
 
ConfirmForgotPasswordRequestWithAnalyticsMetadata (const AnalyticsMetadataType &value)
 
ConfirmForgotPasswordRequestWithAnalyticsMetadata (AnalyticsMetadataType &&value)
 
const UserContextDataTypeGetUserContextData () const
 
bool UserContextDataHasBeenSet () const
 
void SetUserContextData (const UserContextDataType &value)
 
void SetUserContextData (UserContextDataType &&value)
 
ConfirmForgotPasswordRequestWithUserContextData (const UserContextDataType &value)
 
ConfirmForgotPasswordRequestWithUserContextData (UserContextDataType &&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)
 
ConfirmForgotPasswordRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
ConfirmForgotPasswordRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
ConfirmForgotPasswordRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
ConfirmForgotPasswordRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
ConfirmForgotPasswordRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
ConfirmForgotPasswordRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
ConfirmForgotPasswordRequestAddClientMetadata (const char *key, Aws::String &&value)
 
ConfirmForgotPasswordRequestAddClientMetadata (Aws::String &&key, const char *value)
 
ConfirmForgotPasswordRequestAddClientMetadata (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

The request representing the confirmation for a password reset.

See Also:

AWS API Reference

Definition at line 28 of file ConfirmForgotPasswordRequest.h.

Constructor & Destructor Documentation

◆ ConfirmForgotPasswordRequest()

Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::ConfirmForgotPasswordRequest ( )

Member Function Documentation

◆ AddClientMetadata() [1/7]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 541 of file ConfirmForgotPasswordRequest.h.

◆ AddClientMetadata() [2/7]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 567 of file ConfirmForgotPasswordRequest.h.

◆ AddClientMetadata() [3/7]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 593 of file ConfirmForgotPasswordRequest.h.

◆ AddClientMetadata() [4/7]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 619 of file ConfirmForgotPasswordRequest.h.

◆ AddClientMetadata() [5/7]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 645 of file ConfirmForgotPasswordRequest.h.

◆ AddClientMetadata() [6/7]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 671 of file ConfirmForgotPasswordRequest.h.

◆ AddClientMetadata() [7/7]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 697 of file ConfirmForgotPasswordRequest.h.

◆ AnalyticsMetadataHasBeenSet()

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

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

Definition at line 291 of file ConfirmForgotPasswordRequest.h.

◆ ClientIdHasBeenSet()

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

The app client ID of the app associated with the user pool.

Definition at line 52 of file ConfirmForgotPasswordRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 411 of file ConfirmForgotPasswordRequest.h.

◆ ConfirmationCodeHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::ConfirmationCodeHasBeenSet ( ) const
inline

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Definition at line 195 of file ConfirmForgotPasswordRequest.h.

◆ GetAnalyticsMetadata()

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

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

Definition at line 285 of file ConfirmForgotPasswordRequest.h.

◆ GetClientId()

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

The app client ID of the app associated with the user pool.

Definition at line 47 of file ConfirmForgotPasswordRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 385 of file ConfirmForgotPasswordRequest.h.

◆ GetConfirmationCode()

const Aws::String& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::GetConfirmationCode ( ) const
inline

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Definition at line 188 of file ConfirmForgotPasswordRequest.h.

◆ GetPassword()

const Aws::String& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::GetPassword ( ) const
inline

The password sent by a user's request to retrieve a forgotten password.

Definition at line 243 of file ConfirmForgotPasswordRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSecretHash()

const Aws::String& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 ConfirmForgotPasswordRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ConfirmForgotPasswordRequest.h.

◆ GetUserContextData()

const UserContextDataType& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 323 of file ConfirmForgotPasswordRequest.h.

◆ GetUsername()

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

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

Definition at line 138 of file ConfirmForgotPasswordRequest.h.

◆ PasswordHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::PasswordHasBeenSet ( ) const
inline

The password sent by a user's request to retrieve a forgotten password.

Definition at line 248 of file ConfirmForgotPasswordRequest.h.

◆ SecretHashHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 ConfirmForgotPasswordRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAnalyticsMetadata() [1/2]

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

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

Definition at line 297 of file ConfirmForgotPasswordRequest.h.

◆ SetAnalyticsMetadata() [2/2]

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

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

Definition at line 303 of file ConfirmForgotPasswordRequest.h.

◆ SetClientId() [1/3]

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

The app client ID of the app associated with the user pool.

Definition at line 57 of file ConfirmForgotPasswordRequest.h.

◆ SetClientId() [2/3]

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

The app client ID of the app associated with the user pool.

Definition at line 62 of file ConfirmForgotPasswordRequest.h.

◆ SetClientId() [3/3]

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

The app client ID of the app associated with the user pool.

Definition at line 67 of file ConfirmForgotPasswordRequest.h.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 437 of file ConfirmForgotPasswordRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 463 of file ConfirmForgotPasswordRequest.h.

◆ SetConfirmationCode() [1/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::SetConfirmationCode ( const Aws::String value)
inline

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Definition at line 202 of file ConfirmForgotPasswordRequest.h.

◆ SetConfirmationCode() [2/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::SetConfirmationCode ( Aws::String &&  value)
inline

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Definition at line 209 of file ConfirmForgotPasswordRequest.h.

◆ SetConfirmationCode() [3/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::SetConfirmationCode ( const char *  value)
inline

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Definition at line 216 of file ConfirmForgotPasswordRequest.h.

◆ SetPassword() [1/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::SetPassword ( const Aws::String value)
inline

The password sent by a user's request to retrieve a forgotten password.

Definition at line 253 of file ConfirmForgotPasswordRequest.h.

◆ SetPassword() [2/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::SetPassword ( Aws::String &&  value)
inline

The password sent by a user's request to retrieve a forgotten password.

Definition at line 258 of file ConfirmForgotPasswordRequest.h.

◆ SetPassword() [3/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::SetPassword ( const char *  value)
inline

The password sent by a user's request to retrieve a forgotten password.

Definition at line 263 of file ConfirmForgotPasswordRequest.h.

◆ SetSecretHash() [1/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 ConfirmForgotPasswordRequest.h.

◆ SetSecretHash() [2/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 ConfirmForgotPasswordRequest.h.

◆ SetSecretHash() [3/3]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 ConfirmForgotPasswordRequest.h.

◆ SetUserContextData() [1/2]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 337 of file ConfirmForgotPasswordRequest.h.

◆ SetUserContextData() [2/2]

void Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 344 of file ConfirmForgotPasswordRequest.h.

◆ SetUsername() [1/3]

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

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

Definition at line 150 of file ConfirmForgotPasswordRequest.h.

◆ SetUsername() [2/3]

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

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

Definition at line 156 of file ConfirmForgotPasswordRequest.h.

◆ SetUsername() [3/3]

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

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

Definition at line 162 of file ConfirmForgotPasswordRequest.h.

◆ UserContextDataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 330 of file ConfirmForgotPasswordRequest.h.

◆ UsernameHasBeenSet()

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

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

Definition at line 144 of file ConfirmForgotPasswordRequest.h.

◆ WithAnalyticsMetadata() [1/2]

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

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

Definition at line 309 of file ConfirmForgotPasswordRequest.h.

◆ WithAnalyticsMetadata() [2/2]

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

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

Definition at line 315 of file ConfirmForgotPasswordRequest.h.

◆ WithClientId() [1/3]

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

The app client ID of the app associated with the user pool.

Definition at line 72 of file ConfirmForgotPasswordRequest.h.

◆ WithClientId() [2/3]

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

The app client ID of the app associated with the user pool.

Definition at line 77 of file ConfirmForgotPasswordRequest.h.

◆ WithClientId() [3/3]

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

The app client ID of the app associated with the user pool.

Definition at line 82 of file ConfirmForgotPasswordRequest.h.

◆ WithClientMetadata() [1/2]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 489 of file ConfirmForgotPasswordRequest.h.

◆ WithClientMetadata() [2/2]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 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 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 515 of file ConfirmForgotPasswordRequest.h.

◆ WithConfirmationCode() [1/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::WithConfirmationCode ( const Aws::String value)
inline

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Definition at line 223 of file ConfirmForgotPasswordRequest.h.

◆ WithConfirmationCode() [2/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::WithConfirmationCode ( Aws::String &&  value)
inline

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Definition at line 230 of file ConfirmForgotPasswordRequest.h.

◆ WithConfirmationCode() [3/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::WithConfirmationCode ( const char *  value)
inline

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Definition at line 237 of file ConfirmForgotPasswordRequest.h.

◆ WithPassword() [1/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::WithPassword ( const Aws::String value)
inline

The password sent by a user's request to retrieve a forgotten password.

Definition at line 268 of file ConfirmForgotPasswordRequest.h.

◆ WithPassword() [2/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::WithPassword ( Aws::String &&  value)
inline

The password sent by a user's request to retrieve a forgotten password.

Definition at line 273 of file ConfirmForgotPasswordRequest.h.

◆ WithPassword() [3/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::WithPassword ( const char *  value)
inline

The password sent by a user's request to retrieve a forgotten password.

Definition at line 278 of file ConfirmForgotPasswordRequest.h.

◆ WithSecretHash() [1/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 ConfirmForgotPasswordRequest.h.

◆ WithSecretHash() [2/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 ConfirmForgotPasswordRequest.h.

◆ WithSecretHash() [3/3]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 ConfirmForgotPasswordRequest.h.

◆ WithUserContextData() [1/2]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 351 of file ConfirmForgotPasswordRequest.h.

◆ WithUserContextData() [2/2]

ConfirmForgotPasswordRequest& Aws::CognitoIdentityProvider::Model::ConfirmForgotPasswordRequest::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 358 of file ConfirmForgotPasswordRequest.h.

◆ WithUsername() [1/3]

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

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

Definition at line 168 of file ConfirmForgotPasswordRequest.h.

◆ WithUsername() [2/3]

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

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

Definition at line 174 of file ConfirmForgotPasswordRequest.h.

◆ WithUsername() [3/3]

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

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

Definition at line 180 of file ConfirmForgotPasswordRequest.h.


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