AIPromptSummary
The summary of the AI Prompt.
Contents
- aiPromptArn
-
The Amazon Resource Name (ARN) of the AI Prompt.
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
- aiPromptId
-
The identifier of the Amazon Q in Connect AI prompt.
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
- apiFormat
-
The API format used for this AI Prompt.
Type: String
Valid Values:
ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONSRequired: 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
- modelId
-
The identifier of the model used for this AI Prompt. Model Ids supported are:
CLAUDE_3_HAIKU_20240307_V1.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- name
-
The name of the AI Prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: Yes
- templateType
-
The type of the prompt template for this AI Prompt.
Type: String
Valid Values:
TEXTRequired: Yes
- type
-
The type of this AI Prompt.
Type: String
Valid Values:
ANSWER_GENERATION | INTENT_LABELING_GENERATION | QUERY_REFORMULATIONRequired: Yes
- visibilityStatus
-
The visibility status of the AI Prompt.
Type: String
Valid Values:
SAVED | PUBLISHEDRequired: Yes
- description
-
The description of the AI Prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: No
- modifiedTime
-
The time the AI Prompt was last modified.
Type: Timestamp
Required: No
- origin
-
The origin of the AI Prompt.
SYSTEMfor a default AI Prompt created by Q in Connect orCUSTOMERfor an AI Prompt created by calling AI Prompt creation APIs.Type: String
Valid Values:
SYSTEM | CUSTOMERRequired: No
- status
-
The status of the AI Prompt.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
