Module Values.AdminGetUserResponseSource

Represents the response from the server from the request to get the specified user as an administrator.

Sourcetype nonrec t = {
  1. username : UsernameType.t option;
    (*

    The username of the user that you requested.

    *)
  2. userAttributes : AttributeListType.t option;
    (*

    An array of name-value pairs of user attributes and their values, for example "email": "testuser@example.com".

    *)
  3. userCreateDate : DateType.t option;
    (*

    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    *)
  4. userLastModifiedDate : DateType.t option;
    (*

    The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    *)
  5. enabled : BooleanType.t option;
    (*

    Indicates whether the user is activated for sign-in.

    *)
  6. userStatus : UserStatusType.t option;
    (*

    The user's status. Can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. UNKNOWN - User status isn't known. RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in. FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

    *)
  7. 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.

    *)
  8. preferredMfaSetting : StringType.t option;
    (*

    The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.

    *)
  9. 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 = [
  1. | `InternalErrorException of InternalErrorException.t
  2. | `InvalidParameterException of InvalidParameterException.t
  3. | `NotAuthorizedException of NotAuthorizedException.t
  4. | `ResourceNotFoundException of ResourceNotFoundException.t
  5. | `TooManyRequestsException of TooManyRequestsException.t
  6. | `UserNotFoundException of UserNotFoundException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?username:??? -> ?userAttributes:??? -> ?userCreateDate:??? -> ?userLastModifiedDate:??? -> ?enabled:??? -> ?userStatus:??? -> ?mFAOptions:??? -> ?preferredMfaSetting:??? -> ?userMFASettingList:??? -> unit -> t
Sourceval 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 | `UserNotFoundException of UserNotFoundException.t ]
Sourceval 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 | `UserNotFoundException of UserNotFoundException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of BooleanType.t | `Enum of string | `List of [> `String of StringType.t | `Structure of (string * [> `Enum of string | `String of AttributeNameType.t ]) list ] list | `String of UsernameType.t | `Timestamp of DateType.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