:doc:`Translate <../../translate>` / Client / stop_text_translation_job

*************************
stop_text_translation_job
*************************



.. py:method:: Translate.Client.stop_text_translation_job(**kwargs)

  

  Stops an asynchronous batch translation job that is in progress.

   

  If the job's state is ``IN_PROGRESS``, the job will be 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 put into the ``STOPPED`` state.

   

  Asynchronous batch translation jobs are started with the  StartTextTranslationJob operation. You can use the  DescribeTextTranslationJob or  ListTextTranslationJobs operations to get a batch translation job's ``JobId``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/StopTextTranslationJob>`_  


  **Request Syntax**
  ::

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

    The job ID of the job to be stopped.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        The job ID of the stopped batch translation job.

        
      

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

        The status of the designated job. Upon successful completion, the job's status will be ``STOPPED``.

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

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

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

  