StopFlow

Source: src/AWS/AppFlow/StopFlow.ts

Runtime binding for appflow:StopFlow.

Bind this operation to a Flow in the function’s init phase to get a callable that deactivates a schedule or event-triggered flow. On-demand flows cannot be stopped — AppFlow rejects them with a typed UnsupportedOperationException. The flow name is injected automatically and appflow:StopFlow is granted on the flow. Provide the implementation with Effect.provide(AWS.AppFlow.StopFlowHttp).

Running Flows

// init — bind the operation to the flow
const stopFlow = yield* AWS.AppFlow.StopFlow(flow);

// runtime — deactivate the flow
const result = yield* stopFlow();
// result.flowStatus === "Suspended"