package smaws-clients

  1. Overview
  2. Docs
Amazon Web Services SDK clients using EIO

Install

Dune Dependency

Authors

Maintainers

Sources

0.1.preview1.tar.gz
md5=18fb70dbc45e8d81a341b9bed6871bab
sha512=7607dc98acaeed5803b44c9ca32d90c88e7813d4b3e3ae4ec661a0bad16c88dc1476bc780877527ea4cd5a4b7398453c1bb600ce0db14d39afa05dc4762b5ba5

doc/src/smaws-clients.kinesis/builders.ml.html

Source file builders.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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
[@@@warning "-39"]
open Types
let make_stream_mode_details  ~(stream_mode : stream_mode) ()
: stream_mode_details = { stream_mode;  }

let make_update_stream_mode_input 
  ~(stream_mode_details : stream_mode_details) ~(stream_ar_n : string) ()
: update_stream_mode_input = { stream_mode_details; stream_ar_n; 
}

let make_update_shard_count_output 
  ?(stream_ar_n : string option)
  ?(target_shard_count : int option)
  ?(current_shard_count : int option)
  ?(stream_name : string option)
  () : update_shard_count_output = {
  stream_ar_n; target_shard_count; current_shard_count; stream_name; 
}

let make_update_shard_count_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(scaling_type : scaling_type)
  ~(target_shard_count : int)
  () : update_shard_count_input = {
  stream_ar_n; scaling_type; target_shard_count; stream_name;  }

let make_tag  ?(value : string option) ~(key : string) () : tag = {
  value; key;  }

let make_record 
  ?(encryption_type : encryption_type option)
  ?(approximate_arrival_timestamp : float option)
  ~(partition_key : string)
  ~(data : bytes)
  ~(sequence_number : string)
  () : record = {
  encryption_type;
  partition_key;
  data;
  approximate_arrival_timestamp;
  sequence_number;
   }

let make_hash_key_range 
  ~(ending_hash_key : string) ~(starting_hash_key : string) ()
: hash_key_range = { ending_hash_key; starting_hash_key; 
}

let make_child_shard 
  ~(hash_key_range : hash_key_range)
  ~(parent_shards : string list)
  ~(shard_id : string)
  () : child_shard = { hash_key_range; parent_shards; shard_id; 
}

let make_subscribe_to_shard_event 
  ?(child_shards : child_shard list option)
  ~(millis_behind_latest : int)
  ~(continuation_sequence_number : string)
  ~(records : record list)
  () : subscribe_to_shard_event = {
  child_shards; millis_behind_latest; continuation_sequence_number; records; 
}

let make_subscribe_to_shard_output 
  ~(event_stream : subscribe_to_shard_event_stream) ()
: subscribe_to_shard_output = { event_stream;  }

let make_starting_position 
  ?(timestamp_ : float option)
  ?(sequence_number : string option)
  ~(type_ : shard_iterator_type)
  () : starting_position = { timestamp_; sequence_number; type_; 
}

let make_subscribe_to_shard_input 
  ~(starting_position : starting_position)
  ~(shard_id : string)
  ~(consumer_ar_n : string)
  () : subscribe_to_shard_input = {
  starting_position; shard_id; consumer_ar_n;  }

let make_stream_summary 
  ?(stream_creation_timestamp : float option)
  ?(stream_mode_details : stream_mode_details option)
  ~(stream_status : stream_status)
  ~(stream_ar_n : string)
  ~(stream_name : string)
  () : stream_summary = {
  stream_creation_timestamp;
  stream_mode_details;
  stream_status;
  stream_ar_n;
  stream_name;
   }

let make_enhanced_metrics 
  ?(shard_level_metrics : metrics_name list option) () : enhanced_metrics = {
  shard_level_metrics;  }

let make_stream_description_summary 
  ?(consumer_count : int option)
  ?(key_id : string option)
  ?(encryption_type : encryption_type option)
  ?(stream_mode_details : stream_mode_details option)
  ~(open_shard_count : int)
  ~(enhanced_monitoring : enhanced_metrics list)
  ~(stream_creation_timestamp : float)
  ~(retention_period_hours : int)
  ~(stream_status : stream_status)
  ~(stream_ar_n : string)
  ~(stream_name : string)
  () : stream_description_summary = {
  consumer_count;
  open_shard_count;
  key_id;
  encryption_type;
  enhanced_monitoring;
  stream_creation_timestamp;
  retention_period_hours;
  stream_mode_details;
  stream_status;
  stream_ar_n;
  stream_name;
   }

