aws_sdk_connect/operation/update_contact_attributes/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_contact_attributes::_update_contact_attributes_output::UpdateContactAttributesOutputBuilder;
3
4pub use crate::operation::update_contact_attributes::_update_contact_attributes_input::UpdateContactAttributesInputBuilder;
5
6impl crate::operation::update_contact_attributes::builders::UpdateContactAttributesInputBuilder {
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::update_contact_attributes::UpdateContactAttributesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_contact_attributes::UpdateContactAttributesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_contact_attributes();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateContactAttributes`.
24///
25/// <p>Creates or updates user-defined contact attributes associated with the specified contact.</p>
26/// <p>You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.</p>
27/// <p>Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct UpdateContactAttributesFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::update_contact_attributes::builders::UpdateContactAttributesInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::update_contact_attributes::UpdateContactAttributesOutput,
37        crate::operation::update_contact_attributes::UpdateContactAttributesError,
38    > for UpdateContactAttributesFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::update_contact_attributes::UpdateContactAttributesOutput,
46            crate::operation::update_contact_attributes::UpdateContactAttributesError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl UpdateContactAttributesFluentBuilder {
53    /// Creates a new `UpdateContactAttributesFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the UpdateContactAttributes as a reference.
62    pub fn as_input(&self) -> &crate::operation::update_contact_attributes::builders::UpdateContactAttributesInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::update_contact_attributes::UpdateContactAttributesOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::update_contact_attributes::UpdateContactAttributesError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::update_contact_attributes::UpdateContactAttributes::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::update_contact_attributes::UpdateContactAttributes::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::update_contact_attributes::UpdateContactAttributesOutput,
99        crate::operation::update_contact_attributes::UpdateContactAttributesError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>
114    pub fn initial_contact_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.initial_contact_id(input.into());
116        self
117    }
118    /// <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>
119    pub fn set_initial_contact_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_initial_contact_id(input);
121        self
122    }
123    /// <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>
124    pub fn get_initial_contact_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_initial_contact_id()
126    }
127    /// <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>
128    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.instance_id(input.into());
130        self
131    }
132    /// <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>
133    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_instance_id(input);
135        self
136    }
137    /// <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>
138    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_instance_id()
140    }
141    ///
142    /// Adds a key-value pair to `Attributes`.
143    ///
144    /// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
145    ///
146    /// <p>The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.</p>
147    /// <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>
148    /// <p>In the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Set contact attributes</a> block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:</p>
149    /// <ul>
150    /// <li>
151    /// <p>Remove unnecessary attributes by setting their values to empty.</p></li>
152    /// <li>
153    /// <p>If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Flow block: Set contact attributes</a> in the <i>Amazon Connect Administrator Guide</i>.</p></li>
154    /// </ul>
155    pub fn attributes(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
156        self.inner = self.inner.attributes(k.into(), v.into());
157        self
158    }
159    /// <p>The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.</p>
160    /// <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>
161    /// <p>In the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Set contact attributes</a> block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:</p>
162    /// <ul>
163    /// <li>
164    /// <p>Remove unnecessary attributes by setting their values to empty.</p></li>
165    /// <li>
166    /// <p>If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Flow block: Set contact attributes</a> in the <i>Amazon Connect Administrator Guide</i>.</p></li>
167    /// </ul>
168    pub fn set_attributes(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
169        self.inner = self.inner.set_attributes(input);
170        self
171    }
172    /// <p>The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.</p>
173    /// <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>
174    /// <p>In the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Set contact attributes</a> block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:</p>
175    /// <ul>
176    /// <li>
177    /// <p>Remove unnecessary attributes by setting their values to empty.</p></li>
178    /// <li>
179    /// <p>If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Flow block: Set contact attributes</a> in the <i>Amazon Connect Administrator Guide</i>.</p></li>
180    /// </ul>
181    pub fn get_attributes(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
182        self.inner.get_attributes()
183    }
184}