Skip to content

AdminSetUserSettingsRequest

Source code in docs_src/capo_cognito_identity_provider/types/admin_set_user_settings_request.py 
15
16
17
18
19
20
21
22
23
24
25
class AdminSetUserSettingsRequest(TypedDict, closed=True):
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool that contains the user whose options you're setting.</p>"""
    username: "capo_cognito_identity_provider.types.username_type.UsernameType"
    """<p>The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p>"""
    mfa_options: (
        "capo_cognito_identity_provider.types.mfa_option_list_type.MFAOptionListType"
    )
    """<p>You can use this parameter only to set an SMS configuration that uses SMS for delivery.</p>"""

mfa_options instance-attribute 

mfa_options: MFAOptionListType

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

user_pool_id instance-attribute 

user_pool_id: UserPoolIdType

The ID of the user pool that contains the user whose options you're setting.

username instance-attribute 

username: UsernameType

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.