setUserSettings method

Future<void> setUserSettings({ required String accessToken, required List<MFAOptionType> mFAOptions, })

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

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw NotAuthorizedException. May throw PasswordResetRequiredException. May throw UserNotFoundException. May throw UserNotConfirmedException. May throw InternalErrorException.

Parameter accessToken : The access token for the set user settings request.

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

Implementation

Future<void> setUserSettings({
  required String accessToken,
  required List<MFAOptionType> mFAOptions,
}) async {
  ArgumentError.checkNotNull(accessToken, 'accessToken');
  ArgumentError.checkNotNull(mFAOptions, 'mFAOptions');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.SetUserSettings'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    signed: false,
    // TODO queryParams
    headers: headers,
    payload: {
      'AccessToken': accessToken,
      'MFAOptions': mFAOptions,
    },
  );
}