set_user_settings

CognitoIdentityProvider.Client.set_user_settings(**kwargs)

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.

See also: AWS API Documentation

Request Syntax

response = client.set_user_settings(
    AccessToken='string',
    MFAOptions=[
        {
            'DeliveryMedium': 'SMS'|'EMAIL',
            'AttributeName': 'string'
        },
    ]
)

Parameters

• AccessToken (string) --

  [REQUIRED]

  A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

• MFAOptions (list) --

  [REQUIRED]

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

  • (dict) --

    This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.

    • DeliveryMedium (string) --

      The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

    • AttributeName (string) --

      The attribute name of the MFA option type. The only valid value is phone_number .

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

  The response from the server for a set user settings request.

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
• CognitoIdentityProvider.Client.exceptions.InvalidParameterException
• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
• CognitoIdentityProvider.Client.exceptions.PasswordResetRequiredException
• CognitoIdentityProvider.Client.exceptions.UserNotFoundException
• CognitoIdentityProvider.Client.exceptions.UserNotConfirmedException
• CognitoIdentityProvider.Client.exceptions.InternalErrorException
• CognitoIdentityProvider.Client.exceptions.ForbiddenException