Smaws_Client_SQS (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_untag_queue_request : 
  tag_keys:Types.tag_key_list ->
  queue_url:Types.string_ ->
  unit ->
  Types.untag_queue_request

val make_tag_queue_request : 
  tags:Types.tag_map ->
  queue_url:Types.string_ ->
  unit ->
  Types.tag_queue_request

val make_start_message_move_task_request : 
  ?max_number_of_messages_per_second:Types.nullable_integer ->
  ?destination_arn:Types.string_ ->
  source_arn:Types.string_ ->
  unit ->
  Types.start_message_move_task_request

val make_set_queue_attributes_request : 
  attributes:Types.queue_attribute_map ->
  queue_url:Types.string_ ->
  unit ->
  Types.set_queue_attributes_request

val make_message_attribute_value : 
  ?binary_list_values:Types.binary_list ->
  ?string_list_values:Types.string_list ->
  ?binary_value:Types.binary ->
  ?string_value:Types.string_ ->
  data_type:Types.string_ ->
  unit ->
  Types.message_attribute_value

val make_message_system_attribute_value : 
  ?binary_list_values:Types.binary_list ->
  ?string_list_values:Types.string_list ->
  ?binary_value:Types.binary ->
  ?string_value:Types.string_ ->
  data_type:Types.string_ ->
  unit ->
  Types.message_system_attribute_value

val make_send_message_request : 
  ?message_group_id:Types.string_ ->
  ?message_deduplication_id:Types.string_ ->
  ?message_system_attributes:Types.message_body_system_attribute_map ->
  ?message_attributes:Types.message_body_attribute_map ->
  ?delay_seconds:Types.nullable_integer ->
  message_body:Types.string_ ->
  queue_url:Types.string_ ->
  unit ->
  Types.send_message_request

val make_send_message_batch_result_entry : 
  ?sequence_number:Types.string_ ->
  ?md5_of_message_system_attributes:Types.string_ ->
  ?md5_of_message_attributes:Types.string_ ->
  md5_of_message_body:Types.string_ ->
  message_id:Types.string_ ->
  id:Types.string_ ->
  unit ->
  Types.send_message_batch_result_entry

val make_batch_result_error_entry : 
  ?message:Types.string_ ->
  code:Types.string_ ->
  sender_fault:Types.boolean_ ->
  id:Types.string_ ->
  unit ->
  Types.batch_result_error_entry

val make_send_message_batch_request_entry : 
  ?message_group_id:Types.string_ ->
  ?message_deduplication_id:Types.string_ ->
  ?message_system_attributes:Types.message_body_system_attribute_map ->
  ?message_attributes:Types.message_body_attribute_map ->
  ?delay_seconds:Types.nullable_integer ->
  message_body:Types.string_ ->
  id:Types.string_ ->
  unit ->
  Types.send_message_batch_request_entry

val make_send_message_batch_request : 
  entries:Types.send_message_batch_request_entry_list ->
  queue_url:Types.string_ ->
  unit ->
  Types.send_message_batch_request

val make_remove_permission_request : 
  label:Types.string_ ->
  queue_url:Types.string_ ->
  unit ->
  Types.remove_permission_request

val make_message : 
  ?message_attributes:Types.message_body_attribute_map ->
  ?md5_of_message_attributes:Types.string_ ->
  ?attributes:Types.message_system_attribute_map ->
  ?body:Types.string_ ->
  ?md5_of_body:Types.string_ ->
  ?receipt_handle:Types.string_ ->
  ?message_id:Types.string_ ->
  unit ->
  Types.message

val make_receive_message_request : 
  ?receive_request_attempt_id:Types.string_ ->
  ?wait_time_seconds:Types.nullable_integer ->
  ?visibility_timeout:Types.nullable_integer ->
  ?max_number_of_messages:Types.nullable_integer ->
  ?message_attribute_names:Types.message_attribute_name_list ->
  ?message_system_attribute_names:Types.message_system_attribute_list ->
  ?attribute_names:Types.attribute_name_list ->
  queue_url:Types.string_ ->
  unit ->
  Types.receive_message_request

val make_purge_queue_request : 
  queue_url:Types.string_ ->
  unit ->
  Types.purge_queue_request

val make_list_queues_request : 
  ?max_results:Types.boxed_integer ->
  ?next_token:Types.token ->
  ?queue_name_prefix:Types.string_ ->
  unit ->
  Types.list_queues_request

val make_list_queue_tags_request : 
  queue_url:Types.string_ ->
  unit ->
  Types.list_queue_tags_request

val make_list_message_move_tasks_result_entry : 
  ?started_timestamp:Types.long ->
  ?failure_reason:Types.string_ ->
  ?approximate_number_of_messages_to_move:Types.nullable_long ->
  ?approximate_number_of_messages_moved:Types.long ->
  ?max_number_of_messages_per_second:Types.nullable_integer ->
  ?destination_arn:Types.string_ ->
  ?source_arn:Types.string_ ->
  ?status:Types.string_ ->
  ?task_handle:Types.string_ ->
  unit ->
  Types.list_message_move_tasks_result_entry

val make_list_message_move_tasks_request : 
  ?max_results:Types.nullable_integer ->
  source_arn:Types.string_ ->
  unit ->
  Types.list_message_move_tasks_request

val make_list_dead_letter_source_queues_request : 
  ?max_results:Types.boxed_integer ->
  ?next_token:Types.token ->
  queue_url:Types.string_ ->
  unit ->
  Types.list_dead_letter_source_queues_request

val make_get_queue_url_request : 
  ?queue_owner_aws_account_id:Types.string_ ->
  queue_name:Types.string_ ->
  unit ->
  Types.get_queue_url_request

val make_get_queue_attributes_request : 
  ?attribute_names:Types.attribute_name_list ->
  queue_url:Types.string_ ->
  unit ->
  Types.get_queue_attributes_request

val make_delete_queue_request : 
  queue_url:Types.string_ ->
  unit ->
  Types.delete_queue_request

val make_delete_message_request : 
  receipt_handle:Types.string_ ->
  queue_url:Types.string_ ->
  unit ->
  Types.delete_message_request

val make_delete_message_batch_result_entry : 
  id:Types.string_ ->
  unit ->
  Types.delete_message_batch_result_entry

val make_delete_message_batch_request_entry : 
  receipt_handle:Types.string_ ->
  id:Types.string_ ->
  unit ->
  Types.delete_message_batch_request_entry

val make_delete_message_batch_request : 
  entries:Types.delete_message_batch_request_entry_list ->
  queue_url:Types.string_ ->
  unit ->
  Types.delete_message_batch_request

val make_create_queue_request : 
  ?tags:Types.tag_map ->
  ?attributes:Types.queue_attribute_map ->
  queue_name:Types.string_ ->
  unit ->
  Types.create_queue_request

val make_change_message_visibility_request : 
  visibility_timeout:Types.nullable_integer ->
  receipt_handle:Types.string_ ->
  queue_url:Types.string_ ->
  unit ->
  Types.change_message_visibility_request

val make_change_message_visibility_batch_result_entry : 
  id:Types.string_ ->
  unit ->
  Types.change_message_visibility_batch_result_entry

val make_change_message_visibility_batch_request_entry : 
  ?visibility_timeout:Types.nullable_integer ->
  receipt_handle:Types.string_ ->
  id:Types.string_ ->
  unit ->
  Types.change_message_visibility_batch_request_entry

val make_change_message_visibility_batch_request : 
  entries:Types.change_message_visibility_batch_request_entry_list ->
  queue_url:Types.string_ ->
  unit ->
  Types.change_message_visibility_batch_request

val make_cancel_message_move_task_request : 
  task_handle:Types.string_ ->
  unit ->
  Types.cancel_message_move_task_request

val make_add_permission_request : 
  actions:Types.action_name_list ->
  aws_account_ids:Types.aws_account_id_list ->
  label:Types.string_ ->
  queue_url:Types.string_ ->
  unit ->
  Types.add_permission_request

Operations

module AddPermission : sig ... end

Adds a permission to a queue for a specific principal. This allows sharing access to the queue.

module CancelMessageMoveTask : sig ... end

Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.

module ChangeMessageVisibility : sig ... end

Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

module ChangeMessageVisibilityBatch : sig ... end

Changes the visibility timeout of multiple messages. This is a batch version of

module CreateQueue : sig ... end

Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:

module DeleteMessage : sig ... end

Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.

module DeleteMessageBatch : sig ... end

Deletes up to ten messages from the specified queue. This is a batch version of

module DeleteQueue : sig ... end

Deletes the queue specified by the QueueUrl, regardless of the queue's contents.

module GetQueueAttributes : sig ... end

Gets attributes for the specified queue.

module GetQueueUrl : sig ... end

The GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is useful when you know the queue's name but need to retrieve its URL for further operations.

module ListDeadLetterSourceQueues : sig ... end

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

module ListMessageMoveTasks : sig ... end

Gets the most recent message movement tasks (up to 10) under a specific source queue.

module ListQueueTags : sig ... end

List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

module ListQueues : sig ... end

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

module PurgeQueue : sig ... end

Deletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter.

module ReceiveMessage : sig ... end

Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.

module RemovePermission : sig ... end

Revokes any permissions in the queue policy that matches the specified Label parameter.

module SendMessage : sig ... end

Delivers a message to the specified queue.

module SendMessageBatch : sig ... end

You can use SendMessageBatch to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version of

module SetQueueAttributes : sig ... end

Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages.

module StartMessageMoveTask : sig ... end

Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.

module TagQueue : sig ... end

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

module UntagQueue : sig ... end

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

module Json_serializers : sig ... end

module Json_deserializers : sig ... end