Skip to content
AWS for Query.Farm

aws.bedrock.get_guardrail

Example SQL Queries

SELECT * FROM
aws.bedrock.get_guardrail
WHERE
"guardrail_identifier" = 'VALUE';

Description

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

Table Definition

Column NameColumn Data Type
guardrail_identifier Required Input Column

The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

VARCHAR
guardrail_version Input Column

The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
blocked_input_messaging

The message that the guardrail returns when it blocks a prompt.

VARCHAR
blocked_outputs_messaging

The message that the guardrail returns when it blocks a model response.

VARCHAR
content_policy

The content policy that was configured for the guardrail.

STRUCT(
    "filters" STRUCT(
        "type" VARCHAR,
        "input_strength" VARCHAR,
        "output_strength" VARCHAR
    )[]
)
Show child fields
content_policy.filters[]
Show child fields
content_policy.filters[].input_strength

The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

content_policy.filters[].output_strength

The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

content_policy.filters[].type

The harmful category that the content filter is applied to.

contextual_grounding_policy

The contextual grounding policy used in the guardrail.

STRUCT(
    "filters" STRUCT(
        "type" VARCHAR,
        "threshold" DOUBLE
    )[]
)
Show child fields
contextual_grounding_policy.filters[]
Show child fields
contextual_grounding_policy.filters[].threshold

The threshold details for the guardrails contextual grounding filter.

contextual_grounding_policy.filters[].type

The filter type details for the guardrails contextual grounding filter.

created_at

The date and time at which the guardrail was created.

TIMESTAMP_S
description

The description of the guardrail.

VARCHAR
failure_recommendations

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

VARCHAR[]
Show child fields
failure_recommendations[]
guardrail_arn

The ARN of the guardrail.

VARCHAR
guardrail_id

The unique identifier of the guardrail.

VARCHAR
kms_key_arn

The ARN of the KMS key that encrypts the guardrail.

VARCHAR
name

The name of the guardrail.

VARCHAR
sensitive_information_policy

The sensitive information policy that was configured for the guardrail.

STRUCT(
    "pii_entities" STRUCT(
        "type" VARCHAR,
        "action" VARCHAR
    )[],
    "regexes" STRUCT(
        "name" VARCHAR,
        "description" VARCHAR,
        "pattern" VARCHAR,
        "action" VARCHAR
    )[]
)
Show child fields
sensitive_information_policy.pii_entities[]
Show child fields
sensitive_information_policy.pii_entities[].action

The configured guardrail action when PII entity is detected.

sensitive_information_policy.pii_entities[].type

The type of PII entity. For exampvle, Social Security Number.

sensitive_information_policy.regexes[]
Show child fields
sensitive_information_policy.regexes[].action

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

sensitive_information_policy.regexes[].description

The description of the regular expression for the guardrail.

sensitive_information_policy.regexes[].name

The name of the regular expression for the guardrail.

sensitive_information_policy.regexes[].pattern

The pattern of the regular expression configured for the guardrail.

status

The status of the guardrail.

VARCHAR
status_reasons

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

VARCHAR[]
Show child fields
status_reasons[]
topic_policy

The topic policy that was configured for the guardrail.

STRUCT(
    "topics" STRUCT(
        "name" VARCHAR,
        "definition" VARCHAR,
        "examples" VARCHAR[],
        "type" VARCHAR
    )[]
)
Show child fields
topic_policy.topics[]
Show child fields
topic_policy.topics[].definition

A definition of the topic to deny.

topic_policy.topics[].examples[]
topic_policy.topics[].name

The name of the topic to deny.

topic_policy.topics[].type

Specifies to deny the topic.

updated_at

The date and time at which the guardrail was updated.

TIMESTAMP_S
version

The version of the guardrail.

VARCHAR
word_policy

The word policy that was configured for the guardrail.

STRUCT(
    "words" STRUCT(
        "text" VARCHAR
    )[],
    "managed_word_lists" STRUCT(
        "type" VARCHAR
    )[]
)
Show child fields
word_policy.managed_word_lists[]
Show child fields
word_policy.managed_word_lists[].type

ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)

word_policy.words[]
Show child fields
word_policy.words[].text

Text of the word configured for the guardrail to block.