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 UpdateUserPool operation. Updates the specified user pool with the specified attributes.

Inheritance Hierarchy

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

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

Syntax

C#
public class UpdateUserPoolRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The UpdateUserPoolRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateUserPoolRequest()

Properties

NameTypeDescription
Public Property AdminCreateUserConfig Amazon.CognitoIdentityProvider.Model.AdminCreateUserConfigType

Gets and sets the property AdminCreateUserConfig.

The configuration for AdminCreateUser requests.

Public Property AutoVerifiedAttributes System.Collections.Generic.List<System.String>

Gets and sets the property AutoVerifiedAttributes.

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Public Property DeviceConfiguration Amazon.CognitoIdentityProvider.Model.DeviceConfigurationType

Gets and sets the property DeviceConfiguration.

Device configuration.

Public Property EmailConfiguration Amazon.CognitoIdentityProvider.Model.EmailConfigurationType

Gets and sets the property EmailConfiguration.

Email configuration.

Public Property EmailVerificationMessage System.String

Gets and sets the property EmailVerificationMessage.

The contents of the email verification message.

Public Property EmailVerificationSubject System.String

Gets and sets the property EmailVerificationSubject.

The subject of the email verification message.

Public Property LambdaConfig Amazon.CognitoIdentityProvider.Model.LambdaConfigType

Gets and sets the property LambdaConfig.

The AWS Lambda configuration information from the request to update the user pool.

Public Property MfaConfiguration Amazon.CognitoIdentityProvider.UserPoolMfaType

Gets and sets the property MfaConfiguration.

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

Public Property Policies Amazon.CognitoIdentityProvider.Model.UserPoolPolicyType

Gets and sets the property Policies.

A container with the policies you wish to update in a user pool.

Public Property SmsAuthenticationMessage System.String

Gets and sets the property SmsAuthenticationMessage.

The contents of the SMS authentication message.

Public Property SmsConfiguration Amazon.CognitoIdentityProvider.Model.SmsConfigurationType

Gets and sets the property SmsConfiguration.

SMS configuration.

Public Property SmsVerificationMessage System.String

Gets and sets the property SmsVerificationMessage.

A container with information about the SMS verification message.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

The user pool ID for the user pool you want to update.

Public Property UserPoolTags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property UserPoolTags.

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

Public Property VerificationMessageTemplate Amazon.CognitoIdentityProvider.Model.VerificationMessageTemplateType

Gets and sets the property VerificationMessageTemplate.

The template for verification messages.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms