package smaws-clients

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type validation_exception = {
  1. message : string option;
}
type stream_mode =
  1. | ON_DEMAND
  2. | PROVISIONED
type stream_mode_details = {
  1. stream_mode : stream_mode;
}
type update_stream_mode_input = {
  1. stream_mode_details : stream_mode_details;
  2. stream_ar_n : string;
}
type resource_not_found_exception = {
  1. message : string option;
}
type resource_in_use_exception = {
  1. message : string option;
}
type limit_exceeded_exception = {
  1. message : string option;
}
type invalid_argument_exception = {
  1. message : string option;
}
type update_shard_count_output = {
  1. stream_ar_n : string option;
  2. target_shard_count : int option;
  3. current_shard_count : int option;
  4. stream_name : string option;
}
type scaling_type =
  1. | UNIFORM_SCALING
type update_shard_count_input = {
  1. stream_ar_n : string option;
  2. scaling_type : scaling_type;
  3. target_shard_count : int;
  4. stream_name : string option;
}
type access_denied_exception = {
  1. message : string option;
}
type tag = {
  1. value : string option;
  2. key : string;
}
type encryption_type =
  1. | KMS
  2. | NONE
type record = {
  1. encryption_type : encryption_type option;
  2. partition_key : string;
  3. data : bytes;
  4. approximate_arrival_timestamp : float option;
  5. sequence_number : string;
}
type hash_key_range = {
  1. ending_hash_key : string;
  2. starting_hash_key : string;
}
type child_shard = {
  1. hash_key_range : hash_key_range;
  2. parent_shards : string list;
  3. shard_id : string;
}
type subscribe_to_shard_event = {
  1. child_shards : child_shard list option;
  2. millis_behind_latest : int;
  3. continuation_sequence_number : string;
  4. records : record list;
}
type kms_disabled_exception = {
  1. message : string option;
}
type kms_invalid_state_exception = {
  1. message : string option;
}
type kms_access_denied_exception = {
  1. message : string option;
}
type kms_not_found_exception = {
  1. message : string option;
}
type kms_opt_in_required = {
  1. message : string option;
}
type kms_throttling_exception = {
  1. message : string option;
}
type internal_failure_exception = {
  1. message : string option;
}
type subscribe_to_shard_event_stream =
  1. | InternalFailureException of internal_failure_exception
  2. | KMSThrottlingException of kms_throttling_exception
  3. | KMSOptInRequired of kms_opt_in_required
  4. | KMSNotFoundException of kms_not_found_exception
  5. | KMSAccessDeniedException of kms_access_denied_exception
  6. | KMSInvalidStateException of kms_invalid_state_exception
  7. | KMSDisabledException of kms_disabled_exception
  8. | ResourceInUseException of resource_in_use_exception
  9. | ResourceNotFoundException of resource_not_found_exception
  10. | SubscribeToShardEvent of subscribe_to_shard_event
type subscribe_to_shard_output = {
  1. event_stream : subscribe_to_shard_event_stream;
}
type shard_iterator_type =
  1. | AT_TIMESTAMP
  2. | LATEST
  3. | TRIM_HORIZON
  4. | AFTER_SEQUENCE_NUMBER
  5. | AT_SEQUENCE_NUMBER
type starting_position = {
  1. timestamp_ : float option;
  2. sequence_number : string option;
  3. type_ : shard_iterator_type;
}
type subscribe_to_shard_input = {
  1. starting_position : starting_position;
  2. shard_id : string;
  3. consumer_ar_n : string;
}
type stream_status =
  1. | UPDATING
  2. | ACTIVE
  3. | DELETING
  4. | CREATING
type stream_summary = {
  1. stream_creation_timestamp : float option;
  2. stream_mode_details : stream_mode_details option;
  3. stream_status : stream_status;
  4. stream_ar_n : string;
  5. stream_name : string;
}
type metrics_name =
  1. | ALL
  2. | ITERATOR_AGE_MILLISECONDS
  3. | READ_PROVISIONED_THROUGHPUT_EXCEEDED
  4. | WRITE_PROVISIONED_THROUGHPUT_EXCEEDED
  5. | OUTGOING_RECORDS
  6. | OUTGOING_BYTES
  7. | INCOMING_RECORDS
  8. | INCOMING_BYTES
