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

#include <AdminResetUserPasswordRequest.h>

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

Public Member Functions

 AdminResetUserPasswordRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
AdminResetUserPasswordRequestWithUserPoolId (const Aws::String &value)
 
AdminResetUserPasswordRequestWithUserPoolId (Aws::String &&value)
 
AdminResetUserPasswordRequestWithUserPoolId (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)
 
AdminResetUserPasswordRequestWithUsername (const Aws::String &value)
 
AdminResetUserPasswordRequestWithUsername (Aws::String &&value)
 
AdminResetUserPasswordRequestWithUsername (const char *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)
 
AdminResetUserPasswordRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
AdminResetUserPasswordRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
AdminResetUserPasswordRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
AdminResetUserPasswordRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
AdminResetUserPasswordRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
AdminResetUserPasswordRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
AdminResetUserPasswordRequestAddClientMetadata (const char *key, Aws::String &&value)
 
AdminResetUserPasswordRequestAddClientMetadata (Aws::String &&key, const char *value)
 
AdminResetUserPasswordRequestAddClientMetadata (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 as an administrator.

See Also:

AWS API Reference

Definition at line 26 of file AdminResetUserPasswordRequest.h.

Constructor & Destructor Documentation

◆ AdminResetUserPasswordRequest()

Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::AdminResetUserPasswordRequest ( )

Member Function Documentation

◆ AddClientMetadata() [1/7]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 390 of file AdminResetUserPasswordRequest.h.

◆ AddClientMetadata() [2/7]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 338 of file AdminResetUserPasswordRequest.h.

◆ AddClientMetadata() [3/7]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 442 of file AdminResetUserPasswordRequest.h.

◆ AddClientMetadata() [4/7]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 364 of file AdminResetUserPasswordRequest.h.

◆ AddClientMetadata() [5/7]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 312 of file AdminResetUserPasswordRequest.h.

◆ AddClientMetadata() [6/7]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 416 of file AdminResetUserPasswordRequest.h.

◆ AddClientMetadata() [7/7]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 468 of file AdminResetUserPasswordRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 182 of file AdminResetUserPasswordRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 156 of file AdminResetUserPasswordRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file AdminResetUserPasswordRequest.h.

◆ GetUsername()

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

The user name of the user whose password you wish to reset.

Definition at line 94 of file AdminResetUserPasswordRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::GetUserPoolId ( ) const
inline

The user pool ID for the user pool where you want to reset the user's password.

Definition at line 46 of file AdminResetUserPasswordRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 234 of file AdminResetUserPasswordRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 208 of file AdminResetUserPasswordRequest.h.

◆ SetUsername() [1/3]

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

The user name of the user whose password you wish to reset.

Definition at line 109 of file AdminResetUserPasswordRequest.h.

◆ SetUsername() [2/3]

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

The user name of the user whose password you wish to reset.

Definition at line 104 of file AdminResetUserPasswordRequest.h.

◆ SetUsername() [3/3]

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

The user name of the user whose password you wish to reset.

Definition at line 114 of file AdminResetUserPasswordRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::SetUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool where you want to reset the user's password.

Definition at line 64 of file AdminResetUserPasswordRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::SetUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool where you want to reset the user's password.

Definition at line 58 of file AdminResetUserPasswordRequest.h.

◆ SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::SetUserPoolId ( const char *  value)
inline

The user pool ID for the user pool where you want to reset the user's password.

Definition at line 70 of file AdminResetUserPasswordRequest.h.

◆ UsernameHasBeenSet()

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

The user name of the user whose password you wish to reset.

Definition at line 99 of file AdminResetUserPasswordRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::UserPoolIdHasBeenSet ( ) const
inline

The user pool ID for the user pool where you want to reset the user's password.

Definition at line 52 of file AdminResetUserPasswordRequest.h.

◆ WithClientMetadata() [1/2]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 286 of file AdminResetUserPasswordRequest.h.

◆ WithClientMetadata() [2/2]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::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 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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 260 of file AdminResetUserPasswordRequest.h.

◆ WithUsername() [1/3]

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

The user name of the user whose password you wish to reset.

Definition at line 124 of file AdminResetUserPasswordRequest.h.

◆ WithUsername() [2/3]

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

The user name of the user whose password you wish to reset.

Definition at line 119 of file AdminResetUserPasswordRequest.h.

◆ WithUsername() [3/3]

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

The user name of the user whose password you wish to reset.

Definition at line 129 of file AdminResetUserPasswordRequest.h.

◆ WithUserPoolId() [1/3]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::WithUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool where you want to reset the user's password.

Definition at line 82 of file AdminResetUserPasswordRequest.h.

◆ WithUserPoolId() [2/3]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::WithUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool where you want to reset the user's password.

Definition at line 76 of file AdminResetUserPasswordRequest.h.

◆ WithUserPoolId() [3/3]

AdminResetUserPasswordRequest& Aws::CognitoIdentityProvider::Model::AdminResetUserPasswordRequest::WithUserPoolId ( const char *  value)
inline

The user pool ID for the user pool where you want to reset the user's password.

Definition at line 88 of file AdminResetUserPasswordRequest.h.


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