let make_sequence_number_range 
  ?(ending_sequence_number : string option)
  ~(starting_sequence_number : string)
  () : sequence_number_range = {
  ending_sequence_number; starting_sequence_number;  }

let make_shard 
  ?(adjacent_parent_shard_id : string option)
  ?(parent_shard_id : string option)
  ~(sequence_number_range : sequence_number_range)
  ~(hash_key_range : hash_key_range)
  ~(shard_id : string)
  () : shard = {
  sequence_number_range;
  hash_key_range;
  adjacent_parent_shard_id;
  parent_shard_id;
  shard_id;
   }

let make_stream_description 
  ?(key_id : string option)
  ?(encryption_type : encryption_type option)
  ?(stream_mode_details : stream_mode_details option)
  ~(enhanced_monitoring : enhanced_metrics list)
  ~(stream_creation_timestamp : float)
  ~(retention_period_hours : int)
  ~(has_more_shards : bool)
  ~(shards : shard list)
  ~(stream_status : stream_status)
  ~(stream_ar_n : string)
  ~(stream_name : string)
  () : stream_description = {
  key_id;
  encryption_type;
  enhanced_monitoring;
  stream_creation_timestamp;
  retention_period_hours;
  has_more_shards;
  shards;
  stream_mode_details;
  stream_status;
  stream_ar_n;
  stream_name;
   }

let make_stop_stream_encryption_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(key_id : string)
  ~(encryption_type : encryption_type)
  () : stop_stream_encryption_input = {
  stream_ar_n; key_id; encryption_type; stream_name; 
}

let make_start_stream_encryption_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(key_id : string)
  ~(encryption_type : encryption_type)
  () : start_stream_encryption_input = {
  stream_ar_n; key_id; encryption_type; stream_name; 
}

let make_split_shard_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(new_starting_hash_key : string)
  ~(shard_to_split : string)
  () : split_shard_input = {
  stream_ar_n; new_starting_hash_key; shard_to_split; stream_name; 
}

let make_shard_filter 
  ?(timestamp_ : float option)
  ?(shard_id : string option)
  ~(type_ : shard_filter_type)
  () : shard_filter = { timestamp_; shard_id; type_; 
}

let make_remove_tags_from_stream_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(tag_keys : string list)
  () : remove_tags_from_stream_input = { stream_ar_n; tag_keys; stream_name; 
}

let make_consumer 
  ~(consumer_creation_timestamp : float)
  ~(consumer_status : consumer_status)
  ~(consumer_ar_n : string)
  ~(consumer_name : string)
  () : consumer = {
  consumer_creation_timestamp; consumer_status; consumer_ar_n; consumer_name; 
}

let make_register_stream_consumer_output  ~(consumer : consumer) ()
: register_stream_consumer_output = { consumer; 
}

let make_register_stream_consumer_input 
  ~(consumer_name : string) ~(stream_ar_n : string) ()
: register_stream_consumer_input = { consumer_name; stream_ar_n; 
}

let make_put_resource_policy_input 
  ~(policy : string) ~(resource_ar_n : string) () : put_resource_policy_input
= { policy; resource_ar_n;  }

let make_put_records_result_entry 
  ?(error_message : string option)
  ?(error_code : string option)
  ?(shard_id : string option)
  ?(sequence_number : string option)
  () : put_records_result_entry = {
  error_message; error_code; shard_id; sequence_number; 
}

let make_put_records_request_entry 
  ?(explicit_hash_key : string option)
  ~(partition_key : string)
  ~(data : bytes)
  () : put_records_request_entry = { partition_key; explicit_hash_key; data; 
}

let make_put_records_output 
  ?(encryption_type : encryption_type option)
  ?(failed_record_count : int option)
  ~(records : put_records_result_entry list)
  () : put_records_output = { encryption_type; records; failed_record_count; 
}

let make_put_records_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(records : put_records_request_entry list)
  () : put_records_input = { stream_ar_n; stream_name; records; 
}

