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

Sourcetype nonrec t = {

username : UsernameType.t option;
(*
The name of the user that you requested.
*)
userAttributes : AttributeListType.t option;
(*
An array of name-value pairs representing user attributes. Custom attributes are prepended with the custom: prefix.
*)
mFAOptions : MFAOptionListType.t option;
(*
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
*)
preferredMfaSetting : StringType.t option;
(*
The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.
*)
userMFASettingList : UserMFASettingListType.t option;
(*
The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.
*)

}

Sourcetype nonrec error = [

| `ForbiddenException of ForbiddenException.t
| `InternalErrorException of InternalErrorException.t
| `InvalidParameterException of InvalidParameterException.t
| `NotAuthorizedException of NotAuthorizedException.t
| `PasswordResetRequiredException of PasswordResetRequiredException.t
| `ResourceNotFoundException of ResourceNotFoundException.t
| `TooManyRequestsException of TooManyRequestsException.t
| `UserNotConfirmedException of UserNotConfirmedException.t
| `UserNotFoundException of UserNotFoundException.t
| `Unknown_operation_error of string * string option

]

val make : 
  ?username:??? ->
  ?userAttributes:??? ->
  ?mFAOptions:??? ->
  ?preferredMfaSetting:??? ->
  ?userMFASettingList:??? ->
  unit ->
  t

Source

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

Source

val error_of_xml : 
  string ->
  Awso.Xml.t ->
  [> `ForbiddenException of ForbiddenException.t
  | `InternalErrorException of InternalErrorException.t
  | `InvalidParameterException of InvalidParameterException.t
  | `NotAuthorizedException of NotAuthorizedException.t
  | `PasswordResetRequiredException of PasswordResetRequiredException.t
  | `ResourceNotFoundException of ResourceNotFoundException.t
  | `TooManyRequestsException of TooManyRequestsException.t
  | `Unknown_operation_error of string * string option
  | `UserNotConfirmedException of UserNotConfirmedException.t
  | `UserNotFoundException of UserNotFoundException.t ]

Sourceval error_to_json : error -> Yojson.Safe.t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `List of
               [> `String of StringType.t
               | `Structure of
                 (string
                  * [> `Enum of string | `String of AttributeNameType.t ])
                   list ]
                 list
          | `String of UsernameType.t ])
         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