package smaws-clients

  1. Overview
  2. Docs
package smaws-clients
Legend:
Library
Module
Module type
Parameter
Class
Class type
type untag_queue_request = {
  1. tag_keys : string list;
  2. queue_url : string;
}
type unsupported_operation = {
  1. message : string option;
}
type request_throttled = {
  1. message : string option;
}
type queue_does_not_exist = {
  1. message : string option;
}
type invalid_security = {
  1. message : string option;
}
type invalid_address = {
  1. message : string option;
}
type too_many_entries_in_batch_request = {
  1. message : string option;
}
type tag_queue_request = {
  1. tags : (string * string) list;
  2. queue_url : string;
}
type start_message_move_task_result = {
  1. task_handle : string option;
}
type start_message_move_task_request = {
  1. max_number_of_messages_per_second : int option;
  2. destination_arn : string option;
  3. source_arn : string;
}
type resource_not_found_exception = {
  1. message : string option;
}
type queue_attribute_name =
  1. | SqsManagedSseEnabled
  2. | RedriveAllowPolicy
  3. | FifoThroughputLimit
  4. | DeduplicationScope
  5. | KmsDataKeyReusePeriodSeconds
  6. | KmsMasterKeyId
  7. | ContentBasedDeduplication
  8. | FifoQueue
  9. | RedrivePolicy
  10. | ReceiveMessageWaitTimeSeconds
  11. | DelaySeconds
  12. | ApproximateNumberOfMessagesDelayed
  13. | QueueArn
  14. | LastModifiedTimestamp
  15. | CreatedTimestamp
  16. | ApproximateNumberOfMessagesNotVisible
  17. | ApproximateNumberOfMessages
  18. | MessageRetentionPeriod
  19. | MaximumMessageSize
  20. | VisibilityTimeout
  21. | Policy
  22. | All
type set_queue_attributes_request = {
  1. attributes : (string * string) list;
  2. queue_url : string;
}
type over_limit = {
  1. message : string option;
}
type invalid_attribute_value = {
  1. message : string option;
}
type invalid_attribute_name = {
  1. message : string option;
}
type send_message_result = {
  1. sequence_number : string option;
  2. message_id : string option;
  3. md5_of_message_system_attributes : string option;
  4. md5_of_message_attributes : string option;
  5. md5_of_message_body : string option;
}
type message_attribute_value = {
  1. data_type : string;
  2. binary_list_values : bytes list option;
  3. string_list_values : string list option;
  4. binary_value : bytes option;
  5. string_value : string option;
}
type message_system_attribute_value = {
  1. data_type : string;
  2. binary_list_values : bytes list option;
  3. string_list_values : string list option;
  4. binary_value : bytes option;
  5. string_value : string option;
}
type message_system_attribute_name_for_sends =
  1. | AWSTraceHeader
type send_message_request = {
  1. message_group_id : string option;
  2. message_deduplication_id : string option;
  3. message_system_attributes : (string * message_system_attribute_value) list option;
  4. message_attributes : (string * message_attribute_value) list option;
  5. delay_seconds : int option;
  6. message_body : string;
  7. queue_url : string;
}
type send_message_batch_result_entry = {
  1. sequence_number : string option;
  2. md5_of_message_system_attributes : string option;
  3. md5_of_message_attributes : string option;
  4. md5_of_message_body : string;
  5. message_id : string;
  6. id : string;
}
type batch_result_error_entry = {
  1. message : string option;
  2. code : string;
  3. sender_fault : bool;
  4. id : string;
}
type send_message_batch_result = {
  1. failed : batch_result_error_entry list;
  2. successful : send_message_batch_result_entry list;
}
type send_message_batch_request_entry = {
  1. message_group_id : string option;
  2. message_deduplication_id : string option;
  3. message_system_attributes : (string * message_system_attribute_value) list option;
  4. message_attributes : (string * message_attribute_value) list option;
  5. delay_seconds : int option;
  6. message_body : string;
  7. id : string;
}
type send_message_batch_request = {
  1. entries : send_message_batch_request_entry list;
  2. queue_url : string;
}
type kms_throttled = {
  1. message : string option;
}
type kms_opt_in_required = {
  1. message : string option;
}
type kms_not_found = {
  1. message : string option;
}
type kms_invalid_state = {
  1. message : string option;
}
type kms_invalid_key_usage = {
  1. message : string option;
}
type kms_disabled = {
  1. message : string option;
}
type kms_access_denied = {
  1. message : string option;
}
type invalid_batch_entry_id = {
  1. message : string option;
}
type empty_batch_request = {
  1. message : string option;
}
type batch_request_too_long = {
  1. message : string option;
}
type batch_entry_ids_not_distinct = {
  1. message : string option;
}
type invalid_message_contents = {
  1. message : string option;
}
type remove_permission_request = {
  1. label : string;
  2. queue_url : string;
}
type message_system_attribute_name =
  1. | DeadLetterQueueSourceArn
  2. | AWSTraceHeader
  3. | MessageGroupId
  4. | MessageDeduplicationId
  5. | SequenceNumber
  6. | ApproximateFirstReceiveTimestamp
  7. | ApproximateReceiveCount
  8. | SentTimestamp
  9. | SenderId
  10. | All
