1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wisdom
  5. getAiGuardrail

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.wisdom.getAiGuardrail

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Definition of AWS::Wisdom::AIGuardrail Resource Type

Using getAiGuardrail

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAiGuardrail(args: GetAiGuardrailArgs, opts?: InvokeOptions): Promise<GetAiGuardrailResult>
function getAiGuardrailOutput(args: GetAiGuardrailOutputArgs, opts?: InvokeOptions): Output<GetAiGuardrailResult>
Copy
def get_ai_guardrail(ai_guardrail_id: Optional[str] = None,
                     assistant_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAiGuardrailResult
def get_ai_guardrail_output(ai_guardrail_id: Optional[pulumi.Input[str]] = None,
                     assistant_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAiGuardrailResult]
Copy
func LookupAiGuardrail(ctx *Context, args *LookupAiGuardrailArgs, opts ...InvokeOption) (*LookupAiGuardrailResult, error)
func LookupAiGuardrailOutput(ctx *Context, args *LookupAiGuardrailOutputArgs, opts ...InvokeOption) LookupAiGuardrailResultOutput
Copy

> Note: This function is named LookupAiGuardrail in the Go SDK.

public static class GetAiGuardrail 
{
    public static Task<GetAiGuardrailResult> InvokeAsync(GetAiGuardrailArgs args, InvokeOptions? opts = null)
    public static Output<GetAiGuardrailResult> Invoke(GetAiGuardrailInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAiGuardrailResult> getAiGuardrail(GetAiGuardrailArgs args, InvokeOptions options)
public static Output<GetAiGuardrailResult> getAiGuardrail(GetAiGuardrailArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:wisdom:getAiGuardrail
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AiGuardrailId This property is required. string
The identifier of the Amazon Q in Connect AI Guardrail.
AssistantId This property is required. string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
AiGuardrailId This property is required. string
The identifier of the Amazon Q in Connect AI Guardrail.
AssistantId This property is required. string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
aiGuardrailId This property is required. String
The identifier of the Amazon Q in Connect AI Guardrail.
assistantId This property is required. String
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
aiGuardrailId This property is required. string
The identifier of the Amazon Q in Connect AI Guardrail.
assistantId This property is required. string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
ai_guardrail_id This property is required. str
The identifier of the Amazon Q in Connect AI Guardrail.
assistant_id This property is required. str
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
aiGuardrailId This property is required. String
The identifier of the Amazon Q in Connect AI Guardrail.
assistantId This property is required. String
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

getAiGuardrail Result

The following output properties are available:

AiGuardrailArn string
The Amazon Resource Name (ARN) of the AI Guardrail.
AiGuardrailId string
The identifier of the Amazon Q in Connect AI Guardrail.
AssistantArn string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
BlockedInputMessaging string
Messaging for when violations are detected in text
BlockedOutputsMessaging string
Messaging for when violations are detected in text
ContentPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailContentPolicyConfig
Contains details about how to handle harmful content.
ContextualGroundingPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailContextualGroundingPolicyConfig
The policy configuration details for the AI Guardrail's contextual grounding policy.
Description string
Description of the guardrail or its version
SensitiveInformationPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
TopicPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailTopicPolicyConfig
Contains details about topics that the AI Guardrail should identify and deny.
WordPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailWordPolicyConfig
Contains details about the word policy to configured for the AI Guardrail.
AiGuardrailArn string
The Amazon Resource Name (ARN) of the AI Guardrail.
AiGuardrailId string
The identifier of the Amazon Q in Connect AI Guardrail.
AssistantArn string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
BlockedInputMessaging string
Messaging for when violations are detected in text
BlockedOutputsMessaging string
Messaging for when violations are detected in text
ContentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfig
Contains details about how to handle harmful content.
ContextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfig
The policy configuration details for the AI Guardrail's contextual grounding policy.
Description string
Description of the guardrail or its version
SensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
TopicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfig
Contains details about topics that the AI Guardrail should identify and deny.
WordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfig
Contains details about the word policy to configured for the AI Guardrail.
aiGuardrailArn String
The Amazon Resource Name (ARN) of the AI Guardrail.
aiGuardrailId String
The identifier of the Amazon Q in Connect AI Guardrail.
assistantArn String
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
blockedInputMessaging String
Messaging for when violations are detected in text
blockedOutputsMessaging String
Messaging for when violations are detected in text
contentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfig
Contains details about how to handle harmful content.
contextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfig
The policy configuration details for the AI Guardrail's contextual grounding policy.
description String
Description of the guardrail or its version
sensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
topicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfig
Contains details about topics that the AI Guardrail should identify and deny.
wordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfig
Contains details about the word policy to configured for the AI Guardrail.
aiGuardrailArn string
The Amazon Resource Name (ARN) of the AI Guardrail.
aiGuardrailId string
The identifier of the Amazon Q in Connect AI Guardrail.
assistantArn string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
blockedInputMessaging string
Messaging for when violations are detected in text
blockedOutputsMessaging string
Messaging for when violations are detected in text
contentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfig
Contains details about how to handle harmful content.
contextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfig
The policy configuration details for the AI Guardrail's contextual grounding policy.
description string
Description of the guardrail or its version
sensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
topicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfig
Contains details about topics that the AI Guardrail should identify and deny.
wordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfig
Contains details about the word policy to configured for the AI Guardrail.
ai_guardrail_arn str
The Amazon Resource Name (ARN) of the AI Guardrail.
ai_guardrail_id str
The identifier of the Amazon Q in Connect AI Guardrail.
assistant_arn str
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
blocked_input_messaging str
Messaging for when violations are detected in text
blocked_outputs_messaging str
Messaging for when violations are detected in text
content_policy_config AiGuardrailAiGuardrailContentPolicyConfig
Contains details about how to handle harmful content.
contextual_grounding_policy_config AiGuardrailAiGuardrailContextualGroundingPolicyConfig
The policy configuration details for the AI Guardrail's contextual grounding policy.
description str
Description of the guardrail or its version
sensitive_information_policy_config AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
topic_policy_config AiGuardrailAiGuardrailTopicPolicyConfig
Contains details about topics that the AI Guardrail should identify and deny.
word_policy_config AiGuardrailAiGuardrailWordPolicyConfig
Contains details about the word policy to configured for the AI Guardrail.
aiGuardrailArn String
The Amazon Resource Name (ARN) of the AI Guardrail.
aiGuardrailId String
The identifier of the Amazon Q in Connect AI Guardrail.
assistantArn String
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
blockedInputMessaging String
Messaging for when violations are detected in text
blockedOutputsMessaging String
Messaging for when violations are detected in text
contentPolicyConfig Property Map
Contains details about how to handle harmful content.
contextualGroundingPolicyConfig Property Map
The policy configuration details for the AI Guardrail's contextual grounding policy.
description String
Description of the guardrail or its version
sensitiveInformationPolicyConfig Property Map
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
topicPolicyConfig Property Map
Contains details about topics that the AI Guardrail should identify and deny.
wordPolicyConfig Property Map
Contains details about the word policy to configured for the AI Guardrail.

Supporting Types

AiGuardrailAiGuardrailContentPolicyConfig

FiltersConfig This property is required. List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailContentFilterConfig>
List of content filter configs in content policy.
FiltersConfig This property is required. []AiGuardrailGuardrailContentFilterConfig
List of content filter configs in content policy.
filtersConfig This property is required. List<AiGuardrailGuardrailContentFilterConfig>
List of content filter configs in content policy.
filtersConfig This property is required. AiGuardrailGuardrailContentFilterConfig[]
List of content filter configs in content policy.
filters_config This property is required. Sequence[AiGuardrailGuardrailContentFilterConfig]
List of content filter configs in content policy.
filtersConfig This property is required. List<Property Map>
List of content filter configs in content policy.

AiGuardrailAiGuardrailContextualGroundingPolicyConfig

FiltersConfig This property is required. List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailContextualGroundingFilterConfig>
List of contextual grounding filter configs.
FiltersConfig This property is required. []AiGuardrailGuardrailContextualGroundingFilterConfig
List of contextual grounding filter configs.
filtersConfig This property is required. List<AiGuardrailGuardrailContextualGroundingFilterConfig>
List of contextual grounding filter configs.
filtersConfig This property is required. AiGuardrailGuardrailContextualGroundingFilterConfig[]
List of contextual grounding filter configs.
filters_config This property is required. Sequence[AiGuardrailGuardrailContextualGroundingFilterConfig]
List of contextual grounding filter configs.
filtersConfig This property is required. List<Property Map>
List of contextual grounding filter configs.

AiGuardrailAiGuardrailSensitiveInformationPolicyConfig

AiGuardrailAiGuardrailTopicPolicyConfig

TopicsConfig This property is required. List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailTopicConfig>
List of topic configs in topic policy.
TopicsConfig This property is required. []AiGuardrailGuardrailTopicConfig
List of topic configs in topic policy.
topicsConfig This property is required. List<AiGuardrailGuardrailTopicConfig>
List of topic configs in topic policy.
topicsConfig This property is required. AiGuardrailGuardrailTopicConfig[]
List of topic configs in topic policy.
topics_config This property is required. Sequence[AiGuardrailGuardrailTopicConfig]
List of topic configs in topic policy.
topicsConfig This property is required. List<Property Map>
List of topic configs in topic policy.

AiGuardrailAiGuardrailWordPolicyConfig

managedWordListsConfig List<Property Map>
A config for the list of managed words.
wordsConfig List<Property Map>
List of custom word configs.

AiGuardrailGuardrailContentFilterConfig

InputStrength This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailFilterStrength
The strength of the input for the guardrail content filter.
OutputStrength This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailFilterStrength
The output strength of the guardrail content filter.
Type This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailContentFilterType
The type of the guardrail content filter.
InputStrength This property is required. AiGuardrailGuardrailFilterStrength
The strength of the input for the guardrail content filter.
OutputStrength This property is required. AiGuardrailGuardrailFilterStrength
The output strength of the guardrail content filter.
Type This property is required. AiGuardrailGuardrailContentFilterType
The type of the guardrail content filter.
inputStrength This property is required. AiGuardrailGuardrailFilterStrength
The strength of the input for the guardrail content filter.
outputStrength This property is required. AiGuardrailGuardrailFilterStrength
The output strength of the guardrail content filter.
type This property is required. AiGuardrailGuardrailContentFilterType
The type of the guardrail content filter.
inputStrength This property is required. AiGuardrailGuardrailFilterStrength
The strength of the input for the guardrail content filter.
outputStrength This property is required. AiGuardrailGuardrailFilterStrength
The output strength of the guardrail content filter.
type This property is required. AiGuardrailGuardrailContentFilterType
The type of the guardrail content filter.
input_strength This property is required. AiGuardrailGuardrailFilterStrength
The strength of the input for the guardrail content filter.
output_strength This property is required. AiGuardrailGuardrailFilterStrength
The output strength of the guardrail content filter.
type This property is required. AiGuardrailGuardrailContentFilterType
The type of the guardrail content filter.
inputStrength This property is required. "NONE" | "LOW" | "MEDIUM" | "HIGH"
The strength of the input for the guardrail content filter.
outputStrength This property is required. "NONE" | "LOW" | "MEDIUM" | "HIGH"
The output strength of the guardrail content filter.
type This property is required. "SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"
The type of the guardrail content filter.

AiGuardrailGuardrailContentFilterType

AiGuardrailGuardrailContextualGroundingFilterConfig

Threshold This property is required. double
The threshold for this filter.
Type This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailContextualGroundingFilterType
The type of this filter.
Threshold This property is required. float64
The threshold for this filter.
Type This property is required. AiGuardrailGuardrailContextualGroundingFilterType
The type of this filter.
threshold This property is required. Double
The threshold for this filter.
type This property is required. AiGuardrailGuardrailContextualGroundingFilterType
The type of this filter.
threshold This property is required. number
The threshold for this filter.
type This property is required. AiGuardrailGuardrailContextualGroundingFilterType
The type of this filter.
threshold This property is required. float
The threshold for this filter.
type This property is required. AiGuardrailGuardrailContextualGroundingFilterType
The type of this filter.
threshold This property is required. Number
The threshold for this filter.
type This property is required. "GROUNDING" | "RELEVANCE"
The type of this filter.

AiGuardrailGuardrailContextualGroundingFilterType

AiGuardrailGuardrailFilterStrength

AiGuardrailGuardrailManagedWordsConfig

Type This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailManagedWordsType
The type of guardrail managed words.
Type This property is required. AiGuardrailGuardrailManagedWordsType
The type of guardrail managed words.
type This property is required. AiGuardrailGuardrailManagedWordsType
The type of guardrail managed words.
type This property is required. AiGuardrailGuardrailManagedWordsType
The type of guardrail managed words.
type This property is required. AiGuardrailGuardrailManagedWordsType
The type of guardrail managed words.
type This property is required. "PROFANITY"
The type of guardrail managed words.

AiGuardrailGuardrailManagedWordsType

AiGuardrailGuardrailPiiEntityConfig

Action This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailSensitiveInformationAction
The action of guardrail PII entity configuration.
Type This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailPiiEntityType
Action This property is required. AiGuardrailGuardrailSensitiveInformationAction
The action of guardrail PII entity configuration.
Type This property is required. AiGuardrailGuardrailPiiEntityType
action This property is required. AiGuardrailGuardrailSensitiveInformationAction
The action of guardrail PII entity configuration.
type This property is required. AiGuardrailGuardrailPiiEntityType
action This property is required. AiGuardrailGuardrailSensitiveInformationAction
The action of guardrail PII entity configuration.
type This property is required. AiGuardrailGuardrailPiiEntityType
action This property is required. AiGuardrailGuardrailSensitiveInformationAction
The action of guardrail PII entity configuration.
type This property is required. AiGuardrailGuardrailPiiEntityType
action This property is required. "BLOCK" | "ANONYMIZE"
The action of guardrail PII entity configuration.
type This property is required. "ADDRESS" | "AGE" | "AWS_ACCESS_KEY" | "AWS_SECRET_KEY" | "CA_HEALTH_NUMBER" | "CA_SOCIAL_INSURANCE_NUMBER" | "CREDIT_DEBIT_CARD_CVV" | "CREDIT_DEBIT_CARD_EXPIRY" | "CREDIT_DEBIT_CARD_NUMBER" | "DRIVER_ID" | "EMAIL" | "INTERNATIONAL_BANK_ACCOUNT_NUMBER" | "IP_ADDRESS" | "LICENSE_PLATE" | "MAC_ADDRESS" | "NAME" | "PASSWORD" | "PHONE" | "PIN" | "SWIFT_CODE" | "UK_NATIONAL_HEALTH_SERVICE_NUMBER" | "UK_NATIONAL_INSURANCE_NUMBER" | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" | "URL" | "USERNAME" | "US_BANK_ACCOUNT_NUMBER" | "US_BANK_ROUTING_NUMBER" | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" | "US_PASSPORT_NUMBER" | "US_SOCIAL_SECURITY_NUMBER" | "VEHICLE_IDENTIFICATION_NUMBER"

AiGuardrailGuardrailPiiEntityType

AiGuardrailGuardrailRegexConfig

Action This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailSensitiveInformationAction
The action of the guardrail regex configuration.
Name This property is required. string
The regex name.
Pattern This property is required. string
The regex pattern.
Description string
The regex description.
Action This property is required. AiGuardrailGuardrailSensitiveInformationAction
The action of the guardrail regex configuration.
Name This property is required. string
The regex name.
Pattern This property is required. string
The regex pattern.
Description string
The regex description.
action This property is required. AiGuardrailGuardrailSensitiveInformationAction
The action of the guardrail regex configuration.
name This property is required. String
The regex name.
pattern This property is required. String
The regex pattern.
description String
The regex description.
action This property is required. AiGuardrailGuardrailSensitiveInformationAction
The action of the guardrail regex configuration.
name This property is required. string
The regex name.
pattern This property is required. string
The regex pattern.
description string
The regex description.
action This property is required. AiGuardrailGuardrailSensitiveInformationAction
The action of the guardrail regex configuration.
name This property is required. str
The regex name.
pattern This property is required. str
The regex pattern.
description str
The regex description.
action This property is required. "BLOCK" | "ANONYMIZE"
The action of the guardrail regex configuration.
name This property is required. String
The regex name.
pattern This property is required. String
The regex pattern.
description String
The regex description.

AiGuardrailGuardrailSensitiveInformationAction

AiGuardrailGuardrailTopicConfig

Definition This property is required. string
Definition of topic in topic policy
Name This property is required. string
Name of topic in topic policy
Type This property is required. Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailTopicType
Type of topic in a policy.
Examples List<string>
List of text examples
Definition This property is required. string
Definition of topic in topic policy
Name This property is required. string
Name of topic in topic policy
Type This property is required. AiGuardrailGuardrailTopicType
Type of topic in a policy.
Examples []string
List of text examples
definition This property is required. String
Definition of topic in topic policy
name This property is required. String
Name of topic in topic policy
type This property is required. AiGuardrailGuardrailTopicType
Type of topic in a policy.
examples List<String>
List of text examples
definition This property is required. string
Definition of topic in topic policy
name This property is required. string
Name of topic in topic policy
type This property is required. AiGuardrailGuardrailTopicType
Type of topic in a policy.
examples string[]
List of text examples
definition This property is required. str
Definition of topic in topic policy
name This property is required. str
Name of topic in topic policy
type This property is required. AiGuardrailGuardrailTopicType
Type of topic in a policy.
examples Sequence[str]
List of text examples
definition This property is required. String
Definition of topic in topic policy
name This property is required. String
Name of topic in topic policy
type This property is required. "DENY"
Type of topic in a policy.
examples List<String>
List of text examples

AiGuardrailGuardrailTopicType

AiGuardrailGuardrailWordConfig

Text This property is required. string
The custom word text.
Text This property is required. string
The custom word text.
text This property is required. String
The custom word text.
text This property is required. string
The custom word text.
text This property is required. str
The custom word text.
text This property is required. String
The custom word text.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi