Struct SignUpOutput 

#[non_exhaustive]
pub struct SignUpOutput {
    pub user_confirmed: bool,
    pub code_delivery_details: Option<CodeDeliveryDetailsType>,
    pub user_sub: String,
    pub session: Option<String>,
    /* private fields */
}

The response from the server for a registration request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_confirmed: bool

Indicates whether the user was automatically confirmed. You can auto-confirm users with a pre sign-up Lambda trigger.

code_delivery_details: Option<CodeDeliveryDetailsType>

In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered. The CodeDeliveryDetails object is information about the delivery destination for that link or code.

user_sub: String

The unique identifier of the new user, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

session: Option<String>

A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.

Implementations

impl SignUpOutput

pub fn user_confirmed(&self) -> bool

Indicates whether the user was automatically confirmed. You can auto-confirm users with a pre sign-up Lambda trigger.

pub fn code_delivery_details(&self) -> Option<&CodeDeliveryDetailsType>

In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered. The CodeDeliveryDetails object is information about the delivery destination for that link or code.

pub fn user_sub(&self) -> &str

The unique identifier of the new user, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

pub fn session(&self) -> Option<&str>

A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.

impl SignUpOutput

pub fn builder() -> SignUpOutputBuilder

Creates a new builder-style object to manufacture SignUpOutput.

Trait Implementations

impl Clone for SignUpOutput

fn clone(&self) -> SignUpOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignUpOutput

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

Formats the value using the given formatter.

impl PartialEq for SignUpOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for SignUpOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for SignUpOutput