Skip to content

CreateSessionRequest

Source code in docs_src/capo_qconnect/types/create_session_request.py
class CreateSessionRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_qconnect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the session.</p>"""
    description: NotRequired["capo_qconnect.types.description.Description"]
    """<p>The description.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    tag_filter: NotRequired["capo_qconnect.types.tag_filter.TagFilter"]
    """<p>An object that can be used to specify Tag conditions. </p>"""
    ai_agent_configuration: NotRequired[
        "capo_qconnect.types.ai_agent_configuration_map.AIAgentConfigurationMap"
    ]
    """<p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.</p>"""
    contact_arn: NotRequired["capo_qconnect.types.generic_arn.GenericArn"]
    """<p>The Amazon Resource Name (ARN) of the email contact in Connect Customer. Used to retrieve email content and establish session context for AI-powered email assistance.</p>"""
    orchestrator_configuration_list: NotRequired[
        "capo_qconnect.types.orchestrator_configuration_list.OrchestratorConfigurationList"
    ]
    """<p>The list of orchestrator configurations for the session being created.</p>"""
    remove_orchestrator_configuration_list: NotRequired["bool"]
    """<p>The list of orchestrator configurations to remove from the session.</p>"""

ai_agent_configuration instance-attribute

ai_agent_configuration: NotRequired[AIAgentConfigurationMap]

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

assistant_id instance-attribute

assistant_id: UuidOrArn

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

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

contact_arn instance-attribute

contact_arn: NotRequired[GenericArn]

The Amazon Resource Name (ARN) of the email contact in Connect Customer. Used to retrieve email content and establish session context for AI-powered email assistance.

description instance-attribute

description: NotRequired[Description]

The description.

name instance-attribute

name: Name

The name of the session.

orchestrator_configuration_list instance-attribute

orchestrator_configuration_list: NotRequired[OrchestratorConfigurationList]

The list of orchestrator configurations for the session being created.

remove_orchestrator_configuration_list instance-attribute

remove_orchestrator_configuration_list: NotRequired[bool]

The list of orchestrator configurations to remove from the session.

tag_filter instance-attribute

tag_filter: NotRequired[TagFilter]

An object that can be used to specify Tag conditions.

tags instance-attribute

tags: NotRequired[Tags]

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