let make_put_record_output 
  ?(encryption_type : encryption_type option)
  ~(sequence_number : string)
  ~(shard_id : string)
  () : put_record_output = { encryption_type; sequence_number; shard_id; 
}

let make_put_record_input 
  ?(stream_ar_n : string option)
  ?(sequence_number_for_ordering : string option)
  ?(explicit_hash_key : string option)
  ?(stream_name : string option)
  ~(partition_key : string)
  ~(data : bytes)
  () : put_record_input = {
  stream_ar_n;
  sequence_number_for_ordering;
  explicit_hash_key;
  partition_key;
  data;
  stream_name;
   }

let make_merge_shards_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(adjacent_shard_to_merge : string)
  ~(shard_to_merge : string)
  () : merge_shards_input = {
  stream_ar_n; adjacent_shard_to_merge; shard_to_merge; stream_name; 
}

let make_list_tags_for_stream_output 
  ~(has_more_tags : bool) ~(tags : tag list) () : list_tags_for_stream_output
= { has_more_tags; tags;  }

let make_list_tags_for_stream_input 
  ?(stream_ar_n : string option)
  ?(limit : int option)
  ?(exclusive_start_tag_key : string option)
  ?(stream_name : string option)
  () : list_tags_for_stream_input = {
  stream_ar_n; limit; exclusive_start_tag_key; stream_name; 
}

let make_list_streams_output 
  ?(stream_summaries : stream_summary list option)
  ?(next_token : string option)
  ~(has_more_streams : bool)
  ~(stream_names : string list)
  () : list_streams_output = {
  stream_summaries; next_token; has_more_streams; stream_names; 
}

let make_list_streams_input 
  ?(next_token : string option)
  ?(exclusive_start_stream_name : string option)
  ?(limit : int option)
  () : list_streams_input = {
  next_token; exclusive_start_stream_name; limit; 
}

let make_list_stream_consumers_output 
  ?(next_token : string option) ?(consumers : consumer list option) ()
: list_stream_consumers_output = { next_token; consumers; 
}

let make_list_stream_consumers_input 
  ?(stream_creation_timestamp : float option)
  ?(max_results : int option)
  ?(next_token : string option)
  ~(stream_ar_n : string)
  () : list_stream_consumers_input = {
  stream_creation_timestamp; max_results; next_token; stream_ar_n; 
}

let make_list_shards_output 
  ?(next_token : string option) ?(shards : shard list option) ()
: list_shards_output = { next_token; shards;  }

let make_list_shards_input 
  ?(stream_ar_n : string option)
  ?(shard_filter : shard_filter option)
  ?(stream_creation_timestamp : float option)
  ?(max_results : int option)
  ?(exclusive_start_shard_id : string option)
  ?(next_token : string option)
  ?(stream_name : string option)
  () : list_shards_input = {
  stream_ar_n;
  shard_filter;
  stream_creation_timestamp;
  max_results;
  exclusive_start_shard_id;
  next_token;
  stream_name;
   }

let make_increase_stream_retention_period_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(retention_period_hours : int)
  () : increase_stream_retention_period_input = {
  stream_ar_n; retention_period_hours; stream_name; 
}

let make_get_shard_iterator_output  ?(shard_iterator : string option) ()
: get_shard_iterator_output = { shard_iterator; 
}

let make_get_shard_iterator_input 
  ?(stream_ar_n : string option)
  ?(timestamp_ : float option)
  ?(starting_sequence_number : string option)
  ?(stream_name : string option)
  ~(shard_iterator_type : shard_iterator_type)
  ~(shard_id : string)
  () : get_shard_iterator_input = {
  stream_ar_n;
  timestamp_;
  starting_sequence_number;
  shard_iterator_type;
  shard_id;
  stream_name;
   }

let make_get_resource_policy_output  ~(policy : string) ()
: get_resource_policy_output = { policy; 
}

let make_get_resource_policy_input  ~(resource_ar_n : string) ()
: get_resource_policy_input = { resource_ar_n;  }

let make_get_records_output 
  ?(child_shards : child_shard list option)
  ?(millis_behind_latest : int option)
  ?(next_shard_iterator : string option)
  ~(records : record list)
  () : get_records_output = {
  child_shards; millis_behind_latest; next_shard_iterator; records; 
}

