Module Smaws_Client_SQS

SQS client library built on EIO.

Types

type untag_queue_request = {
  1. tag_keys : string list;
    (*

    The list of tags to be removed from the specified queue.

    *)
  2. queue_url : string;
    (*

    The URL of the queue.

    *)
}
type unsupported_operation = {
  1. message : string option;
}

Error code 400. Unsupported operation.

The request was denied due to request throttling.

  • The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
  • A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
  • Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
type request_throttled = {
  1. message : string option;
}
type queue_does_not_exist = {
  1. message : string option;
}

The specified queue doesn't exist.

type invalid_security = {
  1. message : string option;
}

When the request to a queue is not HTTPS and SigV4.

type invalid_address = {
  1. message : string option;
}

The accountId is invalid.

type too_many_entries_in_batch_request = {
  1. message : string option;
}

The batch request contains more entries than permissible.

type tag_queue_request = {
  1. tags : (string * string) list;
    (*

    The list of tags to be added to the specified queue.

    *)
  2. queue_url : string;
    (*

    The URL of the queue.

    *)
}
type start_message_move_task_result = {
  1. task_handle : string option;
    (*

    An identifier associated with a message movement task. You can use this identifier to cancel a specified message movement task using the CancelMessageMoveTask action.

    *)
}
type start_message_move_task_request = {
  1. max_number_of_messages_per_second : int option;
    (*

    The number of messages to be moved per second (the message movement rate). You can use this field to define a fixed message movement rate. The maximum value for messages per second is 500. If this field is left blank, the system will optimize the rate based on the queue message backlog size, which may vary throughout the duration of the message movement task.

    *)
  2. destination_arn : string option;
    (*

    The ARN of the queue that receives the moved messages. You can use this field to specify the destination queue where you would like to redrive messages. If this field is left blank, the messages will be redriven back to their respective original source queues.

    *)
  3. source_arn : string;
    (*

    The ARN of the queue that contains the messages to be moved to another queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are not currently supported.

    *)
}
type resource_not_found_exception = {
  1. message : string option;
}

One or more specified resources don't exist.

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;
    (*

    A map of attributes to set.

    The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

    • DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
    • MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
    • MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). 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.
    • Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Identity and Access Management User Guide.

    • ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a

      [ReceiveMessage]

      action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.

    • VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

    The following attributes apply only to dead-letter queues:

    • RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

      • deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
      • maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

    • RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

      • redrivePermission – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

        • allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue.
        • denyAll – No source queues can specify this queue as the dead-letter queue.
        • byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.
      • sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be

      alias/{i MyAlias}

      . For more examples, see KeyId in the Key Management Service API Reference.

    • KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
    • SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).

    The following attribute applies only to FIFO (first-in-first-out) queues:

    • ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:

      • Every message must have a unique MessageDeduplicationId.

        • You may provide a MessageDeduplicationId explicitly.
        • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
        • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
        • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
      • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
      • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The following attributes apply only to high throughput for FIFO queues:

    • DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
    • FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    To enable high throughput for FIFO queues, do the following:

    • Set DeduplicationScope to messageGroup.
    • Set FifoThroughputLimit to perMessageGroupId.

    If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

    For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

    *)
  2. queue_url : string;
    (*

    The URL of the Amazon SQS queue whose attributes are set.

    Queue URLs and names are case-sensitive.

    *)
}
type over_limit = {
  1. message : string option;
}

The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of in flight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.

type invalid_attribute_value = {
  1. message : string option;
}

A queue attribute value is invalid.

type invalid_attribute_name = {
  1. message : string option;
}

The specified attribute doesn't exist.

type send_message_result = {
  1. sequence_number : string option;
    (*

    This parameter applies only to FIFO (first-in-first-out) queues.

    The large, non-consecutive number that Amazon SQS assigns to each message.

    The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

    *)
  2. message_id : string option;
    (*

    An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

    *)
  3. md5_of_message_system_attributes : string option;
    (*

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

    *)
  4. md5_of_message_attributes : string option;
    (*

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    *)
  5. md5_of_message_body : string option;
    (*

    An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    *)
}

