Struct aws_sdk_sqs::client::fluent_builders::SendMessageBatch

pub struct SendMessageBatch { /* private fields */ }

Fluent builder constructing a request to SendMessageBatch.

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

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

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&AttributeName.1=first

&AttributeName.2=second

Implementations

impl SendMessageBatch

pub async fn customize(
    self
) -> Result<CustomizableOperation<SendMessageBatch, AwsResponseRetryClassifier>, SdkError<SendMessageBatchError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<SendMessageBatchOutput, SdkError<SendMessageBatchError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn queue_url(self, input: impl Into<String>) -> Self

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

Queue URLs and names are case-sensitive.

pub fn set_queue_url(self, input: Option<String>) -> Self

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

Queue URLs and names are case-sensitive.

pub fn entries(self, input: SendMessageBatchRequestEntry) -> Self

Appends an item to Entries.

To override the contents of this collection use set_entries.

A list of SendMessageBatchRequestEntry items.

pub fn set_entries(
    self,
    input: Option<Vec<SendMessageBatchRequestEntry>>
) -> Self

A list of SendMessageBatchRequestEntry items.

Trait Implementations

impl Clone for SendMessageBatch

fn clone(&self) -> SendMessageBatch

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendMessageBatch

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.