Struct rusoto_cognito_idp::SignUpRequest

pub struct SignUpRequest {
    pub analytics_metadata: Option<AnalyticsMetadataType>,
    pub client_id: 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.

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 Default for SignUpRequest

fn default() -> SignUpRequest

Returns the "default value" for a type.

impl Debug for SignUpRequest

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for SignUpRequest

fn clone(&self) -> SignUpRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for SignUpRequest

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

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

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

This method tests for !=.