The MD5OfMessageBody and MessageId elements.

type message_attribute_value = {
  1. data_type : string;
    (*

    Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

    You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

    *)
  2. binary_list_values : bytes list option;
    (*

    Not implemented. Reserved for future use.

    *)
  3. string_list_values : string list option;
    (*

    Not implemented. Reserved for future use.

    *)
  4. binary_value : bytes option;
    (*

    Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

    *)
  5. string_value : string option;
    (*

    Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

    *)
}

The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see

[SendMessage].

Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KiB or 262,144 bytes).

type message_system_attribute_value = {
  1. data_type : string;
    (*

    Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

    You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

    *)
  2. binary_list_values : bytes list option;
    (*

    Not implemented. Reserved for future use.

    *)
  3. string_list_values : string list option;
    (*

    Not implemented. Reserved for future use.

    *)
  4. binary_value : bytes option;
    (*

    Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

    *)
  5. string_value : string option;
    (*

    Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

    *)
}

The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see

[SendMessage].

Name, type, value and the message body must not be empty or null.

type message_system_attribute_name_for_sends =
  1. | AWSTraceHeader
type send_message_request = {
  1. message_group_id : string option;
    (*

    This parameter applies only to FIFO (first-in-first-out) queues.

    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.

    • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
    • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

    The maximum length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|\}~).

    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.

    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

    *)
  2. message_deduplication_id : string option;
    (*

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

    • Every message must have a unique MessageDeduplicationId,

      • You may provide a MessageDeduplicationId explicitly.
      • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
      • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
      • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
    • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
    • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|\}~).

    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.

    *)
  3. message_system_attributes : (string * message_system_attribute_value) list option;
    (*

    The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

    • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.
    • The size of a message system attribute doesn't count towards the total size of a message.
    *)
  4. message_attributes : (string * message_attribute_value) list option;
    (*

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

    *)
  5. delay_seconds : int option;
    (*

    The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.

    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

    *)
  6. message_body : string;
    (*

    The message to send. The minimum size is one character. The maximum size is 256 KiB.

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

    Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

    *)
  7. queue_url : string;
    (*

    The URL of the Amazon SQS queue to which a message is sent.

    Queue URLs and names are case-sensitive.

    *)
}
type send_message_batch_result_entry = {
  1. sequence_number : string option;
    (*

    This parameter applies only to FIFO (first-in-first-out) queues.

    The large, non-consecutive number that Amazon SQS assigns to each message.

    The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.

    *)
  2. md5_of_message_system_attributes : string option;
    (*

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    *)
  3. md5_of_message_attributes : string option;
    (*

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    *)
  4. md5_of_message_body : string;
    (*

    An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    *)
  5. message_id : string;
    (*

    An identifier for the message.

    *)
  6. id : string;
    (*

    An identifier for the message in this batch.

    *)
}

Encloses a MessageId for a successfully-enqueued message in a

[SendMessageBatch].
type batch_result_error_entry = {
  1. message : string option;
    (*

    A message explaining why the action failed on this entry.

    *)
  2. code : string;
    (*

    An error code representing why the action failed on this entry.

    *)
  3. sender_fault : bool;
    (*

    Specifies whether the error happened due to the caller of the batch API action.

    *)
  4. id : string;
    (*

    The Id of an entry in a batch request.

    *)
}

Gives a detailed description of the result of an action on each entry in the request.

type send_message_batch_result = {
  1. failed : batch_result_error_entry list;
    (*

    A list of

    [BatchResultErrorEntry]

    items with error details about each message that can't be enqueued.

    *)
  2. successful : send_message_batch_result_entry list;
    (*

    A list of

    [SendMessageBatchResultEntry]

    items.

    *)
}

For each message in the batch, the response contains a

[SendMessageBatchResultEntry]

tag if the message succeeds or a

[BatchResultErrorEntry]

tag if the message fails.

