package awskit-s3

  1. Overview
  2. Docs
S3 client core — objects, buckets, multipart, and policies

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (2)

Authors

  1. A
    Abdullah Elsayed <hey@abdufelsayed.dev>

Maintainers

  1. A
    Abdullah Elsayed <hey@abdufelsayed.dev>

Sources

awskit-v0.1.0.tbz
sha256=788e91d57b9eed047bdef011aec476e94588be20e2e2f1b8495cf48b1a90cf0f
sha512=0d441d599f3f3efb766270258bb4d8c9cd660943eb7f90ced0ec6f61a6790f5fb8977ca5cf87f466d84701ee34dbfdf81fe5043b568a2236411f577e698c6d1e

doc/awskit-s3/Awskit_s3/index.html

Module Awskit_s3Source

AWS S3 SDK surface.

Awskit_s3 is the public facade for AWS S3 bucket/object storage: object operations, bucket operations and configuration, multipart upload, presigned URLs, endpoint resolution, and runtime-backed clients.

Sourcemodule Credentials = Awskit.Credentials
Sourcemodule Endpoint = Awskit.Endpoint
Sourcemodule Region = Awskit.Region
Sourcemodule Error : sig ... end
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.

Sourcetype addressing_style = [
  1. | `Auto
  2. | `Path
  3. | `Virtual_hosted
]
Sourcetype endpoint_variant = [
  1. | `Regional
  2. | `Dualstack
  3. | `Fips
  4. | `Fips_dualstack
  5. | `Accelerate
  6. | `Accelerate_dualstack
]
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 -> ?scheme:Endpoint.Scheme.t -> ?endpoint:Endpoint.t -> unit -> endpoint_config
Sourceval default_endpoint_config : endpoint_config
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 URL generation.

Sourcemodule Put_object = Object.Put
Sourcemodule Get_object = Object.Get
Sourcemodule Head_object = Object.Head
Sourcemodule Delete_object = Object.Delete
Sourcemodule Delete_objects = Object.Delete_many
Sourcemodule Copy_object = Object.Copy
Sourcemodule List_objects_v2 = Object.List
Sourcemodule List_object_versions = Object.Versions
Sourcemodule Create_bucket = Bucket.Create
Sourcemodule Delete_bucket = Bucket.Delete
Sourcemodule Head_bucket = Bucket.Head
Sourcemodule List_buckets = Bucket.List_buckets
Sourcemodule Get_bucket_location = Bucket.Get_location
Sourcemodule Create_multipart_upload = Multipart.Create
Sourcemodule Upload_part = Multipart.Upload_part
Sourcemodule Complete_multipart_upload = Multipart.Complete
Sourcemodule Abort_multipart_upload = Multipart.Abort
Sourcemodule List_parts = Multipart.List_parts
Sourcemodule type RUNTIME = sig ... end
Sourcemodule type OBJECT = sig ... end
Sourcemodule type BUCKET = sig ... end
Sourcemodule type MULTIPART = sig ... end
Sourcemodule type PRESIGNED = sig ... end
Sourcemodule type S = sig ... end