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

activate_message_template

Activates a specific version of the Amazon Q in Connect message template.

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

# activate_message_template method definition

def activate_message_template(
    self,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    versionNumber: int,
) -> ActivateMessageTemplateResponseTypeDef:  # (1)
    ...

1. See ActivateMessageTemplateResponseTypeDef

# activate_message_template method usage example with argument unpacking

kwargs: ActivateMessageTemplateRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
    "versionNumber": ...,
}

parent.activate_message_template(**kwargs)

1. See ActivateMessageTemplateRequestRequestTypeDef

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: AIAgentConfigurationTypeDef,  # (1)
    name: str,
    type: AIAgentTypeType,  # (2)
    visibilityStatus: VisibilityStatusType,  # (3)
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAIAgentResponseTypeDef:  # (4)
    ...

1. See AIAgentConfigurationTypeDef
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. boto3 documentation

# create_ai_agent_version method definition

def create_ai_agent_version(
    self,
    *,
    aiAgentId: str,
    assistantId: str,
    clientToken: str = ...,
    modifiedTime: TimestampTypeDef = ...,
) -> CreateAIAgentVersionResponseTypeDef:  # (1)
    ...

1. See CreateAIAgentVersionResponseTypeDef

# create_ai_agent_version method usage example with argument unpacking

kwargs: CreateAIAgentVersionRequestRequestTypeDef = {  # (1)
    "aiAgentId": ...,
    "assistantId": ...,
}

parent.create_ai_agent_version(**kwargs)

1. See CreateAIAgentVersionRequestRequestTypeDef

create_ai_prompt

Creates an Amazon Q in Connect AI Prompt.

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

# create_ai_prompt method definition

def create_ai_prompt(
    self,
    *,
    apiFormat: AIPromptAPIFormatType,  # (1)
    assistantId: str,
    modelId: str,
    name: str,
    templateConfiguration: AIPromptTemplateConfigurationTypeDef,  # (2)
    templateType: AIPromptTemplateTypeType,  # (3)
    type: AIPromptTypeType,  # (4)
    visibilityStatus: VisibilityStatusType,  # (5)
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAIPromptResponseTypeDef:  # (6)
    ...

1. See AIPromptAPIFormatType
2. See AIPromptTemplateConfigurationTypeDef
3. See AIPromptTemplateTypeType
4. See AIPromptTypeType
5. See VisibilityStatusType
6. See CreateAIPromptResponseTypeDef

# create_ai_prompt method usage example with argument unpacking

kwargs: CreateAIPromptRequestRequestTypeDef = {  # (1)
    "apiFormat": ...,
    "assistantId": ...,
    "modelId": ...,
    "name": ...,
    "templateConfiguration": ...,
    "templateType": ...,
    "type": ...,
    "visibilityStatus": ...,
}

parent.create_ai_prompt(**kwargs)

1. See CreateAIPromptRequestRequestTypeDef

create_ai_prompt_version

Creates an Amazon Q in Connect AI Prompt version.

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

# create_ai_prompt_version method definition

def create_ai_prompt_version(
    self,
    *,
    aiPromptId: str,
    assistantId: str,
    clientToken: str = ...,
    modifiedTime: TimestampTypeDef = ...,
) -> CreateAIPromptVersionResponseTypeDef:  # (1)
    ...

1. See CreateAIPromptVersionResponseTypeDef

# create_ai_prompt_version method usage example with argument unpacking

kwargs: CreateAIPromptVersionRequestRequestTypeDef = {  # (1)
    "aiPromptId": ...,
    "assistantId": ...,
}

parent.create_ai_prompt_version(**kwargs)

1. See CreateAIPromptVersionRequestRequestTypeDef

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: SourceConfigurationTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
    vectorIngestionConfiguration: VectorIngestionConfigurationTypeDef = ...,  # (5)
) -> CreateKnowledgeBaseResponseTypeDef:  # (6)
    ...

1. See KnowledgeBaseTypeType
2. See RenderingConfigurationTypeDef
3. See ServerSideEncryptionConfigurationTypeDef
4. See SourceConfigurationTypeDef
5. See VectorIngestionConfigurationTypeDef
6. 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_message_template

Creates an Amazon Q in Connect message template.

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

# create_message_template method definition

