GetGuardrailResponse ¶

class GetGuardrailResponse(TypedDict, closed=True):
    name: "capo_bedrock.types.guardrail_name.GuardrailName"
    """<p>The name of the guardrail.</p>"""
    description: NotRequired[
        "capo_bedrock.types.guardrail_description.GuardrailDescription"
    ]
    """<p>The description of the guardrail.</p>"""
    guardrail_id: "capo_bedrock.types.guardrail_id.GuardrailId"
    """<p>The unique identifier of the guardrail.</p>"""
    guardrail_arn: "capo_bedrock.types.guardrail_arn.GuardrailArn"
    """<p>The ARN of the guardrail.</p>"""
    version: "capo_bedrock.types.guardrail_version.GuardrailVersion"
    """<p>The version of the guardrail.</p>"""
    status: "capo_bedrock.types.guardrail_status.GuardrailStatus"
    """<p>The status of the guardrail.</p>"""
    topic_policy: NotRequired[
        "capo_bedrock.types.guardrail_topic_policy.GuardrailTopicPolicy"
    ]
    """<p>The topic policy that was configured for the guardrail.</p>"""
    content_policy: NotRequired[
        "capo_bedrock.types.guardrail_content_policy.GuardrailContentPolicy"
    ]
    """<p>The content policy that was configured for the guardrail.</p>"""
    word_policy: NotRequired[
        "capo_bedrock.types.guardrail_word_policy.GuardrailWordPolicy"
    ]
    """<p>The word policy that was configured for the guardrail.</p>"""
    sensitive_information_policy: NotRequired[
        "capo_bedrock.types.guardrail_sensitive_information_policy.GuardrailSensitiveInformationPolicy"
    ]
    """<p>The sensitive information policy that was configured for the guardrail.</p>"""
    contextual_grounding_policy: NotRequired[
        "capo_bedrock.types.guardrail_contextual_grounding_policy.GuardrailContextualGroundingPolicy"
    ]
    """<p>The contextual grounding policy used in the guardrail.</p>"""
    automated_reasoning_policy: NotRequired[
        "capo_bedrock.types.guardrail_automated_reasoning_policy.GuardrailAutomatedReasoningPolicy"
    ]
    """<p>The current Automated Reasoning policy configuration for the guardrail, if any is configured.</p>"""
    cross_region_details: NotRequired[
        "capo_bedrock.types.guardrail_cross_region_details.GuardrailCrossRegionDetails"
    ]
    """<p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>"""
    created_at: "capo_bedrock.types.timestamp.Timestamp"
    """<p>The date and time at which the guardrail was created.</p>"""
    updated_at: "capo_bedrock.types.timestamp.Timestamp"
    """<p>The date and time at which the guardrail was updated.</p>"""
    status_reasons: NotRequired[
        "capo_bedrock.types.guardrail_status_reasons.GuardrailStatusReasons"
    ]
    """<p>Appears if the <code>status</code> is <code>FAILED</code>. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.</p>"""
    failure_recommendations: NotRequired[
        "capo_bedrock.types.guardrail_failure_recommendations.GuardrailFailureRecommendations"
    ]
    """<p>Appears if the <code>status</code> of the guardrail is <code>FAILED</code>. A list of recommendations to carry out before retrying the request.</p>"""
    blocked_input_messaging: (
        "capo_bedrock.types.guardrail_blocked_messaging.GuardrailBlockedMessaging"
    )
    """<p>The message that the guardrail returns when it blocks a prompt.</p>"""
    blocked_outputs_messaging: (
        "capo_bedrock.types.guardrail_blocked_messaging.GuardrailBlockedMessaging"
    )
    """<p>The message that the guardrail returns when it blocks a model response.</p>"""
    kms_key_arn: NotRequired["capo_bedrock.types.kms_key_arn.KmsKeyArn"]
    """<p>The ARN of the KMS key that encrypts the guardrail.</p>"""