CreateAIGuardrailRequest ¶

class CreateAIGuardrailRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_qconnect.types.client_token.ClientToken"]
    """<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>"""
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name 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>"""
    visibility_status: "capo_qconnect.types.visibility_status.VisibilityStatus"
    """<p>The visibility status of the AI Guardrail.</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>The topic policies to configure for the AI Guardrail.</p>"""
    content_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_content_policy_config.AIGuardrailContentPolicyConfig"
    ]
    """<p>The content filter policies to configure for the AI Guardrail.</p>"""
    word_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_word_policy_config.AIGuardrailWordPolicyConfig"
    ]
    """<p>The word policy you configure for the AI Guardrail.</p>"""
    sensitive_information_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_sensitive_information_policy_config.AIGuardrailSensitiveInformationPolicyConfig"
    ]
    """<p>The sensitive information policy to configure for the AI Guardrail.</p>"""
    contextual_grounding_policy_config: NotRequired[
        "capo_qconnect.types.ai_guardrail_contextual_grounding_policy_config.AIGuardrailContextualGroundingPolicyConfig"
    ]
    """<p>The contextual grounding policy configuration used to create an AI Guardrail.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""