UserType ¶

class UserType(TypedDict, closed=True):
    username: NotRequired[
        "capo_cognito_identity_provider.types.username_type.UsernameType"
    ]
    """<p>The user's username.</p>"""
    attributes: NotRequired[
        "capo_cognito_identity_provider.types.attribute_list_type.AttributeListType"
    ]
    """<p>Names and values of a user's attributes, for example <code>email</code>.</p>"""
    user_create_date: NotRequired[
        "capo_cognito_identity_provider.types.date_type.DateType"
    ]
    """<p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>"""
    user_last_modified_date: NotRequired[
        "capo_cognito_identity_provider.types.date_type.DateType"
    ]
    """<p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>"""
    enabled: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>Indicates whether the user's account is enabled or disabled.</p>"""
    user_status: NotRequired[
        "capo_cognito_identity_provider.types.user_status_type.UserStatusType"
    ]
    """<p>The user status. This can be one of the following:</p> <ul> <li> <p> <code>UNCONFIRMED</code>: User has been created but not confirmed.</p> </li> <li> <p> <code>CONFIRMED</code>: User has been confirmed.</p> </li> <li> <p> <code>EXTERNAL_PROVIDER</code>: User signed in with a third-party IdP.</p> </li> <li> <p> <code>RESET_REQUIRED</code>: User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p> <code>FORCE_CHANGE_PASSWORD</code>: The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. </p> </li> </ul> <p>The statuses <code>ARCHIVED</code>, <code>UNKNOWN</code>, and <code>COMPROMISED</code> are no longer used.</p>"""
    mfa_options: NotRequired[
        "capo_cognito_identity_provider.types.mfa_option_list_type.MFAOptionListType"
    ]
    """<p>The user's MFA configuration.</p>"""