Bedrock  >  Structures  >  GuardrailRegex

GuardrailRegex

Structure Class

GuardrailRegex dataclass

The regular expression configured for the guardrail.

Attributes

action instance-attribute

action: GuardrailSensitiveInformationAction

The action taken when a match to the regular expression is detected.

description class-attribute instance-attribute

description: str | None = None

The description of the regular expression for the guardrail.

input_action class-attribute instance-attribute

input_action: GuardrailSensitiveInformationAction | None = None

The action to take when harmful content is detected in the input. Supported values include:

• BLOCK -- Block the content and replace it with blocked messaging.

• NONE -- Take no action but return detection information in the trace response.

input_enabled class-attribute instance-attribute

input_enabled: bool | None = None

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

name instance-attribute

name: str

The name of the regular expression for the guardrail.

output_action class-attribute instance-attribute

output_action: GuardrailSensitiveInformationAction | None = None

The action to take when harmful content is detected in the output. Supported values include:

• BLOCK -- Block the content and replace it with blocked messaging.

• NONE -- Take no action but return detection information in the trace response.

output_enabled class-attribute instance-attribute

output_enabled: bool | None = None

Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

pattern instance-attribute

pattern: str

The pattern of the regular expression configured for the guardrail.