Struct rusoto_cognito_idp::ConfirmSignUpRequest

pub struct ConfirmSignUpRequest {
    pub analytics_metadata: Option<AnalyticsMetadataType>,
    pub client_id: String,
    pub confirmation_code: String,
    pub force_alias_creation: Option<bool>,
    pub secret_hash: Option<String>,
    pub user_context_data: Option<UserContextDataType>,
    pub username: String,
}

Represents the request to confirm registration of a user.

Fields

analytics_metadata: Option<AnalyticsMetadataType>

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

client_id: String

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

confirmation_code: String

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

force_alias_creation: Option<bool>

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.

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_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 whose registration you wish to confirm.

Trait Implementations

impl Clone for ConfirmSignUpRequest

fn clone(&self) -> ConfirmSignUpRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ConfirmSignUpRequest

fn default() -> ConfirmSignUpRequest

Returns the "default value" for a type.

impl PartialEq<ConfirmSignUpRequest> for ConfirmSignUpRequest

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

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

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

This method tests for !=.

impl Debug for ConfirmSignUpRequest

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

Formats the value using the given formatter.

impl Serialize for ConfirmSignUpRequest

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

Serialize this value into the given Serde serializer.