Post x amz targetdatapipeline.deactivatepipeline

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198974.1 KB

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.

post/#X-Amz-Target=DataPipeline.DeactivatePipeline

Headers

X-Amz-Target'DataPipeline.DeactivatePipeline' required

Request body

pipelineIdstring required

The ID of the pipeline.

cancelActiveboolean

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

Response

Success

DeactivatePipelineOutput required

Contains the output of DeactivatePipeline.