type send_message_batch_request_entry = {
  1. message_group_id : string option;
    (*

    This parameter applies only to FIFO (first-in-first-out) queues.

    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.

    • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
    • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

    The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|\}~).

    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.

    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

    *)
  2. message_deduplication_id : string option;
    (*

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

    • Every message must have a unique MessageDeduplicationId,

      • You may provide a MessageDeduplicationId explicitly.
      • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
      • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
      • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
    • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
    • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|\}~).

    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.

    *)
  3. message_system_attributes : (string * message_system_attribute_value) list option;
    (*

    The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

    • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.
    • The size of a message system attribute doesn't count towards the total size of a message.
    *)
  4. message_attributes : (string * message_attribute_value) list option;
    (*

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

    *)
  5. delay_seconds : int option;
    (*

    The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.

    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

    *)
  6. message_body : string;
    (*

    The body of the message.

    *)
  7. id : string;
    (*

    An identifier for a message in this batch used to communicate the result.

    The Ids of a batch request need to be unique within a request.

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    *)
}

Contains the details of a single Amazon SQS message along with an Id.

type send_message_batch_request = {
  1. entries : send_message_batch_request_entry list;
    (*

    A list of

    [SendMessageBatchRequestEntry]

    items.

    *)
  2. queue_url : string;
    (*

    The URL of the Amazon SQS queue to which batched messages are sent.

    Queue URLs and names are case-sensitive.

    *)
}
type kms_throttled = {
  1. message : string option;
}

Amazon Web Services KMS throttles requests for the following conditions.

type kms_opt_in_required = {
  1. message : string option;
}

The request was rejected because the specified key policy isn't syntactically or semantically correct.

type kms_not_found = {
  1. message : string option;
}

The request was rejected because the specified entity or resource could not be found.

type kms_invalid_state = {
  1. message : string option;
}

The request was rejected because the state of the specified resource is not valid for this request.

type kms_invalid_key_usage = {
  1. message : string option;
}

The request was rejected for one of the following reasons:

  • The KeyUsage value of the KMS key is incompatible with the API operation.
  • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).
type kms_disabled = {
  1. message : string option;
}

The request was denied due to request throttling.

type kms_access_denied = {
  1. message : string option;
}

The caller doesn't have the required KMS access.

type invalid_batch_entry_id = {
  1. message : string option;
}

The Id of a batch entry in a batch request doesn't abide by the specification.

type empty_batch_request = {
  1. message : string option;
}

The batch request doesn't contain any entries.

type batch_request_too_long = {
  1. message : string option;
}

The length of all the messages put together is more than the limit.

type batch_entry_ids_not_distinct = {
  1. message : string option;
}

Two or more batch entries in the request have the same Id.

type invalid_message_contents = {
  1. message : string option;
}

The message contains characters outside the allowed set.

type remove_permission_request = {
  1. label : string;
    (*

    The identification of the permission to remove. This is the label added using the

    [AddPermission]

    action.

    *)
  2. queue_url : string;
    (*

    The URL of the Amazon SQS queue from which permissions are removed.

    Queue URLs and names are case-sensitive.

    *)
}
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;
    (*

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

    *)
  2. md5_of_message_attributes : string option;
    (*

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    *)
  3. attributes : (string * string) list option;
    (*

    A map of the attributes requested in

    [ReceiveMessage]

    to their respective values. Supported attributes:

    • ApproximateReceiveCount
    • ApproximateFirstReceiveTimestamp
    • MessageDeduplicationId
    • MessageGroupId
    • SenderId
    • SentTimestamp
    • SequenceNumber

    ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

    *)
  4. body : string option;
    (*

    The message's contents (not URL-encoded).

    *)
  5. md5_of_body : string option;
    (*

    An MD5 digest of the non-URL-encoded message body string.

    *)
  6. receipt_handle : string option;
    (*

    An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

    *)
  7. message_id : string option;
    (*

    A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

    *)
}

An Amazon SQS message.

type receive_message_result = {
  1. messages : message list option;
    (*

    A list of messages.

    *)
}

A list of received messages.

