Module Values.StopPipelineExecutionInputSource

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

Sourcetype nonrec t = {
  1. pipelineName : PipelineName.t;
    (*

    The name of the pipeline to stop.

    *)
  2. pipelineExecutionId : PipelineExecutionId.t;
    (*

    The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

    *)
  3. abandon : Boolean.t option;
    (*

    Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions. This option can lead to failed or out-of-sequence tasks.

    *)
  4. reason : StopPipelineExecutionReason.t option;
    (*

    Use this option to enter comments, such as the reason the pipeline was stopped.

    *)
}
Sourceval context_ : string
Sourceval make : ?abandon:??? -> ?reason:??? -> pipelineName:PipelineName.t -> pipelineExecutionId:PipelineExecutionId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `String of PipelineName.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t