Skip to content

SignUpResponse

Source code in docs_src/capo_cognito_identity_provider/types/sign_up_response.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class SignUpResponse(TypedDict, closed=True):
    user_confirmed: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>Indicates whether the user was automatically confirmed. You can auto-confirm users with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">pre sign-up Lambda trigger</a>.</p>"""
    code_delivery_details: NotRequired[
        "capo_cognito_identity_provider.types.code_delivery_details_type.CodeDeliveryDetailsType"
    ]
    """<p>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 <code>CodeDeliveryDetails</code> object is information about the delivery destination for that link or code.</p>"""
    user_sub: "capo_cognito_identity_provider.types.string_type.StringType"
    """<p>The unique identifier of the new user, for example <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>"""
    session: NotRequired[
        "capo_cognito_identity_provider.types.session_type.SessionType"
    ]
    """<p>A session Id that you can pass to <code>ConfirmSignUp</code> when you want to immediately sign in your user with the <code>USER_AUTH</code> flow after they complete sign-up.</p>"""

code_delivery_details instance-attribute 

code_delivery_details: NotRequired[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.

session instance-attribute 

session: NotRequired[SessionType]

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.

user_confirmed instance-attribute 

user_confirmed: BooleanType

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

user_sub instance-attribute 

user_sub: StringType

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