UpdateUserPoolRequest Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    accountRecoverySetting

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Declaration

Swift

public let accountRecoverySetting: AccountRecoverySettingType?


                    
                    
                    adminCreateUserConfig

The configuration for AdminCreateUser requests.

Declaration

Swift

public let adminCreateUserConfig: AdminCreateUserConfigType?


                    
                    
                    autoVerifiedAttributes

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

Declaration

Swift

public let autoVerifiedAttributes: [VerifiedAttributeType]?


                    
                    
                    deviceConfiguration

Device configuration.

Declaration

Swift

public let deviceConfiguration: DeviceConfigurationType?


                    
                    
                    emailConfiguration

Email configuration.

Declaration

Swift

public let emailConfiguration: EmailConfigurationType?


                    
                    
                    emailVerificationMessage

The contents of the email verification message.

Declaration

Swift

public let emailVerificationMessage: String?


                    
                    
                    emailVerificationSubject

The subject of the email verification message.

Declaration

Swift

public let emailVerificationSubject: String?


                    
                    
                    lambdaConfig

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

Declaration

Swift

public let lambdaConfig: LambdaConfigType?


                    
                    
                    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.

Declaration

Swift

public let mfaConfiguration: UserPoolMfaType?


                    
                    
                    policies

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

Declaration

Swift

public let policies: UserPoolPolicyType?


                    
                    
                    smsAuthenticationMessage

The contents of the SMS authentication message.

Declaration

Swift

public let smsAuthenticationMessage: String?


                    
                    
                    smsConfiguration

SMS configuration.

Declaration

Swift

public let smsConfiguration: SmsConfigurationType?


                    
                    
                    smsVerificationMessage

A container with information about the SMS verification message.

Declaration

Swift

public let smsVerificationMessage: String?


                    
                    
                    userPoolAddOns

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value “AUDIT”.

Declaration

Swift

public let userPoolAddOns: UserPoolAddOnsType?


                    
                    
                    userPoolId

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

Declaration

Swift

public let userPoolId: String


                    
                    
                    userPoolTags

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Declaration

Swift

public let userPoolTags: [String : String]?


                    
                    
                    verificationMessageTemplate

The template for verification messages.

Declaration

Swift

public let verificationMessageTemplate: VerificationMessageTemplateType?


                    
                    
                    init(accountRecoverySetting:adminCreateUserConfig:autoVerifiedAttributes:deviceConfiguration:emailConfiguration:emailVerificationMessage:emailVerificationSubject:lambdaConfig:mfaConfiguration:policies:smsAuthenticationMessage:smsConfiguration:smsVerificationMessage:userPoolAddOns:userPoolId:userPoolTags:verificationMessageTemplate:)

Undocumented

Declaration

Swift

public init(accountRecoverySetting: AccountRecoverySettingType? = nil, adminCreateUserConfig: AdminCreateUserConfigType? = nil, autoVerifiedAttributes: [VerifiedAttributeType]? = nil, deviceConfiguration: DeviceConfigurationType? = nil, emailConfiguration: EmailConfigurationType? = nil, emailVerificationMessage: String? = nil, emailVerificationSubject: String? = nil, lambdaConfig: LambdaConfigType? = nil, mfaConfiguration: UserPoolMfaType? = nil, policies: UserPoolPolicyType? = nil, smsAuthenticationMessage: String? = nil, smsConfiguration: SmsConfigurationType? = nil, smsVerificationMessage: String? = nil, userPoolAddOns: UserPoolAddOnsType? = nil, userPoolId: String, userPoolTags: [String : String]? = nil, verificationMessageTemplate: VerificationMessageTemplateType? = nil)


                    
                    
                    validate(name:)

Declaration

Swift

public func validate(name: String) throws