AWS::Wisdom::AIPrompt - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Wisdom::AIPrompt

Creates an Amazon Q in Connect AI Prompt.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Wisdom::AIPrompt", "Properties" : { "ApiFormat" : String, "AssistantId" : String, "Description" : String, "ModelId" : String, "Name" : String, "Tags" : {Key: Value, ...}, "TemplateConfiguration" : AIPromptTemplateConfiguration, "TemplateType" : String, "Type" : String } }

YAML

Type: AWS::Wisdom::AIPrompt Properties: ApiFormat: String AssistantId: String Description: String ModelId: String Name: String Tags: Key: Value TemplateConfiguration: AIPromptTemplateConfiguration TemplateType: String Type: String

Properties

ApiFormat

The API format used for this AI Prompt.

Required: Yes

Type: String

Allowed values: ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS

Update requires: Replacement

AssistantId

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Required: No

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^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}$

Update requires: Replacement

Description

The description of the AI Prompt.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: No interruption

ModelId

The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

Name

The name of the AI Prompt

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

The tags used to organize, track, or control access for this resource.

Required: No

Type: Object of String

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Minimum: 1

Maximum: 256

Update requires: Replacement

TemplateConfiguration

The configuration of the prompt template for this AI Prompt.

Required: Yes

Type: AIPromptTemplateConfiguration

Update requires: No interruption

TemplateType

The type of the prompt template for this AI Prompt.

Required: Yes

Type: String

Allowed values: TEXT

Update requires: Replacement

Type

The type of this AI Prompt.

Required: Yes

Type: String

Allowed values: ANSWER_GENERATION | INTENT_LABELING_GENERATION | QUERY_REFORMULATION | SELF_SERVICE_PRE_PROCESSING | SELF_SERVICE_ANSWER_GENERATION

Update requires: Replacement

Return values

Ref

Fn::GetAtt

AIPromptArn

The Amazon Resource Name (ARN) of the AI Prompt.

AIPromptId

The identifier of the Amazon Q in Connect AI prompt.

AssistantArn

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

ModifiedTimeSeconds

Property description not available.