package smaws-clients

You can search for identifiers within the package.
in-package search v0.2.0
smaws-clients
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Source file `types.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
open Smaws_Lib
let service =
  Service.{
    namespace = "kinesis";
    endpointPrefix = "kinesis";
    version = "2013-12-02";
    protocol = AwsJson_1_1
  };
type validation_exception = {
  message: string option
}

type stream_mode = | ON_DEMAND
  | PROVISIONED

type stream_mode_details = {
  stream_mode: stream_mode
}

type update_stream_mode_input = {
  stream_mode_details: stream_mode_details;
  stream_ar_n: string
}

type resource_not_found_exception = {
  message: string option
}

type resource_in_use_exception = {
  message: string option
}

type limit_exceeded_exception = {
  message: string option
}

type invalid_argument_exception = {
  message: string option
}

type update_shard_count_output = {
  stream_ar_n: string option;
  target_shard_count: int option;
  current_shard_count: int option;
  stream_name: string option
}

type scaling_type = | UNIFORM_SCALING

type update_shard_count_input = {
  stream_ar_n: string option;
  scaling_type: scaling_type;
  target_shard_count: int;
  stream_name: string option
}

type access_denied_exception = {
  message: string option
}

type tag = {
  value: string option;
  key: string
}

type encryption_type = | KMS
  | NONE

type record = {
  encryption_type: encryption_type option;
  partition_key: string;
  data: bytes;
  approximate_arrival_timestamp: float option;
  sequence_number: string
}

type hash_key_range = {
  ending_hash_key: string;
  starting_hash_key: string
}

type child_shard = {
  hash_key_range: hash_key_range;
  parent_shards: string list;
  shard_id: string
}

type subscribe_to_shard_event = {
  child_shards: child_shard list option;
  millis_behind_latest: int;
  continuation_sequence_number: string;
  records: record list
}

type kms_disabled_exception = {
  message: string option
}

type kms_invalid_state_exception = {
  message: string option
}

type kms_access_denied_exception = {
  message: string option
}

type kms_not_found_exception = {
  message: string option
}

type kms_opt_in_required = {
  message: string option
}

type kms_throttling_exception = {
  message: string option
}

type internal_failure_exception = {
  message: string option
}

type subscribe_to_shard_event_stream = InternalFailureException of internal_failure_exception | KMSThrottlingException of kms_throttling_exception | KMSOptInRequired of kms_opt_in_required | KMSNotFoundException of kms_not_found_exception | KMSAccessDeniedException of kms_access_denied_exception | KMSInvalidStateException of kms_invalid_state_exception | KMSDisabledException of kms_disabled_exception | ResourceInUseException of resource_in_use_exception | ResourceNotFoundException of resource_not_found_exception | SubscribeToShardEvent of subscribe_to_shard_event

type subscribe_to_shard_output = {
  event_stream: subscribe_to_shard_event_stream
}

type shard_iterator_type = | AT_TIMESTAMP
  | LATEST
  | TRIM_HORIZON
  | AFTER_SEQUENCE_NUMBER
  | AT_SEQUENCE_NUMBER

type starting_position = {
  timestamp_: float option;
  sequence_number: string option;
  type_: shard_iterator_type
}

type subscribe_to_shard_input = {
  starting_position: starting_position;
  shard_id: string;
  consumer_ar_n: string
}

type stream_status = | UPDATING
  | ACTIVE
  | DELETING
  | CREATING

type 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
}

type metrics_name = | ALL
  | ITERATOR_AGE_MILLISECONDS
  | READ_PROVISIONED_THROUGHPUT_EXCEEDED
  | WRITE_PROVISIONED_THROUGHPUT_EXCEEDED
  | OUTGOING_RECORDS
  | OUTGOING_BYTES
  | INCOMING_RECORDS
  | INCOMING_BYTES

type enhanced_metrics = {
  shard_level_metrics: metrics_name list option
}

type stream_description_summary = {
  consumer_count: int option;
  open_shard_count: int;
  key_id: string option;
  encryption_type: encryption_type option;
  enhanced_monitoring: enhanced_metrics list;
  stream_creation_timestamp: float;
  retention_period_hours: int;
  stream_mode_details: stream_mode_details option;
  stream_status: stream_status;
  stream_ar_n: string;
  stream_name: string
}

type sequence_number_range = {
  ending_sequence_number: string option;
  starting_sequence_number: string
}

type shard = {
  sequence_number_range: sequence_number_range;
  hash_key_range: hash_key_range;
  adjacent_parent_shard_id: string option;
  parent_shard_id: string option;
  shard_id: string
}

type stream_description = {
  key_id: string option;
  encryption_type: encryption_type option;
  enhanced_monitoring: enhanced_metrics list;
  stream_creation_timestamp: float;
  retention_period_hours: int;
  has_more_shards: bool;
  shards: shard list;
  stream_mode_details: stream_mode_details option;
  stream_status: stream_status;
  stream_ar_n: string;
  stream_name: string
}

type stop_stream_encryption_input = {
  stream_ar_n: string option;
  key_id: string;
  encryption_type: encryption_type;
  stream_name: string option
}

type start_stream_encryption_input = {
  stream_ar_n: string option;
  key_id: string;
  encryption_type: encryption_type;
  stream_name: string option
}

type split_shard_input = {
  stream_ar_n: string option;
  new_starting_hash_key: string;
  shard_to_split: string;
  stream_name: string option
}

type shard_filter_type = | FROM_TIMESTAMP
  | AT_TIMESTAMP
  | AT_LATEST
  | FROM_TRIM_HORIZON
  | AT_TRIM_HORIZON
  | AFTER_SHARD_ID

type shard_filter = {
  timestamp_: float option;
  shard_id: string option;
  type_: shard_filter_type
}

type remove_tags_from_stream_input = {
  stream_ar_n: string option;
  tag_keys: string list;
  stream_name: string option
}

type consumer_status = | ACTIVE
  | DELETING
  | CREATING

type consumer = {
  consumer_creation_timestamp: float;
  consumer_status: consumer_status;
  consumer_ar_n: string;
  consumer_name: string
}

type register_stream_consumer_output = {
  consumer: consumer
}

type register_stream_consumer_input = {
  consumer_name: string;
  stream_ar_n: string
}

type put_resource_policy_input = {
  policy: string;
  resource_ar_n: string
}

type put_records_result_entry = {
  error_message: string option;
  error_code: string option;
  shard_id: string option;
  sequence_number: string option
}

type put_records_request_entry = {
  partition_key: string;
  explicit_hash_key: string option;
  data: bytes
}

type put_records_output = {
  encryption_type: encryption_type option;
  records: put_records_result_entry list;
  failed_record_count: int option
}

type put_records_input = {
  stream_ar_n: string option;
  stream_name: string option;
  records: put_records_request_entry list
}

type provisioned_throughput_exceeded_exception = {
  message: string option
}

type put_record_output = {
  encryption_type: encryption_type option;
  sequence_number: string;
  shard_id: string
}

type put_record_input = {
  stream_ar_n: string option;
  sequence_number_for_ordering: string option;
  explicit_hash_key: string option;
  partition_key: string;
  data: bytes;
  stream_name: string option
}

type merge_shards_input = {
  stream_ar_n: string option;
  adjacent_shard_to_merge: string;
  shard_to_merge: string;
  stream_name: string option
}

type list_tags_for_stream_output = {
  has_more_tags: bool;
  tags: tag list
}

type list_tags_for_stream_input = {
  stream_ar_n: string option;
  limit: int option;
  exclusive_start_tag_key: string option;
  stream_name: string option
}

type list_streams_output = {
  stream_summaries: stream_summary list option;
  next_token: string option;
  has_more_streams: bool;
  stream_names: string list
}

type list_streams_input = {
  next_token: string option;
  exclusive_start_stream_name: string option;
  limit: int option
}

type expired_next_token_exception = {
  message: string option
}

type list_stream_consumers_output = {
  next_token: string option;
  consumers: consumer list option
}

type list_stream_consumers_input = {
  stream_creation_timestamp: float option;
  max_results: int option;
  next_token: string option;
  stream_ar_n: string
}

type list_shards_output = {
  next_token: string option;
  shards: shard list option
}

type 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
}

type increase_stream_retention_period_input = {
  stream_ar_n: string option;
  retention_period_hours: int;
  stream_name: string option
}

type get_shard_iterator_output = {
  shard_iterator: string option
}

type get_shard_iterator_input = {
  stream_ar_n: string option;
  timestamp_: float option;
  starting_sequence_number: string option;
  shard_iterator_type: shard_iterator_type;
  shard_id: string;
  stream_name: string option
}

type get_resource_policy_output = {
  policy: string
}

type get_resource_policy_input = {
  resource_ar_n: string
}

type expired_iterator_exception = {
  message: string option
}

type get_records_output = {
  child_shards: child_shard list option;
  millis_behind_latest: int option;
  next_shard_iterator: string option;
  records: record list
}

type get_records_input = {
  stream_ar_n: string option;
  limit: int option;
  shard_iterator: string
}

type 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
}

type enable_enhanced_monitoring_input = {
  stream_ar_n: string option;
  shard_level_metrics: metrics_name list;
  stream_name: string option
}

type disable_enhanced_monitoring_input = {
  stream_ar_n: string option;
  shard_level_metrics: metrics_name list;
  stream_name: string option
}

type describe_stream_summary_output = {
  stream_description_summary: stream_description_summary
}

type describe_stream_summary_input = {
  stream_ar_n: string option;
  stream_name: string option
}

type consumer_description = {
  stream_ar_n: string;
  consumer_creation_timestamp: float;
  consumer_status: consumer_status;
  consumer_ar_n: string;
  consumer_name: string
}

type describe_stream_consumer_output = {
  consumer_description: consumer_description
}

type describe_stream_consumer_input = {
  consumer_ar_n: string option;
  consumer_name: string option;
  stream_ar_n: string option
}

type describe_stream_output = {
  stream_description: stream_description
}

type describe_stream_input = {
  stream_ar_n: string option;
  exclusive_start_shard_id: string option;
  limit: int option;
  stream_name: string option
}

type describe_limits_output = {
  on_demand_stream_count_limit: int;
  on_demand_stream_count: int;
  open_shard_count: int;
  shard_limit: int
}

type describe_limits_input = unit

type deregister_stream_consumer_input = {
  consumer_ar_n: string option;
  consumer_name: string option;
  stream_ar_n: string option
}

type delete_stream_input = {
  stream_ar_n: string option;
  enforce_consumer_deletion: bool option;
  stream_name: string option
}

type delete_resource_policy_input = {
  resource_ar_n: string
}

type decrease_stream_retention_period_input = {
  stream_ar_n: string option;
  retention_period_hours: int;
  stream_name: string option
}

type create_stream_input = {
  stream_mode_details: stream_mode_details option;
  shard_count: int option;
  stream_name: string
}

type add_tags_to_stream_input = {
  stream_ar_n: string option;
  tags: (string * string) list;
  stream_name: string option
}



type base_document = Json.t
package smaws-clients

Source file types.ml

Source file `types.ml`
