pub struct SendMessageBatchFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SendMessageBatch
.
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
For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.SendMessage
.
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 KiB (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.
Implementations§
source§impl SendMessageBatchFluentBuilder
impl SendMessageBatchFluentBuilder
sourcepub fn as_input(&self) -> &SendMessageBatchInputBuilder
pub fn as_input(&self) -> &SendMessageBatchInputBuilder
Access the SendMessageBatch as a reference.
sourcepub async fn send(
self
) -> Result<SendMessageBatchOutput, SdkError<SendMessageBatchError, HttpResponse>>
pub async fn send( self ) -> Result<SendMessageBatchOutput, SdkError<SendMessageBatchError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<SendMessageBatchOutput, SendMessageBatchError, Self>
pub fn customize( self ) -> CustomizableOperation<SendMessageBatchOutput, SendMessageBatchError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn queue_url(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_queue_url(self, input: Option<String>) -> Self
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.
sourcepub fn get_queue_url(&self) -> &Option<String>
pub fn get_queue_url(&self) -> &Option<String>
The URL of the Amazon SQS queue to which batched messages are sent.
Queue URLs and names are case-sensitive.
sourcepub fn entries(self, input: SendMessageBatchRequestEntry) -> Self
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
items.SendMessageBatchRequestEntry
sourcepub fn set_entries(
self,
input: Option<Vec<SendMessageBatchRequestEntry>>
) -> Self
pub fn set_entries( self, input: Option<Vec<SendMessageBatchRequestEntry>> ) -> Self
A list of
items.SendMessageBatchRequestEntry
sourcepub fn get_entries(&self) -> &Option<Vec<SendMessageBatchRequestEntry>>
pub fn get_entries(&self) -> &Option<Vec<SendMessageBatchRequestEntry>>
A list of
items.SendMessageBatchRequestEntry
Trait Implementations§
source§impl Clone for SendMessageBatchFluentBuilder
impl Clone for SendMessageBatchFluentBuilder
source§fn clone(&self) -> SendMessageBatchFluentBuilder
fn clone(&self) -> SendMessageBatchFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more