aws_sdk_qconnect/client/
update_ai_prompt.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateAIPrompt`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::set_client_token):<br>required: **false**<br><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><br>
7    ///   - [`assistant_id(impl Into<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::set_assistant_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p><br>
8    ///   - [`ai_prompt_id(impl Into<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::ai_prompt_id) / [`set_ai_prompt_id(Option<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::set_ai_prompt_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect AI Prompt.</p><br>
9    ///   - [`visibility_status(VisibilityStatus)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::visibility_status) / [`set_visibility_status(Option<VisibilityStatus>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::set_visibility_status):<br>required: **true**<br><p>The visibility status of the Amazon Q in Connect AI prompt.</p><br>
10    ///   - [`template_configuration(AiPromptTemplateConfiguration)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::template_configuration) / [`set_template_configuration(Option<AiPromptTemplateConfiguration>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::set_template_configuration):<br>required: **false**<br><p>The configuration of the prompt template for this AI Prompt.</p><br>
11    ///   - [`description(impl Into<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::set_description):<br>required: **false**<br><p>The description of the Amazon Q in Connect AI Prompt.</p><br>
12    ///   - [`model_id(impl Into<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::model_id) / [`set_model_id(Option<String>)`](crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::set_model_id):<br>required: **false**<br><p>The identifier of the model used for this AI Prompt.</p><note>  <p>For more information on supported models, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system and custom prompts</a>.</p> </note><br>
13    /// - On success, responds with [`UpdateAiPromptOutput`](crate::operation::update_ai_prompt::UpdateAiPromptOutput) with field(s):
14    ///   - [`ai_prompt(Option<AiPromptData>)`](crate::operation::update_ai_prompt::UpdateAiPromptOutput::ai_prompt): <p>The data of the updated Amazon Q in Connect AI Prompt.</p>
15    /// - On failure, responds with [`SdkError<UpdateAIPromptError>`](crate::operation::update_ai_prompt::UpdateAIPromptError)
16    pub fn update_ai_prompt(&self) -> crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder {
17        crate::operation::update_ai_prompt::builders::UpdateAIPromptFluentBuilder::new(self.handle.clone())
18    }
19}