Skip to content

QConnect module#

Index > QConnect

Auto-generated documentation for QConnect type annotations stubs module mypy-boto3-qconnect.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.42.2' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add QConnect service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and QConnect.

From PyPI with pip#

Install boto3-stubs for QConnect service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[qconnect]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[qconnect]'

# standalone installation
python -m pip install mypy-boto3-qconnect

How to uninstall#

python -m pip uninstall -y mypy-boto3-qconnect

Usage#

Code samples can be found in Examples.

QConnectClient#

Type annotations and code completion for boto3.client("qconnect") as QConnectClient boto3 documentation

# QConnectClient usage example

from boto3.session import Session

from mypy_boto3_qconnect.client import QConnectClient

def get_client() -> QConnectClient:
    return Session().client("qconnect")

Paginators#

Type annotations and code completion for paginators from boto3.client("qconnect").get_paginator("...").

# ListAIAgentVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_qconnect.paginator import ListAIAgentVersionsPaginator

def get_list_ai_agent_versions_paginator() -> ListAIAgentVersionsPaginator:
    return Session().client("qconnect").get_paginator("list_ai_agent_versions"))

Literals#

Type annotations for literals used in methods and schema.

# AIAgentAssociationConfigurationTypeType usage example

from mypy_boto3_qconnect.literals import AIAgentAssociationConfigurationTypeType

def get_value() -> AIAgentAssociationConfigurationTypeType:
    return "KNOWLEDGE_BASE"

Type definitions#

Type annotations for type definitions used in methods and schema.