Skip to content

Examples#

Index > QBusiness > Examples

Auto-generated documentation for QBusiness type annotations stubs module types-aiobotocore-qbusiness.

Client#

Implicit type annotations#

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

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

Client method usage example#

# QBusinessClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("qbusiness") as client:  # (1)
    result = await client.associate_permission()  # (2)
  1. client: QBusinessClient
  2. result: AssociatePermissionResponseTypeDef

Paginator usage example#

# GetChatControlsConfigurationPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("qbusiness") as client:  # (1)
    paginator = client.get_paginator("get_chat_controls_configuration")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: QBusinessClient
  2. paginator: GetChatControlsConfigurationPaginator
  3. item: GetChatControlsConfigurationResponseTypeDef

Explicit type annotations#

With types-aioboto3-lite[qbusiness] or a standalone types_aiobotocore_qbusiness package, you have to explicitly specify client: QBusinessClient 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#

# QBusinessClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_qbusiness.client import QBusinessClient
from types_aiobotocore_qbusiness.type_defs import AssociatePermissionResponseTypeDef
from types_aiobotocore_qbusiness.type_defs import AssociatePermissionRequestTypeDef


session = Session()

client: QBusinessClient
async with session.client("qbusiness") as client:  # (1)
    kwargs: AssociatePermissionRequestTypeDef = {...}  # (2)
    result: AssociatePermissionResponseTypeDef = await client.associate_permission(**kwargs)  # (3)
  1. client: QBusinessClient
  2. kwargs: AssociatePermissionRequestTypeDef
  3. result: AssociatePermissionResponseTypeDef

Paginator usage example#

# GetChatControlsConfigurationPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_qbusiness.client import QBusinessClient
from types_aiobotocore_qbusiness.paginator import GetChatControlsConfigurationPaginator
from types_aiobotocore_qbusiness.type_defs import GetChatControlsConfigurationResponseTypeDef


session = Session()

client: QBusinessClient
async with session.client("qbusiness") as client:  # (1)
    paginator: GetChatControlsConfigurationPaginator = client.get_paginator("get_chat_controls_configuration")  # (2)
    async for item in paginator.paginate(...):
        item: GetChatControlsConfigurationResponseTypeDef
        print(item)  # (3)
  1. client: QBusinessClient
  2. paginator: GetChatControlsConfigurationPaginator
  3. item: GetChatControlsConfigurationResponseTypeDef