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

#include <SignUpRequest.h>

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

Public Member Functions

 SignUpRequest ()
 
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)
 
SignUpRequestWithClientId (const Aws::String &value)
 
SignUpRequestWithClientId (Aws::String &&value)
 
SignUpRequestWithClientId (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)
 
SignUpRequestWithSecretHash (const Aws::String &value)
 
SignUpRequestWithSecretHash (Aws::String &&value)
 
SignUpRequestWithSecretHash (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)
 
SignUpRequestWithUsername (const Aws::String &value)
 
SignUpRequestWithUsername (Aws::String &&value)
 
SignUpRequestWithUsername (const char *value)
 
const Aws::StringGetPassword () const
 
bool PasswordHasBeenSet () const
 
void SetPassword (const Aws::String &value)
 
void SetPassword (Aws::String &&value)
 
void SetPassword (const char *value)
 
SignUpRequestWithPassword (const Aws::String &value)
 
SignUpRequestWithPassword (Aws::String &&value)
 
SignUpRequestWithPassword (const char *value)
 
const Aws::Vector< AttributeType > & GetUserAttributes () const
 
bool UserAttributesHasBeenSet () const
 
void SetUserAttributes (const Aws::Vector< AttributeType > &value)
 
void SetUserAttributes (Aws::Vector< AttributeType > &&value)
 
SignUpRequestWithUserAttributes (const Aws::Vector< AttributeType > &value)
 
SignUpRequestWithUserAttributes (Aws::Vector< AttributeType > &&value)
 
SignUpRequestAddUserAttributes (const AttributeType &value)
 
SignUpRequestAddUserAttributes (AttributeType &&value)
 
const Aws::Vector< AttributeType > & GetValidationData () const
 
bool ValidationDataHasBeenSet () const
 
void SetValidationData (const Aws::Vector< AttributeType > &value)
 
void SetValidationData (Aws::Vector< AttributeType > &&value)
 
SignUpRequestWithValidationData (const Aws::Vector< AttributeType > &value)
 
SignUpRequestWithValidationData (Aws::Vector< AttributeType > &&value)
 
SignUpRequestAddValidationData (const AttributeType &value)
 
SignUpRequestAddValidationData (AttributeType &&value)
 
const AnalyticsMetadataTypeGetAnalyticsMetadata () const
 
bool AnalyticsMetadataHasBeenSet () const
 
void SetAnalyticsMetadata (const AnalyticsMetadataType &value)
 
void SetAnalyticsMetadata (AnalyticsMetadataType &&value)
 
SignUpRequestWithAnalyticsMetadata (const AnalyticsMetadataType &value)
 
SignUpRequestWithAnalyticsMetadata (AnalyticsMetadataType &&value)
 
const UserContextDataTypeGetUserContextData () const
 
bool UserContextDataHasBeenSet () const
 
void SetUserContextData (const UserContextDataType &value)
 
void SetUserContextData (UserContextDataType &&value)
 
SignUpRequestWithUserContextData (const UserContextDataType &value)
 
SignUpRequestWithUserContextData (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)
 
SignUpRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
SignUpRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
SignUpRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
SignUpRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
SignUpRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
SignUpRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
SignUpRequestAddClientMetadata (const char *key, Aws::String &&value)
 
SignUpRequestAddClientMetadata (Aws::String &&key, const char *value)
 