def create_message_template(
    self,
    *,
    channelSubtype: ChannelSubtypeType,  # (1)
    content: MessageTemplateContentProviderTypeDef,  # (2)
    knowledgeBaseId: str,
    name: str,
    clientToken: str = ...,
    defaultAttributes: MessageTemplateAttributesTypeDef = ...,  # (3)
    description: str = ...,
    groupingConfiguration: GroupingConfigurationTypeDef = ...,  # (4)
    language: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateMessageTemplateResponseTypeDef:  # (5)
    ...

1. See ChannelSubtypeType
2. See MessageTemplateContentProviderTypeDef
3. See MessageTemplateAttributesTypeDef
4. See GroupingConfigurationTypeDef
5. See CreateMessageTemplateResponseTypeDef

# create_message_template method usage example with argument unpacking

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

parent.create_message_template(**kwargs)

1. See CreateMessageTemplateRequestRequestTypeDef

create_message_template_attachment

Uploads an attachment file to the specified Amazon Q in Connect message template.

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

# create_message_template_attachment method definition

def create_message_template_attachment(
    self,
    *,
    body: str,
    contentDisposition: ContentDispositionType,  # (1)
    knowledgeBaseId: str,
    messageTemplateId: str,
    name: str,
    clientToken: str = ...,
) -> CreateMessageTemplateAttachmentResponseTypeDef:  # (2)
    ...

1. See ContentDispositionType
2. See CreateMessageTemplateAttachmentResponseTypeDef

# create_message_template_attachment method usage example with argument unpacking

kwargs: CreateMessageTemplateAttachmentRequestRequestTypeDef = {  # (1)
    "body": ...,
    "contentDisposition": ...,
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
    "name": ...,
}

parent.create_message_template_attachment(**kwargs)

1. See CreateMessageTemplateAttachmentRequestRequestTypeDef

create_message_template_version

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template.

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

# create_message_template_version method definition

def create_message_template_version(
    self,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    messageTemplateContentSha256: str = ...,
) -> CreateMessageTemplateVersionResponseTypeDef:  # (1)
    ...

1. See CreateMessageTemplateVersionResponseTypeDef

# create_message_template_version method usage example with argument unpacking

kwargs: CreateMessageTemplateVersionRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.create_message_template_version(**kwargs)

1. See CreateMessageTemplateVersionRequestRequestTypeDef

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: GroupingConfigurationTypeDef = ...,  # (2)
    isActive: bool = ...,
    language: str = ...,
    shortcutKey: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateQuickResponseResponseTypeDef:  # (3)
    ...

1. See QuickResponseDataProviderTypeDef
2. See GroupingConfigurationTypeDef
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. boto3 documentation

# create_session method definition

def create_session(
    self,
    *,
    assistantId: str,
    name: str,
    aiAgentConfiguration: Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef] = ...,  # (1)
    clientToken: str = ...,
    description: str = ...,
    tagFilter: TagFilterTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateSessionResponseTypeDef:  # (3)
    ...

1. See AIAgentTypeType AIAgentConfigurationDataTypeDef
2. See TagFilterTypeDef
3. See CreateSessionResponseTypeDef

# create_session method usage example with argument unpacking

kwargs: CreateSessionRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "name": ...,
}

parent.create_session(**kwargs)

1. See CreateSessionRequestRequestTypeDef

deactivate_message_template

Deactivates a specific version of the Amazon Q in Connect message template.

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

# deactivate_message_template method definition

def deactivate_message_template(
    self,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    versionNumber: int,
) -> DeactivateMessageTemplateResponseTypeDef:  # (1)
    ...

1. See DeactivateMessageTemplateResponseTypeDef

# deactivate_message_template method usage example with argument unpacking

kwargs: DeactivateMessageTemplateRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
    "versionNumber": ...,
}

parent.deactivate_message_template(**kwargs)

1. See DeactivateMessageTemplateRequestRequestTypeDef

delete_ai_agent

Deletes an Amazon Q in Connect AI Agent.

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

# delete_ai_agent method definition

def delete_ai_agent(
    self,
    *,
    aiAgentId: str,
    assistantId: str,
) -> Dict[str, Any]:
    ...

# delete_ai_agent method usage example with argument unpacking

kwargs: DeleteAIAgentRequestRequestTypeDef = {  # (1)
    "aiAgentId": ...,
    "assistantId": ...,
}

parent.delete_ai_agent(**kwargs)

1. See DeleteAIAgentRequestRequestTypeDef

delete_ai_agent_version

Deletes an Amazon Q in Connect AI Agent Version.

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

# delete_ai_agent_version method definition

def delete_ai_agent_version(
    self,
    *,
    aiAgentId: str,
    assistantId: str,
    versionNumber: int,
) -> Dict[str, Any]:
    ...

# delete_ai_agent_version method usage example with argument unpacking

kwargs: DeleteAIAgentVersionRequestRequestTypeDef = {  # (1)
    "aiAgentId": ...,
    "assistantId": ...,
    "versionNumber": ...,
}

parent.delete_ai_agent_version(**kwargs)

1. See DeleteAIAgentVersionRequestRequestTypeDef

delete_ai_prompt

Deletes an Amazon Q in Connect AI Prompt.

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

# delete_ai_prompt method definition

def delete_ai_prompt(
    self,
    *,
    aiPromptId: str,
    assistantId: str,
) -> Dict[str, Any]:
    ...

# delete_ai_prompt method usage example with argument unpacking

kwargs: DeleteAIPromptRequestRequestTypeDef = {  # (1)
    "aiPromptId": ...,
    "assistantId": ...,
}

parent.delete_ai_prompt(**kwargs)

1. See DeleteAIPromptRequestRequestTypeDef

delete_ai_prompt_version

Delete and Amazon Q in Connect AI Prompt version.

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

# delete_ai_prompt_version method definition

def delete_ai_prompt_version(
    self,
    *,
    aiPromptId: str,
    assistantId: str,
    versionNumber: int,
) -> Dict[str, Any]:
    ...

# delete_ai_prompt_version method usage example with argument unpacking

kwargs: DeleteAIPromptVersionRequestRequestTypeDef = {  # (1)
    "aiPromptId": ...,
    "assistantId": ...,
    "versionNumber": ...,
}

parent.delete_ai_prompt_version(**kwargs)

1. See DeleteAIPromptVersionRequestRequestTypeDef

delete_assistant

Deletes an assistant.

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

# delete_assistant method definition

def delete_assistant(
    self,
    *,
    assistantId: str,
) -> Dict[str, Any]:
    ...

# delete_assistant method usage example with argument unpacking

kwargs: DeleteAssistantRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.delete_assistant(**kwargs)

1. See DeleteAssistantRequestRequestTypeDef

delete_assistant_association

Deletes an assistant association.

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

# delete_assistant_association method definition

def delete_assistant_association(
    self,
    *,
    assistantAssociationId: str,
    assistantId: str,
) -> Dict[str, Any]:
    ...

# delete_assistant_association method usage example with argument unpacking

