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

#include <GetUserAttributeVerificationCodeRequest.h>

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

Public Member Functions

 GetUserAttributeVerificationCodeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAccessToken () const
 
bool AccessTokenHasBeenSet () const
 
void SetAccessToken (const Aws::String &value)
 
void SetAccessToken (Aws::String &&value)
 
void SetAccessToken (const char *value)
 
GetUserAttributeVerificationCodeRequestWithAccessToken (const Aws::String &value)
 
GetUserAttributeVerificationCodeRequestWithAccessToken (Aws::String &&value)
 
GetUserAttributeVerificationCodeRequestWithAccessToken (const char *value)
 
const Aws::StringGetAttributeName () const
 
bool AttributeNameHasBeenSet () const
 
void SetAttributeName (const Aws::String &value)
 
void SetAttributeName (Aws::String &&value)
 
void SetAttributeName (const char *value)
 
GetUserAttributeVerificationCodeRequestWithAttributeName (const Aws::String &value)
 
GetUserAttributeVerificationCodeRequestWithAttributeName (Aws::String &&value)
 
GetUserAttributeVerificationCodeRequestWithAttributeName (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)
 
GetUserAttributeVerificationCodeRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
GetUserAttributeVerificationCodeRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
GetUserAttributeVerificationCodeRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
GetUserAttributeVerificationCodeRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
GetUserAttributeVerificationCodeRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
GetUserAttributeVerificationCodeRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
GetUserAttributeVerificationCodeRequestAddClientMetadata (const char *key, Aws::String &&value)
 
GetUserAttributeVerificationCodeRequestAddClientMetadata (Aws::String &&key, const char *value)
 
GetUserAttributeVerificationCodeRequestAddClientMetadata (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 get user attribute verification.

See Also:

AWS API Reference

Definition at line 26 of file GetUserAttributeVerificationCodeRequest.h.

Constructor & Destructor Documentation

◆ GetUserAttributeVerificationCodeRequest()

Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::GetUserAttributeVerificationCodeRequest ( )

Member Function Documentation

◆ AccessTokenHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::AccessTokenHasBeenSet ( ) const
inline

The access token returned by the server response to get the user attribute verification code.

Definition at line 52 of file GetUserAttributeVerificationCodeRequest.h.

◆ AddClientMetadata() [1/7]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 398 of file GetUserAttributeVerificationCodeRequest.h.

◆ AddClientMetadata() [2/7]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 346 of file GetUserAttributeVerificationCodeRequest.h.

◆ AddClientMetadata() [3/7]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Definition at line 450 of file GetUserAttributeVerificationCodeRequest.h.

◆ AddClientMetadata() [4/7]

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

◆ AddClientMetadata() [5/7]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 320 of file GetUserAttributeVerificationCodeRequest.h.

◆ AddClientMetadata() [6/7]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 424 of file GetUserAttributeVerificationCodeRequest.h.

◆ AddClientMetadata() [7/7]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 476 of file GetUserAttributeVerificationCodeRequest.h.

◆ AttributeNameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::AttributeNameHasBeenSet ( ) const
inline

The attribute name returned by the server response to get the user attribute verification code.

Definition at line 101 of file GetUserAttributeVerificationCodeRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 190 of file GetUserAttributeVerificationCodeRequest.h.

◆ GetAccessToken()

const Aws::String& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::GetAccessToken ( ) const
inline

The access token returned by the server response to get the user attribute verification code.

Definition at line 46 of file GetUserAttributeVerificationCodeRequest.h.

◆ GetAttributeName()

const Aws::String& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::GetAttributeName ( ) const
inline

The attribute name returned by the server response to get the user attribute verification code.

Definition at line 95 of file GetUserAttributeVerificationCodeRequest.h.

◆ GetClientMetadata()

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

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccessToken() [1/3]

void Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::SetAccessToken ( Aws::String &&  value)
inline

The access token returned by the server response to get the user attribute verification code.

Definition at line 64 of file GetUserAttributeVerificationCodeRequest.h.

◆ SetAccessToken() [2/3]

void Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::SetAccessToken ( const Aws::String value)
inline

The access token returned by the server response to get the user attribute verification code.

Definition at line 58 of file GetUserAttributeVerificationCodeRequest.h.

◆ SetAccessToken() [3/3]

void Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::SetAccessToken ( const char *  value)
inline

The access token returned by the server response to get the user attribute verification code.

Definition at line 70 of file GetUserAttributeVerificationCodeRequest.h.

◆ SetAttributeName() [1/3]

void Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::SetAttributeName ( Aws::String &&  value)
inline

The attribute name returned by the server response to get the user attribute verification code.

Definition at line 113 of file GetUserAttributeVerificationCodeRequest.h.

◆ SetAttributeName() [2/3]

void Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::SetAttributeName ( const Aws::String value)
inline

The attribute name returned by the server response to get the user attribute verification code.

Definition at line 107 of file GetUserAttributeVerificationCodeRequest.h.

◆ SetAttributeName() [3/3]

void Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::SetAttributeName ( const char *  value)
inline

The attribute name returned by the server response to get the user attribute verification code.

Definition at line 119 of file GetUserAttributeVerificationCodeRequest.h.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 242 of file GetUserAttributeVerificationCodeRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 216 of file GetUserAttributeVerificationCodeRequest.h.

◆ WithAccessToken() [1/3]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::WithAccessToken ( Aws::String &&  value)
inline

The access token returned by the server response to get the user attribute verification code.

Definition at line 82 of file GetUserAttributeVerificationCodeRequest.h.

◆ WithAccessToken() [2/3]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::WithAccessToken ( const Aws::String value)
inline

The access token returned by the server response to get the user attribute verification code.

Definition at line 76 of file GetUserAttributeVerificationCodeRequest.h.

◆ WithAccessToken() [3/3]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::WithAccessToken ( const char *  value)
inline

The access token returned by the server response to get the user attribute verification code.

Definition at line 88 of file GetUserAttributeVerificationCodeRequest.h.

◆ WithAttributeName() [1/3]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::WithAttributeName ( Aws::String &&  value)
inline

The attribute name returned by the server response to get the user attribute verification code.

Definition at line 131 of file GetUserAttributeVerificationCodeRequest.h.

◆ WithAttributeName() [2/3]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::WithAttributeName ( const Aws::String value)
inline

The attribute name returned by the server response to get the user attribute verification code.

Definition at line 125 of file GetUserAttributeVerificationCodeRequest.h.

◆ WithAttributeName() [3/3]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::WithAttributeName ( const char *  value)
inline

The attribute name returned by the server response to get the user attribute verification code.

Definition at line 137 of file GetUserAttributeVerificationCodeRequest.h.

◆ WithClientMetadata() [1/2]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 294 of file GetUserAttributeVerificationCodeRequest.h.

◆ WithClientMetadata() [2/2]

GetUserAttributeVerificationCodeRequest& Aws::CognitoIdentityProvider::Model::GetUserAttributeVerificationCodeRequest::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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode 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 268 of file GetUserAttributeVerificationCodeRequest.h.


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