sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ MediaLive/ StopChannel.ts

import type * as medialive from "@distilled.cloud/aws/medialive";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Channel } from "./Channel.ts";

/**
 * Runtime binding for `medialive:StopChannel`.
 *
 * Stops the bound {@link Channel}, transitioning it from `RUNNING`
 * through `STOPPING` back to `IDLE` — the other half of a broadcast-window
 * scheduler built on {@link StartChannel}. Stopping a channel that is not
 * running fails with the typed `ConflictException` tag. The channel id is
 * injected from the binding. Provide the implementation with
 * `Effect.provide(AWS.MediaLive.StopChannelHttp)`.
 * ### Controlling Channels
 * **Example:** Stop the Channel After the Broadcast
 * ```typescript
 * // init — bind the operation to the channel
 * const stopChannel = yield* AWS.MediaLive.StopChannel(channel);
 *
 * // runtime
 * const { State } = yield* stopChannel();
 * ```
 *
 * @binding
 */
export interface StopChannel extends Binding.Service<
  StopChannel,
  "AWS.MediaLive.StopChannel",
  (
    channel: Channel,
  ) => Effect.Effect<() => Effect.Effect<medialive.StopChannelResponse, medialive.StopChannelError>>
> {}
export const StopChannel = Binding.Service<StopChannel>("AWS.MediaLive.StopChannel");