aws_sdk_qconnect/client/
update_ai_guardrail.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 [`UpdateAIGuardrail`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::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_guardrail::builders::UpdateAIGuardrailFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::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_guardrail_id(impl Into<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::ai_guardrail_id) / [`set_ai_guardrail_id(Option<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_ai_guardrail_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect AI Guardrail.</p><br>
9    ///   - [`visibility_status(VisibilityStatus)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::visibility_status) / [`set_visibility_status(Option<VisibilityStatus>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_visibility_status):<br>required: **true**<br><p>The visibility status of the Amazon Q in Connect AI Guardrail.</p><br>
10    ///   - [`blocked_input_messaging(impl Into<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::blocked_input_messaging) / [`set_blocked_input_messaging(Option<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_blocked_input_messaging):<br>required: **true**<br><p>The message to return when the AI Guardrail blocks a prompt.</p><br>
11    ///   - [`blocked_outputs_messaging(impl Into<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::blocked_outputs_messaging) / [`set_blocked_outputs_messaging(Option<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_blocked_outputs_messaging):<br>required: **true**<br><p>The message to return when the AI Guardrail blocks a model response.</p><br>
12    ///   - [`description(impl Into<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_description):<br>required: **false**<br><p>A description of the AI Guardrail.</p><br>
13    ///   - [`topic_policy_config(AiGuardrailTopicPolicyConfig)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::topic_policy_config) / [`set_topic_policy_config(Option<AiGuardrailTopicPolicyConfig>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_topic_policy_config):<br>required: **false**<br><p>The topic policies to configure for the AI Guardrail.</p><br>
14    ///   - [`content_policy_config(AiGuardrailContentPolicyConfig)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::content_policy_config) / [`set_content_policy_config(Option<AiGuardrailContentPolicyConfig>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_content_policy_config):<br>required: **false**<br><p>The content filter policies to configure for the AI Guardrail.</p><br>
15    ///   - [`word_policy_config(AiGuardrailWordPolicyConfig)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::word_policy_config) / [`set_word_policy_config(Option<AiGuardrailWordPolicyConfig>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_word_policy_config):<br>required: **false**<br><p>The word policy you configure for the AI Guardrail.</p><br>
16    ///   - [`sensitive_information_policy_config(AiGuardrailSensitiveInformationPolicyConfig)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::sensitive_information_policy_config) / [`set_sensitive_information_policy_config(Option<AiGuardrailSensitiveInformationPolicyConfig>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_sensitive_information_policy_config):<br>required: **false**<br><p>The sensitive information policy to configure for the AI Guardrail.</p><br>
17    ///   - [`contextual_grounding_policy_config(AiGuardrailContextualGroundingPolicyConfig)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::contextual_grounding_policy_config) / [`set_contextual_grounding_policy_config(Option<AiGuardrailContextualGroundingPolicyConfig>)`](crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::set_contextual_grounding_policy_config):<br>required: **false**<br><p>The contextual grounding policy configuration used to create an AI Guardrail.</p><br>
18    /// - On success, responds with [`UpdateAiGuardrailOutput`](crate::operation::update_ai_guardrail::UpdateAiGuardrailOutput) with field(s):
19    ///   - [`ai_guardrail(Option<AiGuardrailData>)`](crate::operation::update_ai_guardrail::UpdateAiGuardrailOutput::ai_guardrail): <p>The data of the updated Amazon Q in Connect AI Guardrail.</p>
20    /// - On failure, responds with [`SdkError<UpdateAIGuardrailError>`](crate::operation::update_ai_guardrail::UpdateAIGuardrailError)
21    pub fn update_ai_guardrail(&self) -> crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder {
22        crate::operation::update_ai_guardrail::builders::UpdateAIGuardrailFluentBuilder::new(self.handle.clone())
23    }
24}