Examples

Index > QConnect > Examples

Auto-generated documentation for QConnect type annotations stubs module types-aiobotocore-qconnect.

Client

Implicit type annotations

Can be used with types-aioboto3[qconnect] package installed.

Write your QConnect code as usual, type checking and code completion should work out of the box.

Client method usage example

# QConnectClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("qconnect") as client:  # (1)
    result = await client.activate_message_template()  # (2)

1. client: QConnectClient
2. result: ActivateMessageTemplateResponseTypeDef

Paginator usage example

# ListAIAgentVersionsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("qconnect") as client:  # (1)
    paginator = client.get_paginator("list_ai_agent_versions")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: QConnectClient
2. paginator: ListAIAgentVersionsPaginator
3. item: ListAIAgentVersionsResponseTypeDef

Explicit type annotations

With types-aioboto3-lite[qconnect] or a standalone types_aiobotocore_qconnect package, you have to explicitly specify client: QConnectClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example

# QConnectClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_qconnect.client import QConnectClient
from types_aiobotocore_qconnect.type_defs import ActivateMessageTemplateResponseTypeDef
from types_aiobotocore_qconnect.type_defs import ActivateMessageTemplateRequestTypeDef


session = Session()

client: QConnectClient
async with session.client("qconnect") as client:  # (1)
    kwargs: ActivateMessageTemplateRequestTypeDef = {...}  # (2)
    result: ActivateMessageTemplateResponseTypeDef = await client.activate_message_template(**kwargs)  # (3)

1. client: QConnectClient
2. kwargs: ActivateMessageTemplateRequestTypeDef
3. result: ActivateMessageTemplateResponseTypeDef

Paginator usage example

# ListAIAgentVersionsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_qconnect.client import QConnectClient
from types_aiobotocore_qconnect.paginator import ListAIAgentVersionsPaginator
from types_aiobotocore_qconnect.type_defs import ListAIAgentVersionsResponseTypeDef


session = Session()

client: QConnectClient
async with session.client("qconnect") as client:  # (1)
    paginator: ListAIAgentVersionsPaginator = client.get_paginator("list_ai_agent_versions")  # (2)
    async for item in paginator.paginate(...):
        item: ListAIAgentVersionsResponseTypeDef
        print(item)  # (3)

1. client: QConnectClient
2. paginator: ListAIAgentVersionsPaginator
3. item: ListAIAgentVersionsResponseTypeDef