StopPipe

Source: src/AWS/Pipes/StopPipe.ts

Runtime binding for pipes:StopPipe.

Stops the bound Pipe without deleting it — e.g. pausing source polling during a maintenance window or in response to a poison-pill backlog. The response reports the transitional STOPPING/desired STOPPED states; use DescribePipe to observe when the pipe settles. The pipe name is injected from the binding. Provide the implementation with Effect.provide(AWS.Pipes.StopPipeHttp).

Controlling a Pipe

// init — bind the operation to the pipe
const stopPipe = yield* AWS.Pipes.StopPipe(pipe);

// runtime
const response = yield* stopPipe();
// response.DesiredState === "STOPPED"