Skip to content

AIAgentData

Source code in docs_src/capo_qconnect/types/ai_agent_data.py
class AIAgentData(TypedDict, closed=True):
    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_agent_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the AI Agent.</p>"""
    ai_agent_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the AI agent.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the AI Agent.</p>"""
    type: "capo_qconnect.types.ai_agent_type.AIAgentType"
    """<p>The type of the AI Agent.</p>"""
    configuration: "capo_qconnect.types.ai_agent_configuration.AIAgentConfiguration"
    """<p>Configuration for the AI Agent.</p>"""
    modified_time: NotRequired["datetime.datetime"]
    """<p>The time the AI Agent was last modified.</p>"""
    description: NotRequired["capo_qconnect.types.description.Description"]
    """<p>The description of the AI Agent.</p>"""
    visibility_status: "capo_qconnect.types.visibility_status.VisibilityStatus"
    """<p>The visibility status of the AI Agent.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    origin: NotRequired["capo_qconnect.types.origin.Origin"]
    """<p>Specifies the origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation APIs. </p>"""
    status: NotRequired["capo_qconnect.types.status.Status"]
    """<p>The status of the AI Agent.</p>"""

ai_agent_arn instance-attribute

ai_agent_arn: Arn

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

ai_agent_id instance-attribute

ai_agent_id: Uuid

The identifier of the AI Agent.

assistant_arn instance-attribute

assistant_arn: Arn

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

assistant_id instance-attribute

assistant_id: Uuid

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

configuration instance-attribute

configuration: AIAgentConfiguration

Configuration for the AI Agent.

description instance-attribute

description: NotRequired[Description]

The description of the AI Agent.

modified_time instance-attribute

modified_time: NotRequired[datetime]

The time the AI Agent was last modified.

name instance-attribute

name: Name

The name of the AI Agent.

origin instance-attribute

origin: NotRequired[Origin]

Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

status instance-attribute

status: NotRequired[Status]

The status of the AI Agent.

tags instance-attribute

tags: NotRequired[Tags]

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

type instance-attribute

The type of the AI Agent.

visibility_status instance-attribute

visibility_status: VisibilityStatus

The visibility status of the AI Agent.