Skip to content

CreateAgentRequest

Source code in docs_src/capo_quicksight/types/create_agent_request.py
class CreateAgentRequest(TypedDict, closed=True):
    spaces: NotRequired[
        "capo_quicksight.types.create_agent_request_spaces_list.CreateAgentRequestSpacesList"
    ]
    """<p>The Amazon Resource Names (ARNs) of the spaces to attach to the agent.</p>"""
    action_connectors: NotRequired[
        "capo_quicksight.types.create_agent_request_action_connectors_list.CreateAgentRequestActionConnectorsList"
    ]
    """<p>The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.</p>"""
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId"
    """<p>The ID of the Amazon Web Services account that contains the agent.</p>"""
    agent_id: "capo_quicksight.types.agent_id.AgentId"
    """<p>A unique identifier for the agent.</p>"""
    name: "capo_quicksight.types.agent_name.AgentName"
    """<p>The name of 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>"""
    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>"""
    agent_lifecycle: NotRequired["capo_quicksight.types.agent_lifecycle.AgentLifecycle"]
    """<p>The lifecycle state of the agent. Valid values are <code>PREVIEW</code> and <code>PUBLISHED</code>.</p>"""
    custom_prompt_input: NotRequired[
        "capo_quicksight.types.custom_prompt_input.CustomPromptInput"
    ]
    """<p>The custom prompt configuration for the agent.</p>"""

action_connectors instance-attribute

action_connectors: NotRequired[CreateAgentRequestActionConnectorsList]

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

agent_id instance-attribute

agent_id: AgentId

A unique identifier for the agent.

agent_lifecycle instance-attribute

agent_lifecycle: NotRequired[AgentLifecycle]

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

aws_account_id instance-attribute

aws_account_id: AwsAccountId

The ID of the Amazon Web Services account that contains the agent.

custom_prompt_input instance-attribute

custom_prompt_input: NotRequired[CustomPromptInput]

The custom prompt configuration for the agent.

description instance-attribute

description: NotRequired[AgentDescription]

A description of the agent.

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[CreateAgentRequestSpacesList]

The Amazon Resource Names (ARNs) of the spaces to attach 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.

welcome_message instance-attribute

welcome_message: NotRequired[WelcomeMessage]

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