sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ IVSRealtime/ GetComposition.ts

import type * as ivsrealtime from "@distilled.cloud/aws/ivs-realtime";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Read a composition's detail — state, layout, destinations, and per
 * destination progress. Compositions are addressed by the server-generated
 * ARN returned by `StartComposition`.
 *
 * ### Compositing a Stage
 * **Example:** Poll a composition's state
 * ```typescript
 * // init
 * const getComposition = yield* IVSRealtime.GetComposition();
 *
 * // runtime
 * const { composition } = yield* getComposition({ arn: compositionArn });
 * // composition.state → "ACTIVE" | "STOPPED" | "FAILED" | …
 * ```
 *
 * @binding
 */
export interface GetComposition extends Binding.Service<
  GetComposition,
  "AWS.IVSRealtime.GetComposition",
  () => Effect.Effect<
    (
      request: ivsrealtime.GetCompositionRequest,
    ) => Effect.Effect<ivsrealtime.GetCompositionResponse, ivsrealtime.GetCompositionError>
  >
> {}
export const GetComposition = Binding.Service<GetComposition>("AWS.IVSRealtime.GetComposition");