package awskit-s3

  1. Overview
  2. Docs
package awskit-s3
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Awskit_s3Source

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.

Sourcemodule type RUNTIME = sig ... end

Runtime required by the S3 functor.

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

Object operations produced by runtime-backed S3 clients.

Sourcemodule type BUCKET = sig ... end

Bucket lifecycle and bucket-configuration operations.

Sourcemodule type MULTIPART = sig ... end

Multipart upload operations.

Sourcemodule type PRESIGNED = sig ... end

Presigned request artifact helpers bound to a client connection.

Sourcemodule type S = sig ... end

Complete S3 client surface for one runtime.

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

S3 bucket name.

Sourcemodule Object_key : sig ... end

S3 object key values.

Sourcemodule Account_id : sig ... end

AWS account id.

Sourcemodule Content_type : sig ... end

Validated Content-Type value.

Sourcemodule Header_value : sig ... end

Validated HTTP header field value.

Sourcemodule Metadata : sig ... end

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

Sourcemodule Storage_class : sig ... end

S3 object storage classes.

Sourcemodule Tag : sig ... end

S3 tag key/value pair.

Sourcemodule Range : sig ... end

HTTP byte-range requests for S3 object reads.

Sourcemodule Encryption : sig ... end

Object encryption domains for S3 request and response metadata.

Sourcemodule Endpoint_config : sig ... end

S3 endpoint policy.

Sourcemodule Endpoint_resolver : sig ... end

S3 endpoint and addressing resolution.

Sourcetype endpoint_config = Endpoint_resolver.t
Sourceval 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.

Sourceval default_endpoint_config : endpoint_config

Default AWS S3 regional HTTPS endpoint resolver.

Sourcemodule Object : sig ... end

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

Sourcemodule Bucket : sig ... end

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

Sourcemodule Multipart : sig ... end

S3 multipart upload data types, options, and results.

Sourcemodule Transfer : sig ... end

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

Sourcemodule Policy : sig ... end

Opaque validated bucket-policy JSON payloads.

Sourcemodule Presigned : sig ... end

Standalone S3 presigned request generation.

Complete S3 client surface for one runtime.