@spec change_message_visibility(
  queue_url :: binary(),
  receipt_handle :: binary(),
  visibility_timeout :: visibility_timeout()
) :: ExAws.Operation.JSON.t()

Extends the read lock timeout for the specified message from the specified queue to the specified value.

AWS API Docs

@spec change_message_visibility_batch(
  queue_url :: binary(),
  opts :: [message_visibility_batch_item(), ...]
) :: ExAws.Operation.JSON.t()

Extends the read lock timeout for a batch of 1..10 messages.

Raises ArgumentError if the batch is not a list, is empty, or is larger than 10 entries so invalid batches fail before the request round-trip.

AWS API Docs

@spec delete_message(queue_url :: binary(), receipt_handle :: binary()) ::
  ExAws.Operation.JSON.t()

Delete a message from a SQS Queue

AWS API Docs

@spec delete_message_batch(
  queue_url :: binary(),
  message_receipts :: [delete_message_batch_item(), ...]
) :: ExAws.Operation.JSON.t()

Deletes a list of messages from a SQS Queue in a single request

Accepts a list of 1..10 entries; raises ArgumentError otherwise (AWS rejects both empty and oversized batches, so we fail before the request round-trip).

AWS API Docs

@spec receive_message(queue_url :: binary(), opts :: receive_message_opts()) ::
  ExAws.Operation.JSON.t()

Read messages from a SQS Queue

AWS API Docs

Options

• :attribute_names - :all or a list of message system attributes to include in the response (sent as the modern MessageSystemAttributeNames field). Valid attributes are: [:sender_id, :sent_timestamp, :approximate_receive_count, :approximate_first_receive_timestamp, :sequence_number, :message_deduplication_id, :message_group_id, :aws_trace_header, :dead_letter_queue_source_arn]

• :message_attribute_names - :all or a list of message attributes to include.

  • 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.

• :max_number_of_messages - 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.

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

• :wait_time_seconds - The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.

• :receive_request_attempt_id - This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of ReceiveMessage calls.

@spec send_message(
  queue_url :: binary(),
  message_body :: binary(),
  opts :: sqs_message_opts()
) ::
  ExAws.Operation.JSON.t()

Send a message to a SQS Queue

AWS API Docs

Options

• :delay_seconds - The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900.

• :message_attributes - Each message attribute consists of a :name, :data_type, and :value. For binary attributes (data_type: :binary), pass the raw binary in :value; the library base64-encodes it for the JSON protocol. See Amazon SQS Message Attributes.

• :message_system_attributes - Same shape as :message_attributes, but for AWS-controlled system attributes. Currently the only supported one is :aws_trace_header (sent as AWSTraceHeader): an X-Ray trace header string (data_type: :string) that propagates tracing context through the queue. Its size doesn't count towards the total message size.

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

• :message_group_id - Required for FIFO queues to group messages for ordered processing. On standard queues, identifies a tenant to enable fair queuing.

Examples

iex> ExAws.SQS.send_message("https://queue.url", "Hello!").data
%{"MessageBody" => "Hello!", "QueueUrl" => "https://queue.url"}

iex> ExAws.SQS.send_message("https://queue.url", "Hello!",
...>   message_attributes: [%{name: "priority", data_type: :number, value: 1}]
...> ).data
%{
  "MessageAttributes" => %{
    "priority" => %{"DataType" => "Number", "StringValue" => "1"}
  },
  "MessageBody" => "Hello!",
  "QueueUrl" => "https://queue.url"
}

iex> ExAws.SQS.send_message("https://queue.url", "Hello!",
...>   message_system_attributes: [
...>     %{name: :aws_trace_header, data_type: :string, value: "Root=1-abc"}
...>   ]
...> ).data
%{
  "MessageBody" => "Hello!",
  "MessageSystemAttributes" => %{
    "AWSTraceHeader" => %{"DataType" => "String", "StringValue" => "Root=1-abc"}
  },
  "QueueUrl" => "https://queue.url"
}

@spec send_message_batch(
  queue_url :: binary(),
  messages :: [sqs_batch_message(), ...]
) ::
  ExAws.Operation.JSON.t()

Send 1..10 messages to a SQS Queue in a single request.

Raises ArgumentError if the batch is not a list, is empty, or is larger than 10 entries so invalid batches fail before the request round-trip.

Each entry needs at least an :id (unique within the batch, used to match up the "Successful"/"Failed" results in the response) and a :message_body. Entries may be keyword lists or maps, and otherwise accept the same options as send_message/3 (:delay_seconds, :message_attributes, :message_system_attributes, :message_deduplication_id, :message_group_id).

AWS API Docs

Examples

iex> ExAws.SQS.send_message_batch("https://queue.url", [
...>   [id: "a1", message_body: "payload1"],
...>   [id: "a2", message_body: "payload2", delay_seconds: 10]
...> ]).data
%{
  "Entries" => [
    %{"Id" => "a1", "MessageBody" => "payload1"},
    %{"DelaySeconds" => 10, "Id" => "a2", "MessageBody" => "payload2"}
  ],
  "QueueUrl" => "https://queue.url"
}

A successful call returns a body shaped like:

%{
  "Successful" => [%{"Id" => "a1", "MessageId" => "...", "MD5OfMessageBody" => "..."}, ...],
  "Failed" => [%{"Id" => "a2", "Code" => "...", "Message" => "...", "SenderFault" => true}, ...]
}