Chapter 453: deleteSite()

Core Idea

Removes a Remotion project from your S3 bucket.

Key Concepts

• Example
• Arguments
• region
• bucketName
• siteName
• forcePathStyle?<AvailableFrom v="4.0.202" />
• Return value
• totalSizeInBytes

Code Examples

const region: AwsRegion = 'eu-central-1';

const {sites} = await getSites({
  region,
});

for (const site of sites) {
  await deleteSite({
    bucketName: site.bucketName,
    siteName: site.id,
    region,
  });
  console.log(`Site ${site.id} deleted.`);
}

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

Key Takeaways

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

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.