AIGuardrailData ¶

class AIGuardrailData(TypedDict, closed=True):
    assistant_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    assistant_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>"""
    ai_guardrail_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the AI Guardrail.</p>"""
    ai_guardrail_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the Amazon Q in Connect AI Guardrail.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the AI Guardrail.</p>"""
    visibility_status: "capo_qconnect.types.visibility_status.VisibilityStatus"
    """<p>The visibility status of the AI Guardrail.</p>"""
    blocked_input_messaging: (
        "capo_qconnect.types.ai_guardrail_blocked_messaging.AIGuardrailBlockedMessaging"
    )
    """<p>The message to return when the AI Guardrail blocks a prompt.</p>"""
    blocked_outputs_messaging: (
        "capo_qconnect.types.ai_guardrail_blocked_messaging.AIGuardrailBlockedMessaging"
    )
    """<p>The message to return when the AI Guardrail blocks a model response.</p>"""
    description: NotRequired[
        "capo_qconnect.types.ai_guardrail_description.AIGuardrailDescription"
    ]
    """<p>A description of the AI Guardrail.</p>"""
    topic_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_topic_policy_config.AIGuardrailTopicPolicyConfig"
    ]
    """<p>Contains details about topics that the AI Guardrail should identify and deny.</p>"""
    content_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_content_policy_config.AIGuardrailContentPolicyConfig"
    ]
    """<p>Contains details about how to handle harmful content.</p>"""
    word_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_word_policy_config.AIGuardrailWordPolicyConfig"
    ]
    """<p>Contains details about the word policy to configured for the AI Guardrail.</p>"""
    sensitive_information_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_sensitive_information_policy_config.AIGuardrailSensitiveInformationPolicyConfig"
    ]
    """<p>Contains details about PII entities and regular expressions to configure for the AI Guardrail.</p>"""
    contextual_grounding_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_contextual_grounding_policy_config.AIGuardrailContextualGroundingPolicyConfig"
    ]
    """<p>The policy configuration details for the AI Guardrail's contextual grounding policy.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    status: NotRequired["capo_qconnect.types.status.Status"]
    """<p>The status of the AI Guardrail.</p>"""
    modified_time: NotRequired["datetime.datetime"]
    """<p>The time the AI Guardrail was last modified.</p>"""