package awskit-s3-lwt-unix

  1. Overview
  2. Docs
On This Page
  1. Client Surface
Lwt Unix adapter for Awskit S3

Install

dune-project
 Dependency

Authors

Maintainers

Sources

awskit-v0.2.0.tbz
sha256=b69c81378d08f443a276b947d9a2b45913495cb61b2ff3aa0ad74d6b071f32f8
sha512=50714b8eda6ea6e589eb34a305afdfa4870a5e8e4240c091ff5cecd309c21fdfda6163fb6449caad5cdaf800857369df5da0534d822cf152ac76fc16fb9216e5

doc/index.html

awskit-s3-lwt-unix

Ready-to-use Lwt + Unix S3 client.

The public entrypoint is Awskit_s3_lwt_unix. This package combines the S3 operation surface with the ready Awskit Lwt Unix runtime.

It can resolve credentials and region from the standard Unix sources exposed by awskit-lwt-unix, and it also owns S3 local-file body, reader, upload, and download helpers.

Client Surface

Awskit_s3_lwt_unix.create accepts explicit credentials, region, retry, timeout, and endpoint configuration. When credentials or region are omitted, the underlying awskit-lwt-unix runtime reads the standard environment, profile, ECS/container, and EC2 metadata sources it supports.

The package exposes:

  • Body.of_lwt_stream, Body.of_channel, and Body.of_path for request bodies with known content lengths.
  • Reader.to_channel and Reader.to_path for scoped response-body consumers.
  • Object.Transfer.upload_file, download_file, multipart_upload_file, and resume_multipart_upload_file for managed local-file workflows.

Managed uploads abort multipart uploads that Awskit created when the helper fails before completion. Resumed caller-owned uploads are left open on failure so the caller can retry or abort explicitly. Managed downloads write through a private temporary file before publishing the target path.