type enhanced_metrics = {
  1. shard_level_metrics : metrics_name list option;
}
type stream_description_summary = {
  1. consumer_count : int option;
  2. open_shard_count : int;
  3. key_id : string option;
  4. encryption_type : encryption_type option;
  5. enhanced_monitoring : enhanced_metrics list;
  6. stream_creation_timestamp : float;
  7. retention_period_hours : int;
  8. stream_mode_details : stream_mode_details option;
  9. stream_status : stream_status;
  10. stream_ar_n : string;
  11. stream_name : string;
}
type sequence_number_range = {
  1. ending_sequence_number : string option;
  2. starting_sequence_number : string;
}
type shard = {
  1. sequence_number_range : sequence_number_range;
  2. hash_key_range : hash_key_range;
  3. adjacent_parent_shard_id : string option;
  4. parent_shard_id : string option;
  5. shard_id : string;
}
type stream_description = {
  1. key_id : string option;
  2. encryption_type : encryption_type option;
  3. enhanced_monitoring : enhanced_metrics list;
  4. stream_creation_timestamp : float;
  5. retention_period_hours : int;
  6. has_more_shards : bool;
  7. shards : shard list;
  8. stream_mode_details : stream_mode_details option;
  9. stream_status : stream_status;
  10. stream_ar_n : string;
  11. stream_name : string;
}
type stop_stream_encryption_input = {
  1. stream_ar_n : string option;
  2. key_id : string;
  3. encryption_type : encryption_type;
  4. stream_name : string option;
}
type start_stream_encryption_input = {
  1. stream_ar_n : string option;
  2. key_id : string;
  3. encryption_type : encryption_type;
  4. stream_name : string option;
}
type split_shard_input = {
  1. stream_ar_n : string option;
  2. new_starting_hash_key : string;
  3. shard_to_split : string;
  4. stream_name : string option;
}
type shard_filter_type =
  1. | FROM_TIMESTAMP
  2. | AT_TIMESTAMP
  3. | AT_LATEST
  4. | FROM_TRIM_HORIZON
  5. | AT_TRIM_HORIZON
  6. | AFTER_SHARD_ID
type shard_filter = {
  1. timestamp_ : float option;
  2. shard_id : string option;
  3. type_ : shard_filter_type;
}
type remove_tags_from_stream_input = {
  1. stream_ar_n : string option;
  2. tag_keys : string list;
  3. stream_name : string option;
}
type consumer_status =
  1. | ACTIVE
  2. | DELETING
  3. | CREATING
