Skip to content

UpdateGuardrailRequest

Source code in docs_src/capo_bedrock/types/update_guardrail_request.py
class UpdateGuardrailRequest(TypedDict, closed=True):
    guardrail_identifier: "capo_bedrock.types.guardrail_identifier.GuardrailIdentifier"
    """<p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>"""
    name: "capo_bedrock.types.guardrail_name.GuardrailName"
    """<p>A name for the guardrail.</p>"""
    description: NotRequired[
        "capo_bedrock.types.guardrail_description.GuardrailDescription"
    ]
    """<p>A description of the guardrail.</p>"""
    topic_policy_config: NotRequired[
        "capo_bedrock.types.guardrail_topic_policy_config.GuardrailTopicPolicyConfig"
    ]
    """<p>The topic policy to configure for the guardrail.</p>"""
    content_policy_config: NotRequired[
        "capo_bedrock.types.guardrail_content_policy_config.GuardrailContentPolicyConfig"
    ]
    """<p>The content policy to configure for the guardrail.</p>"""
    word_policy_config: NotRequired[
        "capo_bedrock.types.guardrail_word_policy_config.GuardrailWordPolicyConfig"
    ]
    """<p>The word policy to configure for the guardrail.</p>"""
    sensitive_information_policy_config: NotRequired[
        "capo_bedrock.types.guardrail_sensitive_information_policy_config.GuardrailSensitiveInformationPolicyConfig"
    ]
    """<p>The sensitive information policy to configure for the guardrail.</p>"""
    contextual_grounding_policy_config: NotRequired[
        "capo_bedrock.types.guardrail_contextual_grounding_policy_config.GuardrailContextualGroundingPolicyConfig"
    ]
    """<p>The contextual grounding policy configuration used to update a guardrail.</p>"""
    automated_reasoning_policy_config: NotRequired[
        "capo_bedrock.types.guardrail_automated_reasoning_policy_config.GuardrailAutomatedReasoningPolicyConfig"
    ]
    """<p>Updated configuration for Automated Reasoning policies associated with the guardrail.</p>"""
    cross_region_config: NotRequired[
        "capo_bedrock.types.guardrail_cross_region_config.GuardrailCrossRegionConfig"
    ]
    """<p>The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>"""
    blocked_input_messaging: (
        "capo_bedrock.types.guardrail_blocked_messaging.GuardrailBlockedMessaging"
    )
    """<p>The message to return when the guardrail blocks a prompt.</p>"""
    blocked_outputs_messaging: (
        "capo_bedrock.types.guardrail_blocked_messaging.GuardrailBlockedMessaging"
    )
    """<p>The message to return when the guardrail blocks a model response.</p>"""
    kms_key_id: NotRequired["capo_bedrock.types.kms_key_id.KmsKeyId"]
    """<p>The ARN of the KMS key with which to encrypt the guardrail.</p>"""

automated_reasoning_policy_config instance-attribute

automated_reasoning_policy_config: NotRequired[GuardrailAutomatedReasoningPolicyConfig]

Updated configuration for Automated Reasoning policies associated with the guardrail.

blocked_input_messaging instance-attribute

blocked_input_messaging: GuardrailBlockedMessaging

The message to return when the guardrail blocks a prompt.

blocked_outputs_messaging instance-attribute

blocked_outputs_messaging: GuardrailBlockedMessaging

The message to return when the guardrail blocks a model response.

content_policy_config instance-attribute

content_policy_config: NotRequired[GuardrailContentPolicyConfig]

The content policy to configure for the guardrail.

contextual_grounding_policy_config instance-attribute

contextual_grounding_policy_config: NotRequired[
    GuardrailContextualGroundingPolicyConfig
]

The contextual grounding policy configuration used to update a guardrail.

cross_region_config instance-attribute

cross_region_config: NotRequired[GuardrailCrossRegionConfig]

The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

description instance-attribute

description: NotRequired[GuardrailDescription]

A description of the guardrail.

guardrail_identifier instance-attribute

guardrail_identifier: GuardrailIdentifier

The unique identifier of the guardrail. This can be an ID or the ARN.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The ARN of the KMS key with which to encrypt the guardrail.

name instance-attribute

A name for the guardrail.

sensitive_information_policy_config instance-attribute

sensitive_information_policy_config: NotRequired[
    GuardrailSensitiveInformationPolicyConfig
]

The sensitive information policy to configure for the guardrail.

topic_policy_config instance-attribute

topic_policy_config: NotRequired[GuardrailTopicPolicyConfig]

The topic policy to configure for the guardrail.

word_policy_config instance-attribute

word_policy_config: NotRequired[GuardrailWordPolicyConfig]

The word policy to configure for the guardrail.