Struct PublishBatchFluentBuilder 

pub struct PublishBatchFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PublishBatch.

Publishes up to 10 messages to the specified topic in a single batch. This is a batch version of the Publish API. If you try to send more than 10 messages in a single batch request, you will receive a TooManyEntriesInBatchRequest exception.

For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for five minutes.

The result of publishing 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).

The PublishBatch API can send up to 10 messages at a time. If you attempt to send more than 10 messages in one request, you will encounter a TooManyEntriesInBatchRequest exception. In such cases, split your messages into multiple requests, each containing no more than 10 messages.

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

If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the batch message is saved, and Amazon SNS immediately delivers the message to subscribers.

Implementations

impl PublishBatchFluentBuilder

pub fn as_input(&self) -> &PublishBatchInputBuilder

Access the PublishBatch as a reference.

pub async fn send( self, ) -> Result<PublishBatchOutput, SdkError<PublishBatchError, 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.

pub fn customize( self, ) -> CustomizableOperation<PublishBatchOutput, PublishBatchError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The Amazon resource name (ARN) of the topic you want to batch publish to.

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

The Amazon resource name (ARN) of the topic you want to batch publish to.

pub fn get_topic_arn(&self) -> &Option<String>

The Amazon resource name (ARN) of the topic you want to batch publish to.

pub fn publish_batch_request_entries( self, input: PublishBatchRequestEntry, ) -> Self

Appends an item to PublishBatchRequestEntries.

To override the contents of this collection use set_publish_batch_request_entries.

A list of PublishBatch request entries to be sent to the SNS topic.

pub fn set_publish_batch_request_entries( self, input: Option<Vec<PublishBatchRequestEntry>>, ) -> Self

A list of PublishBatch request entries to be sent to the SNS topic.

pub fn get_publish_batch_request_entries( &self, ) -> &Option<Vec<PublishBatchRequestEntry>>

A list of PublishBatch request entries to be sent to the SNS topic.

Trait Implementations

impl Clone for PublishBatchFluentBuilder

fn clone(&self) -> PublishBatchFluentBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublishBatchFluentBuilder

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

Formats the value using the given formatter.