Deactivate Pipeline
datapipeline_deactivate_pipeline | R Documentation |
Deactivates the specified running pipeline¶
Description¶
Deactivates the specified running pipeline. The pipeline is set to the
DEACTIVATING
state until the deactivation process completes.
To resume a deactivated pipeline, use activate_pipeline
. By default,
the pipeline resumes from the last completed execution. Optionally, you
can specify the date and time to resume the pipeline.
Usage¶
datapipeline_deactivate_pipeline(pipelineId, cancelActive)
Arguments¶
pipelineId |
[required] The ID of the pipeline. |
cancelActive |
Indicates whether to cancel any running objects. The default is
true, which sets the state of any running objects to
|
Value¶
An empty list.
Request syntax¶
svc$deactivate_pipeline(
pipelineId = "string",
cancelActive = TRUE|FALSE
)