Module Values.SetUserPoolMfaConfigResponseSource

Sets user pool multi-factor authentication (MFA) and passkey configuration. For more information about user pool MFA, see Adding MFA. For more information about WebAuthn passkeys see Authentication flows. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Sourcetype nonrec t = {
  1. smsMfaConfiguration : SmsMfaConfigType.t option;
    (*

    Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs. Includes the message template and the SMS message sending configuration for Amazon SNS.

    *)
  2. softwareTokenMfaConfiguration : SoftwareTokenMfaConfigType.t option;
    (*

    Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.

    *)
  3. emailMfaConfiguration : EmailMfaConfigType.t option;
    (*

    Shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.

    *)
  4. mfaConfiguration : UserPoolMfaType.t option;
    (*

    Displays multi-factor authentication (MFA) as on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL. When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

    *)
  5. webAuthnConfiguration : WebAuthnConfigurationType.t option;
    (*

    The configuration of your user pool for passkey, or WebAuthn, sign-in with authenticators such as biometric and security-key devices. Includes relying-party configuration and settings for user-verification requirements.

    *)
}
Sourcetype nonrec error = [
  1. | `ConcurrentModificationException of ConcurrentModificationException.t
  2. | `FeatureUnavailableInTierException of FeatureUnavailableInTierException.t
  3. | `InternalErrorException of InternalErrorException.t
  4. | `InvalidParameterException of InvalidParameterException.t
  5. | `InvalidSmsRoleAccessPolicyException of InvalidSmsRoleAccessPolicyException.t
  6. | `InvalidSmsRoleTrustRelationshipException of InvalidSmsRoleTrustRelationshipException.t
  7. | `NotAuthorizedException of NotAuthorizedException.t
  8. | `ResourceNotFoundException of ResourceNotFoundException.t
  9. | `TooManyRequestsException of TooManyRequestsException.t
  10. | `Unknown_operation_error of string * string option
]
Sourceval make : ?smsMfaConfiguration:??? -> ?softwareTokenMfaConfiguration:??? -> ?emailMfaConfiguration:??? -> ?mfaConfiguration:??? -> ?webAuthnConfiguration:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ConcurrentModificationException of ConcurrentModificationException.t | `FeatureUnavailableInTierException of FeatureUnavailableInTierException.t | `InternalErrorException of InternalErrorException.t | `InvalidParameterException of InvalidParameterException.t | `InvalidSmsRoleAccessPolicyException of InvalidSmsRoleAccessPolicyException.t | `InvalidSmsRoleTrustRelationshipException of InvalidSmsRoleTrustRelationshipException.t | `NotAuthorizedException of NotAuthorizedException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ConcurrentModificationException of ConcurrentModificationException.t | `FeatureUnavailableInTierException of FeatureUnavailableInTierException.t | `InternalErrorException of InternalErrorException.t | `InvalidParameterException of InvalidParameterException.t | `InvalidSmsRoleAccessPolicyException of InvalidSmsRoleAccessPolicyException.t | `InvalidSmsRoleTrustRelationshipException of InvalidSmsRoleTrustRelationshipException.t | `NotAuthorizedException of NotAuthorizedException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Boolean of BooleanType.t | `Enum of string | `String of SmsVerificationMessageType.t | `Structure of (string * [> `String of ArnType.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t