We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Wisdom::AIPrompt Resource Type
Create AiPrompt Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AiPrompt(name: string, args: AiPromptArgs, opts?: CustomResourceOptions);@overload
def AiPrompt(resource_name: str,
args: AiPromptArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AiPrompt(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_format: Optional[AiPromptAiPromptApiFormat] = None,
model_id: Optional[str] = None,
template_configuration: Optional[AiPromptAiPromptTemplateConfigurationArgs] = None,
template_type: Optional[AiPromptAiPromptTemplateType] = None,
type: Optional[AiPromptAiPromptType] = None,
assistant_id: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewAiPrompt(ctx *Context, name string, args AiPromptArgs, opts ...ResourceOption) (*AiPrompt, error)public AiPrompt(string name, AiPromptArgs args, CustomResourceOptions? opts = null)
public AiPrompt(String name, AiPromptArgs args)
public AiPrompt(String name, AiPromptArgs args, CustomResourceOptions options)
type: aws-native:wisdom:AiPrompt
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AiPromptArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AiPromptArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AiPromptArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AiPromptArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AiPromptArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AiPrompt Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AiPrompt resource accepts the following input properties:
- Api
Format Pulumi.Aws Native. Wisdom. Ai Prompt Ai Prompt Api Format - The API format used for this AI Prompt.
- Model
Id string - The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0apac.amazon.nova-lite-v1:0apac.amazon.nova-micro-v1:0apac.amazon.nova-pro-v1:0apac.anthropic.claude-3-5-sonnet--v2:0apac.anthropic.claude-3-haiku-20240307-v1:0eu.amazon.nova-lite-v1:0eu.amazon.nova-micro-v1:0eu.amazon.nova-pro-v1:0eu.anthropic.claude-3-7-sonnet-20250219-v1:0eu.anthropic.claude-3-haiku-20240307-v1:0us.amazon.nova-lite-v1:0us.amazon.nova-micro-v1:0us.amazon.nova-pro-v1:0us.anthropic.claude-3-5-haiku-20241022-v1:0us.anthropic.claude-3-7-sonnet-20250219-v1:0us.anthropic.claude-3-haiku-20240307-v1:0
- Template
Configuration Pulumi.Aws Native. Wisdom. Inputs. Ai Prompt Ai Prompt Template Configuration - The configuration of the prompt template for this AI Prompt.
- Template
Type Pulumi.Aws Native. Wisdom. Ai Prompt Ai Prompt Template Type - The type of the prompt template for this AI Prompt.
- Type
Pulumi.
Aws Native. Wisdom. Ai Prompt Ai Prompt Type - The type of this AI Prompt.
- Assistant
Id string - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- Description string
- The description of the AI Prompt.
- Name string
- The name of the AI Prompt
- Dictionary<string, string>
- The tags used to organize, track, or control access for this resource.
- Api
Format AiPrompt Ai Prompt Api Format - The API format used for this AI Prompt.
- Model
Id string - The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0apac.amazon.nova-lite-v1:0apac.amazon.nova-micro-v1:0apac.amazon.nova-pro-v1:0apac.anthropic.claude-3-5-sonnet--v2:0apac.anthropic.claude-3-haiku-20240307-v1:0eu.amazon.nova-lite-v1:0eu.amazon.nova-micro-v1:0eu.amazon.nova-pro-v1:0eu.anthropic.claude-3-7-sonnet-20250219-v1:0eu.anthropic.claude-3-haiku-20240307-v1:0us.amazon.nova-lite-v1:0us.amazon.nova-micro-v1:0us.amazon.nova-pro-v1:0us.anthropic.claude-3-5-haiku-20241022-v1:0us.anthropic.claude-3-7-sonnet-20250219-v1:0us.anthropic.claude-3-haiku-20240307-v1:0
- Template
Configuration AiPrompt Ai Prompt Template Configuration Args - The configuration of the prompt template for this AI Prompt.
- Template
Type AiPrompt Ai Prompt Template Type - The type of the prompt template for this AI Prompt.
- Type
Ai
Prompt Ai Prompt Type - The type of this AI Prompt.
- Assistant
Id string - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- Description string
- The description of the AI Prompt.
- Name string
- The name of the AI Prompt
- map[string]string
- The tags used to organize, track, or control access for this resource.
- api
Format AiPrompt Ai Prompt Api Format - The API format used for this AI Prompt.
- model
Id String - The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0apac.amazon.nova-lite-v1:0apac.amazon.nova-micro-v1:0apac.amazon.nova-pro-v1:0apac.anthropic.claude-3-5-sonnet--v2:0apac.anthropic.claude-3-haiku-20240307-v1:0eu.amazon.nova-lite-v1:0eu.amazon.nova-micro-v1:0eu.amazon.nova-pro-v1:0eu.anthropic.claude-3-7-sonnet-20250219-v1:0eu.anthropic.claude-3-haiku-20240307-v1:0us.amazon.nova-lite-v1:0us.amazon.nova-micro-v1:0us.amazon.nova-pro-v1:0us.anthropic.claude-3-5-haiku-20241022-v1:0us.anthropic.claude-3-7-sonnet-20250219-v1:0us.anthropic.claude-3-haiku-20240307-v1:0
- template
Configuration AiPrompt Ai Prompt Template Configuration - The configuration of the prompt template for this AI Prompt.
- template
Type AiPrompt Ai Prompt Template Type - The type of the prompt template for this AI Prompt.
- type
Ai
Prompt Ai Prompt Type - The type of this AI Prompt.
- assistant
Id String - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- description String
- The description of the AI Prompt.
- name String
- The name of the AI Prompt
- Map<String,String>
- The tags used to organize, track, or control access for this resource.
- api
Format AiPrompt Ai Prompt Api Format - The API format used for this AI Prompt.
- model
Id string - The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0apac.amazon.nova-lite-v1:0apac.amazon.nova-micro-v1:0apac.amazon.nova-pro-v1:0apac.anthropic.claude-3-5-sonnet--v2:0apac.anthropic.claude-3-haiku-20240307-v1:0eu.amazon.nova-lite-v1:0eu.amazon.nova-micro-v1:0eu.amazon.nova-pro-v1:0eu.anthropic.claude-3-7-sonnet-20250219-v1:0eu.anthropic.claude-3-haiku-20240307-v1:0us.amazon.nova-lite-v1:0us.amazon.nova-micro-v1:0us.amazon.nova-pro-v1:0us.anthropic.claude-3-5-haiku-20241022-v1:0us.anthropic.claude-3-7-sonnet-20250219-v1:0us.anthropic.claude-3-haiku-20240307-v1:0
- template
Configuration AiPrompt Ai Prompt Template Configuration - The configuration of the prompt template for this AI Prompt.
- template
Type AiPrompt Ai Prompt Template Type - The type of the prompt template for this AI Prompt.
- type
Ai
Prompt Ai Prompt Type - The type of this AI Prompt.
- assistant
Id string - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- description string
- The description of the AI Prompt.
- name string
- The name of the AI Prompt
- {[key: string]: string}
- The tags used to organize, track, or control access for this resource.
- api_
format AiPrompt Ai Prompt Api Format - The API format used for this AI Prompt.
- model_
id str - The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0apac.amazon.nova-lite-v1:0apac.amazon.nova-micro-v1:0apac.amazon.nova-pro-v1:0apac.anthropic.claude-3-5-sonnet--v2:0apac.anthropic.claude-3-haiku-20240307-v1:0eu.amazon.nova-lite-v1:0eu.amazon.nova-micro-v1:0eu.amazon.nova-pro-v1:0eu.anthropic.claude-3-7-sonnet-20250219-v1:0eu.anthropic.claude-3-haiku-20240307-v1:0us.amazon.nova-lite-v1:0us.amazon.nova-micro-v1:0us.amazon.nova-pro-v1:0us.anthropic.claude-3-5-haiku-20241022-v1:0us.anthropic.claude-3-7-sonnet-20250219-v1:0us.anthropic.claude-3-haiku-20240307-v1:0
- template_
configuration AiPrompt Ai Prompt Template Configuration Args - The configuration of the prompt template for this AI Prompt.
- template_
type AiPrompt Ai Prompt Template Type - The type of the prompt template for this AI Prompt.
- type
Ai
Prompt Ai Prompt Type - The type of this AI Prompt.
- assistant_
id str - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- description str
- The description of the AI Prompt.
- name str
- The name of the AI Prompt
- Mapping[str, str]
- The tags used to organize, track, or control access for this resource.
- api
Format "ANTHROPIC_CLAUDE_MESSAGES" | "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" | "MESSAGES" | "TEXT_COMPLETIONS" - The API format used for this AI Prompt.
- model
Id String - The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0apac.amazon.nova-lite-v1:0apac.amazon.nova-micro-v1:0apac.amazon.nova-pro-v1:0apac.anthropic.claude-3-5-sonnet--v2:0apac.anthropic.claude-3-haiku-20240307-v1:0eu.amazon.nova-lite-v1:0eu.amazon.nova-micro-v1:0eu.amazon.nova-pro-v1:0eu.anthropic.claude-3-7-sonnet-20250219-v1:0eu.anthropic.claude-3-haiku-20240307-v1:0us.amazon.nova-lite-v1:0us.amazon.nova-micro-v1:0us.amazon.nova-pro-v1:0us.anthropic.claude-3-5-haiku-20241022-v1:0us.anthropic.claude-3-7-sonnet-20250219-v1:0us.anthropic.claude-3-haiku-20240307-v1:0
- template
Configuration Property Map - The configuration of the prompt template for this AI Prompt.
- template
Type "TEXT" - The type of the prompt template for this AI Prompt.
- type "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"
- The type of this AI Prompt.
- assistant
Id String - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- description String
- The description of the AI Prompt.
- name String
- The name of the AI Prompt
- Map<String>
- The tags used to organize, track, or control access for this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the AiPrompt resource produces the following output properties:
- Ai
Prompt stringArn - The Amazon Resource Name (ARN) of the AI Prompt.
- Ai
Prompt stringId - The identifier of the Amazon Q in Connect AI prompt.
- Assistant
Arn string - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- Id string
- The provider-assigned unique ID for this managed resource.
- Modified
Time doubleSeconds
- Ai
Prompt stringArn - The Amazon Resource Name (ARN) of the AI Prompt.
- Ai
Prompt stringId - The identifier of the Amazon Q in Connect AI prompt.
- Assistant
Arn string - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- Id string
- The provider-assigned unique ID for this managed resource.
- Modified
Time float64Seconds
- ai
Prompt StringArn - The Amazon Resource Name (ARN) of the AI Prompt.
- ai
Prompt StringId - The identifier of the Amazon Q in Connect AI prompt.
- assistant
Arn String - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- id String
- The provider-assigned unique ID for this managed resource.
- modified
Time DoubleSeconds
- ai
Prompt stringArn - The Amazon Resource Name (ARN) of the AI Prompt.
- ai
Prompt stringId - The identifier of the Amazon Q in Connect AI prompt.
- assistant
Arn string - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- id string
- The provider-assigned unique ID for this managed resource.
- modified
Time numberSeconds
- ai_
prompt_ strarn - The Amazon Resource Name (ARN) of the AI Prompt.
- ai_
prompt_ strid - The identifier of the Amazon Q in Connect AI prompt.
- assistant_
arn str - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- id str
- The provider-assigned unique ID for this managed resource.
- modified_
time_ floatseconds
- ai
Prompt StringArn - The Amazon Resource Name (ARN) of the AI Prompt.
- ai
Prompt StringId - The identifier of the Amazon Q in Connect AI prompt.
- assistant
Arn String - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- id String
- The provider-assigned unique ID for this managed resource.
- modified
Time NumberSeconds
Supporting Types
AiPromptAiPromptApiFormat, AiPromptAiPromptApiFormatArgs
- Anthropic
Claude Messages ANTHROPIC_CLAUDE_MESSAGES- Anthropic
Claude Text Completions ANTHROPIC_CLAUDE_TEXT_COMPLETIONS- Messages
MESSAGES- Text
Completions TEXT_COMPLETIONS
- Ai
Prompt Ai Prompt Api Format Anthropic Claude Messages ANTHROPIC_CLAUDE_MESSAGES- Ai
Prompt Ai Prompt Api Format Anthropic Claude Text Completions ANTHROPIC_CLAUDE_TEXT_COMPLETIONS- Ai
Prompt Ai Prompt Api Format Messages MESSAGES- Ai
Prompt Ai Prompt Api Format Text Completions TEXT_COMPLETIONS
- Anthropic
Claude Messages ANTHROPIC_CLAUDE_MESSAGES- Anthropic
Claude Text Completions ANTHROPIC_CLAUDE_TEXT_COMPLETIONS- Messages
MESSAGES- Text
Completions TEXT_COMPLETIONS
- Anthropic
Claude Messages ANTHROPIC_CLAUDE_MESSAGES- Anthropic
Claude Text Completions ANTHROPIC_CLAUDE_TEXT_COMPLETIONS- Messages
MESSAGES- Text
Completions TEXT_COMPLETIONS
- ANTHROPIC_CLAUDE_MESSAGES
ANTHROPIC_CLAUDE_MESSAGES- ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
ANTHROPIC_CLAUDE_TEXT_COMPLETIONS- MESSAGES
MESSAGES- TEXT_COMPLETIONS
TEXT_COMPLETIONS
- "ANTHROPIC_CLAUDE_MESSAGES"
ANTHROPIC_CLAUDE_MESSAGES- "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
ANTHROPIC_CLAUDE_TEXT_COMPLETIONS- "MESSAGES"
MESSAGES- "TEXT_COMPLETIONS"
TEXT_COMPLETIONS
AiPromptAiPromptTemplateType, AiPromptAiPromptTemplateTypeArgs
- Text
TEXT
- Ai
Prompt Ai Prompt Template Type Text TEXT
- Text
TEXT
- Text
TEXT
- TEXT
TEXT
- "TEXT"
TEXT
AiPromptAiPromptType, AiPromptAiPromptTypeArgs
- Answer
Generation ANSWER_GENERATION- Intent
Labeling Generation INTENT_LABELING_GENERATION- Query
Reformulation QUERY_REFORMULATION- Self
Service Pre Processing SELF_SERVICE_PRE_PROCESSING- Self
Service Answer Generation SELF_SERVICE_ANSWER_GENERATION- Email
Response EMAIL_RESPONSE- Email
Overview EMAIL_OVERVIEW- Email
Generative Answer EMAIL_GENERATIVE_ANSWER- Email
Query Reformulation EMAIL_QUERY_REFORMULATION- Orchestration
ORCHESTRATION- Note
Taking NOTE_TAKING- Case
Summarization CASE_SUMMARIZATION
- Ai
Prompt Ai Prompt Type Answer Generation ANSWER_GENERATION- Ai
Prompt Ai Prompt Type Intent Labeling Generation INTENT_LABELING_GENERATION- Ai
Prompt Ai Prompt Type Query Reformulation QUERY_REFORMULATION- Ai
Prompt Ai Prompt Type Self Service Pre Processing SELF_SERVICE_PRE_PROCESSING- Ai
Prompt Ai Prompt Type Self Service Answer Generation SELF_SERVICE_ANSWER_GENERATION- Ai
Prompt Ai Prompt Type Email Response EMAIL_RESPONSE- Ai
Prompt Ai Prompt Type Email Overview EMAIL_OVERVIEW- Ai
Prompt Ai Prompt Type Email Generative Answer EMAIL_GENERATIVE_ANSWER- Ai
Prompt Ai Prompt Type Email Query Reformulation EMAIL_QUERY_REFORMULATION- Ai
Prompt Ai Prompt Type Orchestration ORCHESTRATION- Ai
Prompt Ai Prompt Type Note Taking NOTE_TAKING- Ai
Prompt Ai Prompt Type Case Summarization CASE_SUMMARIZATION
- Answer
Generation ANSWER_GENERATION- Intent
Labeling Generation INTENT_LABELING_GENERATION- Query
Reformulation QUERY_REFORMULATION- Self
Service Pre Processing SELF_SERVICE_PRE_PROCESSING- Self
Service Answer Generation SELF_SERVICE_ANSWER_GENERATION- Email
Response EMAIL_RESPONSE- Email
Overview EMAIL_OVERVIEW- Email
Generative Answer EMAIL_GENERATIVE_ANSWER- Email
Query Reformulation EMAIL_QUERY_REFORMULATION- Orchestration
ORCHESTRATION- Note
Taking NOTE_TAKING- Case
Summarization CASE_SUMMARIZATION
- Answer
Generation ANSWER_GENERATION- Intent
Labeling Generation INTENT_LABELING_GENERATION- Query
Reformulation QUERY_REFORMULATION- Self
Service Pre Processing SELF_SERVICE_PRE_PROCESSING- Self
Service Answer Generation SELF_SERVICE_ANSWER_GENERATION- Email
Response EMAIL_RESPONSE- Email
Overview EMAIL_OVERVIEW- Email
Generative Answer EMAIL_GENERATIVE_ANSWER- Email
Query Reformulation EMAIL_QUERY_REFORMULATION- Orchestration
ORCHESTRATION- Note
Taking NOTE_TAKING- Case
Summarization CASE_SUMMARIZATION
- ANSWER_GENERATION
ANSWER_GENERATION- INTENT_LABELING_GENERATION
INTENT_LABELING_GENERATION- QUERY_REFORMULATION
QUERY_REFORMULATION- SELF_SERVICE_PRE_PROCESSING
SELF_SERVICE_PRE_PROCESSING- SELF_SERVICE_ANSWER_GENERATION
SELF_SERVICE_ANSWER_GENERATION- EMAIL_RESPONSE
EMAIL_RESPONSE- EMAIL_OVERVIEW
EMAIL_OVERVIEW- EMAIL_GENERATIVE_ANSWER
EMAIL_GENERATIVE_ANSWER- EMAIL_QUERY_REFORMULATION
EMAIL_QUERY_REFORMULATION- ORCHESTRATION
ORCHESTRATION- NOTE_TAKING
NOTE_TAKING- CASE_SUMMARIZATION
CASE_SUMMARIZATION
- "ANSWER_GENERATION"
ANSWER_GENERATION- "INTENT_LABELING_GENERATION"
INTENT_LABELING_GENERATION- "QUERY_REFORMULATION"
QUERY_REFORMULATION- "SELF_SERVICE_PRE_PROCESSING"
SELF_SERVICE_PRE_PROCESSING- "SELF_SERVICE_ANSWER_GENERATION"
SELF_SERVICE_ANSWER_GENERATION- "EMAIL_RESPONSE"
EMAIL_RESPONSE- "EMAIL_OVERVIEW"
EMAIL_OVERVIEW- "EMAIL_GENERATIVE_ANSWER"
EMAIL_GENERATIVE_ANSWER- "EMAIL_QUERY_REFORMULATION"
EMAIL_QUERY_REFORMULATION- "ORCHESTRATION"
ORCHESTRATION- "NOTE_TAKING"
NOTE_TAKING- "CASE_SUMMARIZATION"
CASE_SUMMARIZATION
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
