:doc:`Comprehend <../../comprehend>` / Client / stop_key_phrases_detection_job

******************************
stop_key_phrases_detection_job
******************************



.. py:method:: Comprehend.Client.stop_key_phrases_detection_job(**kwargs)

  

  Stops a key phrases detection job in progress.

   

  If the job state is ``IN_PROGRESS`` the job is marked for termination and put into the ``STOP_REQUESTED`` state. If the job completes before it can be stopped, it is put into the ``COMPLETED`` state; otherwise the job is stopped and put into the ``STOPPED`` state.

   

  If the job is in the ``COMPLETED`` or ``FAILED`` state when you call the ``StopDominantLanguageDetectionJob`` operation, the operation returns a 400 Internal Request Exception.

   

  When a job is stopped, any documents already processed are written to the output location.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob>`_  


  **Request Syntax**
  ::

    response = client.stop_key_phrases_detection_job(
        JobId='string'
    )
    
  :type JobId: string
  :param JobId: **[REQUIRED]** 

    The identifier of the key phrases detection job to stop.

    

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

    
    ::

      {
          'JobId': 'string',
          'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **JobId** *(string) --* 

        The identifier of the key phrases detection job to stop.

        
      

      - **JobStatus** *(string) --* 

        Either ``STOP_REQUESTED`` if the job is currently running, or ``STOPPED`` if the job was previously stopped with the ``StopKeyPhrasesDetectionJob`` operation.

        
  
  **Exceptions**
  
  *   :py:class:`Comprehend.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Comprehend.Client.exceptions.JobNotFoundException`

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

  