AIGuardrailData
The data for the AI Guardrail
Contents
- aiGuardrailArn
-
The Amazon Resource Name (ARN) of the AI Guardrail.
Type: String
Pattern:
^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$Required: Yes
- aiGuardrailId
-
The identifier of the Amazon Q in Connect AI Guardrail.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- assistantArn
-
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Type: String
Pattern:
^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$Required: Yes
- assistantId
-
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- blockedInputMessaging
-
The message to return when the AI Guardrail blocks a prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
- blockedOutputsMessaging
-
The message to return when the AI Guardrail blocks a model response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
- name
-
The name of the AI Guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: Yes
- visibilityStatus
-
The visibility status of the AI Guardrail.
Type: String
Valid Values:
SAVED | PUBLISHEDRequired: Yes
- contentPolicyConfig
-
Contains details about how to handle harmful content.
Type: AIGuardrailContentPolicyConfig object
Required: No
- contextualGroundingPolicyConfig
-
The policy configuration details for the AI Guardrail's contextual grounding policy.
Type: AIGuardrailContextualGroundingPolicyConfig object
Required: No
- description
-
A description of the AI Guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
- modifiedTime
-
The time the AI Guardrail was last modified.
Type: Timestamp
Required: No
- sensitiveInformationPolicyConfig
-
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
Type: AIGuardrailSensitiveInformationPolicyConfig object
Required: No
- status
-
The status of the AI Guardrail.
Type: String
Valid Values:
CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETEDRequired: No
-
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- topicPolicyConfig
-
Contains details about topics that the AI Guardrail should identify and deny.
Type: AIGuardrailTopicPolicyConfig object
Required: No
- wordPolicyConfig
-
Contains details about the word policy to configured for the AI Guardrail.
Type: AIGuardrailWordPolicyConfig object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