SignUpRequestAddClientMetadata (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 register a user.

See Also:

AWS API Reference

Definition at line 29 of file SignUpRequest.h.

Constructor & Destructor Documentation

◆ SignUpRequest()

Aws::CognitoIdentityProvider::Model::SignUpRequest::SignUpRequest ( )

Member Function Documentation

◆ AddClientMetadata() [1/7]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 575 of file SignUpRequest.h.

◆ AddClientMetadata() [2/7]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 601 of file SignUpRequest.h.

◆ AddClientMetadata() [3/7]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 627 of file SignUpRequest.h.

◆ AddClientMetadata() [4/7]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 653 of file SignUpRequest.h.

◆ AddClientMetadata() [5/7]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 679 of file SignUpRequest.h.

◆ AddClientMetadata() [6/7]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 705 of file SignUpRequest.h.

◆ AddClientMetadata() [7/7]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 731 of file SignUpRequest.h.

◆ AddUserAttributes() [1/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::AddUserAttributes ( const AttributeType value)
inline

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Definition at line 264 of file SignUpRequest.h.

◆ AddUserAttributes() [2/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::AddUserAttributes ( AttributeType &&  value)
inline

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Definition at line 271 of file SignUpRequest.h.

◆ AddValidationData() [1/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::AddValidationData ( const AttributeType value)
inline

The validation data in the request to register a user.

Definition at line 307 of file SignUpRequest.h.

◆ AddValidationData() [2/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::AddValidationData ( AttributeType &&  value)
inline

The validation data in the request to register a user.

Definition at line 312 of file SignUpRequest.h.

◆ AnalyticsMetadataHasBeenSet()

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

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

Definition at line 325 of file SignUpRequest.h.

◆ ClientIdHasBeenSet()

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

The ID of the client associated with the user pool.

Definition at line 53 of file SignUpRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 445 of file SignUpRequest.h.

◆ GetAnalyticsMetadata()

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

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

Definition at line 319 of file SignUpRequest.h.

◆ GetClientId()

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

The ID of the client associated with the user pool.

Definition at line 48 of file SignUpRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 419 of file SignUpRequest.h.

◆ GetPassword()

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

The password of the user you wish to register.

Definition at line 179 of file SignUpRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSecretHash()

const Aws::String& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 90 of file SignUpRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file SignUpRequest.h.

◆ GetUserAttributes()

const Aws::Vector<AttributeType>& Aws::CognitoIdentityProvider::Model::SignUpRequest::GetUserAttributes ( ) const
inline

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Definition at line 222 of file SignUpRequest.h.

◆ GetUserContextData()

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

◆ GetUsername()

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

The user name of the user you wish to register.

Definition at line 138 of file SignUpRequest.h.

◆ GetValidationData()

const Aws::Vector<AttributeType>& Aws::CognitoIdentityProvider::Model::SignUpRequest::GetValidationData ( ) const
inline

The validation data in the request to register a user.

Definition at line 277 of file SignUpRequest.h.

◆ PasswordHasBeenSet()

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

The password of the user you wish to register.

Definition at line 184 of file SignUpRequest.h.

◆ SecretHashHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAnalyticsMetadata() [1/2]

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

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

Definition at line 331 of file SignUpRequest.h.

◆ SetAnalyticsMetadata() [2/2]

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

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

Definition at line 337 of file SignUpRequest.h.

◆ SetClientId() [1/3]

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

The ID of the client associated with the user pool.

Definition at line 58 of file SignUpRequest.h.

◆ SetClientId() [2/3]

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

The ID of the client associated with the user pool.

Definition at line 63 of file SignUpRequest.h.

◆ SetClientId() [3/3]

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

The ID of the client associated with the user pool.

Definition at line 68 of file SignUpRequest.h.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 471 of file SignUpRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 497 of file SignUpRequest.h.

◆ SetPassword() [1/3]

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

The password of the user you wish to register.

Definition at line 189 of file SignUpRequest.h.

◆ SetPassword() [2/3]

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

The password of the user you wish to register.

Definition at line 194 of file SignUpRequest.h.

◆ SetPassword() [3/3]

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

The password of the user you wish to register.

Definition at line 199 of file SignUpRequest.h.

◆ SetSecretHash() [1/3]

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

◆ SetSecretHash() [2/3]

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

◆ SetSecretHash() [3/3]

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

◆ SetUserAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::SignUpRequest::SetUserAttributes ( const Aws::Vector< AttributeType > &  value)
inline

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Definition at line 236 of file SignUpRequest.h.

◆ SetUserAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::SignUpRequest::SetUserAttributes ( Aws::Vector< AttributeType > &&  value)
inline

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Definition at line 243 of file SignUpRequest.h.

◆ SetUserContextData() [1/2]

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

◆ SetUserContextData() [2/2]

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

◆ SetUsername() [1/3]

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

The user name of the user you wish to register.

Definition at line 148 of file SignUpRequest.h.

◆ SetUsername() [2/3]

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

The user name of the user you wish to register.

Definition at line 153 of file SignUpRequest.h.

◆ SetUsername() [3/3]

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

The user name of the user you wish to register.

Definition at line 158 of file SignUpRequest.h.

◆ SetValidationData() [1/2]

void Aws::CognitoIdentityProvider::Model::SignUpRequest::SetValidationData ( const Aws::Vector< AttributeType > &  value)
inline

The validation data in the request to register a user.

Definition at line 287 of file SignUpRequest.h.

◆ SetValidationData() [2/2]

void Aws::CognitoIdentityProvider::Model::SignUpRequest::SetValidationData ( Aws::Vector< AttributeType > &&  value)
inline

The validation data in the request to register a user.

Definition at line 292 of file SignUpRequest.h.

◆ UserAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::SignUpRequest::UserAttributesHasBeenSet ( ) const
inline

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Definition at line 229 of file SignUpRequest.h.

◆ UserContextDataHasBeenSet()

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

◆ UsernameHasBeenSet()

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

The user name of the user you wish to register.

Definition at line 143 of file SignUpRequest.h.

◆ ValidationDataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::SignUpRequest::ValidationDataHasBeenSet ( ) const
inline

The validation data in the request to register a user.

Definition at line 282 of file SignUpRequest.h.

◆ WithAnalyticsMetadata() [1/2]

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

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

Definition at line 343 of file SignUpRequest.h.

◆ WithAnalyticsMetadata() [2/2]

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

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

Definition at line 349 of file SignUpRequest.h.

◆ WithClientId() [1/3]

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

The ID of the client associated with the user pool.

Definition at line 73 of file SignUpRequest.h.

◆ WithClientId() [2/3]

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

The ID of the client associated with the user pool.

Definition at line 78 of file SignUpRequest.h.

◆ WithClientId() [3/3]

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

The ID of the client associated with the user pool.

Definition at line 83 of file SignUpRequest.h.

◆ WithClientMetadata() [1/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 523 of file SignUpRequest.h.

◆ WithClientMetadata() [2/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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 549 of file SignUpRequest.h.

◆ WithPassword() [1/3]

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

The password of the user you wish to register.

Definition at line 204 of file SignUpRequest.h.

◆ WithPassword() [2/3]

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

The password of the user you wish to register.

Definition at line 209 of file SignUpRequest.h.

◆ WithPassword() [3/3]

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

The password of the user you wish to register.

Definition at line 214 of file SignUpRequest.h.

◆ WithSecretHash() [1/3]

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

◆ WithSecretHash() [2/3]

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

◆ WithSecretHash() [3/3]

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

◆ WithUserAttributes() [1/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::WithUserAttributes ( const Aws::Vector< AttributeType > &  value)
inline

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Definition at line 250 of file SignUpRequest.h.

◆ WithUserAttributes() [2/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::WithUserAttributes ( Aws::Vector< AttributeType > &&  value)
inline

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Definition at line 257 of file SignUpRequest.h.

◆ WithUserContextData() [1/2]

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

◆ WithUserContextData() [2/2]

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

◆ WithUsername() [1/3]

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

The user name of the user you wish to register.

Definition at line 163 of file SignUpRequest.h.

◆ WithUsername() [2/3]

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

The user name of the user you wish to register.

Definition at line 168 of file SignUpRequest.h.

◆ WithUsername() [3/3]

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

The user name of the user you wish to register.

Definition at line 173 of file SignUpRequest.h.

◆ WithValidationData() [1/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::WithValidationData ( const Aws::Vector< AttributeType > &  value)
inline

The validation data in the request to register a user.

Definition at line 297 of file SignUpRequest.h.

◆ WithValidationData() [2/2]

SignUpRequest& Aws::CognitoIdentityProvider::Model::SignUpRequest::WithValidationData ( Aws::Vector< AttributeType > &&  value)
inline

The validation data in the request to register a user.

Definition at line 302 of file SignUpRequest.h.


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