@remotion/lambda 4.0.0-umungobongo.5 → 4.0.0-webhook.26

package/dist/admin/make-layer-public.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const client_lambda_1 = require("@aws-sdk/client-lambda");
 const aws_policies_1 = require("aws-policies");
-const __1 = require("..");
+const version_1 = require("remotion/version");
+const get_regions_1 = require("../api/get-regions");
 const quit_1 = require("../cli/helpers/quit");
 const aws_clients_1 = require("../shared/aws-clients");
-const constants_1 = require("../shared/constants");
 const runtimes = ['nodejs14.x'];
 const archictures = ['arm64', 'x86_64'];
 const layerInfo = {
@@ -37,13 +37,13 @@ const layerInfo = {
 const makeLayerPublic = async () => {
     const layers = ['fonts', 'ffmpeg', 'chromium'];
     for (const architecture of archictures) {
-        for (const region of (0, __1.getRegions)()) {
+        for (const region of (0, get_regions_1.getRegions)()) {
             for (const layer of layers) {
                 const layerName = `remotion-binaries-${layer}-${architecture}`;
                 const { Version, LayerArn } = await (0, aws_clients_1.getLambdaClient)(region).send(new client_lambda_1.PublishLayerVersionCommand({
                     Content: {
                         S3Bucket: 'remotionlambda-binaries-' + region,
-                        S3Key: `remotion-layer-${layer}-v7-${architecture}.zip`,
+                        S3Key: `remotion-layer-${layer}-v8-${architecture}.zip`,
                     },
                     LayerName: layerName,
                     LicenseInfo: layer === 'chromium'
@@ -52,7 +52,7 @@ const makeLayerPublic = async () => {
                             ? 'Compiled from FFMPEG source. Read FFMPEG license: https://ffmpeg.org/legal.html'
                             : 'Contains Noto Sans font. Read Noto Sans License: https://fonts.google.com/noto/specimen/Noto+Sans/about',
                     CompatibleRuntimes: runtimes,
-                    Description: constants_1.CURRENT_VERSION,
+                    Description: version_1.VERSION,
                 }));
                 await (0, aws_clients_1.getLambdaClient)(region).send(new client_lambda_1.AddLayerVersionPermissionCommand({
                     Action: aws_policies_1.lambda.GetLayerVersion,

package/dist/api/bucket-exists.js

@@ -6,7 +6,7 @@ const aws_clients_1 = require("../shared/aws-clients");
 const bucketExistsInRegion = async ({ bucketName, region, expectedBucketOwner, }) => {
     var _a;
     try {
-        const bucket = await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.GetBucketLocationCommand({
+        const bucket = await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.GetBucketLocationCommand({
             Bucket: bucketName,
             ExpectedBucketOwner: expectedBucketOwner !== null && expectedBucketOwner !== void 0 ? expectedBucketOwner : undefined,
         }));

package/dist/api/clean-items.js

@@ -11,7 +11,7 @@ const cleanItems = async ({ bucket, onAfterItemDeleted, onBeforeItemDeleted, reg
             bucketName: bucket,
             itemName: object,
         });
-        await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.DeleteObjectCommand({
+        await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.DeleteObjectCommand({
             Bucket: bucket,
             Key: object,
         }));

package/dist/api/create-bucket.js

@@ -4,7 +4,7 @@ exports.createBucket = void 0;
 const client_s3_1 = require("@aws-sdk/client-s3");
 const aws_clients_1 = require("../shared/aws-clients");
 const createBucket = async ({ region, bucketName, }) => {
-    await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.CreateBucketCommand({
+    await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.CreateBucketCommand({
         Bucket: bucketName,
         ACL: 'public-read',
     }));

package/dist/api/delete-render.d.ts

@@ -0,0 +1,19 @@
+import type { AwsRegion } from '../client';
+import type { CustomCredentials } from '../shared/aws-clients';
+export declare type DeleteRenderInput = {
+    region: AwsRegion;
+    bucketName: string;
+    renderId: string;
+    customCredentials?: CustomCredentials;
+};
+/**
+ * @description Deletes a render artifact and it's metadata given it's renderId.
+ * @link https://remotion.dev/docs/lambda/deleterender
+ * @param params.region The AWS region in which the media resides.
+ * @param params.bucketName The `bucketName` that was specified during the render
+ * @param params.renderId The `renderId` that was obtained after triggering the render.
+ * @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
+ */
+export declare const deleteRender: (input: DeleteRenderInput) => Promise<{
+    freedBytes: number;
+}>;

package/dist/api/delete-render.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteRender = void 0;
+const defaults_1 = require("../defaults");
+const expected_out_name_1 = require("../functions/helpers/expected-out-name");
+const get_render_metadata_1 = require("../functions/helpers/get-render-metadata");
+const io_1 = require("../functions/helpers/io");
+const get_account_id_1 = require("../shared/get-account-id");
+const clean_items_1 = require("./clean-items");
+/**
+ * @description Deletes a render artifact and it's metadata given it's renderId.
+ * @link https://remotion.dev/docs/lambda/deleterender
+ * @param params.region The AWS region in which the media resides.
+ * @param params.bucketName The `bucketName` that was specified during the render
+ * @param params.renderId The `renderId` that was obtained after triggering the render.
+ * @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
+ */
+const deleteRender = async (input) => {
+    var _a;
+    const expectedBucketOwner = await (0, get_account_id_1.getAccountId)({
+        region: input.region,
+    });
+    const renderMetadata = await (0, get_render_metadata_1.getRenderMetadata)({
+        bucketName: input.bucketName,
+        expectedBucketOwner,
+        region: input.region,
+        renderId: input.renderId,
+    });
+    const { key, renderBucketName, customCredentials } = (0, expected_out_name_1.getExpectedOutName)(renderMetadata, input.bucketName, (_a = input.customCredentials) !== null && _a !== void 0 ? _a : null);
+    await (0, io_1.lambdaDeleteFile)({
+        bucketName: renderBucketName,
+        customCredentials,
+        key,
+        region: input.region,
+    });
+    let files = await (0, io_1.lambdaLs)({
+        bucketName: input.bucketName,
+        prefix: (0, defaults_1.rendersPrefix)(input.renderId),
+        region: input.region,
+        expectedBucketOwner,
+    });
+    let totalSize = 0;
+    while (files.length > 0) {
+        totalSize += files.reduce((a, b) => {
+            var _a;
+            return a + ((_a = b.Size) !== null && _a !== void 0 ? _a : 0);
+        }, 0);
+        await (0, clean_items_1.cleanItems)({
+            list: files.map((f) => f.Key),
+            bucket: input.bucketName,
+            onAfterItemDeleted: () => undefined,
+            onBeforeItemDeleted: () => undefined,
+            region: input.region,
+        });
+        files = await (0, io_1.lambdaLs)({
+            bucketName: input.bucketName,
+            prefix: (0, defaults_1.rendersPrefix)(input.renderId),
+            region: input.region,
+            expectedBucketOwner,
+        });
+    }
+    return {
+        freedBytes: totalSize,
+    };
+};
+exports.deleteRender = deleteRender;

package/dist/api/delete-site.js

@@ -23,11 +23,6 @@ const deleteSite = async ({ bucketName, siteName, region, onAfterItemDeleted, })
         region,
         expectedBucketOwner: accountId,
     });
-    if (files.length === 0) {
-        return {
-            totalSizeInBytes: 0,
-        };
-    }
     let totalSize = 0;
     while (files.length > 0) {
         totalSize += files.reduce((a, b) => {

package/dist/api/deploy-function.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deployFunction = void 0;
+const version_1 = require("remotion/version");
 const get_functions_1 = require("../api/get-functions");
 const constants_1 = require("../shared/constants");
 const function_zip_path_1 = require("../shared/function-zip-path");
 const get_account_id_1 = require("../shared/get-account-id");
+const lambda_version_string_1 = require("../shared/lambda-version-string");
 const validate_architecture_1 = require("../shared/validate-architecture");
 const validate_aws_region_1 = require("../shared/validate-aws-region");
 const validate_custom_role_arn_1 = require("../shared/validate-custom-role-arn");
@@ -36,7 +38,7 @@ const deployFunction = async (options) => {
     (0, validate_disk_size_in_mb_1.validateDiskSizeInMb)(diskSizeInMb);
     (0, validate_custom_role_arn_1.validateCustomRoleArn)(options.customRoleArn);
     const fnNameRender = [
-        `${constants_1.RENDER_FN_PREFIX}${constants_1.CURRENT_VERSION}`,
+        `${constants_1.RENDER_FN_PREFIX}${lambda_version_string_1.LAMBDA_VERSION_STRING}`,
         `mem${options.memorySizeInMb}mb`,
         `disk${diskSizeInMb}mb`,
         `${options.timeoutInSeconds}sec`,
@@ -46,7 +48,7 @@ const deployFunction = async (options) => {
         compatibleOnly: true,
         region: options.region,
     });
-    const alreadyDeployed = fns.find((f) => f.version === constants_1.CURRENT_VERSION &&
+    const alreadyDeployed = fns.find((f) => f.version === version_1.VERSION &&
         f.memorySizeInMb === options.memorySizeInMb &&
         f.timeoutInSeconds === options.timeoutInSeconds &&
         f.diskSizeInMb === diskSizeInMb);

package/dist/api/deploy-site.d.ts

@@ -11,6 +11,8 @@ export declare type DeploySiteInput = {
         onUploadProgress?: (upload: UploadDirProgress) => void;
         webpackOverride?: WebpackOverrideFn;
         enableCaching?: boolean;
+        publicDir?: string | null;
+        rootDir?: string;
     };
 };
 export declare type DeploySiteOutput = Promise<{

package/dist/api/deploy-site.js

@@ -47,6 +47,8 @@ const deploySite = async ({ bucketName, entryPoint, siteName, options, region, }
         publicPath: `/${subFolder}/`,
         webpackOverride: (_b = options === null || options === void 0 ? void 0 : options.webpackOverride) !== null && _b !== void 0 ? _b : ((f) => f),
         enableCaching: (_c = options === null || options === void 0 ? void 0 : options.enableCaching) !== null && _c !== void 0 ? _c : true,
+        publicDir: options === null || options === void 0 ? void 0 : options.publicDir,
+        rootDir: options === null || options === void 0 ? void 0 : options.rootDir,
     });
     await Promise.all([
         (0, upload_dir_1.uploadDir)({

package/dist/api/download-media.d.ts

@@ -1,16 +1,29 @@
 import type { LambdaReadFileProgress } from '../functions/helpers/read-with-progress';
 import type { AwsRegion } from '../pricing/aws-regions';
+import type { CustomCredentials } from '../shared/aws-clients';
 export declare type DownloadMediaInput = {
     region: AwsRegion;
     bucketName: string;
     renderId: string;
     outPath: string;
     onProgress?: LambdaReadFileProgress;
+    customCredentials?: CustomCredentials;
 };
 export declare type DownloadMediaOutput = {
     outputPath: string;
     sizeInBytes: number;
 };
+/**
+ * @description Triggers a render on a lambda given a composition and a lambda function.
+ * @link https://remotion.dev/docs/lambda/downloadmedia
+ * @param params.region The AWS region in which the media resides.
+ * @param params.bucketName The `bucketName` that was specified during the render.
+ * @param params.renderId The `renderId` that was obtained after triggering the render.
+ * @param params.outPath Where to save the media.
+ * @param params.onProgress Progress callback function - see docs for details.
+ * @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
+ * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
+ */
 export declare const downloadMedia: (input: DownloadMediaInput) => Promise<DownloadMediaOutput>;
 /**
  * @deprecated Renamed to downloadMedia()

package/dist/api/download-media.js

@@ -10,8 +10,19 @@ const expected_out_name_1 = require("../functions/helpers/expected-out-name");
 const get_render_metadata_1 = require("../functions/helpers/get-render-metadata");
 const read_with_progress_1 = require("../functions/helpers/read-with-progress");
 const get_account_id_1 = require("../shared/get-account-id");
+/**
+ * @description Triggers a render on a lambda given a composition and a lambda function.
+ * @link https://remotion.dev/docs/lambda/downloadmedia
+ * @param params.region The AWS region in which the media resides.
+ * @param params.bucketName The `bucketName` that was specified during the render.
+ * @param params.renderId The `renderId` that was obtained after triggering the render.
+ * @param params.outPath Where to save the media.
+ * @param params.onProgress Progress callback function - see docs for details.
+ * @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
+ * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
+ */
 const downloadMedia = async (input) => {
-    var _a;
+    var _a, _b;
     const expectedBucketOwner = await (0, get_account_id_1.getAccountId)({
         region: input.region,
     });
@@ -23,14 +34,15 @@ const downloadMedia = async (input) => {
     });
     const outputPath = path_1.default.resolve(process.cwd(), input.outPath);
     renderer_1.RenderInternals.ensureOutputDirectory(outputPath);
-    const { key, renderBucketName } = (0, expected_out_name_1.getExpectedOutName)(renderMetadata, input.bucketName);
+    const { key, renderBucketName, customCredentials } = (0, expected_out_name_1.getExpectedOutName)(renderMetadata, input.bucketName, (_a = input.customCredentials) !== null && _a !== void 0 ? _a : null);
     const { sizeInBytes } = await (0, read_with_progress_1.lambdaDownloadFileWithProgress)({
         bucketName: renderBucketName,
         expectedBucketOwner,
         key,
         region: input.region,
-        onProgress: (_a = input.onProgress) !== null && _a !== void 0 ? _a : (() => undefined),
+        onProgress: (_b = input.onProgress) !== null && _b !== void 0 ? _b : (() => undefined),
         outputPath,
+        customCredentials,
     });
     return {
         outputPath,

package/dist/api/enable-s3-website.js

@@ -4,7 +4,7 @@ exports.enableS3Website = void 0;
 const client_s3_1 = require("@aws-sdk/client-s3");
 const aws_clients_1 = require("../shared/aws-clients");
 const enableS3Website = async ({ region, bucketName, }) => {
-    await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.PutBucketWebsiteCommand({
+    await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.PutBucketWebsiteCommand({
         Bucket: bucketName,
         WebsiteConfiguration: {
             IndexDocument: {

package/dist/api/get-aws-client.d.ts

@@ -4,10 +4,11 @@ import * as LambdaSDK from '@aws-sdk/client-lambda';
 import * as S3SDK from '@aws-sdk/client-s3';
 import * as ServiceQuotasSDK from '@aws-sdk/client-service-quotas';
 import type { AwsRegion } from '../client';
-import type { ServiceMapping } from '../shared/aws-clients';
+import type { CustomCredentials, ServiceMapping } from '../shared/aws-clients';
 export declare type GetAwsClientInput<T extends keyof ServiceMapping> = {
     region: AwsRegion;
     service: T;
+    customCredentials?: CustomCredentials | null;
 };
 declare type SdkMapping = {
     s3: typeof S3SDK;
@@ -25,7 +26,8 @@ export declare type GetAwsClientOutput<T extends keyof ServiceMapping> = {
  * @link https://remotion.dev/docs/lambda/getawsclient
  * @param {AwsRegion} params.region The region in which the S3 bucket resides in.
  * @param {string} params.service One of `iam`, `s3`, `cloudwatch`, `iam` or `servicequotas`
+ * @param {CustomCredentials} params.customCredentials Pass endpoint and credentials if you want to connect to a different cloud for S3
  * @returns {GetAwsClientOutput<T>} Returns `client` and `sdk` of a AWS service
  */
-export declare const getAwsClient: <T extends keyof ServiceMapping>({ region, service, }: GetAwsClientInput<T>) => GetAwsClientOutput<T>;
+export declare const getAwsClient: <T extends keyof ServiceMapping>({ region, service, customCredentials, }: GetAwsClientInput<T>) => GetAwsClientOutput<T>;
 export {};

package/dist/api/get-aws-client.js

@@ -35,11 +35,16 @@ const aws_clients_1 = require("../shared/aws-clients");
  * @link https://remotion.dev/docs/lambda/getawsclient
  * @param {AwsRegion} params.region The region in which the S3 bucket resides in.
  * @param {string} params.service One of `iam`, `s3`, `cloudwatch`, `iam` or `servicequotas`
+ * @param {CustomCredentials} params.customCredentials Pass endpoint and credentials if you want to connect to a different cloud for S3
  * @returns {GetAwsClientOutput<T>} Returns `client` and `sdk` of a AWS service
  */
-const getAwsClient = ({ region, service, }) => {
+const getAwsClient = ({ region, service, customCredentials, }) => {
     return {
-        client: (0, aws_clients_1.getServiceClient)(region, service),
+        client: (0, aws_clients_1.getServiceClient)({
+            region,
+            service,
+            customCredentials: customCredentials !== null && customCredentials !== void 0 ? customCredentials : null,
+        }),
         sdk: {
             lambda: LambdaSDK,
             cloudwatch: CloudWatchSDK,

package/dist/api/get-buckets.js

@@ -5,13 +5,13 @@ const client_s3_1 = require("@aws-sdk/client-s3");
 const aws_clients_1 = require("../shared/aws-clients");
 const constants_1 = require("../shared/constants");
 const getRemotionS3Buckets = async (region) => {
-    const { Buckets } = await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.ListBucketsCommand({}));
+    const { Buckets } = await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.ListBucketsCommand({}));
     if (!Buckets) {
         return { remotionBuckets: [] };
     }
     const remotionBuckets = Buckets.filter((b) => { var _a; return (_a = b.Name) === null || _a === void 0 ? void 0 : _a.startsWith(constants_1.REMOTION_BUCKET_PREFIX); });
     const locations = await Promise.all(remotionBuckets.map((bucket) => {
-        return (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.GetBucketLocationCommand({
+        return (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.GetBucketLocationCommand({
             Bucket: bucket.Name,
         }));
     }));

package/dist/api/get-function-info.d.ts

@@ -1,10 +1,9 @@
 import type { AwsRegion } from '../pricing/aws-regions';
-import type { LambdaVersions } from '../shared/constants';
 export declare type FunctionInfo = {
     functionName: string;
     timeoutInSeconds: number;
     memorySizeInMb: number;
-    version: LambdaVersions | null;
+    version: string | null;
     diskSizeInMb: number;
 };
 export declare type GetFunctionInfoInput = {

package/dist/api/get-functions.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFunctions = void 0;
 const client_lambda_1 = require("@aws-sdk/client-lambda");
+const version_1 = require("remotion/version");
 const aws_clients_1 = require("../shared/aws-clients");
 const constants_1 = require("../shared/constants");
 const get_function_version_1 = require("../shared/get-function-version");
@@ -73,7 +74,7 @@ const getFunctions = async (options) => {
         if (!options.compatibleOnly) {
             return true;
         }
-        return l.version === constants_1.CURRENT_VERSION;
+        return l.version === version_1.VERSION;
     });
 };
 exports.getFunctions = getFunctions;

package/dist/api/get-render-progress.d.ts

@@ -1,10 +1,12 @@
 import type { AwsRegion } from '../pricing/aws-regions';
+import type { CustomCredentials } from '../shared/aws-clients';
 import type { RenderProgress } from '../shared/constants';
 export declare type GetRenderInput = {
     functionName: string;
     bucketName: string;
     renderId: string;
     region: AwsRegion;
+    s3OutputProvider?: CustomCredentials;
 };
 /**
  * @description Gets the current status of a render originally triggered via renderMediaOnLambda().
@@ -13,6 +15,7 @@ export declare type GetRenderInput = {
  * @param {string} params.bucketName The name of the bucket that was used in the render.
  * @param {string} params.renderId The ID of the render that was returned by `renderMediaOnLambda()`.
  * @param {AwsRegion} params.region The region in which the render was triggered.
+ * @param {CustomCredentials} params.s3OutputProvider? Endpoint and credentials if the output file is stored outside of AWS.
  * @returns {Promise<RenderProgress>} See documentation for this function to see all properties on the return object.
  */
-export declare const getRenderProgress: ({ functionName, bucketName, renderId, region, }: GetRenderInput) => Promise<RenderProgress>;
+export declare const getRenderProgress: ({ functionName, bucketName, renderId, region, s3OutputProvider, }: GetRenderInput) => Promise<RenderProgress>;

package/dist/api/get-render-progress.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRenderProgress = void 0;
+const version_1 = require("remotion/version");
 const call_lambda_1 = require("../shared/call-lambda");
 const constants_1 = require("../shared/constants");
 /**
@@ -10,15 +11,18 @@ const constants_1 = require("../shared/constants");
  * @param {string} params.bucketName The name of the bucket that was used in the render.
  * @param {string} params.renderId The ID of the render that was returned by `renderMediaOnLambda()`.
  * @param {AwsRegion} params.region The region in which the render was triggered.
+ * @param {CustomCredentials} params.s3OutputProvider? Endpoint and credentials if the output file is stored outside of AWS.
  * @returns {Promise<RenderProgress>} See documentation for this function to see all properties on the return object.
  */
-const getRenderProgress = async ({ functionName, bucketName, renderId, region, }) => {
+const getRenderProgress = async ({ functionName, bucketName, renderId, region, s3OutputProvider, }) => {
     const result = await (0, call_lambda_1.callLambda)({
         functionName,
         type: constants_1.LambdaRoutines.status,
         payload: {
             bucketName,
             renderId,
+            version: version_1.VERSION,
+            s3OutputProvider,
         },
         region,
     });

package/dist/api/mock-functions.d.ts

@@ -1,19 +1,18 @@
 import type { AwsRegion } from '../pricing/aws-regions';
-import type { LambdaVersions } from '../shared/constants';
 import type { FunctionInfo } from './get-function-info';
 export declare let mockFunctionsStore: (FunctionInfo & {
     region: AwsRegion;
-    version: LambdaVersions;
+    version: string;
 })[];
 export declare const addFunction: (fn: FunctionInfo, region: AwsRegion) => void;
 export declare const deleteMockFunction: (name: string, region: string) => void;
 export declare const findFunction: (name: string, region: string) => (FunctionInfo & {
     region: AwsRegion;
-    version: LambdaVersions;
+    version: string;
 }) | undefined;
-export declare const getAllMockFunctions: (region: string, version: LambdaVersions | null) => (FunctionInfo & {
+export declare const getAllMockFunctions: (region: string, version: string | null) => (FunctionInfo & {
     region: AwsRegion;
-    version: LambdaVersions;
+    version: string;
 })[];
 export declare const cleanFnStore: () => void;
 export declare const markFunctionAsIncompatible: (functionName: string) => void;

package/dist/api/presign-url.js

@@ -19,7 +19,7 @@ const validate_presign_expiration_1 = require("../shared/validate-presign-expira
 const presignUrl = async ({ region, bucketName, objectKey, checkIfObjectExists = false, expiresInSeconds, }) => {
     (0, validate_bucketname_1.validateBucketName)(bucketName, { mustStartWithRemotion: false });
     (0, validate_presign_expiration_1.validatePresignExpiration)(expiresInSeconds);
-    const s3Client = (0, aws_clients_1.getS3Client)(region);
+    const s3Client = (0, aws_clients_1.getS3Client)(region, null);
     if (checkIfObjectExists) {
         try {
             await s3Client.send(new client_s3_1.HeadObjectCommand({
@@ -31,6 +31,11 @@ const presignUrl = async ({ region, bucketName, objectKey, checkIfObjectExists =
             if (err.name === 'NotFound') {
                 return null;
             }
+            if (err.message === 'UnknownError' ||
+                err.$metadata
+                    .httpStatusCode === 403) {
+                throw new Error(`Unable to access item "${objectKey}" from bucket "${bucketName}". You must have permission for both "s3:GetObject" and "s3:ListBucket" actions.`);
+            }
             throw err;
         }
     }

package/dist/api/render-media-on-lambda.d.ts

@@ -8,16 +8,16 @@ export declare type RenderMediaOnLambdaInput = {
     functionName: string;
     serveUrl: string;
     composition: string;
-    inputProps: unknown;
+    inputProps?: unknown;
     codec: LambdaCodec;
-    imageFormat: ImageFormat;
+    imageFormat?: ImageFormat;
     crf?: number | undefined;
     envVariables?: Record<string, string>;
     pixelFormat?: PixelFormat;
     proResProfile?: ProResProfile;
-    privacy: Privacy;
+    privacy?: Privacy;
     quality?: number;
-    maxRetries: number;
+    maxRetries?: number;
     framesPerLambda?: number;
     logLevel?: LogLevel;
     frameRange?: FrameRange;
@@ -29,10 +29,17 @@ export declare type RenderMediaOnLambdaInput = {
     numberOfGifLoops?: number | null;
     concurrencyPerLambda?: number;
     downloadBehavior?: DownloadBehavior | null;
+    muted?: boolean;
+    overwrite?: boolean;
+    webhook?: {
+        url: string;
+        secret: string | null;
+    };
 };
 export declare type RenderMediaOnLambdaOutput = {
     renderId: string;
     bucketName: string;
+    cloudWatchLogs: string;
 };
 /**
  * @description Triggers a render on a lambda given a composition and a lambda function.
@@ -41,19 +48,20 @@ export declare type RenderMediaOnLambdaOutput = {
  * @param params.serveUrl The URL of the deployed project
  * @param params.composition The ID of the composition which should be rendered.
  * @param params.inputProps The input props that should be passed to the composition.
- * @param params.codec The video codec which should be used for encoding.
- * @param params.imageFormat In which image format the frames should be rendered.
+ * @param params.codec The media codec which should be used for encoding.
+ * @param params.imageFormat In which image format the frames should be rendered. Default "jpeg"
  * @param params.crf The constant rate factor to be used during encoding.
  * @param params.envVariables Object containing environment variables to be inserted into the video environment
  * @param params.proResProfile The ProRes profile if rendering a ProRes video
  * @param params.quality JPEG quality if JPEG was selected as the image format.
- * @param params.region The AWS region in which the video should be rendered.
- * @param params.maxRetries How often rendering a chunk may fail before the video render gets aborted.
+ * @param params.region The AWS region in which the media should be rendered.
+ * @param params.maxRetries How often rendering a chunk may fail before the media render gets aborted. Default "1"
  * @param params.logLevel Level of logging that Lambda function should perform. Default "info".
+ * @param params.webhook Webhook URL to be called upon completion or timeout of the rendering process.
  * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
  */
-export declare const renderMediaOnLambda: ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, }: RenderMediaOnLambdaInput) => Promise<RenderMediaOnLambdaOutput>;
+export declare const renderMediaOnLambda: ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, muted, overwrite, webhook, }: RenderMediaOnLambdaInput) => Promise<RenderMediaOnLambdaOutput>;
 /**
  * @deprecated Renamed to renderMediaOnLambda()
  */
-export declare const renderVideoOnLambda: ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, }: RenderMediaOnLambdaInput) => Promise<RenderMediaOnLambdaOutput>;
+export declare const renderVideoOnLambda: ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, muted, overwrite, webhook, }: RenderMediaOnLambdaInput) => Promise<RenderMediaOnLambdaOutput>;