Skip to content

GetUserResponse

Source code in docs_src/capo_cognito_identity_provider/types/get_user_response.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class GetUserResponse(TypedDict, closed=True):
    username: "capo_cognito_identity_provider.types.username_type.UsernameType"
    """<p>The name of the user that you requested.</p>"""
    user_attributes: (
        "capo_cognito_identity_provider.types.attribute_list_type.AttributeListType"
    )
    """<p>An array of name-value pairs representing user attributes.</p> <p>Custom attributes are prepended with the <code>custom:</code> prefix.</p>"""
    mfa_options: NotRequired[
        "capo_cognito_identity_provider.types.mfa_option_list_type.MFAOptionListType"
    ]
    """<p> <i>This response parameter is no longer supported.</i> It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.</p>"""
    preferred_mfa_setting: NotRequired[
        "capo_cognito_identity_provider.types.string_type.StringType"
    ]
    """<p>The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.</p>"""
    user_mfa_setting_list: NotRequired[
        "capo_cognito_identity_provider.types.user_mfa_setting_list_type.UserMFASettingListType"
    ]
    """<p>The MFA options that are activated for the user. The possible values in this list are <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and <code>SOFTWARE_TOKEN_MFA</code>.</p>"""

mfa_options instance-attribute 

mfa_options: NotRequired[MFAOptionListType]

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

preferred_mfa_setting instance-attribute 

preferred_mfa_setting: NotRequired[StringType]

The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.

user_attributes instance-attribute 

user_attributes: AttributeListType

An array of name-value pairs representing user attributes.

Custom attributes are prepended with the custom: prefix.

user_mfa_setting_list instance-attribute 

user_mfa_setting_list: NotRequired[UserMFASettingListType]

The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

username instance-attribute 

username: UsernameType

The name of the user that you requested.