Skip to content

DescribeThumbnails

Source: src/AWS/MediaLive/DescribeThumbnails.ts

Runtime binding for medialive:DescribeThumbnails.

Fetches the latest preview thumbnail (base64 JPEG) from a pipeline of the bound RUNNING Channel — e.g. a confidence-monitoring dashboard that renders a live snapshot of what the channel is encoding. Requires thumbnails to be enabled in the channel’s encoder settings; a channel that is not running answers with the typed BadRequestException tag. The channel id is injected from the binding. Provide the implementation with Effect.provide(AWS.MediaLive.DescribeThumbnailsHttp).

// init — bind the operation to the channel
const describeThumbnails = yield* AWS.MediaLive.DescribeThumbnails(channel);
// runtime
const { ThumbnailDetails } = yield* describeThumbnails({
PipelineId: "0",
ThumbnailType: "CURRENT_ACTIVE",
});