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

#include <AdminConfirmSignUpRequest.h>

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

Public Member Functions

 AdminConfirmSignUpRequest ()
 
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)
 
AdminConfirmSignUpRequestWithUserPoolId (const Aws::String &value)
 
AdminConfirmSignUpRequestWithUserPoolId (Aws::String &&value)
 
AdminConfirmSignUpRequestWithUserPoolId (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)
 
AdminConfirmSignUpRequestWithUsername (const Aws::String &value)
 
AdminConfirmSignUpRequestWithUsername (Aws::String &&value)
 
AdminConfirmSignUpRequestWithUsername (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)
 
AdminConfirmSignUpRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
AdminConfirmSignUpRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
AdminConfirmSignUpRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
AdminConfirmSignUpRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
AdminConfirmSignUpRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
AdminConfirmSignUpRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
AdminConfirmSignUpRequestAddClientMetadata (const char *key, Aws::String &&value)
 
AdminConfirmSignUpRequestAddClientMetadata (Aws::String &&key, const char *value)
 
AdminConfirmSignUpRequestAddClientMetadata (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 confirm user registration.

See Also:

AWS API Reference

Definition at line 26 of file AdminConfirmSignUpRequest.h.

Constructor & Destructor Documentation

◆ AdminConfirmSignUpRequest()

Aws::CognitoIdentityProvider::Model::AdminConfirmSignUpRequest::AdminConfirmSignUpRequest ( )

Member Function Documentation

◆ AddClientMetadata() [1/7]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 372 of file AdminConfirmSignUpRequest.h.

◆ AddClientMetadata() [2/7]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 322 of file AdminConfirmSignUpRequest.h.

◆ AddClientMetadata() [3/7]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 422 of file AdminConfirmSignUpRequest.h.

◆ AddClientMetadata() [4/7]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 347 of file AdminConfirmSignUpRequest.h.

◆ AddClientMetadata() [5/7]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 297 of file AdminConfirmSignUpRequest.h.

◆ AddClientMetadata() [6/7]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 397 of file AdminConfirmSignUpRequest.h.

◆ AddClientMetadata() [7/7]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 447 of file AdminConfirmSignUpRequest.h.

◆ ClientMetadataHasBeenSet()

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

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 172 of file AdminConfirmSignUpRequest.h.

◆ GetClientMetadata()

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

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 147 of file AdminConfirmSignUpRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file AdminConfirmSignUpRequest.h.

◆ GetUsername()

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

The user name for which you want to confirm user registration.

Definition at line 86 of file AdminConfirmSignUpRequest.h.

◆ GetUserPoolId()

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

The user pool ID for which you want to confirm user registration.

Definition at line 45 of file AdminConfirmSignUpRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientMetadata() [1/2]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 222 of file AdminConfirmSignUpRequest.h.

◆ SetClientMetadata() [2/2]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 197 of file AdminConfirmSignUpRequest.h.

◆ SetUsername() [1/3]

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

The user name for which you want to confirm user registration.

Definition at line 101 of file AdminConfirmSignUpRequest.h.

◆ SetUsername() [2/3]

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

The user name for which you want to confirm user registration.

Definition at line 96 of file AdminConfirmSignUpRequest.h.

◆ SetUsername() [3/3]

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

The user name for which you want to confirm user registration.

Definition at line 106 of file AdminConfirmSignUpRequest.h.

◆ SetUserPoolId() [1/3]

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

The user pool ID for which you want to confirm user registration.

Definition at line 60 of file AdminConfirmSignUpRequest.h.

◆ SetUserPoolId() [2/3]

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

The user pool ID for which you want to confirm user registration.

Definition at line 55 of file AdminConfirmSignUpRequest.h.

◆ SetUserPoolId() [3/3]

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

The user pool ID for which you want to confirm user registration.

Definition at line 65 of file AdminConfirmSignUpRequest.h.

◆ UsernameHasBeenSet()

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

The user name for which you want to confirm user registration.

Definition at line 91 of file AdminConfirmSignUpRequest.h.

◆ UserPoolIdHasBeenSet()

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

The user pool ID for which you want to confirm user registration.

Definition at line 50 of file AdminConfirmSignUpRequest.h.

◆ WithClientMetadata() [1/2]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 272 of file AdminConfirmSignUpRequest.h.

◆ WithClientMetadata() [2/2]

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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 247 of file AdminConfirmSignUpRequest.h.

◆ WithUsername() [1/3]

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

The user name for which you want to confirm user registration.

Definition at line 116 of file AdminConfirmSignUpRequest.h.

◆ WithUsername() [2/3]

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

The user name for which you want to confirm user registration.

Definition at line 111 of file AdminConfirmSignUpRequest.h.

◆ WithUsername() [3/3]

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

The user name for which you want to confirm user registration.

Definition at line 121 of file AdminConfirmSignUpRequest.h.

◆ WithUserPoolId() [1/3]

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

The user pool ID for which you want to confirm user registration.

Definition at line 75 of file AdminConfirmSignUpRequest.h.

◆ WithUserPoolId() [2/3]

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

The user pool ID for which you want to confirm user registration.

Definition at line 70 of file AdminConfirmSignUpRequest.h.

◆ WithUserPoolId() [3/3]

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

The user pool ID for which you want to confirm user registration.

Definition at line 80 of file AdminConfirmSignUpRequest.h.


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