package aws-s3-lwt

You can search for identifiers within the package.

in-package search v0.2.0

package aws-s3-lwt

aws-s3-lwt
- Aws_s3_lwt
  - Credentials
    
    Helper
    
    Iam
    
    Local
  - Io
    
    Deferred
    
    Or_error
    
    Ivar
    
    Net
    
    Pipe
  - S3
    
    Delete_multi
    
    Ls
    
    Multipart_upload
    
    Stream
    
    Stream

Legend:
Library
Module
Module type
Parameter
Class
Class type

Lwt aware S3 commands. For API documentation

see ../../../aws-s3/Aws_s3/S3/Make/index.html
(Aws_s3.S3.Make)
Lwt uses a default buffer size of 4096 bytes, which means that on high speed connections lwt will make needlessly many read / write system calls.
When transferring data over high speed connections, it is recommended to increase the global channel buffer size e.g: Lwt_io.set_default_buffer_size (128*1024).
Each operation will allocate at least 2*default_buffer_size.

include sig ... end

type error = Aws_s3__S3.Make(Aws_s3_lwt.Io).error =

| Throttled
| Unknown of int * string
| Failed of exn
| Forbidden
| Not_found

type etag = string

type storage_class = Aws_s3__S3.Make(Aws_s3_lwt.Io).storage_class =

| Standard
| Standard_ia
| Onezone_ia
| Reduced_redundancy
| Glacier

type content = Aws_s3__S3.Make(Aws_s3_lwt.Io).content = {

storage_class : storage_class;
size : int;
last_modified : float;
key : string;
etag : etag;

}

type nonrec 'a result = ('a, error) Stdlib.result Io.Deferred.t

type !'a command =
  ?credentials:Aws_s3__.Credentials.t ->
  ?connect_timeout_ms:int ->
  endpoint:Aws_s3__.Region.endpoint ->
  'a

module Ls : sig ... end

module Delete_multi : sig ... end

type range = Aws_s3__S3.Make(Aws_s3_lwt.Io).range = {

first : int option;
last : int option;

}

val put : 
  (?content_type:string ->
    ?content_encoding:string ->
    ?acl:string ->
    ?cache_control:string ->
    ?expect:bool ->
    bucket:string ->
    key:string ->
    data:string ->
    unit ->
    etag result)
    command

val get : 
  (?range:range ->
    bucket:string ->
    key:string ->
    unit ->
    string result)
    command

val head : (bucket:string -> key:string -> unit -> content result) command

val delete : (bucket:string -> key:string -> unit -> unit result) command

val delete_multi : 
  (bucket:string ->
    objects:Delete_multi.objekt list ->
    unit ->
    Delete_multi.result result)
    command

val ls : 
  (?start_after:string ->
    ?continuation_token:string ->
    ?prefix:string ->
    ?max_keys:int ->
    bucket:string ->
    unit ->
    Ls.t)
    command

module Stream : sig ... end

module Multipart_upload : sig ... end

val retry : 
  endpoint:Aws_s3__.Region.endpoint ->
  retries:int ->
  f:(endpoint:Aws_s3__.Region.endpoint -> unit -> 'a result) ->
  unit ->
  'a result