type receive_message_request = {
  1. receive_request_attempt_id : string option;
    (*

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

    • You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
    • When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
    • It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

    • During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

      If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

      To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

    • While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
    • If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.

    The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|\}~).

    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.

    *)
  2. wait_time_seconds : int option;
    (*

    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call does not return a message list.

    To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage requests is longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.

    *)
  3. visibility_timeout : int option;
    (*

    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

    *)
  4. max_number_of_messages : int option;
    (*

    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.

    *)
  5. message_attribute_names : string list option;
    (*

    The name of the message attribute, where N is the index.

    • The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
    • The name is case-sensitive and must be unique among all attribute names for the message.
    • The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    • The name must not start or end with a period (.), and it should not have periods in succession (..).
    • The name can be up to 256 characters long.

    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.

    *)
  6. message_system_attribute_names : message_system_attribute_name list option;
    (*

    A list of attributes that need to be returned along with each message. These attributes include:

    • All – Returns all values.
    • ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
    • ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
    • AWSTraceHeader – Returns the X-Ray trace header string.

    • SenderId

      • For a user, returns the user ID, for example ABCDEFGHI1JKLMNOPQ23R.
      • For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    • SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
    • SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).

    • MessageDeduplicationId – Returns the value provided by the producer that calls the

      [SendMessage]

      action.

    • MessageGroupId – Returns the value provided by the producer that calls the

      [SendMessage]

      action. Messages with the same MessageGroupId are returned in sequence.

    • SequenceNumber – Returns the value provided by Amazon SQS.
    *)
  7. attribute_names : queue_attribute_name list option;
    (*

    This parameter has been deprecated but will be supported for backward compatibility. To provide attribute names, you are encouraged to use MessageSystemAttributeNames.

    A list of attributes that need to be returned along with each message. These attributes include:

    • All – Returns all values.
    • ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
    • ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
    • AWSTraceHeader – Returns the X-Ray trace header string.

    • SenderId

      • For a user, returns the user ID, for example ABCDEFGHI1JKLMNOPQ23R.
      • For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    • SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
    • SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).

    • MessageDeduplicationId – Returns the value provided by the producer that calls the

      [SendMessage]

      action.

    • MessageGroupId – Returns the value provided by the producer that calls the

      [SendMessage]

      action. Messages with the same MessageGroupId are returned in sequence.

    • SequenceNumber – Returns the value provided by Amazon SQS.
    *)
  8. queue_url : string;
    (*

    The URL of the Amazon SQS queue from which messages are received.

    Queue URLs and names are case-sensitive.

    *)
}
type receipt_handle_is_invalid = {
  1. message : string option;
}

The specified receipt handle isn't valid.

type queue_name_exists = {
  1. message : string option;
}

A queue with this name already exists. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.

type queue_deleted_recently = {
  1. message : string option;
}

You must wait 60 seconds after deleting a queue before you can create another queue with the same name.

type purge_queue_request = {
  1. queue_url : string;
    (*

    The URL of the queue from which the PurgeQueue action deletes messages.

    Queue URLs and names are case-sensitive.

    *)
}
type purge_queue_in_progress = {
  1. message : string option;
}

Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).

type message_not_inflight = unit

The specified message isn't in flight.

type list_queues_result = {
  1. next_token : string option;
    (*

    Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

    *)
  2. queue_urls : string list option;
    (*

    A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.

    *)
}

A list of your queues.

