Skip to content

ApplyGuardrailRequest

Source code in docs_src/capo_bedrock_runtime/types/apply_guardrail_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ApplyGuardrailRequest(TypedDict, closed=True):
    guardrail_identifier: (
        "capo_bedrock_runtime.types.guardrail_identifier.GuardrailIdentifier"
    )
    """<p>The guardrail identifier used in the request to apply the guardrail.</p>"""
    guardrail_version: "capo_bedrock_runtime.types.guardrail_version.GuardrailVersion"
    """<p>The guardrail version used in the request to apply the guardrail.</p>"""
    source: "capo_bedrock_runtime.types.guardrail_content_source.GuardrailContentSource"
    """<p>The source of data used in the request to apply the guardrail.</p>"""
    content: "capo_bedrock_runtime.types.guardrail_content_block_list.GuardrailContentBlockList"
    """<p>The content details used in the request to apply the guardrail.</p>"""
    output_scope: NotRequired[
        "capo_bedrock_runtime.types.guardrail_output_scope.GuardrailOutputScope"
    ]
    """<p>Specifies the scope of the output that you get in the response. Set to <code>FULL</code> to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.</p> <p>Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).</p>"""

content instance-attribute 

content: GuardrailContentBlockList

The content details used in the request to apply the guardrail.

guardrail_identifier instance-attribute 

guardrail_identifier: GuardrailIdentifier

The guardrail identifier used in the request to apply the guardrail.

guardrail_version instance-attribute 

guardrail_version: GuardrailVersion

The guardrail version used in the request to apply the guardrail.

output_scope instance-attribute 

output_scope: NotRequired[GuardrailOutputScope]

Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.

Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).

source instance-attribute 

source: GuardrailContentSource

The source of data used in the request to apply the guardrail.