kwargs: DeleteAssistantAssociationRequestRequestTypeDef = {  # (1)
    "assistantAssociationId": ...,
    "assistantId": ...,
}

parent.delete_assistant_association(**kwargs)

1. See DeleteAssistantAssociationRequestRequestTypeDef

delete_content

Deletes the content.

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

# delete_content method definition

def delete_content(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

# delete_content method usage example with argument unpacking

kwargs: DeleteContentRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.delete_content(**kwargs)

1. See DeleteContentRequestRequestTypeDef

delete_content_association

Deletes the content association.

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

# delete_content_association method definition

def delete_content_association(
    self,
    *,
    contentAssociationId: str,
    contentId: str,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

# delete_content_association method usage example with argument unpacking

kwargs: DeleteContentAssociationRequestRequestTypeDef = {  # (1)
    "contentAssociationId": ...,
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.delete_content_association(**kwargs)

1. See DeleteContentAssociationRequestRequestTypeDef

delete_import_job

Deletes the quick response import job.

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

# delete_import_job method definition

def delete_import_job(
    self,
    *,
    importJobId: str,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

# delete_import_job method usage example with argument unpacking

kwargs: DeleteImportJobRequestRequestTypeDef = {  # (1)
    "importJobId": ...,
    "knowledgeBaseId": ...,
}

parent.delete_import_job(**kwargs)

1. See DeleteImportJobRequestRequestTypeDef

delete_knowledge_base

Deletes the knowledge base.

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

# delete_knowledge_base method definition

def delete_knowledge_base(
    self,
    *,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

# delete_knowledge_base method usage example with argument unpacking

kwargs: DeleteKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.delete_knowledge_base(**kwargs)

1. See DeleteKnowledgeBaseRequestRequestTypeDef

delete_message_template

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request.

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

# delete_message_template method definition

def delete_message_template(
    self,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
) -> Dict[str, Any]:
    ...

# delete_message_template method usage example with argument unpacking

kwargs: DeleteMessageTemplateRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.delete_message_template(**kwargs)

1. See DeleteMessageTemplateRequestRequestTypeDef

delete_message_template_attachment

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier.

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

# delete_message_template_attachment method definition

def delete_message_template_attachment(
    self,
    *,
    attachmentId: str,
    knowledgeBaseId: str,
    messageTemplateId: str,
) -> Dict[str, Any]:
    ...

# delete_message_template_attachment method usage example with argument unpacking

kwargs: DeleteMessageTemplateAttachmentRequestRequestTypeDef = {  # (1)
    "attachmentId": ...,
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.delete_message_template_attachment(**kwargs)

1. See DeleteMessageTemplateAttachmentRequestRequestTypeDef

delete_quick_response

Deletes a quick response.

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

# delete_quick_response method definition

def delete_quick_response(
    self,
    *,
    knowledgeBaseId: str,
    quickResponseId: str,
) -> Dict[str, Any]:
    ...

# delete_quick_response method usage example with argument unpacking

kwargs: DeleteQuickResponseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "quickResponseId": ...,
}

parent.delete_quick_response(**kwargs)

1. See DeleteQuickResponseRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_ai_agent

Gets an Amazon Q in Connect AI Agent.

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

# get_ai_agent method definition

def get_ai_agent(
    self,
    *,
    aiAgentId: str,
    assistantId: str,
) -> GetAIAgentResponseTypeDef:  # (1)
    ...

1. See GetAIAgentResponseTypeDef

# get_ai_agent method usage example with argument unpacking

kwargs: GetAIAgentRequestRequestTypeDef = {  # (1)
    "aiAgentId": ...,
    "assistantId": ...,
}

parent.get_ai_agent(**kwargs)

1. See GetAIAgentRequestRequestTypeDef

get_ai_prompt

Gets and Amazon Q in Connect AI Prompt.

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

# get_ai_prompt method definition

def get_ai_prompt(
    self,
    *,
    aiPromptId: str,
    assistantId: str,
) -> GetAIPromptResponseTypeDef:  # (1)
    ...

1. See GetAIPromptResponseTypeDef

# get_ai_prompt method usage example with argument unpacking

kwargs: GetAIPromptRequestRequestTypeDef = {  # (1)
    "aiPromptId": ...,
    "assistantId": ...,
}

parent.get_ai_prompt(**kwargs)

1. See GetAIPromptRequestRequestTypeDef

get_assistant

Retrieves information about an assistant.

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

# get_assistant method definition

def get_assistant(
    self,
    *,
    assistantId: str,
) -> GetAssistantResponseTypeDef:  # (1)
    ...

1. See GetAssistantResponseTypeDef

# get_assistant method usage example with argument unpacking

kwargs: GetAssistantRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.get_assistant(**kwargs)

1. See GetAssistantRequestRequestTypeDef

get_assistant_association

Retrieves information about an assistant association.

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

# get_assistant_association method definition

def get_assistant_association(
    self,
    *,
    assistantAssociationId: str,
    assistantId: str,
) -> GetAssistantAssociationResponseTypeDef:  # (1)
    ...

1. See GetAssistantAssociationResponseTypeDef

# get_assistant_association method usage example with argument unpacking

kwargs: GetAssistantAssociationRequestRequestTypeDef = {  # (1)
    "assistantAssociationId": ...,
    "assistantId": ...,
}

parent.get_assistant_association(**kwargs)

1. See GetAssistantAssociationRequestRequestTypeDef

get_content

Retrieves content, including a pre-signed URL to download the content.

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

# get_content method definition

def get_content(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
) -> GetContentResponseTypeDef:  # (1)
    ...

1. See GetContentResponseTypeDef

# get_content method usage example with argument unpacking

kwargs: GetContentRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.get_content(**kwargs)

1. See GetContentRequestRequestTypeDef

get_content_association

Returns the content association.

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

# get_content_association method definition

def get_content_association(
    self,
    *,
    contentAssociationId: str,
    contentId: str,
    knowledgeBaseId: str,
) -> GetContentAssociationResponseTypeDef:  # (1)
    ...

1. See GetContentAssociationResponseTypeDef

# get_content_association method usage example with argument unpacking

kwargs: GetContentAssociationRequestRequestTypeDef = {  # (1)
    "contentAssociationId": ...,
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.get_content_association(**kwargs)

1. See GetContentAssociationRequestRequestTypeDef

get_content_summary

Retrieves summary information about the content.

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

# get_content_summary method definition

def get_content_summary(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
) -> GetContentSummaryResponseTypeDef:  # (1)
    ...

1. See GetContentSummaryResponseTypeDef

# get_content_summary method usage example with argument unpacking

kwargs: GetContentSummaryRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.get_content_summary(**kwargs)

1. See GetContentSummaryRequestRequestTypeDef

get_import_job

Retrieves the started import job.

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

# get_import_job method definition

def get_import_job(
    self,
    *,
    importJobId: str,
    knowledgeBaseId: str,
) -> GetImportJobResponseTypeDef:  # (1)
    ...

1. See GetImportJobResponseTypeDef

# get_import_job method usage example with argument unpacking

kwargs: GetImportJobRequestRequestTypeDef = {  # (1)
    "importJobId": ...,
    "knowledgeBaseId": ...,
}

parent.get_import_job(**kwargs)

1. See GetImportJobRequestRequestTypeDef

get_knowledge_base

Retrieves information about the knowledge base.

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

# get_knowledge_base method definition

def get_knowledge_base(
    self,
    *,
    knowledgeBaseId: str,
) -> GetKnowledgeBaseResponseTypeDef:  # (1)
    ...

1. See GetKnowledgeBaseResponseTypeDef

# get_knowledge_base method usage example with argument unpacking

kwargs: GetKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.get_knowledge_base(**kwargs)

1. See GetKnowledgeBaseRequestRequestTypeDef

get_message_template

Retrieves the Amazon Q in Connect message template.

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

# get_message_template method definition

def get_message_template(
    self,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
) -> GetMessageTemplateResponseTypeDef:  # (1)
    ...

1. See GetMessageTemplateResponseTypeDef

# get_message_template method usage example with argument unpacking

kwargs: GetMessageTemplateRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.get_message_template(**kwargs)

1. See GetMessageTemplateRequestRequestTypeDef

get_quick_response

Retrieves the quick response.

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

# get_quick_response method definition

def get_quick_response(
    self,
    *,
    knowledgeBaseId: str,
    quickResponseId: str,
) -> GetQuickResponseResponseTypeDef:  # (1)
    ...

1. See GetQuickResponseResponseTypeDef

# get_quick_response method usage example with argument unpacking

kwargs: GetQuickResponseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "quickResponseId": ...,
}

parent.get_quick_response(**kwargs)

1. See GetQuickResponseRequestRequestTypeDef

get_recommendations

.

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

# get_recommendations method definition

def get_recommendations(
    self,
    *,
    assistantId: str,
    sessionId: str,
    maxResults: int = ...,
    waitTimeSeconds: int = ...,
) -> GetRecommendationsResponseTypeDef:  # (1)
    ...

1. See GetRecommendationsResponseTypeDef

# get_recommendations method usage example with argument unpacking

kwargs: GetRecommendationsRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "sessionId": ...,
}

parent.get_recommendations(**kwargs)

1. See GetRecommendationsRequestRequestTypeDef

get_session

Retrieves information for a specified session.

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

# get_session method definition

def get_session(
    self,
    *,
    assistantId: str,
    sessionId: str,
) -> GetSessionResponseTypeDef:  # (1)
    ...

1. See GetSessionResponseTypeDef

# get_session method usage example with argument unpacking

kwargs: GetSessionRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "sessionId": ...,
}

parent.get_session(**kwargs)

1. See GetSessionRequestRequestTypeDef

list_ai_agent_versions

List AI Agent versions.

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

# list_ai_agent_versions method definition

def list_ai_agent_versions(
    self,
    *,
    aiAgentId: str,
    assistantId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    origin: OriginType = ...,  # (1)
) -> ListAIAgentVersionsResponseTypeDef:  # (2)
    ...

1. See OriginType
2. See ListAIAgentVersionsResponseTypeDef

# list_ai_agent_versions method usage example with argument unpacking

kwargs: ListAIAgentVersionsRequestRequestTypeDef = {  # (1)
    "aiAgentId": ...,
    "assistantId": ...,
}

parent.list_ai_agent_versions(**kwargs)

1. See ListAIAgentVersionsRequestRequestTypeDef

list_ai_agents

Lists AI Agents.

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

# list_ai_agents method definition

def list_ai_agents(
    self,
    *,
    assistantId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    origin: OriginType = ...,  # (1)
) -> ListAIAgentsResponseTypeDef:  # (2)
    ...

1. See OriginType
2. See ListAIAgentsResponseTypeDef

# list_ai_agents method usage example with argument unpacking

kwargs: ListAIAgentsRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.list_ai_agents(**kwargs)

1. See ListAIAgentsRequestRequestTypeDef

list_ai_prompt_versions

Lists AI Prompt versions.

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

# list_ai_prompt_versions method definition

def list_ai_prompt_versions(
    self,
    *,
    aiPromptId: str,
    assistantId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    origin: OriginType = ...,  # (1)
) -> ListAIPromptVersionsResponseTypeDef:  # (2)
    ...

1. See OriginType
2. See ListAIPromptVersionsResponseTypeDef

# list_ai_prompt_versions method usage example with argument unpacking

kwargs: ListAIPromptVersionsRequestRequestTypeDef = {  # (1)
    "aiPromptId": ...,
    "assistantId": ...,
}

parent.list_ai_prompt_versions(**kwargs)

1. See ListAIPromptVersionsRequestRequestTypeDef

list_ai_prompts

Lists the AI Prompts available on the Amazon Q in Connect assistant.

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

# list_ai_prompts method definition

def list_ai_prompts(
    self,
    *,
    assistantId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    origin: OriginType = ...,  # (1)
) -> ListAIPromptsResponseTypeDef:  # (2)
    ...

1. See OriginType
2. See ListAIPromptsResponseTypeDef

# list_ai_prompts method usage example with argument unpacking

kwargs: ListAIPromptsRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.list_ai_prompts(**kwargs)

1. See ListAIPromptsRequestRequestTypeDef

list_assistant_associations

Lists information about assistant associations.

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

# list_assistant_associations method definition

def list_assistant_associations(
    self,
    *,
    assistantId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAssistantAssociationsResponseTypeDef:  # (1)
    ...

1. See ListAssistantAssociationsResponseTypeDef

# list_assistant_associations method usage example with argument unpacking

kwargs: ListAssistantAssociationsRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.list_assistant_associations(**kwargs)

1. See ListAssistantAssociationsRequestRequestTypeDef

list_assistants

Lists information about assistants.

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

# list_assistants method definition

def list_assistants(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAssistantsResponseTypeDef:  # (1)
    ...

1. See ListAssistantsResponseTypeDef

# list_assistants method usage example with argument unpacking

kwargs: ListAssistantsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_assistants(**kwargs)

1. See ListAssistantsRequestRequestTypeDef

list_content_associations

Lists the content associations.

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

# list_content_associations method definition

def list_content_associations(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListContentAssociationsResponseTypeDef:  # (1)
    ...

1. See ListContentAssociationsResponseTypeDef

# list_content_associations method usage example with argument unpacking

kwargs: ListContentAssociationsRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.list_content_associations(**kwargs)

1. See ListContentAssociationsRequestRequestTypeDef

list_contents

Lists the content.

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

# list_contents method definition

def list_contents(
    self,
    *,
    knowledgeBaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListContentsResponseTypeDef:  # (1)
    ...

1. See ListContentsResponseTypeDef

# list_contents method usage example with argument unpacking

kwargs: ListContentsRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.list_contents(**kwargs)

1. See ListContentsRequestRequestTypeDef

list_import_jobs

Lists information about import jobs.

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

# list_import_jobs method definition

def list_import_jobs(
    self,
    *,
    knowledgeBaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImportJobsResponseTypeDef:  # (1)
    ...

1. See ListImportJobsResponseTypeDef

# list_import_jobs method usage example with argument unpacking

kwargs: ListImportJobsRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.list_import_jobs(**kwargs)

1. See ListImportJobsRequestRequestTypeDef

list_knowledge_bases

Lists the knowledge bases.

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

# list_knowledge_bases method definition

def list_knowledge_bases(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListKnowledgeBasesResponseTypeDef:  # (1)
    ...

1. See ListKnowledgeBasesResponseTypeDef

# list_knowledge_bases method usage example with argument unpacking

kwargs: ListKnowledgeBasesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_knowledge_bases(**kwargs)

1. See ListKnowledgeBasesRequestRequestTypeDef

list_message_template_versions

Lists all the available versions for the specified Amazon Q in Connect message template.

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

# list_message_template_versions method definition

def list_message_template_versions(
    self,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMessageTemplateVersionsResponseTypeDef:  # (1)
    ...

1. See ListMessageTemplateVersionsResponseTypeDef

# list_message_template_versions method usage example with argument unpacking

kwargs: ListMessageTemplateVersionsRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.list_message_template_versions(**kwargs)

1. See ListMessageTemplateVersionsRequestRequestTypeDef

list_message_templates

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

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

# list_message_templates method definition

def list_message_templates(
    self,
    *,
    knowledgeBaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMessageTemplatesResponseTypeDef:  # (1)
    ...

1. See ListMessageTemplatesResponseTypeDef

# list_message_templates method usage example with argument unpacking

kwargs: ListMessageTemplatesRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.list_message_templates(**kwargs)

1. See ListMessageTemplatesRequestRequestTypeDef

list_quick_responses

Lists information about quick response.

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

# list_quick_responses method definition

def list_quick_responses(
    self,
    *,
    knowledgeBaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListQuickResponsesResponseTypeDef:  # (1)
    ...

1. See ListQuickResponsesResponseTypeDef

# list_quick_responses method usage example with argument unpacking

kwargs: ListQuickResponsesRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.list_quick_responses(**kwargs)

1. See ListQuickResponsesRequestRequestTypeDef

list_tags_for_resource

Lists the tags for the specified resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

notify_recommendations_received

Removes the specified recommendations from the specified assistant's queue of newly available recommendations.

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

# notify_recommendations_received method definition

def notify_recommendations_received(
    self,
    *,
    assistantId: str,
    recommendationIds: Sequence[str],
    sessionId: str,
) -> NotifyRecommendationsReceivedResponseTypeDef:  # (1)
    ...

1. See NotifyRecommendationsReceivedResponseTypeDef

# notify_recommendations_received method usage example with argument unpacking

kwargs: NotifyRecommendationsReceivedRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "recommendationIds": ...,
    "sessionId": ...,
}

parent.notify_recommendations_received(**kwargs)

1. See NotifyRecommendationsReceivedRequestRequestTypeDef

put_feedback

Provides feedback against the specified assistant for the specified target.

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

# put_feedback method definition

def put_feedback(
    self,
    *,
    assistantId: str,
    contentFeedback: ContentFeedbackDataTypeDef,  # (1)
    targetId: str,
    targetType: TargetTypeType,  # (2)
) -> PutFeedbackResponseTypeDef:  # (3)
    ...

1. See ContentFeedbackDataTypeDef
2. See TargetTypeType
3. See PutFeedbackResponseTypeDef

# put_feedback method usage example with argument unpacking

kwargs: PutFeedbackRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "contentFeedback": ...,
    "targetId": ...,
    "targetType": ...,
}

parent.put_feedback(**kwargs)

1. See PutFeedbackRequestRequestTypeDef

query_assistant

.

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

# query_assistant method definition

def query_assistant(
    self,
    *,
    assistantId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    overrideKnowledgeBaseSearchType: KnowledgeBaseSearchTypeType = ...,  # (1)
    queryCondition: Sequence[QueryConditionTypeDef] = ...,  # (2)
    queryInputData: QueryInputDataTypeDef = ...,  # (3)
    queryText: str = ...,
    sessionId: str = ...,
) -> QueryAssistantResponseTypeDef:  # (4)
    ...

1. See KnowledgeBaseSearchTypeType
2. See QueryConditionTypeDef
3. See QueryInputDataTypeDef
4. See QueryAssistantResponseTypeDef

# query_assistant method usage example with argument unpacking

kwargs: QueryAssistantRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.query_assistant(**kwargs)

1. See QueryAssistantRequestRequestTypeDef

remove_assistant_ai_agent

Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

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

# remove_assistant_ai_agent method definition

def remove_assistant_ai_agent(
    self,
    *,
    aiAgentType: AIAgentTypeType,  # (1)
    assistantId: str,
) -> Dict[str, Any]:
    ...

1. See AIAgentTypeType

# remove_assistant_ai_agent method usage example with argument unpacking

kwargs: RemoveAssistantAIAgentRequestRequestTypeDef = {  # (1)
    "aiAgentType": ...,
    "assistantId": ...,
}

parent.remove_assistant_ai_agent(**kwargs)

1. See RemoveAssistantAIAgentRequestRequestTypeDef

remove_knowledge_base_template_uri

Removes a URI template from a knowledge base.

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

# remove_knowledge_base_template_uri method definition

def remove_knowledge_base_template_uri(
    self,
    *,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

# remove_knowledge_base_template_uri method usage example with argument unpacking

kwargs: RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.remove_knowledge_base_template_uri(**kwargs)

1. See RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef

render_message_template

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content.

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

# render_message_template method definition

def render_message_template(
    self,
    *,
    attributes: MessageTemplateAttributesTypeDef,  # (1)
    knowledgeBaseId: str,
    messageTemplateId: str,
) -> RenderMessageTemplateResponseTypeDef:  # (2)
    ...

1. See MessageTemplateAttributesTypeDef
2. See RenderMessageTemplateResponseTypeDef

# render_message_template method usage example with argument unpacking

kwargs: RenderMessageTemplateRequestRequestTypeDef = {  # (1)
    "attributes": ...,
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.render_message_template(**kwargs)

1. See RenderMessageTemplateRequestRequestTypeDef

search_content

Searches for content in a specified knowledge base.

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

# search_content method definition

def search_content(
    self,
    *,
    knowledgeBaseId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchContentResponseTypeDef:  # (2)
    ...

1. See SearchExpressionTypeDef
2. See SearchContentResponseTypeDef

# search_content method usage example with argument unpacking

kwargs: SearchContentRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "searchExpression": ...,
}

parent.search_content(**kwargs)

1. See SearchContentRequestRequestTypeDef

search_message_templates

Searches for Amazon Q in Connect message templates in the specified knowledge base.

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

# search_message_templates method definition

def search_message_templates(
    self,
    *,
    knowledgeBaseId: str,
    searchExpression: MessageTemplateSearchExpressionTypeDef,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchMessageTemplatesResponseTypeDef:  # (2)
    ...

1. See MessageTemplateSearchExpressionTypeDef
2. See SearchMessageTemplatesResponseTypeDef

# search_message_templates method usage example with argument unpacking

kwargs: SearchMessageTemplatesRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "searchExpression": ...,
}

parent.search_message_templates(**kwargs)

1. See SearchMessageTemplatesRequestRequestTypeDef

search_quick_responses

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

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

# search_quick_responses method definition

def search_quick_responses(
    self,
    *,
    knowledgeBaseId: str,
    searchExpression: QuickResponseSearchExpressionTypeDef,  # (1)
    attributes: Mapping[str, str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchQuickResponsesResponseTypeDef:  # (2)
    ...

1. See QuickResponseSearchExpressionTypeDef
2. See SearchQuickResponsesResponseTypeDef

# search_quick_responses method usage example with argument unpacking

kwargs: SearchQuickResponsesRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "searchExpression": ...,
}

parent.search_quick_responses(**kwargs)

1. See SearchQuickResponsesRequestRequestTypeDef

search_sessions

Searches for sessions.

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

# search_sessions method definition

def search_sessions(
    self,
    *,
    assistantId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchSessionsResponseTypeDef:  # (2)
    ...

1. See SearchExpressionTypeDef
2. See SearchSessionsResponseTypeDef

# search_sessions method usage example with argument unpacking

kwargs: SearchSessionsRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "searchExpression": ...,
}

parent.search_sessions(**kwargs)

1. See SearchSessionsRequestRequestTypeDef

start_content_upload

Get a URL to upload content to a knowledge base.

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

# start_content_upload method definition

def start_content_upload(
    self,
    *,
    contentType: str,
    knowledgeBaseId: str,
    presignedUrlTimeToLive: int = ...,
) -> StartContentUploadResponseTypeDef:  # (1)
    ...

1. See StartContentUploadResponseTypeDef

# start_content_upload method usage example with argument unpacking

kwargs: StartContentUploadRequestRequestTypeDef = {  # (1)
    "contentType": ...,
    "knowledgeBaseId": ...,
}

parent.start_content_upload(**kwargs)

1. See StartContentUploadRequestRequestTypeDef

start_import_job

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.

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

# start_import_job method definition

def start_import_job(
    self,
    *,
    importJobType: ImportJobTypeType,  # (1)
    knowledgeBaseId: str,
    uploadId: str,
    clientToken: str = ...,
    externalSourceConfiguration: ExternalSourceConfigurationTypeDef = ...,  # (2)
    metadata: Mapping[str, str] = ...,
) -> StartImportJobResponseTypeDef:  # (3)
    ...

1. See ImportJobTypeType
2. See ExternalSourceConfigurationTypeDef
3. See StartImportJobResponseTypeDef

# start_import_job method usage example with argument unpacking

kwargs: StartImportJobRequestRequestTypeDef = {  # (1)
    "importJobType": ...,
    "knowledgeBaseId": ...,
    "uploadId": ...,
}

parent.start_import_job(**kwargs)

1. See StartImportJobRequestRequestTypeDef

tag_resource

Adds the specified tags to the specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the specified tags from the specified resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_ai_agent

Updates an AI Agent.

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

# update_ai_agent method definition

def update_ai_agent(
    self,
    *,
    aiAgentId: str,
    assistantId: str,
    visibilityStatus: VisibilityStatusType,  # (1)
    clientToken: str = ...,
    configuration: AIAgentConfigurationTypeDef = ...,  # (2)
    description: str = ...,
) -> UpdateAIAgentResponseTypeDef:  # (3)
    ...

1. See VisibilityStatusType
2. See AIAgentConfigurationTypeDef
3. See UpdateAIAgentResponseTypeDef

# update_ai_agent method usage example with argument unpacking

kwargs: UpdateAIAgentRequestRequestTypeDef = {  # (1)
    "aiAgentId": ...,
    "assistantId": ...,
    "visibilityStatus": ...,
}

parent.update_ai_agent(**kwargs)

1. See UpdateAIAgentRequestRequestTypeDef

update_ai_prompt

Updates an AI Prompt.

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

# update_ai_prompt method definition

def update_ai_prompt(
    self,
    *,
    aiPromptId: str,
    assistantId: str,
    visibilityStatus: VisibilityStatusType,  # (1)
    clientToken: str = ...,
    description: str = ...,
    templateConfiguration: AIPromptTemplateConfigurationTypeDef = ...,  # (2)
) -> UpdateAIPromptResponseTypeDef:  # (3)
    ...

1. See VisibilityStatusType
2. See AIPromptTemplateConfigurationTypeDef
3. See UpdateAIPromptResponseTypeDef

# update_ai_prompt method usage example with argument unpacking

kwargs: UpdateAIPromptRequestRequestTypeDef = {  # (1)
    "aiPromptId": ...,
    "assistantId": ...,
    "visibilityStatus": ...,
}

parent.update_ai_prompt(**kwargs)

1. See UpdateAIPromptRequestRequestTypeDef

update_assistant_ai_agent

Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

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

# update_assistant_ai_agent method definition

def update_assistant_ai_agent(
    self,
    *,
    aiAgentType: AIAgentTypeType,  # (1)
    assistantId: str,
    configuration: AIAgentConfigurationDataTypeDef,  # (2)
) -> UpdateAssistantAIAgentResponseTypeDef:  # (3)
    ...

1. See AIAgentTypeType
2. See AIAgentConfigurationDataTypeDef
3. See UpdateAssistantAIAgentResponseTypeDef

# update_assistant_ai_agent method usage example with argument unpacking

kwargs: UpdateAssistantAIAgentRequestRequestTypeDef = {  # (1)
    "aiAgentType": ...,
    "assistantId": ...,
    "configuration": ...,
}

parent.update_assistant_ai_agent(**kwargs)

1. See UpdateAssistantAIAgentRequestRequestTypeDef

update_content

Updates information about the content.

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

# update_content method definition

def update_content(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
    metadata: Mapping[str, str] = ...,
    overrideLinkOutUri: str = ...,
    removeOverrideLinkOutUri: bool = ...,
    revisionId: str = ...,
    title: str = ...,
    uploadId: str = ...,
) -> UpdateContentResponseTypeDef:  # (1)
    ...

1. See UpdateContentResponseTypeDef

# update_content method usage example with argument unpacking

kwargs: UpdateContentRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.update_content(**kwargs)

1. See UpdateContentRequestRequestTypeDef

update_knowledge_base_template_uri

Updates the template URI of a knowledge base.

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

# update_knowledge_base_template_uri method definition

def update_knowledge_base_template_uri(
    self,
    *,
    knowledgeBaseId: str,
    templateUri: str,
) -> UpdateKnowledgeBaseTemplateUriResponseTypeDef:  # (1)
    ...

1. See UpdateKnowledgeBaseTemplateUriResponseTypeDef

# update_knowledge_base_template_uri method usage example with argument unpacking

kwargs: UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "templateUri": ...,
}

parent.update_knowledge_base_template_uri(**kwargs)

1. See UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef

update_message_template

Updates the Amazon Q in Connect message template.

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

# update_message_template method definition

def update_message_template(
    self,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    content: MessageTemplateContentProviderTypeDef = ...,  # (1)
    defaultAttributes: MessageTemplateAttributesTypeDef = ...,  # (2)
    language: str = ...,
) -> UpdateMessageTemplateResponseTypeDef:  # (3)
    ...

1. See MessageTemplateContentProviderTypeDef
2. See MessageTemplateAttributesTypeDef
3. See UpdateMessageTemplateResponseTypeDef

# update_message_template method usage example with argument unpacking

kwargs: UpdateMessageTemplateRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.update_message_template(**kwargs)

1. See UpdateMessageTemplateRequestRequestTypeDef

update_message_template_metadata

Updates the Amazon Q in Connect message template metadata.

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

# update_message_template_metadata method definition

def update_message_template_metadata(
    self,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    description: str = ...,
    groupingConfiguration: GroupingConfigurationTypeDef = ...,  # (1)
    name: str = ...,
) -> UpdateMessageTemplateMetadataResponseTypeDef:  # (2)
    ...

1. See GroupingConfigurationTypeDef
2. See UpdateMessageTemplateMetadataResponseTypeDef

# update_message_template_metadata method usage example with argument unpacking

kwargs: UpdateMessageTemplateMetadataRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.update_message_template_metadata(**kwargs)

1. See UpdateMessageTemplateMetadataRequestRequestTypeDef

update_quick_response

Updates an existing Amazon Q in Connect quick response.

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

# update_quick_response method definition

def update_quick_response(
    self,
    *,
    knowledgeBaseId: str,
    quickResponseId: str,
    channels: Sequence[str] = ...,
    content: QuickResponseDataProviderTypeDef = ...,  # (1)
    contentType: str = ...,
    description: str = ...,
    groupingConfiguration: GroupingConfigurationTypeDef = ...,  # (2)
    isActive: bool = ...,
    language: str = ...,
    name: str = ...,
    removeDescription: bool = ...,
    removeGroupingConfiguration: bool = ...,
    removeShortcutKey: bool = ...,
    shortcutKey: str = ...,
) -> UpdateQuickResponseResponseTypeDef:  # (3)
    ...

1. See QuickResponseDataProviderTypeDef
2. See GroupingConfigurationTypeDef
3. See UpdateQuickResponseResponseTypeDef

# update_quick_response method usage example with argument unpacking

kwargs: UpdateQuickResponseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "quickResponseId": ...,
}

parent.update_quick_response(**kwargs)

1. See UpdateQuickResponseRequestRequestTypeDef

update_session

Updates a session.

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

# update_session method definition

def update_session(
    self,
    *,
    assistantId: str,
    sessionId: str,
    aiAgentConfiguration: Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef] = ...,  # (1)
    description: str = ...,
    tagFilter: TagFilterTypeDef = ...,  # (2)
) -> UpdateSessionResponseTypeDef:  # (3)
    ...

1. See AIAgentTypeType AIAgentConfigurationDataTypeDef
2. See TagFilterTypeDef
3. See UpdateSessionResponseTypeDef

# update_session method usage example with argument unpacking

kwargs: UpdateSessionRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "sessionId": ...,
}

parent.update_session(**kwargs)

1. See UpdateSessionRequestRequestTypeDef

update_session_data

Updates the data stored on an Amazon Q in Connect Session.

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

# update_session_data method definition

def update_session_data(
    self,
    *,
    assistantId: str,
    data: Sequence[RuntimeSessionDataTypeDef],  # (1)
    sessionId: str,
    namespace: SessionDataNamespaceType = ...,  # (2)
) -> UpdateSessionDataResponseTypeDef:  # (3)
    ...

1. See RuntimeSessionDataTypeDef
2. See SessionDataNamespaceType
3. See UpdateSessionDataResponseTypeDef

# update_session_data method usage example with argument unpacking

kwargs: UpdateSessionDataRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "data": ...,
    "sessionId": ...,
}

parent.update_session_data(**kwargs)

1. See UpdateSessionDataRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("qconnect").get_paginator method with overloads.

• client.get_paginator("list_ai_agent_versions") -> ListAIAgentVersionsPaginator
• client.get_paginator("list_ai_agents") -> ListAIAgentsPaginator
• client.get_paginator("list_ai_prompt_versions") -> ListAIPromptVersionsPaginator
• client.get_paginator("list_ai_prompts") -> ListAIPromptsPaginator
• client.get_paginator("list_assistant_associations") -> ListAssistantAssociationsPaginator
• client.get_paginator("list_assistants") -> ListAssistantsPaginator
• client.get_paginator("list_content_associations") -> ListContentAssociationsPaginator
• client.get_paginator("list_contents") -> ListContentsPaginator
• client.get_paginator("list_import_jobs") -> ListImportJobsPaginator
• client.get_paginator("list_knowledge_bases") -> ListKnowledgeBasesPaginator
• client.get_paginator("list_message_template_versions") -> ListMessageTemplateVersionsPaginator
• client.get_paginator("list_message_templates") -> ListMessageTemplatesPaginator
• client.get_paginator("list_quick_responses") -> ListQuickResponsesPaginator
• client.get_paginator("query_assistant") -> QueryAssistantPaginator
• client.get_paginator("search_content") -> SearchContentPaginator
• client.get_paginator("search_message_templates") -> SearchMessageTemplatesPaginator
• client.get_paginator("search_quick_responses") -> SearchQuickResponsesPaginator
• client.get_paginator("search_sessions") -> SearchSessionsPaginator