type list_queues_request = {
  1. max_results : int option;
    (*

    Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

    *)
  2. next_token : string option;
    (*

    Pagination token to request the next set of results.

    *)
  3. queue_name_prefix : string option;
    (*

    A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

    Queue URLs and names are case-sensitive.

    *)
}
type list_queue_tags_result = {
  1. tags : (string * string) list option;
    (*

    The list of all tags added to the specified queue.

    *)
}
type list_queue_tags_request = {
  1. queue_url : string;
    (*

    The URL of the queue.

    *)
}
type list_message_move_tasks_result_entry = {
  1. started_timestamp : int option;
    (*

    The timestamp of starting the message movement task.

    *)
  2. failure_reason : string option;
    (*

    The task failure reason (only included if the task status is FAILED).

    *)
  3. approximate_number_of_messages_to_move : int option;
    (*

    The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task and is only included after the message movement task is selected to start.

    *)
  4. approximate_number_of_messages_moved : int option;
    (*

    The approximate number of messages already moved to the destination queue.

    *)
  5. max_number_of_messages_per_second : int option;
    (*

    The number of messages to be moved per second (the message movement rate), if it has been specified in the StartMessageMoveTask request. If a MaxNumberOfMessagesPerSecond has not been specified in the StartMessageMoveTask request, this field value will be NULL.

    *)
  6. destination_arn : string option;
    (*

    The ARN of the destination queue if it has been specified in the StartMessageMoveTask request. If a DestinationArn has not been specified in the StartMessageMoveTask request, this field value will be NULL.

    *)
  7. source_arn : string option;
    (*

    The ARN of the queue that contains the messages to be moved to another queue.

    *)
  8. status : string option;
    (*

    The status of the message movement task. Possible values are: RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.

    *)
  9. task_handle : string option;
    (*

    An identifier associated with a message movement task. When this field is returned in the response of the ListMessageMoveTasks action, it is only populated for tasks that are in RUNNING status.

    *)
}

Contains the details of a message movement task.

type list_message_move_tasks_result = {
  1. results : list_message_move_tasks_result_entry list option;
    (*

    A list of message movement tasks and their attributes.

    *)
}
type list_message_move_tasks_request = {
  1. max_results : int option;
    (*

    The maximum number of results to include in the response. The default is 1, which provides the most recent message movement task. The upper limit is 10.

    *)
  2. source_arn : string;
    (*

    The ARN of the queue whose message movement tasks are to be listed.

    *)
}
type list_dead_letter_source_queues_result = {
  1. next_token : string option;
    (*

    Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

    *)
  2. queue_urls : string list;
    (*

    A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.

    *)
}

A list of your dead letter source queues.

type list_dead_letter_source_queues_request = {
  1. max_results : int option;
    (*

    Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

    *)
  2. next_token : string option;
    (*

    Pagination token to request the next set of results.

    *)
  3. queue_url : string;
    (*

    The URL of a dead-letter queue.

    Queue URLs and names are case-sensitive.

    *)
}
type invalid_id_format = unit

The specified receipt handle isn't valid for the current version.

type get_queue_url_result = {
  1. queue_url : string option;
    (*

    The URL of the queue.

    *)
}

For more information, see Interpreting Responses in the Amazon SQS Developer Guide.

type get_queue_url_request = {
  1. queue_owner_aws_account_id : string option;
    (*

    The Amazon Web Services account ID of the account that created the queue.

    *)
  2. queue_name : string;
    (*

    The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).

    Queue URLs and names are case-sensitive.

    *)
}
type get_queue_attributes_result = {
  1. attributes : (string * string) list option;
    (*

    A map of attributes to their respective values.

    *)
}

A list of returned queue attributes.

type get_queue_attributes_request = {
  1. attribute_names : queue_attribute_name list option;
    (*

    A list of attributes for which to retrieve information.

    The AttributeNames parameter is optional, but if you don't specify values for this parameter, the request returns empty results.

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    The following attributes are supported:

    The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency.

    • All – Returns all values.
    • ApproximateNumberOfMessages – Returns the approximate number of messages available for retrieval from the queue.
    • ApproximateNumberOfMessagesDelayed – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
    • ApproximateNumberOfMessagesNotVisible – Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
    • CreatedTimestamp – Returns the time when the queue was created in seconds (epoch time).
    • DelaySeconds – Returns the default delay on the queue in seconds.
    • LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time).
    • MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
    • MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message. 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.
    • Policy – Returns the policy of the queue.
    • QueueArn – Returns the Amazon resource name (ARN) of the queue.
    • ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
    • VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

    The following attributes apply only to dead-letter queues:

    • RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

      • deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
      • maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

    • RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

      • redrivePermission – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

        • allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue.
        • denyAll – No source queues can specify this queue as the dead-letter queue.
        • byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.
      • sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
    • KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?.
    • SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).

    The following attributes apply only to FIFO (first-in-first-out) queues:

    • FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.

      To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

    • ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

    The following attributes apply only to high throughput for FIFO queues:

    • DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
    • FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    To enable high throughput for FIFO queues, do the following:

    • Set DeduplicationScope to messageGroup.
    • Set FifoThroughputLimit to perMessageGroupId.

    If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

    For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

    *)
  2. queue_url : string;
    (*

    The URL of the Amazon SQS queue whose attribute information is retrieved.

    Queue URLs and names are case-sensitive.

    *)
}
type delete_queue_request = {
  1. queue_url : string;
    (*

    The URL of the Amazon SQS queue to delete.

    Queue URLs and names are case-sensitive.

    *)
}
type delete_message_request = {
  1. receipt_handle : string;
    (*

    The receipt handle associated with the message to delete.

    *)
  2. queue_url : string;
    (*

    The URL of the Amazon SQS queue from which messages are deleted.

    Queue URLs and names are case-sensitive.

    *)
}
type delete_message_batch_result_entry = {
  1. id : string;
    (*

    Represents a successfully deleted message.

    *)
}

