aws_sdk_connect/operation/create_predefined_attribute/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_predefined_attribute::_create_predefined_attribute_output::CreatePredefinedAttributeOutputBuilder;
3
4pub use crate::operation::create_predefined_attribute::_create_predefined_attribute_input::CreatePredefinedAttributeInputBuilder;
5
6impl crate::operation::create_predefined_attribute::builders::CreatePredefinedAttributeInputBuilder {
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_predefined_attribute::CreatePredefinedAttributeOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_predefined_attribute::CreatePredefinedAttributeError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_predefined_attribute();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreatePredefinedAttribute`.
24///
25/// <p>Creates a new predefined attribute for the specified Amazon Connect instance. A <i>predefined attribute</i> is made up of a name and a value.</p>
26/// <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
27/// <p><b>Use cases</b></p>
28/// <p>Following are common uses cases for this API:</p>
29/// <ul>
30/// <li>
31/// <p>Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create predefined attributes for routing contacts to agents</a>.</p></li>
32/// <li>
33/// <p>Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p></li>
34/// </ul>
35/// <p><b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and quotas</a>.</p>
36#[derive(::std::clone::Clone, ::std::fmt::Debug)]
37pub struct CreatePredefinedAttributeFluentBuilder {
38    handle: ::std::sync::Arc<crate::client::Handle>,
39    inner: crate::operation::create_predefined_attribute::builders::CreatePredefinedAttributeInputBuilder,
40    config_override: ::std::option::Option<crate::config::Builder>,
41}
42impl
43    crate::client::customize::internal::CustomizableSend<
44        crate::operation::create_predefined_attribute::CreatePredefinedAttributeOutput,
45        crate::operation::create_predefined_attribute::CreatePredefinedAttributeError,
46    > for CreatePredefinedAttributeFluentBuilder
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::create_predefined_attribute::CreatePredefinedAttributeOutput,
54            crate::operation::create_predefined_attribute::CreatePredefinedAttributeError,
55        >,
56    > {
57        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
58    }
59}
60impl CreatePredefinedAttributeFluentBuilder {
61    /// Creates a new `CreatePredefinedAttributeFluentBuilder`.
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 CreatePredefinedAttribute as a reference.
70    pub fn as_input(&self) -> &crate::operation::create_predefined_attribute::builders::CreatePredefinedAttributeInputBuilder {
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::create_predefined_attribute::CreatePredefinedAttributeOutput,
85        ::aws_smithy_runtime_api::client::result::SdkError<
86            crate::operation::create_predefined_attribute::CreatePredefinedAttributeError,
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::create_predefined_attribute::CreatePredefinedAttribute::operation_runtime_plugins(
95            self.handle.runtime_plugins.clone(),
96            &self.handle.conf,
97            self.config_override,
98        );
99        crate::operation::create_predefined_attribute::CreatePredefinedAttribute::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::create_predefined_attribute::CreatePredefinedAttributeOutput,
107        crate::operation::create_predefined_attribute::CreatePredefinedAttributeError,
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 identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>
122    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
123        self.inner = self.inner.instance_id(input.into());
124        self
125    }
126    /// <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>
127    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
128        self.inner = self.inner.set_instance_id(input);
129        self
130    }
131    /// <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>
132    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
133        self.inner.get_instance_id()
134    }
135    /// <p>The name of the predefined attribute.</p>
136    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
137        self.inner = self.inner.name(input.into());
138        self
139    }
140    /// <p>The name of the predefined attribute.</p>
141    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142        self.inner = self.inner.set_name(input);
143        self
144    }
145    /// <p>The name of the predefined attribute.</p>
146    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
147        self.inner.get_name()
148    }
149    /// <p>The values of the predefined attribute.</p>
150    pub fn values(mut self, input: crate::types::PredefinedAttributeValues) -> Self {
151        self.inner = self.inner.values(input);
152        self
153    }
154    /// <p>The values of the predefined attribute.</p>
155    pub fn set_values(mut self, input: ::std::option::Option<crate::types::PredefinedAttributeValues>) -> Self {
156        self.inner = self.inner.set_values(input);
157        self
158    }
159    /// <p>The values of the predefined attribute.</p>
160    pub fn get_values(&self) -> &::std::option::Option<crate::types::PredefinedAttributeValues> {
161        self.inner.get_values()
162    }
163    ///
164    /// Appends an item to `Purposes`.
165    ///
166    /// To override the contents of this collection use [`set_purposes`](Self::set_purposes).
167    ///
168    /// <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>
169    pub fn purposes(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
170        self.inner = self.inner.purposes(input.into());
171        self
172    }
173    /// <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>
174    pub fn set_purposes(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
175        self.inner = self.inner.set_purposes(input);
176        self
177    }
178    /// <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>
179    pub fn get_purposes(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
180        self.inner.get_purposes()
181    }
182    /// <p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
183    pub fn attribute_configuration(mut self, input: crate::types::InputPredefinedAttributeConfiguration) -> Self {
184        self.inner = self.inner.attribute_configuration(input);
185        self
186    }
187    /// <p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
188    pub fn set_attribute_configuration(mut self, input: ::std::option::Option<crate::types::InputPredefinedAttributeConfiguration>) -> Self {
189        self.inner = self.inner.set_attribute_configuration(input);
190        self
191    }
192    /// <p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
193    pub fn get_attribute_configuration(&self) -> &::std::option::Option<crate::types::InputPredefinedAttributeConfiguration> {
194        self.inner.get_attribute_configuration()
195    }
196}
aws_sdk_connect/operation/create_predefined_attribute/builders.rs

aws_sdk_connect/operation/create_predefined_attribute/
builders.rs
