aws_sdk_connect/operation/transfer_contact/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::transfer_contact::_transfer_contact_output::TransferContactOutputBuilder;
3
4pub use crate::operation::transfer_contact::_transfer_contact_input::TransferContactInputBuilder;
5
6impl crate::operation::transfer_contact::builders::TransferContactInputBuilder {
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::transfer_contact::TransferContactOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::transfer_contact::TransferContactError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.transfer_contact();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `TransferContact`.
24///
25/// <p>Transfers <code>TASK</code> or <code>EMAIL</code> contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.</p>
26/// <p>Note the following requirements:</p>
27/// <ul>
28/// <li>
29/// <p>Transfer is only supported for <code>TASK</code> and <code>EMAIL</code> contacts.</p></li>
30/// <li>
31/// <p>Do not use both <code>QueueId</code> and <code>UserId</code> in the same call.</p></li>
32/// <li>
33/// <p>The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.</p></li>
34/// <li>
35/// <p>The <code>TransferContact</code> API can be called only on active contacts.</p></li>
36/// <li>
37/// <p>A contact cannot be transferred more than 11 times.</p></li>
38/// </ul>
39#[derive(::std::clone::Clone, ::std::fmt::Debug)]
40pub struct TransferContactFluentBuilder {
41    handle: ::std::sync::Arc<crate::client::Handle>,
42    inner: crate::operation::transfer_contact::builders::TransferContactInputBuilder,
43    config_override: ::std::option::Option<crate::config::Builder>,
44}
45impl
46    crate::client::customize::internal::CustomizableSend<
47        crate::operation::transfer_contact::TransferContactOutput,
48        crate::operation::transfer_contact::TransferContactError,
49    > for TransferContactFluentBuilder
50{
51    fn send(
52        self,
53        config_override: crate::config::Builder,
54    ) -> crate::client::customize::internal::BoxFuture<
55        crate::client::customize::internal::SendResult<
56            crate::operation::transfer_contact::TransferContactOutput,
57            crate::operation::transfer_contact::TransferContactError,
58        >,
59    > {
60        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
61    }
62}
63impl TransferContactFluentBuilder {
64    /// Creates a new `TransferContactFluentBuilder`.
65    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
66        Self {
67            handle,
68            inner: ::std::default::Default::default(),
69            config_override: ::std::option::Option::None,
70        }
71    }
72    /// Access the TransferContact as a reference.
73    pub fn as_input(&self) -> &crate::operation::transfer_contact::builders::TransferContactInputBuilder {
74        &self.inner
75    }
76    /// Sends the request and returns the response.
77    ///
78    /// If an error occurs, an `SdkError` will be returned with additional details that
79    /// can be matched against.
80    ///
81    /// By default, any retryable failures will be retried twice. Retry behavior
82    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
83    /// set when configuring the client.
84    pub async fn send(
85        self,
86    ) -> ::std::result::Result<
87        crate::operation::transfer_contact::TransferContactOutput,
88        ::aws_smithy_runtime_api::client::result::SdkError<
89            crate::operation::transfer_contact::TransferContactError,
90            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
91        >,
92    > {
93        let input = self
94            .inner
95            .build()
96            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
97        let runtime_plugins = crate::operation::transfer_contact::TransferContact::operation_runtime_plugins(
98            self.handle.runtime_plugins.clone(),
99            &self.handle.conf,
100            self.config_override,
101        );
102        crate::operation::transfer_contact::TransferContact::orchestrate(&runtime_plugins, input).await
103    }
104
105    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
106    pub fn customize(
107        self,
108    ) -> crate::client::customize::CustomizableOperation<
109        crate::operation::transfer_contact::TransferContactOutput,
110        crate::operation::transfer_contact::TransferContactError,
111        Self,
112    > {
113        crate::client::customize::CustomizableOperation::new(self)
114    }
115    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
116        self.set_config_override(::std::option::Option::Some(config_override.into()));
117        self
118    }
119
120    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
121        self.config_override = config_override;
122        self
123    }
124    /// <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>
125    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
126        self.inner = self.inner.instance_id(input.into());
127        self
128    }
129    /// <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>
130    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
131        self.inner = self.inner.set_instance_id(input);
132        self
133    }
134    /// <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>
135    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
136        self.inner.get_instance_id()
137    }
138    /// <p>The identifier of the contact in this instance of Amazon Connect.</p>
139    pub fn contact_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
140        self.inner = self.inner.contact_id(input.into());
141        self
142    }
143    /// <p>The identifier of the contact in this instance of Amazon Connect.</p>
144    pub fn set_contact_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
145        self.inner = self.inner.set_contact_id(input);
146        self
147    }
148    /// <p>The identifier of the contact in this instance of Amazon Connect.</p>
149    pub fn get_contact_id(&self) -> &::std::option::Option<::std::string::String> {
150        self.inner.get_contact_id()
151    }
152    /// <p>The identifier for the queue.</p>
153    pub fn queue_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
154        self.inner = self.inner.queue_id(input.into());
155        self
156    }
157    /// <p>The identifier for the queue.</p>
158    pub fn set_queue_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
159        self.inner = self.inner.set_queue_id(input);
160        self
161    }
162    /// <p>The identifier for the queue.</p>
163    pub fn get_queue_id(&self) -> &::std::option::Option<::std::string::String> {
164        self.inner.get_queue_id()
165    }
166    /// <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
167    pub fn user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
168        self.inner = self.inner.user_id(input.into());
169        self
170    }
171    /// <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
172    pub fn set_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
173        self.inner = self.inner.set_user_id(input);
174        self
175    }
176    /// <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
177    pub fn get_user_id(&self) -> &::std::option::Option<::std::string::String> {
178        self.inner.get_user_id()
179    }
180    /// <p>The identifier of the flow.</p>
181    pub fn contact_flow_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
182        self.inner = self.inner.contact_flow_id(input.into());
183        self
184    }
185    /// <p>The identifier of the flow.</p>
186    pub fn set_contact_flow_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
187        self.inner = self.inner.set_contact_flow_id(input);
188        self
189    }
190    /// <p>The identifier of the flow.</p>
191    pub fn get_contact_flow_id(&self) -> &::std::option::Option<::std::string::String> {
192        self.inner.get_contact_flow_id()
193    }
194    /// <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>
195    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
196        self.inner = self.inner.client_token(input.into());
197        self
198    }
199    /// <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>
200    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
201        self.inner = self.inner.set_client_token(input);
202        self
203    }
204    /// <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>
205    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
206        self.inner.get_client_token()
207    }
208}