aws_sdk_connect/operation/create_notification/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_notification::_create_notification_input::CreateNotificationInputBuilder;
3
4pub use crate::operation::create_notification::_create_notification_output::CreateNotificationOutputBuilder;
5
6impl crate::operation::create_notification::builders::CreateNotificationInputBuilder {
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::create_notification::CreateNotificationOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_notification::CreateNotificationError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_notification();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateNotification`.
24///
25/// <p>Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateNotificationFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_notification::builders::CreateNotificationInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_notification::CreateNotificationOutput,
35        crate::operation::create_notification::CreateNotificationError,
36    > for CreateNotificationFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::create_notification::CreateNotificationOutput,
44            crate::operation::create_notification::CreateNotificationError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateNotificationFluentBuilder {
51    /// Creates a new `CreateNotificationFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CreateNotification as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_notification::builders::CreateNotificationInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::create_notification::CreateNotificationOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_notification::CreateNotificationError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::create_notification::CreateNotification::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_notification::CreateNotification::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::create_notification::CreateNotificationOutput,
97        crate::operation::create_notification::CreateNotificationError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
112    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.instance_id(input.into());
114        self
115    }
116    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
117    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_instance_id(input);
119        self
120    }
121    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
122    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_instance_id()
124    }
125    /// <p>The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.</p>
126    pub fn expires_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
127        self.inner = self.inner.expires_at(input);
128        self
129    }
130    /// <p>The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.</p>
131    pub fn set_expires_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
132        self.inner = self.inner.set_expires_at(input);
133        self
134    }
135    /// <p>The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.</p>
136    pub fn get_expires_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
137        self.inner.get_expires_at()
138    }
139    ///
140    /// Appends an item to `Recipients`.
141    ///
142    /// To override the contents of this collection use [`set_recipients`](Self::set_recipients).
143    ///
144    /// <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.</p>
145    pub fn recipients(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
146        self.inner = self.inner.recipients(input.into());
147        self
148    }
149    /// <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.</p>
150    pub fn set_recipients(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
151        self.inner = self.inner.set_recipients(input);
152        self
153    }
154    /// <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.</p>
155    pub fn get_recipients(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
156        self.inner.get_recipients()
157    }
158    /// <p>The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.</p>
159    pub fn priority(mut self, input: crate::types::ConfigurableNotificationPriority) -> Self {
160        self.inner = self.inner.priority(input);
161        self
162    }
163    /// <p>The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.</p>
164    pub fn set_priority(mut self, input: ::std::option::Option<crate::types::ConfigurableNotificationPriority>) -> Self {
165        self.inner = self.inner.set_priority(input);
166        self
167    }
168    /// <p>The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.</p>
169    pub fn get_priority(&self) -> &::std::option::Option<crate::types::ConfigurableNotificationPriority> {
170        self.inner.get_priority()
171    }
172    ///
173    /// Adds a key-value pair to `Content`.
174    ///
175    /// To override the contents of this collection use [`set_content`](Self::set_content).
176    ///
177    /// <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports links. Maximum 250 characters per locale.</p>
178    pub fn content(mut self, k: crate::types::LocaleCode, v: impl ::std::convert::Into<::std::string::String>) -> Self {
179        self.inner = self.inner.content(k, v.into());
180        self
181    }
182    /// <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports links. Maximum 250 characters per locale.</p>
183    pub fn set_content(mut self, input: ::std::option::Option<::std::collections::HashMap<crate::types::LocaleCode, ::std::string::String>>) -> Self {
184        self.inner = self.inner.set_content(input);
185        self
186    }
187    /// <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports links. Maximum 250 characters per locale.</p>
188    pub fn get_content(&self) -> &::std::option::Option<::std::collections::HashMap<crate::types::LocaleCode, ::std::string::String>> {
189        self.inner.get_content()
190    }
191    ///
192    /// Adds a key-value pair to `Tags`.
193    ///
194    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
195    ///
196    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
197    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
198        self.inner = self.inner.tags(k.into(), v.into());
199        self
200    }
201    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
202    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
203        self.inner = self.inner.set_tags(input);
204        self
205    }
206    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
207    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
208        self.inner.get_tags()
209    }
210    /// <p>The unique identifier for a notification.</p>
211    #[deprecated(note = "PredefinedNotificationId is deprecated. Use ClientToken for idempotency.", since = "3/13/2026")]
212    pub fn predefined_notification_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
213        self.inner = self.inner.predefined_notification_id(input.into());
214        self
215    }
216    /// <p>The unique identifier for a notification.</p>
217    #[deprecated(note = "PredefinedNotificationId is deprecated. Use ClientToken for idempotency.", since = "3/13/2026")]
218    pub fn set_predefined_notification_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
219        self.inner = self.inner.set_predefined_notification_id(input);
220        self
221    }
222    /// <p>The unique identifier for a notification.</p>
223    #[deprecated(note = "PredefinedNotificationId is deprecated. Use ClientToken for idempotency.", since = "3/13/2026")]
224    pub fn get_predefined_notification_id(&self) -> &::std::option::Option<::std::string::String> {
225        self.inner.get_predefined_notification_id()
226    }
227    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
228    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
229        self.inner = self.inner.client_token(input.into());
230        self
231    }
232    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
233    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
234        self.inner = self.inner.set_client_token(input);
235        self
236    }
237    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
238    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
239        self.inner.get_client_token()
240    }
241}
aws_sdk_connect/operation/create_notification/builders.rs

aws_sdk_connect/operation/create_notification/
builders.rs
