GetUserPoolMfaConfigResponse (p.awso.0.9.1.doc.awso.cognito-idp.Awso_cognito

Sourcetype nonrec t = {

smsMfaConfiguration : SmsMfaConfigType.t option;
(*
Shows user pool configuration for SMS message MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.
*)
softwareTokenMfaConfiguration : SoftwareTokenMfaConfigType.t option;
(*
Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.
*)
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.
*)
mfaConfiguration : UserPoolMfaType.t option;
(*
Displays the state of 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.
*)
webAuthnConfiguration : WebAuthnConfigurationType.t option;
(*
Shows user pool configuration for sign-in with passkey authenticators such as biometric devices and security keys. Includes relying-party configuration, user-verification requirements, and whether passkeys can satisfy MFA requirements.
*)

}

Sourcetype nonrec error = [

| `InternalErrorException of InternalErrorException.t
| `InvalidParameterException of InvalidParameterException.t
| `NotAuthorizedException of NotAuthorizedException.t
| `ResourceNotFoundException of ResourceNotFoundException.t
| `TooManyRequestsException of TooManyRequestsException.t
| `Unknown_operation_error of string * string option

]

val make : 
  ?smsMfaConfiguration:??? ->
  ?softwareTokenMfaConfiguration:??? ->
  ?emailMfaConfiguration:??? ->
  ?mfaConfiguration:??? ->
  ?webAuthnConfiguration:??? ->
  unit ->
  t

Source

val error_of_json : 
  string ->
  Yojson.Safe.t ->
  [> `InternalErrorException of InternalErrorException.t
  | `InvalidParameterException of InvalidParameterException.t
  | `NotAuthorizedException of NotAuthorizedException.t
  | `ResourceNotFoundException of ResourceNotFoundException.t
  | `TooManyRequestsException of TooManyRequestsException.t
  | `Unknown_operation_error of string * string option ]

Source

val error_of_xml : 
  string ->
  Awso.Xml.t ->
  [> `InternalErrorException of InternalErrorException.t
  | `InvalidParameterException of InvalidParameterException.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

Source

val 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