Chapter 426: cancelRenderOnLambda()

Core Idea

Signals the renderer functions of an in-progress Lambda render to stop.

Key Concepts

• Example
• Arguments
• region
• bucketName
• renderId
• forcePathStyle?
• requestHandler?
• Return value

Code Examples

import {
  cancelRenderOnLambda,
  renderMediaOnLambda,
} from '@remotion/lambda/client';

const {bucketName, renderId} = await renderMediaOnLambda({
  region: 'us-east-1',
  functionName: 'remotion-render-bds9aab',
  composition: 'MyVideo',
  serveUrl: 'https://remotionlambda-qg35eyp1s1.s3.eu-central-1.amazonaws.com/sites/bf2jrbfkw',
  codec: 'h264',
  enableCancellation: true,
});

await cancelRenderOnLambda({
  region: 'us-east-1',
  bucketName,
  renderId,
});

• What it demonstrates: Usage pattern for cancelRenderOnLambda() from the official docs.

Key Takeaways

1. Understand example when working with cancelRenderOnLambda().
2. Understand arguments when working with cancelRenderOnLambda().
3. Understand region when working with cancelRenderOnLambda().
4. Understand bucketname when working with cancelRenderOnLambda().
5. Understand renderid when working with cancelRenderOnLambda().

Connects To

• api: related page in the Lambda (@remotion/lambda) section.
• Approuterwebhook: related page in the Lambda (@remotion/lambda) section.
• Authentication: related page in the Lambda (@remotion/lambda) section.