type message = {
  1. message_attributes : (string * message_attribute_value) list option;
  2. md5_of_message_attributes : string option;
  3. attributes : (string * string) list option;
  4. body : string option;
  5. md5_of_body : string option;
  6. receipt_handle : string option;
  7. message_id : string option;
}
type receive_message_result = {
  1. messages : message list option;
}
type receive_message_request = {
  1. receive_request_attempt_id : string option;
  2. wait_time_seconds : int option;
  3. visibility_timeout : int option;
  4. max_number_of_messages : int option;
  5. message_attribute_names : string list option;
  6. message_system_attribute_names : message_system_attribute_name list option;
  7. attribute_names : queue_attribute_name list option;
  8. queue_url : string;
}
type receipt_handle_is_invalid = {
  1. message : string option;
}
type queue_name_exists = {
  1. message : string option;
}
type queue_deleted_recently = {
  1. message : string option;
}
type purge_queue_request = {
  1. queue_url : string;
}
type purge_queue_in_progress = {
  1. message : string option;
}
type message_not_inflight = unit
type list_queues_result = {
  1. next_token : string option;
  2. queue_urls : string list option;
}
type list_queues_request = {
  1. max_results : int option;
  2. next_token : string option;
  3. queue_name_prefix : string option;
}
type list_queue_tags_result = {
  1. tags : (string * string) list option;
}
type list_queue_tags_request = {
  1. queue_url : string;
}
type list_message_move_tasks_result_entry = {
  1. started_timestamp : int option;
  2. failure_reason : string option;
  3. approximate_number_of_messages_to_move : int option;
  4. approximate_number_of_messages_moved : int option;
  5. max_number_of_messages_per_second : int option;
  6. destination_arn : string option;
  7. source_arn : string option;
  8. status : string option;
  9. task_handle : string option;
}
type list_message_move_tasks_result = {
  1. results : list_message_move_tasks_result_entry list option;
}
type list_message_move_tasks_request = {
  1. max_results : int option;
  2. source_arn : string;
}
type list_dead_letter_source_queues_result = {
  1. next_token : string option;
  2. queue_urls : string list;
}
type list_dead_letter_source_queues_request = {
  1. max_results : int option;
  2. next_token : string option;
  3. queue_url : string;
}
type invalid_id_format = unit
type get_queue_url_result = {
  1. queue_url : string option;
}
type get_queue_url_request = {
  1. queue_owner_aws_account_id : string option;
  2. queue_name : string;
}
type get_queue_attributes_result = {
  1. attributes : (string * string) list option;
}
type get_queue_attributes_request = {
  1. attribute_names : queue_attribute_name list option;
  2. queue_url : string;
}
type delete_queue_request = {
  1. queue_url : string;
}
type delete_message_request = {
  1. receipt_handle : string;
  2. queue_url : string;
}
type delete_message_batch_result_entry = {
  1. id : string;
}
type delete_message_batch_result = {
  1. failed : batch_result_error_entry list;
  2. successful : delete_message_batch_result_entry list;
}
type delete_message_batch_request_entry = {
  1. receipt_handle : string;
  2. id : string;
}
type delete_message_batch_request = {
  1. entries : delete_message_batch_request_entry list;
  2. queue_url : string;
}
type create_queue_result = {
  1. queue_url : string option;
}
type create_queue_request = {
  1. tags : (string * string) list option;
  2. attributes : (string * string) list option;
  3. queue_name : string;
}
type change_message_visibility_request = {
  1. visibility_timeout : int;
  2. receipt_handle : string;
  3. queue_url : string;
}
type change_message_visibility_batch_result_entry = {
  1. id : string;
}
type change_message_visibility_batch_result = {
  1. failed : batch_result_error_entry list;
  2. successful : change_message_visibility_batch_result_entry list;
}
type change_message_visibility_batch_request_entry = {
  1. visibility_timeout : int option;
  2. receipt_handle : string;
  3. id : string;
}
type change_message_visibility_batch_request = {
  1. entries : change_message_visibility_batch_request_entry list;
  2. queue_url : string;
}
type cancel_message_move_task_result = {
  1. approximate_number_of_messages_moved : int option;
}
type cancel_message_move_task_request = {
  1. task_handle : string;
}
type add_permission_request = {
  1. actions : string list;
  2. aws_account_ids : string list;
  3. label : string;
  4. queue_url : string;
}
type base_document = Smaws_Lib.Json.t
val make_untag_queue_request : tag_keys:string list -> queue_url:string -> unit -> untag_queue_request
val make_tag_queue_request : tags:(string * string) list -> queue_url:string -> unit -> tag_queue_request
val make_start_message_move_task_result : ?task_handle:string -> unit -> start_message_move_task_result
val make_start_message_move_task_request : ?max_number_of_messages_per_second:int -> ?destination_arn:string -> source_arn:string -> unit -> start_message_move_task_request
val make_set_queue_attributes_request : attributes:(string * string) list -> queue_url:string -> unit -> set_queue_attributes_request
val make_send_message_result : ?sequence_number:string -> ?message_id:string -> ?md5_of_message_system_attributes:string -> ?md5_of_message_attributes:string -> ?md5_of_message_body:string -> unit -> send_message_result
val make_message_attribute_value : ?binary_list_values:bytes list -> ?string_list_values:string list -> ?binary_value:bytes -> ?string_value:string -> data_type:string -> unit -> message_attribute_value
val make_message_system_attribute_value : ?binary_list_values:bytes list -> ?string_list_values:string list -> ?binary_value:bytes -> ?string_value:string -> data_type:string -> unit -> message_system_attribute_value
val make_send_message_request : ?message_group_id:string -> ?message_deduplication_id:string -> ?message_system_attributes:(string * message_system_attribute_value) list -> ?message_attributes:(string * message_attribute_value) list -> ?delay_seconds:int -> message_body:string -> queue_url:string -> unit -> send_message_request
val make_send_message_batch_result_entry : ?sequence_number:string -> ?md5_of_message_system_attributes:string -> ?md5_of_message_attributes:string -> md5_of_message_body:string -> message_id:string -> id:string -> unit -> send_message_batch_result_entry
val make_batch_result_error_entry : ?message:string -> code:string -> sender_fault:bool -> id:string -> unit -> batch_result_error_entry
val make_send_message_batch_result : failed:batch_result_error_entry list -> successful:send_message_batch_result_entry list -> unit -> send_message_batch_result
val make_send_message_batch_request_entry : ?message_group_id:string -> ?message_deduplication_id:string -> ?message_system_attributes:(string * message_system_attribute_value) list -> ?message_attributes:(string * message_attribute_value) list -> ?delay_seconds:int -> message_body:string -> id:string -> unit -> send_message_batch_request_entry
val make_send_message_batch_request : entries:send_message_batch_request_entry list -> queue_url:string -> unit -> send_message_batch_request
val make_remove_permission_request : label:string -> queue_url:string -> unit -> remove_permission_request
val make_message : ?message_attributes:(string * message_attribute_value) list -> ?md5_of_message_attributes:string -> ?attributes:(string * string) list -> ?body:string -> ?md5_of_body:string -> ?receipt_handle:string -> ?message_id:string -> unit -> message
val make_receive_message_result : ?messages:message list -> unit -> receive_message_result
val make_receive_message_request : ?receive_request_attempt_id:string -> ?wait_time_seconds:int -> ?visibility_timeout:int -> ?max_number_of_messages:int -> ?message_attribute_names:string list -> ?message_system_attribute_names:message_system_attribute_name list -> ?attribute_names:queue_attribute_name list -> queue_url:string -> unit -> receive_message_request
val make_purge_queue_request : queue_url:string -> unit -> purge_queue_request
val make_list_queues_result : ?next_token:string -> ?queue_urls:string list -> unit -> list_queues_result
val make_list_queues_request : ?max_results:int -> ?next_token:string -> ?queue_name_prefix:string -> unit -> list_queues_request
val make_list_queue_tags_result : ?tags:(string * string) list -> unit -> list_queue_tags_result
val make_list_queue_tags_request : queue_url:string -> unit -> list_queue_tags_request
val make_list_message_move_tasks_result_entry : ?started_timestamp:int -> ?failure_reason:string -> ?approximate_number_of_messages_to_move:int -> ?approximate_number_of_messages_moved:int -> ?max_number_of_messages_per_second:int -> ?destination_arn:string -> ?source_arn:string -> ?status:string -> ?task_handle:string -> unit -> list_message_move_tasks_result_entry
val make_list_message_move_tasks_result : ?results:list_message_move_tasks_result_entry list -> unit -> list_message_move_tasks_result
val make_list_message_move_tasks_request : ?max_results:int -> source_arn:string -> unit -> list_message_move_tasks_request
val make_list_dead_letter_source_queues_result : ?next_token:string -> queue_urls:string list -> unit -> list_dead_letter_source_queues_result
val make_list_dead_letter_source_queues_request : ?max_results:int -> ?next_token:string -> queue_url:string -> unit -> list_dead_letter_source_queues_request
val make_get_queue_url_result : ?queue_url:string -> unit -> get_queue_url_result
val make_get_queue_url_request : ?queue_owner_aws_account_id:string -> queue_name:string -> unit -> get_queue_url_request
val make_get_queue_attributes_result : ?attributes:(string * string) list -> unit -> get_queue_attributes_result
val make_get_queue_attributes_request : ?attribute_names:queue_attribute_name list -> queue_url:string -> unit -> get_queue_attributes_request
val make_delete_queue_request : queue_url:string -> unit -> delete_queue_request
val make_delete_message_request : receipt_handle:string -> queue_url:string -> unit -> delete_message_request
val make_delete_message_batch_result_entry : id:string -> unit -> delete_message_batch_result_entry
val make_delete_message_batch_result : failed:batch_result_error_entry list -> successful:delete_message_batch_result_entry list -> unit -> delete_message_batch_result
val make_delete_message_batch_request_entry : receipt_handle:string -> id:string -> unit -> delete_message_batch_request_entry
val make_delete_message_batch_request : entries:delete_message_batch_request_entry list -> queue_url:string -> unit -> delete_message_batch_request
val make_create_queue_result : ?queue_url:string -> unit -> create_queue_result
val make_create_queue_request : ?tags:(string * string) list -> ?attributes:(string * string) list -> queue_name:string -> unit -> create_queue_request
val make_change_message_visibility_request : visibility_timeout:int -> receipt_handle:string -> queue_url:string -> unit -> change_message_visibility_request
val make_change_message_visibility_batch_result_entry : id:string -> unit -> change_message_visibility_batch_result_entry
val make_change_message_visibility_batch_result : failed:batch_result_error_entry list -> successful:change_message_visibility_batch_result_entry list -> unit -> change_message_visibility_batch_result
val make_change_message_visibility_batch_request_entry : ?visibility_timeout:int -> receipt_handle:string -> id:string -> unit -> change_message_visibility_batch_request_entry
val make_change_message_visibility_batch_request : entries:change_message_visibility_batch_request_entry list -> queue_url:string -> unit -> change_message_visibility_batch_request
val make_cancel_message_move_task_result : ?approximate_number_of_messages_moved:int -> unit -> cancel_message_move_task_result
val make_cancel_message_move_task_request : task_handle:string -> unit -> cancel_message_move_task_request
val make_add_permission_request : actions:string list -> aws_account_ids:string list -> label:string -> queue_url:string -> unit -> add_permission_request
module UntagQueue : sig ... end
module TagQueue : sig ... end
module StartMessageMoveTask : sig ... end
module SetQueueAttributes : sig ... end
module SendMessageBatch : sig ... end
module SendMessage : sig ... end
module RemovePermission : sig ... end
module ReceiveMessage : sig ... end
module PurgeQueue : sig ... end
module ListQueues : sig ... end
module ListQueueTags : sig ... end
module ListMessageMoveTasks : sig ... end
module ListDeadLetterSourceQueues : sig ... end
module GetQueueUrl : sig ... end
module GetQueueAttributes : sig ... end
module DeleteQueue : sig ... end
module DeleteMessageBatch : sig ... end
module DeleteMessage : sig ... end
module CreateQueue : sig ... end
module ChangeMessageVisibilityBatch : sig ... end
module ChangeMessageVisibility : sig ... end
module CancelMessageMoveTask : sig ... end
module AddPermission : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct