deactivate_pipeline

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

Request Syntax

response = client.deactivate_pipeline(
    pipelineId='string',
    cancelActive=True|False
)

Parameters

• pipelineId (string) --

  [REQUIRED]

  The ID of the pipeline.

• cancelActive (boolean) -- 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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

  Contains the output of DeactivatePipeline.

Exceptions

• DataPipeline.Client.exceptions.PipelineNotFoundException
• DataPipeline.Client.exceptions.PipelineDeletedException
• DataPipeline.Client.exceptions.InternalServiceError
• DataPipeline.Client.exceptions.InvalidRequestException