Encloses the Id of an entry in

[DeleteMessageBatch].
type delete_message_batch_result = {
  1. failed : batch_result_error_entry list;
    (*

    A list of

    [BatchResultErrorEntry]

    items.

    *)
  2. successful : delete_message_batch_result_entry list;
    (*

    A list of

    [DeleteMessageBatchResultEntry]

    items.

    *)
}

For each message in the batch, the response contains a

[DeleteMessageBatchResultEntry]

tag if the message is deleted or a

[BatchResultErrorEntry]

tag if the message can't be deleted.

type delete_message_batch_request_entry = {
  1. receipt_handle : string;
    (*

    A receipt handle.

    *)
  2. id : string;
    (*

    The identifier for this particular receipt handle. This is used to communicate the result.

    The Ids of a batch request need to be unique within a request.

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    *)
}

Encloses a receipt handle and an identifier for it.

type delete_message_batch_request = {
  1. entries : delete_message_batch_request_entry list;
    (*

    Lists the receipt handles for the messages to be deleted.

    *)
  2. queue_url : string;
    (*

    The URL of the Amazon SQS queue from which messages are deleted.

    Queue URLs and names are case-sensitive.

    *)
}
type create_queue_result = {
  1. queue_url : string option;
    (*

    The URL of the created Amazon SQS queue.

    *)
}

Returns the QueueUrl attribute of the created queue.

type create_queue_request = {
  1. tags : (string * string) list option;
    (*

    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.

    When you use queue tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a queue isn't recommended.
    • Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
    • Tags are case-sensitive.
    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.

    To be able to tag a queue on creation, you must have the sqs:CreateQueue and sqs:TagQueue permissions.

    Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.

    *)
  2. attributes : (string * string) list option;
    (*

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

    • DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
    • MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
    • MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). 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.
    • Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the IAM User Guide.

    • ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a

      [ReceiveMessage]

      action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.

    • VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

    The following attributes apply only to dead-letter queues:

    • RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

      • deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
      • maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

    • RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

      • redrivePermission – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

        • allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue.
        • denyAll – No source queues can specify this queue as the dead-letter queue.
        • byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.
      • sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be

      alias/{i MyAlias}

      . For more examples, see KeyId in the Key Management Service API Reference.

    • KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?
    • SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).

    The following attributes apply only to FIFO (first-in-first-out) queues:

    • FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.

      For more information, see FIFO queue logic in the Amazon SQS Developer Guide.

    • ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:

      • Every message must have a unique MessageDeduplicationId.

        • You may provide a MessageDeduplicationId explicitly.
        • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
        • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
        • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
      • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
      • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The following attributes apply only to high throughput for FIFO queues:

    • DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
    • FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    To enable high throughput for FIFO queues, do the following:

    • Set DeduplicationScope to messageGroup.
    • Set FifoThroughputLimit to perMessageGroupId.

    If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

    For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

    *)
  3. queue_name : string;
    (*

    The name of the new queue. The following limits apply to this name:

    • A queue name can have up to 80 characters.
    • Valid values: alphanumeric characters, hyphens (-), and underscores (_).
    • A FIFO queue name must end with the .fifo suffix.

    Queue URLs and names are case-sensitive.

    *)
}
type change_message_visibility_request = {
  1. visibility_timeout : int;
    (*

    The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.

    *)
  2. receipt_handle : string;
    (*

    The receipt handle associated with the message, whose visibility timeout is changed. This parameter is returned by the

    [ReceiveMessage]

    action.

    *)
  3. queue_url : string;
    (*

    The URL of the Amazon SQS queue whose message's visibility is changed.

    Queue URLs and names are case-sensitive.

    *)
}
type change_message_visibility_batch_result_entry = {
  1. id : string;
    (*

    Represents a message whose visibility timeout has been changed successfully.

    *)
}

