Smaws_Client_CognitoIdentityProvider.AdminInitiateAuthStarts sign-in for applications with a server-side component, for example a traditional web application. This operation specifies the authentication flow that you'd like to begin. The authentication flow that you specify must be supported in your app client configuration. For more information about authentication flows, see Authentication flows.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
val error_to_string :
[ Smaws_Lib.Protocols.AwsJson.error
| `InternalErrorException of Types.internal_error_exception
| `InvalidEmailRoleAccessPolicyException of
Types.invalid_email_role_access_policy_exception
| `InvalidLambdaResponseException of Types.invalid_lambda_response_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidSmsRoleAccessPolicyException of
Types.invalid_sms_role_access_policy_exception
| `InvalidSmsRoleTrustRelationshipException of
Types.invalid_sms_role_trust_relationship_exception
| `InvalidUserPoolConfigurationException of
Types.invalid_user_pool_configuration_exception
| `MFAMethodNotFoundException of Types.mfa_method_not_found_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
| `TooManyRequestsException of Types.too_many_requests_exception
| `UnexpectedLambdaException of Types.unexpected_lambda_exception
| `UnsupportedOperationException of Types.unsupported_operation_exception
| `UserLambdaValidationException of Types.user_lambda_validation_exception
| `UserNotConfirmedException of Types.user_not_confirmed_exception
| `UserNotFoundException of Types.user_not_found_exception ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.admin_initiate_auth_request ->
(Types.admin_initiate_auth_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `InternalErrorException of Types.internal_error_exception
| `InvalidEmailRoleAccessPolicyException of
Types.invalid_email_role_access_policy_exception
| `InvalidLambdaResponseException of
Types.invalid_lambda_response_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidSmsRoleAccessPolicyException of
Types.invalid_sms_role_access_policy_exception
| `InvalidSmsRoleTrustRelationshipException of
Types.invalid_sms_role_trust_relationship_exception
| `InvalidUserPoolConfigurationException of
Types.invalid_user_pool_configuration_exception
| `MFAMethodNotFoundException of Types.mfa_method_not_found_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
| `TooManyRequestsException of Types.too_many_requests_exception
| `UnexpectedLambdaException of Types.unexpected_lambda_exception
| `UnsupportedOperationException of Types.unsupported_operation_exception
| `UserLambdaValidationException of Types.user_lambda_validation_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.admin_initiate_auth_request ->
(Types.admin_initiate_auth_response Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsJson.error
| `InternalErrorException of Types.internal_error_exception
| `InvalidEmailRoleAccessPolicyException of
Types.invalid_email_role_access_policy_exception
| `InvalidLambdaResponseException of
Types.invalid_lambda_response_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidSmsRoleAccessPolicyException of
Types.invalid_sms_role_access_policy_exception
| `InvalidSmsRoleTrustRelationshipException of
Types.invalid_sms_role_trust_relationship_exception
| `InvalidUserPoolConfigurationException of
Types.invalid_user_pool_configuration_exception
| `MFAMethodNotFoundException of Types.mfa_method_not_found_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
| `TooManyRequestsException of Types.too_many_requests_exception
| `UnexpectedLambdaException of Types.unexpected_lambda_exception
| `UnsupportedOperationException of Types.unsupported_operation_exception
| `UserLambdaValidationException of Types.user_lambda_validation_exception
| `UserNotConfirmedException of Types.user_not_confirmed_exception
| `UserNotFoundException of Types.user_not_found_exception ]
* Smaws_Lib.Response.metadata)
Stdlib.result