AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the SetUserSettings operation. 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.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.SetUserSettingsRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public class SetUserSettingsRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The SetUserSettingsRequest type exposes the following members

Constructors

NameDescription
Public Method SetUserSettingsRequest()

Properties

NameTypeDescription
Public Property AccessToken System.String

Gets and sets the property AccessToken.

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

Public Property MFAOptions System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.MFAOptionType>

Gets and sets the property MFAOptions.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5