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

#include <ConfirmSignUpRequest.h>

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

Public Member Functions

 ConfirmSignUpRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetClientId () const
 
bool ClientIdHasBeenSet () const
 
void SetClientId (const Aws::String &value)
 
void SetClientId (Aws::String &&value)
 
void SetClientId (const char *value)
 
ConfirmSignUpRequestWithClientId (const Aws::String &value)
 
ConfirmSignUpRequestWithClientId (Aws::String &&value)
 
ConfirmSignUpRequestWithClientId (const char *value)
 
const Aws::StringGetSecretHash () const
 
bool SecretHashHasBeenSet () const
 
void SetSecretHash (const Aws::String &value)
 
void SetSecretHash (Aws::String &&value)
 
void SetSecretHash (const char *value)
 
ConfirmSignUpRequestWithSecretHash (const Aws::String &value)
 
ConfirmSignUpRequestWithSecretHash (Aws::String &&value)
 
ConfirmSignUpRequestWithSecretHash (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)
 
ConfirmSignUpRequestWithUsername (const Aws::String &value)
 
ConfirmSignUpRequestWithUsername (Aws::String &&value)
 
ConfirmSignUpRequestWithUsername (const char *value)
 
const Aws::StringGetConfirmationCode () const
 
bool ConfirmationCodeHasBeenSet () const
 
void SetConfirmationCode (const Aws::String &value)
 
void SetConfirmationCode (Aws::String &&value)
 
void SetConfirmationCode (const char *value)
 
ConfirmSignUpRequestWithConfirmationCode (const Aws::String &value)
 
ConfirmSignUpRequestWithConfirmationCode (Aws::String &&value)
 
ConfirmSignUpRequestWithConfirmationCode (const char *value)
 
bool GetForceAliasCreation () const
 
bool ForceAliasCreationHasBeenSet () const
 
void SetForceAliasCreation (bool value)
 
ConfirmSignUpRequestWithForceAliasCreation (bool value)
 
const AnalyticsMetadataTypeGetAnalyticsMetadata () const
 
bool AnalyticsMetadataHasBeenSet () const
 
void SetAnalyticsMetadata (const AnalyticsMetadataType &value)
 
void SetAnalyticsMetadata (AnalyticsMetadataType &&value)
 
ConfirmSignUpRequestWithAnalyticsMetadata (const AnalyticsMetadataType &value)
 
ConfirmSignUpRequestWithAnalyticsMetadata (AnalyticsMetadataType &&value)
 
const UserContextDataTypeGetUserContextData () const
 
bool UserContextDataHasBeenSet () const
 
void SetUserContextData (const UserContextDataType &value)
 
void SetUserContextData (UserContextDataType &&value)
 
ConfirmSignUpRequestWithUserContextData (const UserContextDataType &value)
 