Encloses the Id of an entry in

[ChangeMessageVisibilityBatch].
type change_message_visibility_batch_result = {
  1. failed : batch_result_error_entry list;
    (*

    A list of

    [BatchResultErrorEntry]

    items.

    *)
  2. successful : change_message_visibility_batch_result_entry list;
    (*

    A list of

    [ChangeMessageVisibilityBatchResultEntry]

    items.

    *)
}

For each message in the batch, the response contains a

[ChangeMessageVisibilityBatchResultEntry]

tag if the message succeeds or a

[BatchResultErrorEntry]

tag if the message fails.

type change_message_visibility_batch_request_entry = {
  1. visibility_timeout : int option;
    (*

    The new value (in seconds) for the message's visibility timeout.

    *)
  2. receipt_handle : string;
    (*

    A receipt handle.

    *)
  3. id : string;
    (*

    An identifier for this particular receipt handle used to communicate the result.

    The Ids of a batch request need to be unique within a request.

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    *)
}

Encloses a receipt handle and an entry ID for each message in

[ChangeMessageVisibilityBatch].
type change_message_visibility_batch_request = {
  1. entries : change_message_visibility_batch_request_entry list;
    (*

    Lists the receipt handles of the messages for which the visibility timeout must be changed.

    *)
  2. queue_url : string;
    (*

    The URL of the Amazon SQS queue whose messages' visibility is changed.

    Queue URLs and names are case-sensitive.

    *)
}
type cancel_message_move_task_result = {
  1. approximate_number_of_messages_moved : int option;
    (*

    The approximate number of messages already moved to the destination queue.

    *)
}
type cancel_message_move_task_request = {
  1. task_handle : string;
    (*

    An identifier associated with a message movement task.

    *)
}
type add_permission_request = {
  1. actions : string list;
    (*

    The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

    For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

    Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

    *)
  2. aws_account_ids : string list;
    (*

    The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

    *)
  3. label : string;
    (*

    The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

    *)
  4. queue_url : string;
    (*

    The URL of the Amazon SQS queue to which permissions are added.

    Queue URLs and names are case-sensitive.

    *)
}

Welcome to the Amazon SQS API Reference.

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.

You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

Additional information

type base_document = Smaws_Lib.Json.t

Builders

val make_untag_queue_request : tag_keys:string list -> queue_url:string -> unit -> untag_queue_request

Create a untag_queue_request type

val make_tag_queue_request : tags:(string * string) list -> queue_url:string -> unit -> tag_queue_request

Create a tag_queue_request type

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

Create a start_message_move_task_request type

val make_set_queue_attributes_request : attributes:(string * string) list -> queue_url:string -> unit -> set_queue_attributes_request

Create a set_queue_attributes_request type

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

Create a message_attribute_value type

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

Create a message_system_attribute_value type

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

Create a send_message_request type

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

Create a send_message_batch_result_entry type

val make_batch_result_error_entry : ?message:string -> code:string -> sender_fault:bool -> id:string -> unit -> batch_result_error_entry

Create a batch_result_error_entry type

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

Create a send_message_batch_request_entry type

val make_send_message_batch_request : entries:send_message_batch_request_entry list -> queue_url:string -> unit -> send_message_batch_request

Create a send_message_batch_request type

val make_remove_permission_request : label:string -> queue_url:string -> unit -> remove_permission_request

Create a remove_permission_request type

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

