Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  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.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.wisdom.getAiGuardrail

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    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>
    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]
    func LookupAiGuardrail(ctx *Context, args *LookupAiGuardrailArgs, opts ...InvokeOption) (*LookupAiGuardrailResult, error)
func LookupAiGuardrailOutput(ctx *Context, args *LookupAiGuardrailOutputArgs, opts ...InvokeOption) LookupAiGuardrailResultOutput

    > 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)
}
    public static CompletableFuture<GetAiGuardrailResult> getAiGuardrail(GetAiGuardrailArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:wisdom:getAiGuardrail
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    AssistantId string
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    AiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    AssistantId string
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    aiGuardrailId String
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantId String
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    aiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantId 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 str
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistant_id str
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    aiGuardrailId String
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantId 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 []AiGuardrailGuardrailContentFilterConfig
    List of content filter configs in content policy.
    filtersConfig List<AiGuardrailGuardrailContentFilterConfig>
    List of content filter configs in content policy.
    filtersConfig AiGuardrailGuardrailContentFilterConfig[]
    List of content filter configs in content policy.
    filters_config Sequence[AiGuardrailGuardrailContentFilterConfig]
    List of content filter configs in content policy.
    filtersConfig List<Property Map>
    List of content filter configs in content policy.

    AiGuardrailAiGuardrailContextualGroundingPolicyConfig

    FiltersConfig []AiGuardrailGuardrailContextualGroundingFilterConfig
    List of contextual grounding filter configs.
    filtersConfig AiGuardrailGuardrailContextualGroundingFilterConfig[]
    List of contextual grounding filter configs.
    filtersConfig List<Property Map>
    List of contextual grounding filter configs.

    AiGuardrailAiGuardrailSensitiveInformationPolicyConfig

    AiGuardrailAiGuardrailTopicPolicyConfig

    TopicsConfig []AiGuardrailGuardrailTopicConfig
    List of topic configs in topic policy.
    topicsConfig List<AiGuardrailGuardrailTopicConfig>
    List of topic configs in topic policy.
    topicsConfig AiGuardrailGuardrailTopicConfig[]
    List of topic configs in topic policy.
    topics_config Sequence[AiGuardrailGuardrailTopicConfig]
    List of topic configs in topic policy.
    topicsConfig 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 Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    OutputStrength Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    InputStrength AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    OutputStrength AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    Type AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    inputStrength AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    outputStrength AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    type AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    inputStrength AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    outputStrength AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    type AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    input_strength AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    output_strength AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    type AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    inputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
    The strength of the input for the guardrail content filter.
    outputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
    The output strength of the guardrail content filter.
    type "SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"
    The type of the guardrail content filter.

    AiGuardrailGuardrailContentFilterType

    AiGuardrailGuardrailContextualGroundingFilterConfig

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

    AiGuardrailGuardrailContextualGroundingFilterType

    AiGuardrailGuardrailFilterStrength

    AiGuardrailGuardrailManagedWordsConfig

    Type AiGuardrailGuardrailManagedWordsType
    The type of guardrail managed words.
    type AiGuardrailGuardrailManagedWordsType
    The type of guardrail managed words.
    type AiGuardrailGuardrailManagedWordsType
    The type of guardrail managed words.
    type AiGuardrailGuardrailManagedWordsType
    The type of guardrail managed words.
    type "PROFANITY"
    The type of guardrail managed words.

    AiGuardrailGuardrailManagedWordsType

    AiGuardrailGuardrailPiiEntityConfig

    AiGuardrailGuardrailPiiEntityType

    AiGuardrailGuardrailRegexConfig

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

    AiGuardrailGuardrailSensitiveInformationAction

    AiGuardrailGuardrailTopicConfig

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

    AiGuardrailGuardrailTopicType

    AiGuardrailGuardrailWordConfig

    Text string
    The custom word text.
    Text string
    The custom word text.
    text String
    The custom word text.
    text string
    The custom word text.
    text str
    The custom word text.
    text String
    The custom word text.

    Package Details

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

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

    AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
    pulumi/pulumi-aws-native