Skip to content

DescribePipe

Source: src/AWS/Pipes/DescribePipe.ts

Runtime binding for pipes:DescribePipe.

Reads the bound Pipe’s full definition and live state (CurrentState, DesiredState, source/enrichment/target parameters) — e.g. an operational dashboard or a controller that checks whether the pipe settled after a start/stop. The pipe name is injected from the binding. Provide the implementation with Effect.provide(AWS.Pipes.DescribePipeHttp).

// init — bind the operation to the pipe
const describePipe = yield* AWS.Pipes.DescribePipe(pipe);
// runtime
const described = yield* describePipe();
// described.CurrentState === "RUNNING"