Create a message type

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

Create a receive_message_request type

val make_purge_queue_request : queue_url:string -> unit -> purge_queue_request

Create a purge_queue_request type

val make_list_queues_request : ?max_results:int -> ?next_token:string -> ?queue_name_prefix:string -> unit -> list_queues_request

Create a list_queues_request type

val make_list_queue_tags_request : queue_url:string -> unit -> list_queue_tags_request

Create a list_queue_tags_request type

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

Create a list_message_move_tasks_result_entry type

val make_list_message_move_tasks_request : ?max_results:int -> source_arn:string -> unit -> list_message_move_tasks_request

Create a list_message_move_tasks_request type

val make_list_dead_letter_source_queues_request : ?max_results:int -> ?next_token:string -> queue_url:string -> unit -> list_dead_letter_source_queues_request

Create a list_dead_letter_source_queues_request type

val make_get_queue_url_request : ?queue_owner_aws_account_id:string -> queue_name:string -> unit -> get_queue_url_request

Create a get_queue_url_request type

val make_get_queue_attributes_request : ?attribute_names:queue_attribute_name list -> queue_url:string -> unit -> get_queue_attributes_request

Create a get_queue_attributes_request type

val make_delete_queue_request : queue_url:string -> unit -> delete_queue_request

Create a delete_queue_request type

val make_delete_message_request : receipt_handle:string -> queue_url:string -> unit -> delete_message_request

Create a delete_message_request type

val make_delete_message_batch_result_entry : id:string -> unit -> delete_message_batch_result_entry

Create a delete_message_batch_result_entry type

val make_delete_message_batch_request_entry : receipt_handle:string -> id:string -> unit -> delete_message_batch_request_entry

Create a delete_message_batch_request_entry type

val make_delete_message_batch_request : entries:delete_message_batch_request_entry list -> queue_url:string -> unit -> delete_message_batch_request

Create a delete_message_batch_request type

val make_create_queue_request : ?tags:(string * string) list -> ?attributes:(string * string) list -> queue_name:string -> unit -> create_queue_request

Create a create_queue_request type

val make_change_message_visibility_request : visibility_timeout:int -> receipt_handle:string -> queue_url:string -> unit -> change_message_visibility_request

Create a change_message_visibility_request type

val make_change_message_visibility_batch_result_entry : id:string -> unit -> change_message_visibility_batch_result_entry

Create a change_message_visibility_batch_result_entry type

val make_change_message_visibility_batch_request_entry : ?visibility_timeout:int -> receipt_handle:string -> id:string -> unit -> change_message_visibility_batch_request_entry

Create a change_message_visibility_batch_request_entry type

val make_change_message_visibility_batch_request : entries:change_message_visibility_batch_request_entry list -> queue_url:string -> unit -> change_message_visibility_batch_request

Create a change_message_visibility_batch_request type

val make_cancel_message_move_task_request : task_handle:string -> unit -> cancel_message_move_task_request

Create a cancel_message_move_task_request type

val make_add_permission_request : actions:string list -> aws_account_ids:string list -> label:string -> queue_url:string -> unit -> add_permission_request

Create a add_permission_request type

Operations

module AddPermission : sig ... end
module CancelMessageMoveTask : sig ... end
module ChangeMessageVisibility : sig ... end
module ChangeMessageVisibilityBatch : sig ... end
module CreateQueue : sig ... end
module DeleteMessage : sig ... end
module DeleteMessageBatch : sig ... end
module DeleteQueue : sig ... end
module GetQueueAttributes : sig ... end
module GetQueueUrl : sig ... end
module ListDeadLetterSourceQueues : sig ... end
module ListMessageMoveTasks : sig ... end
module ListQueueTags : sig ... end
module ListQueues : sig ... end
module PurgeQueue : sig ... end
module ReceiveMessage : sig ... end
module RemovePermission : sig ... end
module SendMessage : sig ... end
module SendMessageBatch : sig ... end
module SetQueueAttributes : sig ... end
module StartMessageMoveTask : sig ... end
module TagQueue : sig ... end
module UntagQueue : sig ... end