package awskit-s3

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file bucket.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
type info = { name : Bucket_name.t; creation_date : Ptime.t option }

module Create = struct
  type options = { region : Awskit.Region.t option }
  type result = { response : Awskit.Response.t }

  let default_options = { region = None }
  let options ?region () = Ok { region }

  let options_exn ?region () =
    Awskit.Error.Producer.get_ok_exn (options ?region ())
end

module Delete = struct
  type options = { expected_bucket_owner : Account_id.t option }
  type result = { response : Awskit.Response.t }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module Head = struct
  type options = { expected_bucket_owner : Account_id.t option }

  type result = {
    name : Bucket_name.t;
    region : Awskit.Region.t option;
    response : Awskit.Response.t;
  }

  type info = result

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module List_buckets = struct
  type result = { buckets : info list; response : Awskit.Response.t }
end

module Get_location = struct
  type options = { expected_bucket_owner : Account_id.t option }
  type result = { region : Awskit.Region.t; response : Awskit.Response.t }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module Policy = struct
  type options = { expected_bucket_owner : Account_id.t option }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module Versioning = struct
  type options = { expected_bucket_owner : Account_id.t option }

  module Status = struct
    type t = Enabled | Suspended | Unknown of string

    let to_string = function
      | Enabled -> "Enabled"
      | Suspended -> "Suspended"
      | Unknown value -> value

    let of_string = function
      | "Enabled" -> Enabled
      | "Suspended" -> Suspended
      | value -> Unknown value
  end

  type result = { status : Status.t option; response : Awskit.Response.t }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module Tagging = struct
  type options = { expected_bucket_owner : Account_id.t option }
  type result = { tags : Tag.Set.t; response : Awskit.Response.t }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module Encryption = struct
  type options = { expected_bucket_owner : Account_id.t option }

  module Algorithm = struct
    type t = Aes256 | Aws_kms | Aws_kms_dsse | Unknown of string

    let to_string = function
      | Aes256 -> "AES256"
      | Aws_kms -> "aws:kms"
      | Aws_kms_dsse -> "aws:kms:dsse"
      | Unknown value -> value

    let of_string = function
      | "AES256" -> Aes256
      | "aws:kms" -> Aws_kms
      | "aws:kms:dsse" -> Aws_kms_dsse
      | value -> Unknown value
  end

  module Blocked_encryption_type = struct
    type t = Sse_c | No_block | Unknown of string

    let to_string = function
      | Sse_c -> "SSE-C"
      | No_block -> "NONE"
      | Unknown value -> value

    let of_string = function
      | "SSE-C" -> Sse_c
      | "NONE" -> No_block
      | value -> Unknown value
  end

  module Rule = struct
    type t = {
      sse_algorithm : Algorithm.t option;
      kms_master_key_id : string option;
      bucket_key_enabled : bool option;
      blocked_encryption_types : Blocked_encryption_type.t list;
    }
  end

  type config = { rules : Rule.t list }
  type result = { config : config; response : Awskit.Response.t }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module Cors = struct
  type options = { expected_bucket_owner : Account_id.t option }

  module Method = struct
    type t = Get | Put | Post | Delete | Head

    let to_string = function
      | Get -> "GET"
      | Put -> "PUT"
      | Post -> "POST"
      | Delete -> "DELETE"
      | Head -> "HEAD"

    let of_string = function
      | "GET" -> Some Get
      | "PUT" -> Some Put
      | "POST" -> Some Post
      | "DELETE" -> Some Delete
      | "HEAD" -> Some Head
      | _ -> None
  end

  type rule = {
    id : string option;
    allowed_origins : string list;
    allowed_methods : Method.t list;
    allowed_headers : string list;
    expose_headers : string list;
    max_age_seconds : int option;
  }

  type config = { rules : rule list }
  type result = { config : config; response : Awskit.Response.t }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module Public_access_block = struct
  type options = { expected_bucket_owner : Account_id.t option }

  type config = {
    block_public_acls : bool;
    ignore_public_acls : bool;
    block_public_policy : bool;
    restrict_public_buckets : bool;
  }

  type result = { config : config; response : Awskit.Response.t }

  let all_false =
    {
      block_public_acls = false;
      ignore_public_acls = false;
      block_public_policy = false;
      restrict_public_buckets = false;
    }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end

module Ownership_controls = struct
  type options = { expected_bucket_owner : Account_id.t option }

  module Object_ownership = struct
    type t =
      | Bucket_owner_enforced
      | Bucket_owner_preferred
      | Object_writer
      | Unknown of string

    let to_string = function
      | Bucket_owner_enforced -> "BucketOwnerEnforced"
      | Bucket_owner_preferred -> "BucketOwnerPreferred"
      | Object_writer -> "ObjectWriter"
      | Unknown value -> value

    let of_string = function
      | "BucketOwnerEnforced" -> Bucket_owner_enforced
      | "BucketOwnerPreferred" -> Bucket_owner_preferred
      | "ObjectWriter" -> Object_writer
      | value -> Unknown value
  end

  type config = { object_ownership : Object_ownership.t }
  type result = { config : config; response : Awskit.Response.t }

  let default_options = { expected_bucket_owner = None }
  let options ?expected_bucket_owner () = Ok { expected_bucket_owner }

  let options_exn ?expected_bucket_owner () =
    Awskit.Error.Producer.get_ok_exn (options ?expected_bucket_owner ())
end