Module Awskit_s3

AWS S3 client API.

Awskit_s3 is the main entrypoint for AWS S3 bucket and object storage: object operations, bucket operations and configuration, multipart upload, presigned request artifacts, endpoint resolution, and runtime-backed clients.

module type RUNTIME = sig ... end

Runtime required by the S3 functor.

module type BODY = sig ... end
module type READER = sig ... end
module type OBJECT = sig ... end

Object operations produced by runtime-backed S3 clients.

module type BUCKET = sig ... end

Bucket lifecycle and bucket-configuration operations.

module type MULTIPART = sig ... end

Multipart upload operations.

module type PRESIGNED = sig ... end

Presigned request artifact helpers bound to a client connection.

module type S = sig ... end

Complete S3 client surface for one runtime.

module Credentials = Awskit.Credentials
module Endpoint = Awskit.Endpoint
module Region = Awskit.Region
module Error : sig ... end
module Bucket_name : sig ... end

S3 bucket name.

module Object_key : sig ... end

S3 object key values.

module Account_id : sig ... end

AWS account id.

module Content_type : sig ... end

Validated Content-Type value.

module Header_value : sig ... end

Validated HTTP header field value.

module Metadata : sig ... end

User metadata represented as unprefixed x-amz-meta-* key/value pairs.

module Storage_class : sig ... end

S3 object storage classes.

module Tag : sig ... end

S3 tag key/value pair.

module Range : sig ... end

HTTP byte-range requests for S3 object reads.

module Encryption : sig ... end

Object encryption domains for S3 request and response metadata.

module Endpoint_config : sig ... end

S3 endpoint policy.

module Endpoint_resolver : sig ... end

S3 endpoint and addressing resolution.

type addressing_style = Endpoint_config.addressing_style
type endpoint_variant = Endpoint_config.endpoint_variant
type endpoint_config = Endpoint_resolver.t
val endpoint_config : ?addressing_style:addressing_style -> ?endpoint_variant:endpoint_variant -> unit -> endpoint_config

Build an AWS S3 endpoint resolver from addressing and endpoint variant preferences.

Use Awskit_s3.Endpoint_config.s3_compatible, Awskit_s3.Endpoint_config.local_plaintext, or Awskit_s3.Endpoint_config.unsafe_plaintext before passing ~endpoint_config to an adapter when targeting an explicit non-AWS endpoint.

val default_endpoint_config : endpoint_config

Default AWS S3 regional HTTPS endpoint resolver.

module Object : sig ... end

S3 object data types, object-operation options, and object-operation results.

module Bucket : sig ... end

S3 bucket data types, bucket-operation options, and bucket-operation results.

module Multipart : sig ... end

S3 multipart upload data types, options, and results.

module Transfer : sig ... end

High-level S3 transfer configuration shared by object transfer helpers.

module Policy : sig ... end

Opaque validated bucket-policy JSON payloads.

module Presigned : sig ... end

Standalone S3 presigned request generation.

module Make (R : RUNTIME) : S with type connection = R.connection and type 'a io = 'a R.t and type request_body = R.request_body and type response_body_reader = R.response_body_reader

Complete S3 client surface for one runtime.