Skip to content

CreateUserRequest

Source code in docs_src/capo_appstream/types/create_user_request.py
class CreateUserRequest(TypedDict, closed=True):
    user_name: NotRequired["capo_appstream.types.username.Username"]
    """<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.</p> </note>"""
    message_action: NotRequired["capo_appstream.types.message_action.MessageAction"]
    """<p>The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. </p> <note> <p>The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.</p> </note>"""
    first_name: NotRequired[
        "capo_appstream.types.user_attribute_value.UserAttributeValue"
    ]
    """<p>The first name, or given name, of the user.</p>"""
    last_name: NotRequired[
        "capo_appstream.types.user_attribute_value.UserAttributeValue"
    ]
    """<p>The last name, or surname, of the user.</p>"""
    authentication_type: NotRequired[
        "capo_appstream.types.authentication_type.AuthenticationType"
    ]
    """<p>The authentication type for the user. You must specify USERPOOL. </p>"""

authentication_type instance-attribute

authentication_type: NotRequired[AuthenticationType]

The authentication type for the user. You must specify USERPOOL.

first_name instance-attribute

first_name: NotRequired[UserAttributeValue]

The first name, or given name, of the user.

last_name instance-attribute

last_name: NotRequired[UserAttributeValue]

The last name, or surname, of the user.

message_action instance-attribute

message_action: NotRequired[MessageAction]

The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.

user_name instance-attribute

user_name: NotRequired[Username]

The email address of the user.

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.