# AIPromptSummary


The summary of the AI Prompt.

## Contents


 ** aiPromptArn **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-aiPromptArn"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-aiPromptId"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-apiFormat"></a>
The API format used for this AI Prompt.  
Type: String  
Valid Values: `ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS | MESSAGES | TEXT_COMPLETIONS`   
Required: Yes

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-assistantArn"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-assistantId"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-modelId"></a>
The identifier of the model used for this AI Prompt. Model Ids supported are: `anthropic.claude-3-haiku-20240307-v1:0`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-name"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-templateType"></a>
The type of the prompt template for this AI Prompt.  
Type: String  
Valid Values: `TEXT`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-type"></a>
The type of this AI Prompt.  
Type: String  
Valid Values: `ANSWER_GENERATION | INTENT_LABELING_GENERATION | QUERY_REFORMULATION | SELF_SERVICE_PRE_PROCESSING | SELF_SERVICE_ANSWER_GENERATION | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | EMAIL_QUERY_REFORMULATION | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** visibilityStatus **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-visibilityStatus"></a>
The visibility status of the AI Prompt.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-description"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-modifiedTime"></a>
The time the AI Prompt was last modified.  
Type: Timestamp  
Required: No

 ** origin **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-origin"></a>
The origin of the AI Prompt. `SYSTEM` for a default AI Prompt created by Q in Connect or `CUSTOMER` for an AI Prompt created by calling AI Prompt creation APIs.   
Type: String  
Valid Values: `SYSTEM | CUSTOMER`   
Required: No

 ** status **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-status"></a>
The status of the AI Prompt.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-tags"></a>
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:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIPromptSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIPromptSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIPromptSummary)