Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wisdom
  5. AiPrompt

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.wisdom.AiPrompt

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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:

    ApiFormat Pulumi.AwsNative.Wisdom.AiPromptAiPromptApiFormat
    The API format used for this AI Prompt.
    ModelId string
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
    TemplateConfiguration Pulumi.AwsNative.Wisdom.Inputs.AiPromptAiPromptTemplateConfiguration
    The configuration of the prompt template for this AI Prompt.
    TemplateType Pulumi.AwsNative.Wisdom.AiPromptAiPromptTemplateType
    The type of the prompt template for this AI Prompt.
    Type Pulumi.AwsNative.Wisdom.AiPromptAiPromptType
    The type of this AI Prompt.
    AssistantId 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
    Tags Dictionary<string, string>
    The tags used to organize, track, or control access for this resource.
    ApiFormat AiPromptAiPromptApiFormat
    The API format used for this AI Prompt.
    ModelId string
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
    TemplateConfiguration AiPromptAiPromptTemplateConfigurationArgs
    The configuration of the prompt template for this AI Prompt.
    TemplateType AiPromptAiPromptTemplateType
    The type of the prompt template for this AI Prompt.
    Type AiPromptAiPromptType
    The type of this AI Prompt.
    AssistantId 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
    Tags map[string]string
    The tags used to organize, track, or control access for this resource.
    apiFormat AiPromptAiPromptApiFormat
    The API format used for this AI Prompt.
    modelId String
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
    templateConfiguration AiPromptAiPromptTemplateConfiguration
    The configuration of the prompt template for this AI Prompt.
    templateType AiPromptAiPromptTemplateType
    The type of the prompt template for this AI Prompt.
    type AiPromptAiPromptType
    The type of this AI Prompt.
    assistantId 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
    tags Map<String,String>
    The tags used to organize, track, or control access for this resource.
    apiFormat AiPromptAiPromptApiFormat
    The API format used for this AI Prompt.
    modelId string
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
    templateConfiguration AiPromptAiPromptTemplateConfiguration
    The configuration of the prompt template for this AI Prompt.
    templateType AiPromptAiPromptTemplateType
    The type of the prompt template for this AI Prompt.
    type AiPromptAiPromptType
    The type of this AI Prompt.
    assistantId 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
    tags {[key: string]: string}
    The tags used to organize, track, or control access for this resource.
    api_format AiPromptAiPromptApiFormat
    The API format used for this AI Prompt.
    model_id str
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
    template_configuration AiPromptAiPromptTemplateConfigurationArgs
    The configuration of the prompt template for this AI Prompt.
    template_type AiPromptAiPromptTemplateType
    The type of the prompt template for this AI Prompt.
    type AiPromptAiPromptType
    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
    tags Mapping[str, str]
    The tags used to organize, track, or control access for this resource.
    apiFormat "ANTHROPIC_CLAUDE_MESSAGES" | "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
    The API format used for this AI Prompt.
    modelId String
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
    templateConfiguration Property Map
    The configuration of the prompt template for this AI Prompt.
    templateType "TEXT"
    The type of the prompt template for this AI Prompt.
    type "ANSWER_GENERATION" | "INTENT_LABELING_GENERATION" | "QUERY_REFORMULATION"
    The type of this AI Prompt.
    assistantId 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
    tags 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:

    AiPromptArn string
    The Amazon Resource Name (ARN) of the AI Prompt.
    AiPromptId string
    The identifier of the Amazon Q in Connect AI prompt.
    AssistantArn string
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    Id string
    The provider-assigned unique ID for this managed resource.
    AiPromptArn string
    The Amazon Resource Name (ARN) of the AI Prompt.
    AiPromptId string
    The identifier of the Amazon Q in Connect AI prompt.
    AssistantArn string
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    Id string
    The provider-assigned unique ID for this managed resource.
    aiPromptArn String
    The Amazon Resource Name (ARN) of the AI Prompt.
    aiPromptId String
    The identifier of the Amazon Q in Connect AI prompt.
    assistantArn String
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    id String
    The provider-assigned unique ID for this managed resource.
    aiPromptArn string
    The Amazon Resource Name (ARN) of the AI Prompt.
    aiPromptId string
    The identifier of the Amazon Q in Connect AI prompt.
    assistantArn string
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    id string
    The provider-assigned unique ID for this managed resource.
    ai_prompt_arn str
    The Amazon Resource Name (ARN) of the AI Prompt.
    ai_prompt_id str
    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.
    aiPromptArn String
    The Amazon Resource Name (ARN) of the AI Prompt.
    aiPromptId String
    The identifier of the Amazon Q in Connect AI prompt.
    assistantArn String
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AiPromptAiPromptApiFormat, AiPromptAiPromptApiFormatArgs

    AnthropicClaudeMessages
    ANTHROPIC_CLAUDE_MESSAGES
    AnthropicClaudeTextCompletions
    ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
    AiPromptAiPromptApiFormatAnthropicClaudeMessages
    ANTHROPIC_CLAUDE_MESSAGES
    AiPromptAiPromptApiFormatAnthropicClaudeTextCompletions
    ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
    AnthropicClaudeMessages
    ANTHROPIC_CLAUDE_MESSAGES
    AnthropicClaudeTextCompletions
    ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
    AnthropicClaudeMessages
    ANTHROPIC_CLAUDE_MESSAGES
    AnthropicClaudeTextCompletions
    ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
    ANTHROPIC_CLAUDE_MESSAGES
    ANTHROPIC_CLAUDE_MESSAGES
    ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
    ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
    "ANTHROPIC_CLAUDE_MESSAGES"
    ANTHROPIC_CLAUDE_MESSAGES
    "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
    ANTHROPIC_CLAUDE_TEXT_COMPLETIONS

    AiPromptAiPromptTemplateType, AiPromptAiPromptTemplateTypeArgs

    Text
    TEXT
    AiPromptAiPromptTemplateTypeText
    TEXT
    Text
    TEXT
    Text
    TEXT
    TEXT
    TEXT
    "TEXT"
    TEXT

    AiPromptAiPromptType, AiPromptAiPromptTypeArgs

    AnswerGeneration
    ANSWER_GENERATION
    IntentLabelingGeneration
    INTENT_LABELING_GENERATION
    QueryReformulation
    QUERY_REFORMULATION
    AiPromptAiPromptTypeAnswerGeneration
    ANSWER_GENERATION
    AiPromptAiPromptTypeIntentLabelingGeneration
    INTENT_LABELING_GENERATION
    AiPromptAiPromptTypeQueryReformulation
    QUERY_REFORMULATION
    AnswerGeneration
    ANSWER_GENERATION
    IntentLabelingGeneration
    INTENT_LABELING_GENERATION
    QueryReformulation
    QUERY_REFORMULATION
    AnswerGeneration
    ANSWER_GENERATION
    IntentLabelingGeneration
    INTENT_LABELING_GENERATION
    QueryReformulation
    QUERY_REFORMULATION
    ANSWER_GENERATION
    ANSWER_GENERATION
    INTENT_LABELING_GENERATION
    INTENT_LABELING_GENERATION
    QUERY_REFORMULATION
    QUERY_REFORMULATION
    "ANSWER_GENERATION"
    ANSWER_GENERATION
    "INTENT_LABELING_GENERATION"
    INTENT_LABELING_GENERATION
    "QUERY_REFORMULATION"
    QUERY_REFORMULATION

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native