type consumer = {
  1. consumer_creation_timestamp : float;
  2. consumer_status : consumer_status;
  3. consumer_ar_n : string;
  4. consumer_name : string;
}
type register_stream_consumer_output = {
  1. consumer : consumer;
}
type register_stream_consumer_input = {
  1. consumer_name : string;
  2. stream_ar_n : string;
}
type put_resource_policy_input = {
  1. policy : string;
  2. resource_ar_n : string;
}
type put_records_result_entry = {
  1. error_message : string option;
  2. error_code : string option;
  3. shard_id : string option;
  4. sequence_number : string option;
}
type put_records_request_entry = {
  1. partition_key : string;
  2. explicit_hash_key : string option;
  3. data : bytes;
}
type put_records_output = {
  1. encryption_type : encryption_type option;
  2. records : put_records_result_entry list;
  3. failed_record_count : int option;
}
type put_records_input = {
  1. stream_ar_n : string option;
  2. stream_name : string option;
  3. records : put_records_request_entry list;
}
type provisioned_throughput_exceeded_exception = {
  1. message : string option;
}
type put_record_output = {
  1. encryption_type : encryption_type option;
  2. sequence_number : string;
  3. shard_id : string;
}
type put_record_input = {
  1. stream_ar_n : string option;
  2. sequence_number_for_ordering : string option;
  3. explicit_hash_key : string option;
  4. partition_key : string;
  5. data : bytes;
  6. stream_name : string option;
}
type merge_shards_input = {
  1. stream_ar_n : string option;
  2. adjacent_shard_to_merge : string;
  3. shard_to_merge : string;
  4. stream_name : string option;
}
type list_tags_for_stream_output = {
  1. has_more_tags : bool;
  2. tags : tag list;
}
type list_tags_for_stream_input = {
  1. stream_ar_n : string option;
  2. limit : int option;
  3. exclusive_start_tag_key : string option;
  4. stream_name : string option;
}
type list_streams_output = {
  1. stream_summaries : stream_summary list option;
  2. next_token : string option;
  3. has_more_streams : bool;
  4. stream_names : string list;
}
type list_streams_input = {
  1. next_token : string option;
  2. exclusive_start_stream_name : string option;
  3. limit : int option;
}
type expired_next_token_exception = {
  1. message : string option;
}
type list_stream_consumers_output = {
  1. next_token : string option;
  2. consumers : consumer list option;
}
type list_stream_consumers_input = {
  1. stream_creation_timestamp : float option;
  2. max_results : int option;
  3. next_token : string option;
  4. stream_ar_n : string;
}
type list_shards_output = {
  1. next_token : string option;
  2. shards : shard list option;
}
type list_shards_input = {
  1. stream_ar_n : string option;
  2. shard_filter : shard_filter option;
  3. stream_creation_timestamp : float option;
  4. max_results : int option;
  5. exclusive_start_shard_id : string option;
  6. next_token : string option;
  7. stream_name : string option;
}
type increase_stream_retention_period_input = {
  1. stream_ar_n : string option;
  2. retention_period_hours : int;
  3. stream_name : string option;
}
type get_shard_iterator_output = {
  1. shard_iterator : string option;
}
type get_shard_iterator_input = {
  1. stream_ar_n : string option;
  2. timestamp_ : float option;
  3. starting_sequence_number : string option;
  4. shard_iterator_type : shard_iterator_type;
  5. shard_id : string;
  6. stream_name : string option;
}
type get_resource_policy_output = {
  1. policy : string;
}
type get_resource_policy_input = {
  1. resource_ar_n : string;
}
type expired_iterator_exception = {
  1. message : string option;
}
type get_records_output = {
  1. child_shards : child_shard list option;
  2. millis_behind_latest : int option;
  3. next_shard_iterator : string option;
  4. records : record list;
}
type get_records_input = {
  1. stream_ar_n : string option;
  2. limit : int option;
  3. shard_iterator : string;
}
type enhanced_monitoring_output = {
  1. stream_ar_n : string option;
  2. desired_shard_level_metrics : metrics_name list option;
  3. current_shard_level_metrics : metrics_name list option;
  4. stream_name : string option;
}
type enable_enhanced_monitoring_input = {
  1. stream_ar_n : string option;
  2. shard_level_metrics : metrics_name list;
  3. stream_name : string option;
}
type disable_enhanced_monitoring_input = {
  1. stream_ar_n : string option;
  2. shard_level_metrics : metrics_name list;
  3. stream_name : string option;
}
type describe_stream_summary_output = {
  1. stream_description_summary : stream_description_summary;
}
type describe_stream_summary_input = {
  1. stream_ar_n : string option;
  2. stream_name : string option;
}
type consumer_description = {
  1. stream_ar_n : string;
  2. consumer_creation_timestamp : float;
  3. consumer_status : consumer_status;
  4. consumer_ar_n : string;
  5. consumer_name : string;
}
type describe_stream_consumer_output = {
  1. consumer_description : consumer_description;
}
type describe_stream_consumer_input = {
  1. consumer_ar_n : string option;
  2. consumer_name : string option;
  3. stream_ar_n : string option;
}
type describe_stream_output = {
  1. stream_description : stream_description;
}
type describe_stream_input = {
  1. stream_ar_n : string option;
  2. exclusive_start_shard_id : string option;
  3. limit : int option;
  4. stream_name : string option;
}
type describe_limits_output = {
  1. on_demand_stream_count_limit : int;
  2. on_demand_stream_count : int;
  3. open_shard_count : int;
  4. shard_limit : int;
}
type describe_limits_input = unit
type deregister_stream_consumer_input = {
  1. consumer_ar_n : string option;
  2. consumer_name : string option;
  3. stream_ar_n : string option;
}
type delete_stream_input = {
  1. stream_ar_n : string option;
  2. enforce_consumer_deletion : bool option;
  3. stream_name : string option;
}
type delete_resource_policy_input = {
  1. resource_ar_n : string;
}
type decrease_stream_retention_period_input = {
  1. stream_ar_n : string option;
  2. retention_period_hours : int;
  3. stream_name : string option;
}
type create_stream_input = {
  1. stream_mode_details : stream_mode_details option;
  2. shard_count : int option;
  3. stream_name : string;
}
type add_tags_to_stream_input = {
  1. stream_ar_n : string option;
  2. tags : (string * string) list;
  3. stream_name : string option;
}
type base_document = Smaws_Lib.Json.t
val make_stream_mode_details : stream_mode:stream_mode -> unit -> stream_mode_details
val make_update_stream_mode_input : stream_mode_details:stream_mode_details -> stream_ar_n:string -> unit -> update_stream_mode_input
val make_update_shard_count_output : ?stream_ar_n:string -> ?target_shard_count:int -> ?current_shard_count:int -> ?stream_name:string -> unit -> update_shard_count_output
val make_update_shard_count_input : ?stream_ar_n:string -> ?stream_name:string -> scaling_type:scaling_type -> target_shard_count:int -> unit -> update_shard_count_input
val make_tag : ?value:string -> key:string -> unit -> tag
val make_record : ?encryption_type:encryption_type -> ?approximate_arrival_timestamp:float -> partition_key:string -> data:bytes -> sequence_number:string -> unit -> record
val make_hash_key_range : ending_hash_key:string -> starting_hash_key:string -> unit -> hash_key_range
val make_child_shard : hash_key_range:hash_key_range -> parent_shards:string list -> shard_id:string -> unit -> child_shard
val make_subscribe_to_shard_event : ?child_shards:child_shard list -> millis_behind_latest:int -> continuation_sequence_number:string -> records:record list -> unit -> subscribe_to_shard_event
val make_subscribe_to_shard_output : event_stream:subscribe_to_shard_event_stream -> unit -> subscribe_to_shard_output
val make_starting_position : ?timestamp_:float -> ?sequence_number:string -> type_:shard_iterator_type -> unit -> starting_position
val make_subscribe_to_shard_input : starting_position:starting_position -> shard_id:string -> consumer_ar_n:string -> unit -> subscribe_to_shard_input
val make_stream_summary : ?stream_creation_timestamp:float -> ?stream_mode_details:stream_mode_details -> stream_status:stream_status -> stream_ar_n:string -> stream_name:string -> unit -> stream_summary
val make_enhanced_metrics : ?shard_level_metrics:metrics_name list -> unit -> enhanced_metrics
val make_stream_description_summary : ?consumer_count:int -> ?key_id:string -> ?encryption_type:encryption_type -> ?stream_mode_details:stream_mode_details -> 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 -> unit -> stream_description_summary
val make_sequence_number_range : ?ending_sequence_number:string -> starting_sequence_number:string -> unit -> sequence_number_range
val make_shard : ?adjacent_parent_shard_id:string -> ?parent_shard_id:string -> sequence_number_range:sequence_number_range -> hash_key_range:hash_key_range -> shard_id:string -> unit -> shard
val make_stream_description : ?key_id:string -> ?encryption_type:encryption_type -> ?stream_mode_details:stream_mode_details -> 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 -> unit -> stream_description
val make_stop_stream_encryption_input : ?stream_ar_n:string -> ?stream_name:string -> key_id:string -> encryption_type:encryption_type -> unit -> stop_stream_encryption_input
val make_start_stream_encryption_input : ?stream_ar_n:string -> ?stream_name:string -> key_id:string -> encryption_type:encryption_type -> unit -> start_stream_encryption_input
val make_split_shard_input : ?stream_ar_n:string -> ?stream_name:string -> new_starting_hash_key:string -> shard_to_split:string -> unit -> split_shard_input
val make_shard_filter : ?timestamp_:float -> ?shard_id:string -> type_:shard_filter_type -> unit -> shard_filter
val make_remove_tags_from_stream_input : ?stream_ar_n:string -> ?stream_name:string -> tag_keys:string list -> unit -> remove_tags_from_stream_input
val make_consumer : consumer_creation_timestamp:float -> consumer_status:consumer_status -> consumer_ar_n:string -> consumer_name:string -> unit -> consumer
val make_register_stream_consumer_output : consumer:consumer -> unit -> register_stream_consumer_output
val make_register_stream_consumer_input : consumer_name:string -> stream_ar_n:string -> unit -> register_stream_consumer_input
val make_put_resource_policy_input : policy:string -> resource_ar_n:string -> unit -> put_resource_policy_input
val make_put_records_result_entry : ?error_message:string -> ?error_code:string -> ?shard_id:string -> ?sequence_number:string -> unit -> put_records_result_entry
val make_put_records_request_entry : ?explicit_hash_key:string -> partition_key:string -> data:bytes -> unit -> put_records_request_entry
val make_put_records_output : ?encryption_type:encryption_type -> ?failed_record_count:int -> records:put_records_result_entry list -> unit -> put_records_output
val make_put_records_input : ?stream_ar_n:string -> ?stream_name:string -> records:put_records_request_entry list -> unit -> put_records_input
val make_put_record_output : ?encryption_type:encryption_type -> sequence_number:string -> shard_id:string -> unit -> put_record_output
val make_put_record_input : ?stream_ar_n:string -> ?sequence_number_for_ordering:string -> ?explicit_hash_key:string -> ?stream_name:string -> partition_key:string -> data:bytes -> unit -> put_record_input
val make_merge_shards_input : ?stream_ar_n:string -> ?stream_name:string -> adjacent_shard_to_merge:string -> shard_to_merge:string -> unit -> merge_shards_input
val make_list_tags_for_stream_output : has_more_tags:bool -> tags:tag list -> unit -> list_tags_for_stream_output
val make_list_tags_for_stream_input : ?stream_ar_n:string -> ?limit:int -> ?exclusive_start_tag_key:string -> ?stream_name:string -> unit -> list_tags_for_stream_input
val make_list_streams_output : ?stream_summaries:stream_summary list -> ?next_token:string -> has_more_streams:bool -> stream_names:string list -> unit -> list_streams_output
val make_list_streams_input : ?next_token:string -> ?exclusive_start_stream_name:string -> ?limit:int -> unit -> list_streams_input
val make_list_stream_consumers_output : ?next_token:string -> ?consumers:consumer list -> unit -> list_stream_consumers_output
val make_list_stream_consumers_input : ?stream_creation_timestamp:float -> ?max_results:int -> ?next_token:string -> stream_ar_n:string -> unit -> list_stream_consumers_input
val make_list_shards_output : ?next_token:string -> ?shards:shard list -> unit -> list_shards_output
val make_list_shards_input : ?stream_ar_n:string -> ?shard_filter:shard_filter -> ?stream_creation_timestamp:float -> ?max_results:int -> ?exclusive_start_shard_id:string -> ?next_token:string -> ?stream_name:string -> unit -> list_shards_input
val make_increase_stream_retention_period_input : ?stream_ar_n:string -> ?stream_name:string -> retention_period_hours:int -> unit -> increase_stream_retention_period_input
val make_get_shard_iterator_output : ?shard_iterator:string -> unit -> get_shard_iterator_output
val make_get_shard_iterator_input : ?stream_ar_n:string -> ?timestamp_:float -> ?starting_sequence_number:string -> ?stream_name:string -> shard_iterator_type:shard_iterator_type -> shard_id:string -> unit -> get_shard_iterator_input
val make_get_resource_policy_output : policy:string -> unit -> get_resource_policy_output
val make_get_resource_policy_input : resource_ar_n:string -> unit -> get_resource_policy_input
val make_get_records_output : ?child_shards:child_shard list -> ?millis_behind_latest:int -> ?next_shard_iterator:string -> records:record list -> unit -> get_records_output
val make_get_records_input : ?stream_ar_n:string -> ?limit:int -> shard_iterator:string -> unit -> get_records_input
val make_enhanced_monitoring_output : ?stream_ar_n:string -> ?desired_shard_level_metrics:metrics_name list -> ?current_shard_level_metrics:metrics_name list -> ?stream_name:string -> unit -> enhanced_monitoring_output
val make_enable_enhanced_monitoring_input : ?stream_ar_n:string -> ?stream_name:string -> shard_level_metrics:metrics_name list -> unit -> enable_enhanced_monitoring_input
val make_disable_enhanced_monitoring_input : ?stream_ar_n:string -> ?stream_name:string -> shard_level_metrics:metrics_name list -> unit -> disable_enhanced_monitoring_input
val make_describe_stream_summary_output : stream_description_summary:stream_description_summary -> unit -> describe_stream_summary_output
val make_describe_stream_summary_input : ?stream_ar_n:string -> ?stream_name:string -> unit -> describe_stream_summary_input
val make_consumer_description : stream_ar_n:string -> consumer_creation_timestamp:float -> consumer_status:consumer_status -> consumer_ar_n:string -> consumer_name:string -> unit -> consumer_description
val make_describe_stream_consumer_output : consumer_description:consumer_description -> unit -> describe_stream_consumer_output
val make_describe_stream_consumer_input : ?consumer_ar_n:string -> ?consumer_name:string -> ?stream_ar_n:string -> unit -> describe_stream_consumer_input
val make_describe_stream_output : stream_description:stream_description -> unit -> describe_stream_output
val make_describe_stream_input : ?stream_ar_n:string -> ?exclusive_start_shard_id:string -> ?limit:int -> ?stream_name:string -> unit -> describe_stream_input
val make_describe_limits_output : on_demand_stream_count_limit:int -> on_demand_stream_count:int -> open_shard_count:int -> shard_limit:int -> unit -> describe_limits_output
val make_describe_limits_input : unit -> describe_limits_input
val make_deregister_stream_consumer_input : ?consumer_ar_n:string -> ?consumer_name:string -> ?stream_ar_n:string -> unit -> deregister_stream_consumer_input
val make_delete_stream_input : ?stream_ar_n:string -> ?enforce_consumer_deletion:bool -> ?stream_name:string -> unit -> delete_stream_input
val make_delete_resource_policy_input : resource_ar_n:string -> unit -> delete_resource_policy_input
val make_decrease_stream_retention_period_input : ?stream_ar_n:string -> ?stream_name:string -> retention_period_hours:int -> unit -> decrease_stream_retention_period_input
val make_create_stream_input : ?stream_mode_details:stream_mode_details -> ?shard_count:int -> stream_name:string -> unit -> create_stream_input
val make_add_tags_to_stream_input : ?stream_ar_n:string -> ?stream_name:string -> tags:(string * string) list -> unit -> add_tags_to_stream_input
module UpdateStreamMode : sig ... end
module UpdateShardCount : sig ... end
module SubscribeToShard : sig ... end
module StopStreamEncryption : sig ... end
module StartStreamEncryption : sig ... end
module SplitShard : sig ... end
module RemoveTagsFromStream : sig ... end
module RegisterStreamConsumer : sig ... end
module PutResourcePolicy : sig ... end
module PutRecords : sig ... end
module PutRecord : sig ... end
module MergeShards : sig ... end
module ListTagsForStream : sig ... end
module ListStreams : sig ... end
module ListStreamConsumers : sig ... end
module ListShards : sig ... end
module IncreaseStreamRetentionPeriod : sig ... end
module GetShardIterator : sig ... end
module GetResourcePolicy : sig ... end
module GetRecords : sig ... end
module EnableEnhancedMonitoring : sig ... end
module DisableEnhancedMonitoring : sig ... end
module DescribeStreamSummary : sig ... end
module DescribeStreamConsumer : sig ... end
module DescribeStream : sig ... end
module DescribeLimits : sig ... end
module DeregisterStreamConsumer : sig ... end
module DeleteStream : sig ... end
module DeleteResourcePolicy : sig ... end
module DecreaseStreamRetentionPeriod : sig ... end
module CreateStream : sig ... end
module AddTagsToStream : sig ... end
OCaml

Innovation. Community. Security.