aws_sdk_qconnect/operation/create_ai_prompt/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_ai_prompt::_create_ai_prompt_output::CreateAiPromptOutputBuilder;
3
4pub use crate::operation::create_ai_prompt::_create_ai_prompt_input::CreateAiPromptInputBuilder;
5
6impl crate::operation::create_ai_prompt::builders::CreateAiPromptInputBuilder {
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_ai_prompt::CreateAiPromptOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_ai_prompt::CreateAIPromptError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_ai_prompt();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateAIPrompt`.
24///
25/// <p>Creates an Amazon Q in Connect AI Prompt.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateAIPromptFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_ai_prompt::builders::CreateAiPromptInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_ai_prompt::CreateAiPromptOutput,
35        crate::operation::create_ai_prompt::CreateAIPromptError,
36    > for CreateAIPromptFluentBuilder
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_ai_prompt::CreateAiPromptOutput,
44            crate::operation::create_ai_prompt::CreateAIPromptError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateAIPromptFluentBuilder {
51    /// Creates a new `CreateAIPromptFluentBuilder`.
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 CreateAIPrompt as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_ai_prompt::builders::CreateAiPromptInputBuilder {
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_ai_prompt::CreateAiPromptOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_ai_prompt::CreateAIPromptError,
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_ai_prompt::CreateAIPrompt::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_ai_prompt::CreateAIPrompt::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_ai_prompt::CreateAiPromptOutput,
97        crate::operation::create_ai_prompt::CreateAIPromptError,
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>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="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
112    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.client_token(input.into());
114        self
115    }
116    /// <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="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
117    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_client_token(input);
119        self
120    }
121    /// <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="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
122    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_client_token()
124    }
125    /// <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
126    pub fn assistant_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.assistant_id(input.into());
128        self
129    }
130    /// <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
131    pub fn set_assistant_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_assistant_id(input);
133        self
134    }
135    /// <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
136    pub fn get_assistant_id(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_assistant_id()
138    }
139    /// <p>The name of the AI Prompt.</p>
140    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.name(input.into());
142        self
143    }
144    /// <p>The name of the AI Prompt.</p>
145    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_name(input);
147        self
148    }
149    /// <p>The name of the AI Prompt.</p>
150    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_name()
152    }
153    /// <p>The type of this AI Prompt.</p>
154    pub fn r#type(mut self, input: crate::types::AiPromptType) -> Self {
155        self.inner = self.inner.r#type(input);
156        self
157    }
158    /// <p>The type of this AI Prompt.</p>
159    pub fn set_type(mut self, input: ::std::option::Option<crate::types::AiPromptType>) -> Self {
160        self.inner = self.inner.set_type(input);
161        self
162    }
163    /// <p>The type of this AI Prompt.</p>
164    pub fn get_type(&self) -> &::std::option::Option<crate::types::AiPromptType> {
165        self.inner.get_type()
166    }
167    /// <p>The configuration of the prompt template for this AI Prompt.</p>
168    pub fn template_configuration(mut self, input: crate::types::AiPromptTemplateConfiguration) -> Self {
169        self.inner = self.inner.template_configuration(input);
170        self
171    }
172    /// <p>The configuration of the prompt template for this AI Prompt.</p>
173    pub fn set_template_configuration(mut self, input: ::std::option::Option<crate::types::AiPromptTemplateConfiguration>) -> Self {
174        self.inner = self.inner.set_template_configuration(input);
175        self
176    }
177    /// <p>The configuration of the prompt template for this AI Prompt.</p>
178    pub fn get_template_configuration(&self) -> &::std::option::Option<crate::types::AiPromptTemplateConfiguration> {
179        self.inner.get_template_configuration()
180    }
181    /// <p>The visibility status of the AI Prompt.</p>
182    pub fn visibility_status(mut self, input: crate::types::VisibilityStatus) -> Self {
183        self.inner = self.inner.visibility_status(input);
184        self
185    }
186    /// <p>The visibility status of the AI Prompt.</p>
187    pub fn set_visibility_status(mut self, input: ::std::option::Option<crate::types::VisibilityStatus>) -> Self {
188        self.inner = self.inner.set_visibility_status(input);
189        self
190    }
191    /// <p>The visibility status of the AI Prompt.</p>
192    pub fn get_visibility_status(&self) -> &::std::option::Option<crate::types::VisibilityStatus> {
193        self.inner.get_visibility_status()
194    }
195    /// <p>The type of the prompt template for this AI Prompt.</p>
196    pub fn template_type(mut self, input: crate::types::AiPromptTemplateType) -> Self {
197        self.inner = self.inner.template_type(input);
198        self
199    }
200    /// <p>The type of the prompt template for this AI Prompt.</p>
201    pub fn set_template_type(mut self, input: ::std::option::Option<crate::types::AiPromptTemplateType>) -> Self {
202        self.inner = self.inner.set_template_type(input);
203        self
204    }
205    /// <p>The type of the prompt template for this AI Prompt.</p>
206    pub fn get_template_type(&self) -> &::std::option::Option<crate::types::AiPromptTemplateType> {
207        self.inner.get_template_type()
208    }
209    /// <p>The identifier of the model used for this AI Prompt.</p><note>
210    /// <p>For information about which models are supported in each Amazon Web Services Region, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system/custom prompts</a>.</p>
211    /// </note>
212    pub fn model_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
213        self.inner = self.inner.model_id(input.into());
214        self
215    }
216    /// <p>The identifier of the model used for this AI Prompt.</p><note>
217    /// <p>For information about which models are supported in each Amazon Web Services Region, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system/custom prompts</a>.</p>
218    /// </note>
219    pub fn set_model_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
220        self.inner = self.inner.set_model_id(input);
221        self
222    }
223    /// <p>The identifier of the model used for this AI Prompt.</p><note>
224    /// <p>For information about which models are supported in each Amazon Web Services Region, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system/custom prompts</a>.</p>
225    /// </note>
226    pub fn get_model_id(&self) -> &::std::option::Option<::std::string::String> {
227        self.inner.get_model_id()
228    }
229    /// <p>The API Format of the AI Prompt.</p>
230    /// <p>Recommended values: <code>MESSAGES | TEXT_COMPLETIONS</code></p><note>
231    /// <p>The values <code>ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS</code> will be deprecated.</p>
232    /// </note>
233    pub fn api_format(mut self, input: crate::types::AiPromptApiFormat) -> Self {
234        self.inner = self.inner.api_format(input);
235        self
236    }
237    /// <p>The API Format of the AI Prompt.</p>
238    /// <p>Recommended values: <code>MESSAGES | TEXT_COMPLETIONS</code></p><note>
239    /// <p>The values <code>ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS</code> will be deprecated.</p>
240    /// </note>
241    pub fn set_api_format(mut self, input: ::std::option::Option<crate::types::AiPromptApiFormat>) -> Self {
242        self.inner = self.inner.set_api_format(input);
243        self
244    }
245    /// <p>The API Format of the AI Prompt.</p>
246    /// <p>Recommended values: <code>MESSAGES | TEXT_COMPLETIONS</code></p><note>
247    /// <p>The values <code>ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS</code> will be deprecated.</p>
248    /// </note>
249    pub fn get_api_format(&self) -> &::std::option::Option<crate::types::AiPromptApiFormat> {
250        self.inner.get_api_format()
251    }
252    ///
253    /// Adds a key-value pair to `tags`.
254    ///
255    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
256    ///
257    /// <p>The tags used to organize, track, or control access for this resource.</p>
258    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
259        self.inner = self.inner.tags(k.into(), v.into());
260        self
261    }
262    /// <p>The tags used to organize, track, or control access for this resource.</p>
263    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
264        self.inner = self.inner.set_tags(input);
265        self
266    }
267    /// <p>The tags used to organize, track, or control access for this resource.</p>
268    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
269        self.inner.get_tags()
270    }
271    /// <p>The description of the AI Prompt.</p>
272    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
273        self.inner = self.inner.description(input.into());
274        self
275    }
276    /// <p>The description of the AI Prompt.</p>
277    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
278        self.inner = self.inner.set_description(input);
279        self
280    }
281    /// <p>The description of the AI Prompt.</p>
282    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
283        self.inner.get_description()
284    }
285}