Skip to content

DescribeChannel

Source: src/AWS/MediaLive/DescribeChannel.ts

Runtime binding for medialive:DescribeChannel.

Reads the bound Channel’s live state — lifecycle state (IDLE/RUNNING), pipeline details, egress endpoints, and attached inputs — e.g. for an operations dashboard or a scheduler that only starts a channel that is not already running. The channel id is injected from the binding. Provide the implementation with Effect.provide(AWS.MediaLive.DescribeChannelHttp).

// init — bind the operation to the channel
const describeChannel = yield* AWS.MediaLive.DescribeChannel(channel);
// runtime
const { State } = yield* describeChannel();
const running = State === "RUNNING";