Skip to content

Agent

Source code in docs_src/capo_quicksight/types/agent.py
class Agent(TypedDict, closed=True):
    spaces: NotRequired["capo_quicksight.types.agent_spaces_list.AgentSpacesList"]
    """<p>The Amazon Resource Names (ARNs) of the spaces attached to the agent.</p>"""
    action_connectors: NotRequired[
        "capo_quicksight.types.agent_action_connectors_list.AgentActionConnectorsList"
    ]
    """<p>The Amazon Resource Names (ARNs) of the action connectors attached to the agent.</p>"""
    description: NotRequired["capo_quicksight.types.agent_description.AgentDescription"]
    """<p>A description of the agent.</p>"""
    icon_id: NotRequired["capo_quicksight.types.icon_id.IconId"]
    """<p>The icon identifier for the agent.</p>"""
    name: "capo_quicksight.types.agent_name.AgentName"
    """<p>The name of the agent.</p>"""
    starter_prompts: NotRequired[
        "capo_quicksight.types.starter_prompt_list.StarterPromptList"
    ]
    """<p>A list of starter prompts that are displayed to users when they begin interacting with the agent.</p>"""
    welcome_message: NotRequired["capo_quicksight.types.welcome_message.WelcomeMessage"]
    """<p>The welcome message that is displayed when a user starts a conversation with the agent.</p>"""
    arn: "capo_quicksight.types.agent_arn.AgentArn"
    """<p>The Amazon Resource Name (ARN) of the agent.</p>"""
    agent_id: "capo_quicksight.types.agent_id.AgentId"
    """<p>The unique identifier for the agent.</p>"""
    agent_lifecycle: "capo_quicksight.types.agent_lifecycle.AgentLifecycle"
    """<p>The lifecycle state of the agent. Valid values are <code>PREVIEW</code> and <code>PUBLISHED</code>.</p>"""
    agent_status: "capo_quicksight.types.agent_status.AgentStatus"
    """<p>The status of the agent.</p>"""
    created_at: "datetime.datetime"
    """<p>The date and time that the agent was created.</p>"""
    creator: "str"
    """<p>The identity of the user who created the agent.</p>"""
    custom_prompt_interface: NotRequired[
        "capo_quicksight.types.custom_prompt_interface.CustomPromptInterface"
    ]
    """<p>The custom prompt interface configuration for the agent.</p>"""
    error_message: NotRequired["str"]
    """<p>An error message associated with the agent, if applicable.</p>"""
    updated_at: "datetime.datetime"
    """<p>The date and time that the agent was last updated.</p>"""

action_connectors instance-attribute

action_connectors: NotRequired[AgentActionConnectorsList]

The Amazon Resource Names (ARNs) of the action connectors attached to the agent.

agent_id instance-attribute

agent_id: AgentId

The unique identifier for the agent.

agent_lifecycle instance-attribute

agent_lifecycle: AgentLifecycle

The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.

agent_status instance-attribute

agent_status: AgentStatus

The status of the agent.

arn instance-attribute

arn: AgentArn

The Amazon Resource Name (ARN) of the agent.

created_at instance-attribute

created_at: datetime

The date and time that the agent was created.

creator instance-attribute

creator: str

The identity of the user who created the agent.

custom_prompt_interface instance-attribute

custom_prompt_interface: NotRequired[CustomPromptInterface]

The custom prompt interface configuration for the agent.

description instance-attribute

description: NotRequired[AgentDescription]

A description of the agent.

error_message instance-attribute

error_message: NotRequired[str]

An error message associated with the agent, if applicable.

icon_id instance-attribute

icon_id: NotRequired[IconId]

The icon identifier for the agent.

name instance-attribute

name: AgentName

The name of the agent.

spaces instance-attribute

spaces: NotRequired[AgentSpacesList]

The Amazon Resource Names (ARNs) of the spaces attached to the agent.

starter_prompts instance-attribute

starter_prompts: NotRequired[StarterPromptList]

A list of starter prompts that are displayed to users when they begin interacting with the agent.

updated_at instance-attribute

updated_at: datetime

The date and time that the agent was last updated.

welcome_message instance-attribute

welcome_message: NotRequired[WelcomeMessage]

The welcome message that is displayed when a user starts a conversation with the agent.