Module Values.AssociateSoftwareTokenResponseSource

Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito. Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Sourcetype nonrec t = {
  1. secretCode : SecretCodeType.t option;
    (*

    A unique generated shared secret code that is used by the TOTP algorithm to generate a one-time code.

    *)
  2. session : SessionType.t option;
    (*

    The session identifier that maintains the state of authentication requests and challenge responses.

    *)
}
Sourcetype nonrec error = [
  1. | `ConcurrentModificationException of ConcurrentModificationException.t
  2. | `ForbiddenException of ForbiddenException.t
  3. | `InternalErrorException of InternalErrorException.t
  4. | `InvalidParameterException of InvalidParameterException.t
  5. | `NotAuthorizedException of NotAuthorizedException.t
  6. | `ResourceNotFoundException of ResourceNotFoundException.t
  7. | `SoftwareTokenMFANotFoundException of SoftwareTokenMFANotFoundException.t
  8. | `Unknown_operation_error of string * string option
]
Sourceval make : ?secretCode:??? -> ?session:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ConcurrentModificationException of ConcurrentModificationException.t | `ForbiddenException of ForbiddenException.t | `InternalErrorException of InternalErrorException.t | `InvalidParameterException of InvalidParameterException.t | `NotAuthorizedException of NotAuthorizedException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `SoftwareTokenMFANotFoundException of SoftwareTokenMFANotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ConcurrentModificationException of ConcurrentModificationException.t | `ForbiddenException of ForbiddenException.t | `InternalErrorException of InternalErrorException.t | `InvalidParameterException of InvalidParameterException.t | `NotAuthorizedException of NotAuthorizedException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `SoftwareTokenMFANotFoundException of SoftwareTokenMFANotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of SecretCodeType.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