:doc:`CognitoIdentityProvider <../../cognito-idp>` / Client / forgot_password

***************
forgot_password
***************



.. py:method:: CognitoIdentityProvider.Client.forgot_password(**kwargs)

  

  Sends a password-reset confirmation code to the email address or phone number of the requested username. The message delivery method is determined by the user's available attributes and the ``AccountRecoverySetting`` configuration of the user pool.

   

  For the ``Username`` parameter, you can use the username or an email, phone, or preferred username alias.

   

  If neither a verified phone number nor a verified email exists, Amazon Cognito responds with an ``InvalidParameterException`` error . If your app client has a client secret and you don't provide a ``SECRET_HASH`` parameter, this API returns ``NotAuthorizedException``.

   

  .. note::

    

    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 <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html>`__.

    

   

  .. note::

    

    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 <https://console.aws.amazon.com/pinpoint/home/>`__. 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 <https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html>`__ , 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 <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`__ in the *Amazon Cognito Developer Guide*.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgotPassword>`_  


  **Request Syntax**
  ::

    response = client.forgot_password(
        ClientId='string',
        SecretHash='string',
        UserContextData={
            'IpAddress': 'string',
            'EncodedData': 'string'
        },
        Username='string',
        AnalyticsMetadata={
            'AnalyticsEndpointId': 'string'
        },
        ClientMetadata={
            'string': 'string'
        }
    )
    
  :type ClientId: string
  :param ClientId: **[REQUIRED]** 

    The ID of the user pool app client associated with the current signed-in user.

    

  
  :type SecretHash: string
  :param SecretHash: 

    A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about ``SecretHash``, see `Computing secret hash values <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash>`__.

    

  
  :type UserContextData: dict
  :param UserContextData: 

    Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

     

    For more information, see `Collecting data for threat protection in applications <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html>`__.

    

  
    - **IpAddress** *(string) --* 

      The source IP address of your user's device.

      

    
    - **EncodedData** *(string) --* 

      Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see `Adding user device and session data to API requests <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint>`__.

      

    
  
  :type Username: string
  :param Username: **[REQUIRED]** 

    The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If ``username`` isn't an alias attribute in your user pool, this value must be the ``sub`` of a local user or the username of a user from a third-party IdP.

    

  
  :type AnalyticsMetadata: dict
  :param AnalyticsMetadata: 

    Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

    

  
    - **AnalyticsEndpointId** *(string) --* 

      The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send notifications.

      

    
  
  :type ClientMetadata: dict
  :param ClientMetadata: 

    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

     

    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: *pre sign-up*, *custom message*, and *user migration*. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a ``clientMetadata`` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the ``clientMetadata`` value to enhance your workflow for your specific needs.

     

    For more information, see `Using Lambda triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html>`__ in the *Amazon Cognito Developer Guide*.

     

    .. note::

      

      When you use the ``ClientMetadata`` parameter, note that Amazon Cognito won't do the following:

       

      
      * Store the ``ClientMetadata`` value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ``ClientMetadata`` parameter serves no purpose.
       
      * Validate the ``ClientMetadata`` value.
       
      * Encrypt the ``ClientMetadata`` value. Don't send sensitive information in this parameter.
      

      

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'CodeDeliveryDetails': {
              'Destination': 'string',
              'DeliveryMedium': 'SMS'|'EMAIL',
              'AttributeName': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The response from Amazon Cognito to a request to reset a password.

      
      

      - **CodeDeliveryDetails** *(dict) --* 

        Information about the phone number or email address that Amazon Cognito sent the password-recovery code to.

        
        

        - **Destination** *(string) --* 

          The email address or phone number destination where Amazon Cognito sent the code.

          
        

        - **DeliveryMedium** *(string) --* 

          The method that Amazon Cognito used to send the code.

          
        

        - **AttributeName** *(string) --* 

          The name of the attribute that Amazon Cognito verifies with the code.

          
    
  
  **Exceptions**
  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.UnexpectedLambdaException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.UserLambdaValidationException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.NotAuthorizedException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.InvalidLambdaResponseException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.LimitExceededException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleAccessPolicyException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleTrustRelationshipException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.InvalidEmailRoleAccessPolicyException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.CodeDeliveryFailureException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.UserNotFoundException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.InternalErrorException`

  
  *   :py:class:`CognitoIdentityProvider.Client.exceptions.ForbiddenException`

  