AIPromptSummary ¶

class AIPromptSummary(TypedDict, closed=True):
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the AI Prompt.</p>"""
    assistant_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    assistant_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>"""
    ai_prompt_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the Amazon Q in Connect AI prompt.</p>"""
    type: "capo_qconnect.types.ai_prompt_type.AIPromptType"
    """<p>The type of this AI Prompt.</p>"""
    ai_prompt_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the AI Prompt.</p>"""
    modified_time: NotRequired["datetime.datetime"]
    """<p>The time the AI Prompt was last modified.</p>"""
    template_type: "capo_qconnect.types.ai_prompt_template_type.AIPromptTemplateType"
    """<p>The type of the prompt template for this AI Prompt.</p>"""
    model_id: "capo_qconnect.types.ai_prompt_model_identifier.AIPromptModelIdentifier"
    """<p>The identifier of the model used for this AI Prompt. Model Ids supported are: <code>anthropic.claude-3-haiku-20240307-v1:0</code>.</p>"""
    api_format: "capo_qconnect.types.ai_prompt_api_format.AIPromptAPIFormat"
    """<p>The API format used for this AI Prompt.</p>"""
    visibility_status: "capo_qconnect.types.visibility_status.VisibilityStatus"
    """<p>The visibility status of the AI Prompt.</p>"""
    origin: NotRequired["capo_qconnect.types.origin.Origin"]
    """<p>The origin of the AI Prompt. <code>SYSTEM</code> for a default AI Prompt created by Q in Connect or <code>CUSTOMER</code> for an AI Prompt created by calling AI Prompt creation APIs. </p>"""
    description: NotRequired["capo_qconnect.types.description.Description"]
    """<p>The description of the AI Prompt.</p>"""
    status: NotRequired["capo_qconnect.types.status.Status"]
    """<p>The status of the AI Prompt.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""