:doc:`LexModelsV2 <../../lexv2-models>` / Client / stop_bot_recommendation

***********************
stop_bot_recommendation
***********************



.. py:method:: LexModelsV2.Client.stop_bot_recommendation(**kwargs)

  

  Stop an already running Bot Recommendation request.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendation>`_  


  **Request Syntax**
  ::

    response = client.stop_bot_recommendation(
        botId='string',
        botVersion='string',
        localeId='string',
        botRecommendationId='string'
    )
    
  :type botId: string
  :param botId: **[REQUIRED]** 

    The unique identifier of the bot containing the bot recommendation to be stopped.

    

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

    The version of the bot containing the bot recommendation.

    

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

    The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see `Supported languages <https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html>`__

    

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

    The unique identifier of the bot recommendation to be stopped.

    

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

    
    ::

      {
          'botId': 'string',
          'botVersion': 'string',
          'localeId': 'string',
          'botRecommendationStatus': 'Processing'|'Deleting'|'Deleted'|'Downloading'|'Updating'|'Available'|'Failed'|'Stopping'|'Stopped',
          'botRecommendationId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **botId** *(string) --* 

        The unique identifier of the bot containing the bot recommendation that is being stopped.

        
      

      - **botVersion** *(string) --* 

        The version of the bot containing the recommendation that is being stopped.

        
      

      - **localeId** *(string) --* 

        The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see `Supported languages <https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html>`__

        
      

      - **botRecommendationStatus** *(string) --* 

        The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

        
      

      - **botRecommendationId** *(string) --* 

        The unique identifier of the bot recommendation that is being stopped.

        
  
  **Exceptions**
  
  *   :py:class:`LexModelsV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ValidationException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ConflictException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.PreconditionFailedException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ConflictException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.InternalServerException`

  