aws_sdk_qconnect/client/

create_ai_guardrail.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateAIGuardrail`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::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>
    ///   - [`assistant_id(impl Into<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::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>
    ///   - [`name(impl Into<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_name):<br>required: **true**<br><p>The name of the AI Guardrail.</p><br>
    ///   - [`blocked_input_messaging(impl Into<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::blocked_input_messaging) / [`set_blocked_input_messaging(Option<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_blocked_input_messaging):<br>required: **true**<br><p>The message to return when the AI Guardrail blocks a prompt.</p><br>
    ///   - [`blocked_outputs_messaging(impl Into<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::blocked_outputs_messaging) / [`set_blocked_outputs_messaging(Option<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_blocked_outputs_messaging):<br>required: **true**<br><p>The message to return when the AI Guardrail blocks a model response.</p><br>
    ///   - [`visibility_status(VisibilityStatus)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::visibility_status) / [`set_visibility_status(Option<VisibilityStatus>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_visibility_status):<br>required: **true**<br><p>The visibility status of the AI Guardrail.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_description):<br>required: **false**<br><p>A description of the AI Guardrail.</p><br>
    ///   - [`topic_policy_config(AiGuardrailTopicPolicyConfig)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::topic_policy_config) / [`set_topic_policy_config(Option<AiGuardrailTopicPolicyConfig>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_topic_policy_config):<br>required: **false**<br><p>The topic policies to configure for the AI Guardrail.</p><br>
    ///   - [`content_policy_config(AiGuardrailContentPolicyConfig)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::content_policy_config) / [`set_content_policy_config(Option<AiGuardrailContentPolicyConfig>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_content_policy_config):<br>required: **false**<br><p>The content filter policies to configure for the AI Guardrail.</p><br>
    ///   - [`word_policy_config(AiGuardrailWordPolicyConfig)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::word_policy_config) / [`set_word_policy_config(Option<AiGuardrailWordPolicyConfig>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_word_policy_config):<br>required: **false**<br><p>The word policy you configure for the AI Guardrail.</p><br>
    ///   - [`sensitive_information_policy_config(AiGuardrailSensitiveInformationPolicyConfig)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::sensitive_information_policy_config) / [`set_sensitive_information_policy_config(Option<AiGuardrailSensitiveInformationPolicyConfig>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_sensitive_information_policy_config):<br>required: **false**<br><p>The sensitive information policy to configure for the AI Guardrail.</p><br>
    ///   - [`contextual_grounding_policy_config(AiGuardrailContextualGroundingPolicyConfig)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::contextual_grounding_policy_config) / [`set_contextual_grounding_policy_config(Option<AiGuardrailContextualGroundingPolicyConfig>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_contextual_grounding_policy_config):<br>required: **false**<br><p>The contextual grounding policy configuration used to create an AI Guardrail.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::set_tags):<br>required: **false**<br><p>The tags used to organize, track, or control access for this resource.</p><br>
    /// - On success, responds with [`CreateAiGuardrailOutput`](crate::operation::create_ai_guardrail::CreateAiGuardrailOutput) with field(s):
    ///   - [`ai_guardrail(Option<AiGuardrailData>)`](crate::operation::create_ai_guardrail::CreateAiGuardrailOutput::ai_guardrail): <p>The data of the AI Guardrail.</p>
    /// - On failure, responds with [`SdkError<CreateAIGuardrailError>`](crate::operation::create_ai_guardrail::CreateAIGuardrailError)
    pub fn create_ai_guardrail(&self) -> crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder {
        crate::operation::create_ai_guardrail::builders::CreateAIGuardrailFluentBuilder::new(self.handle.clone())
    }
}