Struct rusoto_cognito_idp::SignUpRequest

pub struct SignUpRequest {
    pub analytics_metadata: Option<AnalyticsMetadataType>,
    pub client_id: String,
    pub client_metadata: Option<HashMap<String, String>>,
    pub password: String,
    pub secret_hash: Option<String>,
    pub user_attributes: Option<Vec<AttributeType>>,
    pub user_context_data: Option<UserContextDataType>,
    pub username: String,
    pub validation_data: Option<Vec<AttributeType>>,
}

Represents the request to register a user.

Fields

analytics_metadata: Option<AnalyticsMetadataType>

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

client_id: String

The ID of the client associated with the user pool.

client_metadata: Option<HashMap<String, String>>

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.

password: String

The password of the user you wish to register.

secret_hash: Option<String>

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.

user_attributes: Option<Vec<AttributeType>>

An array of name-value pairs representing user attributes.

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

user_context_data: Option<UserContextDataType>

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.

username: String

The user name of the user you wish to register.

validation_data: Option<Vec<AttributeType>>

The validation data in the request to register a user.

Trait Implementations

impl Clone for SignUpRequest

pub fn clone(&self) -> SignUpRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignUpRequest

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SignUpRequest

pub fn default() -> SignUpRequest

Returns the "default value" for a type.

impl PartialEq<SignUpRequest> for SignUpRequest

pub fn eq(&self, other: &SignUpRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &SignUpRequest) -> bool

This method tests for !=.

impl Serialize for SignUpRequest

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SignUpRequest