let make_get_records_input 
  ?(stream_ar_n : string option)
  ?(limit : int option)
  ~(shard_iterator : string)
  () : get_records_input = { stream_ar_n; limit; shard_iterator; 
}

let make_enhanced_monitoring_output 
  ?(stream_ar_n : string option)
  ?(desired_shard_level_metrics : metrics_name list option)
  ?(current_shard_level_metrics : metrics_name list option)
  ?(stream_name : string option)
  () : enhanced_monitoring_output = {
  stream_ar_n;
  desired_shard_level_metrics;
  current_shard_level_metrics;
  stream_name;
   }

let make_enable_enhanced_monitoring_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(shard_level_metrics : metrics_name list)
  () : enable_enhanced_monitoring_input = {
  stream_ar_n; shard_level_metrics; stream_name; 
}

let make_disable_enhanced_monitoring_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(shard_level_metrics : metrics_name list)
  () : disable_enhanced_monitoring_input = {
  stream_ar_n; shard_level_metrics; stream_name; 
}

let make_describe_stream_summary_output 
  ~(stream_description_summary : stream_description_summary) ()
: describe_stream_summary_output = { stream_description_summary; 
}

let make_describe_stream_summary_input 
  ?(stream_ar_n : string option) ?(stream_name : string option) ()
: describe_stream_summary_input = { stream_ar_n; stream_name; 
}

let make_consumer_description 
  ~(stream_ar_n : string)
  ~(consumer_creation_timestamp : float)
  ~(consumer_status : consumer_status)
  ~(consumer_ar_n : string)
  ~(consumer_name : string)
  () : consumer_description = {
  stream_ar_n;
  consumer_creation_timestamp;
  consumer_status;
  consumer_ar_n;
  consumer_name;
   }

let make_describe_stream_consumer_output 
  ~(consumer_description : consumer_description) ()
: describe_stream_consumer_output = { consumer_description; 
}

let make_describe_stream_consumer_input 
  ?(consumer_ar_n : string option)
  ?(consumer_name : string option)
  ?(stream_ar_n : string option)
  () : describe_stream_consumer_input = {
  consumer_ar_n; consumer_name; stream_ar_n; 
}

let make_describe_stream_output 
  ~(stream_description : stream_description) () : describe_stream_output = {
  stream_description;  }

let make_describe_stream_input 
  ?(stream_ar_n : string option)
  ?(exclusive_start_shard_id : string option)
  ?(limit : int option)
  ?(stream_name : string option)
  () : describe_stream_input = {
  stream_ar_n; exclusive_start_shard_id; limit; stream_name; 
}

let make_describe_limits_output 
  ~(on_demand_stream_count_limit : int)
  ~(on_demand_stream_count : int)
  ~(open_shard_count : int)
  ~(shard_limit : int)
  () : describe_limits_output = {
  on_demand_stream_count_limit;
  on_demand_stream_count;
  open_shard_count;
  shard_limit;
   }

let make_describe_limits_input  () : describe_limits_input =
()

let make_deregister_stream_consumer_input 
  ?(consumer_ar_n : string option)
  ?(consumer_name : string option)
  ?(stream_ar_n : string option)
  () : deregister_stream_consumer_input = {
  consumer_ar_n; consumer_name; stream_ar_n;  }

let make_delete_stream_input 
  ?(stream_ar_n : string option)
  ?(enforce_consumer_deletion : bool option)
  ?(stream_name : string option)
  () : delete_stream_input = {
  stream_ar_n; enforce_consumer_deletion; stream_name; 
}

let make_delete_resource_policy_input  ~(resource_ar_n : string) ()
: delete_resource_policy_input = { resource_ar_n; 
}

let make_decrease_stream_retention_period_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(retention_period_hours : int)
  () : decrease_stream_retention_period_input = {
  stream_ar_n; retention_period_hours; stream_name; 
}

let make_create_stream_input 
  ?(stream_mode_details : stream_mode_details option)
  ?(shard_count : int option)
  ~(stream_name : string)
  () : create_stream_input = {
  stream_mode_details; shard_count; stream_name; 
}

let make_add_tags_to_stream_input 
  ?(stream_ar_n : string option)
  ?(stream_name : string option)
  ~(tags : (string * string) list)
  () : add_tags_to_stream_input = { stream_ar_n; tags; stream_name; 
}

OCaml

Innovation. Community. Security.