:doc:`DataPipeline <../../datapipeline>` / Client / deactivate_pipeline

*******************
deactivate_pipeline
*******************



.. py:method:: DataPipeline.Client.deactivate_pipeline(**kwargs)

  

  Deactivates the specified running pipeline. The pipeline is set to the ``DEACTIVATING`` state until the deactivation process completes.

   

  To resume a deactivated pipeline, use  ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeactivatePipeline>`_  


  **Request Syntax**
  ::

    response = client.deactivate_pipeline(
        pipelineId='string',
        cancelActive=True|False
    )
    
  :type pipelineId: string
  :param pipelineId: **[REQUIRED]** 

    The ID of the pipeline.

    

  
  :type cancelActive: boolean
  :param cancelActive: 

    Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to ``CANCELED``. If this value is false, the pipeline is deactivated after all running objects finish.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 

      Contains the output of DeactivatePipeline.

      
  
  **Exceptions**
  
  *   :py:class:`DataPipeline.Client.exceptions.PipelineNotFoundException`

  
  *   :py:class:`DataPipeline.Client.exceptions.PipelineDeletedException`

  
  *   :py:class:`DataPipeline.Client.exceptions.InternalServiceError`

  
  *   :py:class:`DataPipeline.Client.exceptions.InvalidRequestException`

  