QConnectClient

Index > QConnect > QConnectClient

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

QConnectClient

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

# QConnectClient usage example

from boto3.session import Session
from mypy_boto3_qconnect.client import QConnectClient

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

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("qconnect").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("qconnect")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.PreconditionFailedException,
    client.exceptions.RequestTimeoutException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_qconnect.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("qconnect").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("qconnect").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_ai_agent

Creates an Amazon Q in Connect AI Agent.

Type annotations and code completion for boto3.client("qconnect").create_ai_agent method. boto3 documentation

# create_ai_agent method definition

def create_ai_agent(
    self,
    *,
    assistantId: str,
    configuration: Union[AIAgentConfigurationTypeDef, AIAgentConfigurationExtraOutputTypeDef],  # (1)
    name: str,
    type: AIAgentTypeType,  # (2)
    visibilityStatus: VisibilityStatusType,  # (3)
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAIAgentResponseTypeDef:  # (4)
    ...

1. See AIAgentConfigurationTypeDef AIAgentConfigurationExtraOutputTypeDef
2. See AIAgentTypeType
3. See VisibilityStatusType
4. See CreateAIAgentResponseTypeDef

# create_ai_agent method usage example with argument unpacking

kwargs: CreateAIAgentRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "configuration": ...,
    "name": ...,
    "type": ...,
    "visibilityStatus": ...,
}

parent.create_ai_agent(**kwargs)

1. See CreateAIAgentRequestRequestTypeDef

create_ai_agent_version

Creates and Amazon Q in Connect AI Agent version.

Type annotations and code completion for boto3.client("qconnect").create_ai_agent_version method.