@pulumi/aws-native/wisdom/getAiGuardrail.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Definition of AWS::Wisdom::AIGuardrail Resource Type
 */
export declare function getAiGuardrail(args: GetAiGuardrailArgs, opts?: pulumi.InvokeOptions): Promise<GetAiGuardrailResult>;
export interface GetAiGuardrailArgs {
    /**
     * The identifier of the Amazon Q in Connect AI Guardrail.
     */
    aiGuardrailId: string;
    /**
     * The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
     */
    assistantId: string;
}
export interface GetAiGuardrailResult {
    /**
     * The Amazon Resource Name (ARN) of the AI Guardrail.
     */
    readonly aiGuardrailArn?: string;
    /**
     * The identifier of the Amazon Q in Connect AI Guardrail.
     */
    readonly aiGuardrailId?: string;
    /**
     * The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
     */
    readonly assistantArn?: string;
    /**
     * Messaging for when violations are detected in text
     */
    readonly blockedInputMessaging?: string;
    /**
     * Messaging for when violations are detected in text
     */
    readonly blockedOutputsMessaging?: string;
    /**
     * Contains details about how to handle harmful content.
     */
    readonly contentPolicyConfig?: outputs.wisdom.AiGuardrailAiGuardrailContentPolicyConfig;
    /**
     * The policy configuration details for the AI Guardrail's contextual grounding policy.
     */
    readonly contextualGroundingPolicyConfig?: outputs.wisdom.AiGuardrailAiGuardrailContextualGroundingPolicyConfig;
    /**
     * Description of the guardrail or its version
     */
    readonly description?: string;
    /**
     * Contains details about PII entities and regular expressions to configure for the AI Guardrail.
     */
    readonly sensitiveInformationPolicyConfig?: outputs.wisdom.AiGuardrailAiGuardrailSensitiveInformationPolicyConfig;
    /**
     * Contains details about topics that the AI Guardrail should identify and deny.
     */
    readonly topicPolicyConfig?: outputs.wisdom.AiGuardrailAiGuardrailTopicPolicyConfig;
    /**
     * Contains details about the word policy to configured for the AI Guardrail.
     */
    readonly wordPolicyConfig?: outputs.wisdom.AiGuardrailAiGuardrailWordPolicyConfig;
}
/**
 * Definition of AWS::Wisdom::AIGuardrail Resource Type
 */
export declare function getAiGuardrailOutput(args: GetAiGuardrailOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAiGuardrailResult>;
export interface GetAiGuardrailOutputArgs {
    /**
     * The identifier of the Amazon Q in Connect AI Guardrail.
     */
    aiGuardrailId: pulumi.Input<string>;
    /**
     * The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
     */
    assistantId: pulumi.Input<string>;
}