Smaws_Client_CognitoIdentityProvider.VerifySoftwareTokenRegisters the current user's time-based one-time password (TOTP) authenticator with a code generated in their authenticator app from a private key that's supplied by your user pool. Marks the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
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.
val error_to_string :
[ Smaws_Lib.Protocols.AwsJson.error
| `CodeMismatchException of Types.code_mismatch_exception
| `EnableSoftwareTokenMFAException of
Types.enable_software_token_mfa_exception
| `ForbiddenException of Types.forbidden_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidUserPoolConfigurationException of
Types.invalid_user_pool_configuration_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `PasswordResetRequiredException of Types.password_reset_required_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `SoftwareTokenMFANotFoundException of
Types.software_token_mfa_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotConfirmedException of Types.user_not_confirmed_exception
| `UserNotFoundException of Types.user_not_found_exception ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.verify_software_token_request ->
(Types.verify_software_token_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `CodeMismatchException of Types.code_mismatch_exception
| `EnableSoftwareTokenMFAException of
Types.enable_software_token_mfa_exception
| `ForbiddenException of Types.forbidden_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidUserPoolConfigurationException of
Types.invalid_user_pool_configuration_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `PasswordResetRequiredException of
Types.password_reset_required_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `SoftwareTokenMFANotFoundException of
Types.software_token_mfa_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotConfirmedException of Types.user_not_confirmed_exception
| `UserNotFoundException of Types.user_not_found_exception ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.verify_software_token_request ->
(Types.verify_software_token_response Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsJson.error
| `CodeMismatchException of Types.code_mismatch_exception
| `EnableSoftwareTokenMFAException of
Types.enable_software_token_mfa_exception
| `ForbiddenException of Types.forbidden_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidUserPoolConfigurationException of
Types.invalid_user_pool_configuration_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `PasswordResetRequiredException of
Types.password_reset_required_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `SoftwareTokenMFANotFoundException of
Types.software_token_mfa_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotConfirmedException of Types.user_not_confirmed_exception
| `UserNotFoundException of Types.user_not_found_exception ]
* Smaws_Lib.Response.metadata)
Stdlib.result