pub struct PublishBatchFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to PublishBatch
.
Publishes up to ten messages to the specified topic. This is a batch version of Publish
. 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 5 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).
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§
source§impl PublishBatchFluentBuilder
impl PublishBatchFluentBuilder
sourcepub fn as_input(&self) -> &PublishBatchInputBuilder
pub fn as_input(&self) -> &PublishBatchInputBuilder
Access the PublishBatch as a reference.
sourcepub async fn send(
self
) -> Result<PublishBatchOutput, SdkError<PublishBatchError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<PublishBatchOutput, PublishBatchError, Self>
pub fn customize( self ) -> CustomizableOperation<PublishBatchOutput, PublishBatchError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn topic_arn(self, input: impl Into<String>) -> Self
pub fn topic_arn(self, input: impl Into<String>) -> Self
The Amazon resource name (ARN) of the topic you want to batch publish to.
sourcepub fn set_topic_arn(self, input: Option<String>) -> Self
pub fn set_topic_arn(self, input: Option<String>) -> Self
The Amazon resource name (ARN) of the topic you want to batch publish to.
sourcepub fn get_topic_arn(&self) -> &Option<String>
pub fn get_topic_arn(&self) -> &Option<String>
The Amazon resource name (ARN) of the topic you want to batch publish to.
sourcepub fn publish_batch_request_entries(
self,
input: PublishBatchRequestEntry
) -> Self
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.
sourcepub fn set_publish_batch_request_entries(
self,
input: Option<Vec<PublishBatchRequestEntry>>
) -> Self
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.
sourcepub fn get_publish_batch_request_entries(
&self
) -> &Option<Vec<PublishBatchRequestEntry>>
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§
source§impl Clone for PublishBatchFluentBuilder
impl Clone for PublishBatchFluentBuilder
source§fn clone(&self) -> PublishBatchFluentBuilder
fn clone(&self) -> PublishBatchFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for PublishBatchFluentBuilder
impl !RefUnwindSafe for PublishBatchFluentBuilder
impl Send for PublishBatchFluentBuilder
impl Sync for PublishBatchFluentBuilder
impl Unpin for PublishBatchFluentBuilder
impl !UnwindSafe for PublishBatchFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more