ConfirmSignUpRequestWithUserContextData (UserContextDataType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetClientMetadata () const
 
bool ClientMetadataHasBeenSet () const
 
void SetClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
ConfirmSignUpRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
ConfirmSignUpRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
ConfirmSignUpRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
ConfirmSignUpRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
ConfirmSignUpRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
ConfirmSignUpRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
ConfirmSignUpRequestAddClientMetadata (const char *key, Aws::String &&value)
 
ConfirmSignUpRequestAddClientMetadata (Aws::String &&key, const char *value)
 
ConfirmSignUpRequestAddClientMetadata (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 registration of a user.

See Also:

AWS API Reference

Definition at line 28 of file ConfirmSignUpRequest.h.

Constructor & Destructor Documentation

◆ ConfirmSignUpRequest()

Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::ConfirmSignUpRequest ( )

Member Function Documentation

◆ AddClientMetadata() [1/7]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 599 of file ConfirmSignUpRequest.h.

◆ AddClientMetadata() [2/7]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 547 of file ConfirmSignUpRequest.h.

◆ AddClientMetadata() [3/7]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 651 of file ConfirmSignUpRequest.h.

◆ AddClientMetadata() [4/7]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 573 of file ConfirmSignUpRequest.h.

◆ AddClientMetadata() [5/7]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 521 of file ConfirmSignUpRequest.h.

◆ AddClientMetadata() [6/7]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 625 of file ConfirmSignUpRequest.h.

◆ AddClientMetadata() [7/7]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 677 of file ConfirmSignUpRequest.h.

◆ AnalyticsMetadataHasBeenSet()

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

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

Definition at line 271 of file ConfirmSignUpRequest.h.

◆ ClientIdHasBeenSet()

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

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

Definition at line 52 of file ConfirmSignUpRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 391 of file ConfirmSignUpRequest.h.

◆ ConfirmationCodeHasBeenSet()

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

The confirmation code sent by a user's request to confirm registration.

Definition at line 183 of file ConfirmSignUpRequest.h.

◆ ForceAliasCreationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::ForceAliasCreationHasBeenSet ( ) const
inline

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Definition at line 236 of file ConfirmSignUpRequest.h.

◆ GetAnalyticsMetadata()

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

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

Definition at line 265 of file ConfirmSignUpRequest.h.

◆ GetClientId()

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

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

Definition at line 47 of file ConfirmSignUpRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 365 of file ConfirmSignUpRequest.h.

◆ GetConfirmationCode()

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

The confirmation code sent by a user's request to confirm registration.

Definition at line 178 of file ConfirmSignUpRequest.h.

◆ GetForceAliasCreation()

bool Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::GetForceAliasCreation ( ) const
inline

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Definition at line 225 of file ConfirmSignUpRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSecretHash()

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

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Definition at line 89 of file ConfirmSignUpRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ConfirmSignUpRequest.h.

◆ GetUserContextData()

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

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Definition at line 303 of file ConfirmSignUpRequest.h.

◆ GetUsername()

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

The user name of the user whose registration you wish to confirm.

Definition at line 137 of file ConfirmSignUpRequest.h.

◆ SecretHashHasBeenSet()

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

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Definition at line 95 of file ConfirmSignUpRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAnalyticsMetadata() [1/2]

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

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

Definition at line 283 of file ConfirmSignUpRequest.h.

◆ SetAnalyticsMetadata() [2/2]

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

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

Definition at line 277 of file ConfirmSignUpRequest.h.

◆ SetClientId() [1/3]

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

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

Definition at line 62 of file ConfirmSignUpRequest.h.

◆ SetClientId() [2/3]

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

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

Definition at line 57 of file ConfirmSignUpRequest.h.

◆ SetClientId() [3/3]

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

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

Definition at line 67 of file ConfirmSignUpRequest.h.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 443 of file ConfirmSignUpRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 417 of file ConfirmSignUpRequest.h.

◆ SetConfirmationCode() [1/3]

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

The confirmation code sent by a user's request to confirm registration.

Definition at line 193 of file ConfirmSignUpRequest.h.

◆ SetConfirmationCode() [2/3]

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

The confirmation code sent by a user's request to confirm registration.

Definition at line 188 of file ConfirmSignUpRequest.h.

◆ SetConfirmationCode() [3/3]

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

The confirmation code sent by a user's request to confirm registration.

Definition at line 198 of file ConfirmSignUpRequest.h.

◆ SetForceAliasCreation()

void Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::SetForceAliasCreation ( bool  value)
inline

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Definition at line 247 of file ConfirmSignUpRequest.h.

◆ SetSecretHash() [1/3]

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

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Definition at line 107 of file ConfirmSignUpRequest.h.

◆ SetSecretHash() [2/3]

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

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Definition at line 101 of file ConfirmSignUpRequest.h.

◆ SetSecretHash() [3/3]

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

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Definition at line 113 of file ConfirmSignUpRequest.h.

◆ SetUserContextData() [1/2]

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

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Definition at line 317 of file ConfirmSignUpRequest.h.

◆ SetUserContextData() [2/2]

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

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Definition at line 324 of file ConfirmSignUpRequest.h.

◆ SetUsername() [1/3]

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

The user name of the user whose registration you wish to confirm.

Definition at line 152 of file ConfirmSignUpRequest.h.

◆ SetUsername() [2/3]

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

The user name of the user whose registration you wish to confirm.

Definition at line 147 of file ConfirmSignUpRequest.h.

◆ SetUsername() [3/3]

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

The user name of the user whose registration you wish to confirm.

Definition at line 157 of file ConfirmSignUpRequest.h.

◆ UserContextDataHasBeenSet()

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

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Definition at line 310 of file ConfirmSignUpRequest.h.

◆ UsernameHasBeenSet()

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

The user name of the user whose registration you wish to confirm.

Definition at line 142 of file ConfirmSignUpRequest.h.

◆ WithAnalyticsMetadata() [1/2]

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

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

Definition at line 295 of file ConfirmSignUpRequest.h.

◆ WithAnalyticsMetadata() [2/2]

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

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

Definition at line 289 of file ConfirmSignUpRequest.h.

◆ WithClientId() [1/3]

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

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

Definition at line 77 of file ConfirmSignUpRequest.h.

◆ WithClientId() [2/3]

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

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

Definition at line 72 of file ConfirmSignUpRequest.h.

◆ WithClientId() [3/3]

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

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

Definition at line 82 of file ConfirmSignUpRequest.h.

◆ WithClientMetadata() [1/2]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 495 of file ConfirmSignUpRequest.h.

◆ WithClientMetadata() [2/2]

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp 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 469 of file ConfirmSignUpRequest.h.

◆ WithConfirmationCode() [1/3]

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

The confirmation code sent by a user's request to confirm registration.

Definition at line 208 of file ConfirmSignUpRequest.h.

◆ WithConfirmationCode() [2/3]

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

The confirmation code sent by a user's request to confirm registration.

Definition at line 203 of file ConfirmSignUpRequest.h.

◆ WithConfirmationCode() [3/3]

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

The confirmation code sent by a user's request to confirm registration.

Definition at line 213 of file ConfirmSignUpRequest.h.

◆ WithForceAliasCreation()

ConfirmSignUpRequest& Aws::CognitoIdentityProvider::Model::ConfirmSignUpRequest::WithForceAliasCreation ( bool  value)
inline

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Definition at line 258 of file ConfirmSignUpRequest.h.

◆ WithSecretHash() [1/3]

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

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Definition at line 125 of file ConfirmSignUpRequest.h.

◆ WithSecretHash() [2/3]

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

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Definition at line 119 of file ConfirmSignUpRequest.h.

◆ WithSecretHash() [3/3]

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

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Definition at line 131 of file ConfirmSignUpRequest.h.

◆ WithUserContextData() [1/2]

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

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Definition at line 331 of file ConfirmSignUpRequest.h.

◆ WithUserContextData() [2/2]

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

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Definition at line 338 of file ConfirmSignUpRequest.h.

◆ WithUsername() [1/3]

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

The user name of the user whose registration you wish to confirm.

Definition at line 167 of file ConfirmSignUpRequest.h.

◆ WithUsername() [2/3]

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

The user name of the user whose registration you wish to confirm.

Definition at line 162 of file ConfirmSignUpRequest.h.

◆ WithUsername() [3/3]

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

The user name of the user whose registration you wish to confirm.

Definition at line 172 of file ConfirmSignUpRequest.h.


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