UpdateUserPoolRequest

import type { UpdateUserPoolRequest } from "https://aws-api.deno.dev/v0.3/services/cognitoidentityserviceprovider.ts?docs=full";

Represents the request to update the user pool.

interface UpdateUserPoolRequest {

AccountRecoverySetting?: AccountRecoverySettingType | null;

AdminCreateUserConfig?: AdminCreateUserConfigType | null;

AutoVerifiedAttributes?: VerifiedAttributeType[] | null;

DeviceConfiguration?: DeviceConfigurationType | null;

EmailConfiguration?: EmailConfigurationType | null;

EmailVerificationMessage?: string | null;

EmailVerificationSubject?: string | null;

LambdaConfig?: LambdaConfigType | null;

MfaConfiguration?: UserPoolMfaType | null;

Policies?: UserPoolPolicyType | null;

SmsAuthenticationMessage?: string | null;

SmsConfiguration?: SmsConfigurationType | null;

SmsVerificationMessage?: string | null;

UserPoolAddOns?: UserPoolAddOnsType | null;

UserPoolId: string;

UserPoolTags?: {

[key: string]: string | null | undefined;

} | null;

VerificationMessageTemplate?: VerificationMessageTemplateType | null;

}

§Properties

AccountRecoverySetting?: AccountRecoverySettingType | null

[src]

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.

AdminCreateUserConfig?: AdminCreateUserConfigType | null

[src]

The configuration for AdminCreateUser requests.

AutoVerifiedAttributes?: VerifiedAttributeType[] | null

[src]

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

DeviceConfiguration?: DeviceConfigurationType | null

[src]

Device configuration.

EmailConfiguration?: EmailConfigurationType | null

[src]

Email configuration.

EmailVerificationMessage?: string | null

[src]

The contents of the email verification message.

EmailVerificationSubject?: string | null

[src]

The subject of the email verification message.

LambdaConfig?: LambdaConfigType | null

[src]

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

MfaConfiguration?: UserPoolMfaType | null

[src]

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 ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.

Policies?: UserPoolPolicyType | null

[src]

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

SmsAuthenticationMessage?: string | null

[src]

The contents of the SMS authentication message.

SmsConfiguration?: SmsConfigurationType | null

[src]

SMS configuration.

SmsVerificationMessage?: string | null

[src]

A container with information about the SMS verification message.

UserPoolAddOns?: UserPoolAddOnsType | null

[src]

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

UserPoolId: string

[src]

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

UserPoolTags?: {

[key: string]: string | null | undefined;

} | null

[src]

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.

VerificationMessageTemplate?: VerificationMessageTemplateType | null

[src]

The template for verification messages.