Skip to content

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_assistant#

Creates an Amazon Q in Connect assistant.

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

# create_assistant method definition

def create_assistant(
    self,
    *,
    name: str,
    type: AssistantTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateAssistantResponseTypeDef:  # (3)
    ...
  1. See AssistantTypeType
  2. See ServerSideEncryptionConfigurationTypeDef
  3. See CreateAssistantResponseTypeDef
# create_assistant method usage example with argument unpacking

kwargs: CreateAssistantRequestRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
}

parent.create_assistant(**kwargs)
  1. See CreateAssistantRequestRequestTypeDef

create_assistant_association#

Creates an association between an Amazon Q in Connect assistant and another resource.

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

# create_assistant_association method definition

def create_assistant_association(
    self,
    *,
    assistantId: str,
    association: AssistantAssociationInputDataTypeDef,  # (1)
    associationType: AssociationTypeType,  # (2)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAssistantAssociationResponseTypeDef:  # (3)
    ...
  1. See AssistantAssociationInputDataTypeDef
  2. See AssociationTypeType
  3. See CreateAssistantAssociationResponseTypeDef
# create_assistant_association method usage example with argument unpacking

kwargs: CreateAssistantAssociationRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "association": ...,
    "associationType": ...,
}

parent.create_assistant_association(**kwargs)
  1. See CreateAssistantAssociationRequestRequestTypeDef

create_content#

Creates Amazon Q in Connect content.

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

# create_content method definition

def create_content(
    self,
    *,
    knowledgeBaseId: str,
    name: str,
    uploadId: str,
    clientToken: str = ...,
    metadata: Mapping[str, str] = ...,
    overrideLinkOutUri: str = ...,
    tags: Mapping[str, str] = ...,
    title: str = ...,
) -> CreateContentResponseTypeDef:  # (1)
    ...
  1. See CreateContentResponseTypeDef
# create_content method usage example with argument unpacking

kwargs: CreateContentRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "name": ...,
    "uploadId": ...,
}

parent.create_content(**kwargs)
  1. See CreateContentRequestRequestTypeDef

create_content_association#

Creates an association between a content resource in a knowledge base and step-by-step guides.

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

# create_content_association method definition

def create_content_association(
    self,
    *,
    association: ContentAssociationContentsTypeDef,  # (1)
    associationType: ContentAssociationTypeType,  # (2)
    contentId: str,
    knowledgeBaseId: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateContentAssociationResponseTypeDef:  # (3)
    ...
  1. See ContentAssociationContentsTypeDef
  2. See ContentAssociationTypeType
  3. See CreateContentAssociationResponseTypeDef
# create_content_association method usage example with argument unpacking

kwargs: CreateContentAssociationRequestRequestTypeDef = {  # (1)
    "association": ...,
    "associationType": ...,
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.create_content_association(**kwargs)
  1. See CreateContentAssociationRequestRequestTypeDef

create_knowledge_base#

Creates a knowledge base.

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

# create_knowledge_base method definition

def create_knowledge_base(
    self,
    *,
    knowledgeBaseType: KnowledgeBaseTypeType,  # (1)
    name: str,
    clientToken: str = ...,
    description: str = ...,
    renderingConfiguration: RenderingConfigurationTypeDef = ...,  # (2)
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (3)
    sourceConfiguration: Union[SourceConfigurationTypeDef, SourceConfigurationExtraOutputTypeDef] = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateKnowledgeBaseResponseTypeDef:  # (5)
    ...
  1. See KnowledgeBaseTypeType
  2. See RenderingConfigurationTypeDef
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See SourceConfigurationTypeDef SourceConfigurationExtraOutputTypeDef
  5. See CreateKnowledgeBaseResponseTypeDef
# create_knowledge_base method usage example with argument unpacking

kwargs: CreateKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseType": ...,
    "name": ...,
}

parent.create_knowledge_base(**kwargs)
  1. See CreateKnowledgeBaseRequestRequestTypeDef

create_quick_response#

Creates an Amazon Q in Connect quick response.

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

# create_quick_response method definition

def create_quick_response(
    self,
    *,
    content: QuickResponseDataProviderTypeDef,  # (1)
    knowledgeBaseId: str,
    name: str,
    channels: Sequence[str] = ...,
    clientToken: str = ...,
    contentType: str = ...,
    description: str = ...,
    groupingConfiguration: Union[GroupingConfigurationTypeDef, GroupingConfigurationExtraOutputTypeDef] = ...,  # (2)
    isActive: bool = ...,
    language: str = ...,
    shortcutKey: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateQuickResponseResponseTypeDef:  # (3)
    ...
  1. See QuickResponseDataProviderTypeDef
  2. See GroupingConfigurationTypeDef GroupingConfigurationExtraOutputTypeDef
  3. See CreateQuickResponseResponseTypeDef
# create_quick_response method usage example with argument unpacking

kwargs: CreateQuickResponseRequestRequestTypeDef = {  # (1)
    "content": ...,
    "knowledgeBaseId": ...,
    "name": ...,
}

parent.create_quick_response(**kwargs)
  1. See CreateQuickResponseRequestRequestTypeDef

create_session#

Creates a session.

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