aws_sdk_sns/operation/publish_batch/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::publish_batch::_publish_batch_output::PublishBatchOutputBuilder;
3
4pub use crate::operation::publish_batch::_publish_batch_input::PublishBatchInputBuilder;
5
6impl crate::operation::publish_batch::builders::PublishBatchInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::publish_batch::PublishBatchOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::publish_batch::PublishBatchError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.publish_batch();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `PublishBatch`.
24///
25/// <p>Publishes up to 10 messages to the specified topic in a single batch. This is a batch version of the <code>Publish</code> API. If you try to send more than 10 messages in a single batch request, you will receive a <code>TooManyEntriesInBatchRequest</code> exception.</p>
26/// <p>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.</p>
27/// <p>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.</p>
28/// <p>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).</p><important>
29/// <p>The <code>PublishBatch</code> 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 <code>TooManyEntriesInBatchRequest</code> exception. In such cases, split your messages into multiple requests, each containing no more than 10 messages.</p>
30/// </important>
31/// <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from <b>1</b>. For example, a parameter list with two elements looks like this:</p>
32/// <p><code>&amp;AttributeName.1=first</code></p>
33/// <p><code>&amp;AttributeName.2=second</code></p>
34/// <p>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.</p>
35/// <p>When a <code>messageId</code> is returned, the batch message is saved, and Amazon SNS immediately delivers the message to subscribers.</p>
36#[derive(::std::clone::Clone, ::std::fmt::Debug)]
37pub struct PublishBatchFluentBuilder {
38    handle: ::std::sync::Arc<crate::client::Handle>,
39    inner: crate::operation::publish_batch::builders::PublishBatchInputBuilder,
40    config_override: ::std::option::Option<crate::config::Builder>,
41}
42impl
43    crate::client::customize::internal::CustomizableSend<
44        crate::operation::publish_batch::PublishBatchOutput,
45        crate::operation::publish_batch::PublishBatchError,
46    > for PublishBatchFluentBuilder
47{
48    fn send(
49        self,
50        config_override: crate::config::Builder,
51    ) -> crate::client::customize::internal::BoxFuture<
52        crate::client::customize::internal::SendResult<
53            crate::operation::publish_batch::PublishBatchOutput,
54            crate::operation::publish_batch::PublishBatchError,
55        >,
56    > {
57        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
58    }
59}
60impl PublishBatchFluentBuilder {
61    /// Creates a new `PublishBatchFluentBuilder`.
62    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
63        Self {
64            handle,
65            inner: ::std::default::Default::default(),
66            config_override: ::std::option::Option::None,
67        }
68    }
69    /// Access the PublishBatch as a reference.
70    pub fn as_input(&self) -> &crate::operation::publish_batch::builders::PublishBatchInputBuilder {
71        &self.inner
72    }
73    /// Sends the request and returns the response.
74    ///
75    /// If an error occurs, an `SdkError` will be returned with additional details that
76    /// can be matched against.
77    ///
78    /// By default, any retryable failures will be retried twice. Retry behavior
79    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
80    /// set when configuring the client.
81    pub async fn send(
82        self,
83    ) -> ::std::result::Result<
84        crate::operation::publish_batch::PublishBatchOutput,
85        ::aws_smithy_runtime_api::client::result::SdkError<
86            crate::operation::publish_batch::PublishBatchError,
87            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
88        >,
89    > {
90        let input = self
91            .inner
92            .build()
93            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
94        let runtime_plugins = crate::operation::publish_batch::PublishBatch::operation_runtime_plugins(
95            self.handle.runtime_plugins.clone(),
96            &self.handle.conf,
97            self.config_override,
98        );
99        crate::operation::publish_batch::PublishBatch::orchestrate(&runtime_plugins, input).await
100    }
101
102    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
103    pub fn customize(
104        self,
105    ) -> crate::client::customize::CustomizableOperation<
106        crate::operation::publish_batch::PublishBatchOutput,
107        crate::operation::publish_batch::PublishBatchError,
108        Self,
109    > {
110        crate::client::customize::CustomizableOperation::new(self)
111    }
112    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
113        self.set_config_override(::std::option::Option::Some(config_override.into()));
114        self
115    }
116
117    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
118        self.config_override = config_override;
119        self
120    }
121    /// <p>The Amazon resource name (ARN) of the topic you want to batch publish to.</p>
122    pub fn topic_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
123        self.inner = self.inner.topic_arn(input.into());
124        self
125    }
126    /// <p>The Amazon resource name (ARN) of the topic you want to batch publish to.</p>
127    pub fn set_topic_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
128        self.inner = self.inner.set_topic_arn(input);
129        self
130    }
131    /// <p>The Amazon resource name (ARN) of the topic you want to batch publish to.</p>
132    pub fn get_topic_arn(&self) -> &::std::option::Option<::std::string::String> {
133        self.inner.get_topic_arn()
134    }
135    ///
136    /// Appends an item to `PublishBatchRequestEntries`.
137    ///
138    /// To override the contents of this collection use [`set_publish_batch_request_entries`](Self::set_publish_batch_request_entries).
139    ///
140    /// <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS topic.</p>
141    pub fn publish_batch_request_entries(mut self, input: crate::types::PublishBatchRequestEntry) -> Self {
142        self.inner = self.inner.publish_batch_request_entries(input);
143        self
144    }
145    /// <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS topic.</p>
146    pub fn set_publish_batch_request_entries(
147        mut self,
148        input: ::std::option::Option<::std::vec::Vec<crate::types::PublishBatchRequestEntry>>,
149    ) -> Self {
150        self.inner = self.inner.set_publish_batch_request_entries(input);
151        self
152    }
153    /// <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS topic.</p>
154    pub fn get_publish_batch_request_entries(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::PublishBatchRequestEntry>> {
155        self.inner.get_publish_batch_request_entries()
156    }
157}
aws_sdk_sns/operation/publish_batch/builders.rs

aws_sdk_sns/operation/publish_batch/
builders.rs
