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#

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:
    ...

generate_presigned_url#

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:
    ...

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: ActivateMessageTemplateRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
    "versionNumber": ...,
}

parent.activate_message_template(**kwargs)
  1. See ActivateMessageTemplateRequestTypeDef

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,
    name: str,
    type: AIAgentTypeType,  # (1)
    configuration: AIAgentConfigurationUnionTypeDef,  # (2)
    visibilityStatus: VisibilityStatusType,  # (3)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
    description: str = ...,
) -> CreateAIAgentResponseTypeDef:  # (4)
    ...
  1. See AIAgentTypeType
  2. See AIAgentConfigurationUnionTypeDef
  3. See VisibilityStatusType
  4. See CreateAIAgentResponseTypeDef
# create_ai_agent method usage example with argument unpacking

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

parent.create_ai_agent(**kwargs)
  1. See CreateAIAgentRequestTypeDef

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,
    *,
    assistantId: str,
    aiAgentId: str,
    modifiedTime: TimestampTypeDef = ...,
    clientToken: str = ...,
) -> CreateAIAgentVersionResponseTypeDef:  # (1)
    ...
  1. See CreateAIAgentVersionResponseTypeDef
# create_ai_agent_version method usage example with argument unpacking

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

parent.create_ai_agent_version(**kwargs)
  1. See CreateAIAgentVersionRequestTypeDef

create_ai_guardrail#

Creates an Amazon Q in Connect AI Guardrail.

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

# create_ai_guardrail method definition

def create_ai_guardrail(
    self,
    *,
    assistantId: str,
    name: str,
    blockedInputMessaging: str,
    blockedOutputsMessaging: str,
    visibilityStatus: VisibilityStatusType,  # (1)
    clientToken: str = ...,
    description: str = ...,
    topicPolicyConfig: AIGuardrailTopicPolicyConfigUnionTypeDef = ...,  # (2)
    contentPolicyConfig: AIGuardrailContentPolicyConfigUnionTypeDef = ...,  # (3)
    wordPolicyConfig: AIGuardrailWordPolicyConfigUnionTypeDef = ...,  # (4)
    sensitiveInformationPolicyConfig: AIGuardrailSensitiveInformationPolicyConfigUnionTypeDef = ...,  # (5)
    contextualGroundingPolicyConfig: AIGuardrailContextualGroundingPolicyConfigUnionTypeDef = ...,  # (6)
    tags: Mapping[str, str] = ...,
) -> CreateAIGuardrailResponseTypeDef:  # (7)
    ...
  1. See VisibilityStatusType
  2. See AIGuardrailTopicPolicyConfigUnionTypeDef
  3. See AIGuardrailContentPolicyConfigUnionTypeDef
  4. See AIGuardrailWordPolicyConfigUnionTypeDef
  5. See AIGuardrailSensitiveInformationPolicyConfigUnionTypeDef
  6. See AIGuardrailContextualGroundingPolicyConfigUnionTypeDef
  7. See CreateAIGuardrailResponseTypeDef
# create_ai_guardrail method usage example with argument unpacking

kwargs: CreateAIGuardrailRequestTypeDef = {  # (1)
    "assistantId": ...,
    "name": ...,
    "blockedInputMessaging": ...,
    "blockedOutputsMessaging": ...,
    "visibilityStatus": ...,
}

parent.create_ai_guardrail(**kwargs)
  1. See CreateAIGuardrailRequestTypeDef

create_ai_guardrail_version#

Creates an Amazon Q in Connect AI Guardrail version.

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

# create_ai_guardrail_version method definition

def create_ai_guardrail_version(
    self,
    *,
    assistantId: str,
    aiGuardrailId: str,
    modifiedTime: TimestampTypeDef = ...,
    clientToken: str = ...,
) -> CreateAIGuardrailVersionResponseTypeDef:  # (1)
    ...
  1. See CreateAIGuardrailVersionResponseTypeDef
# create_ai_guardrail_version method usage example with argument unpacking

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

parent.create_ai_guardrail_version(**kwargs)
  1. See CreateAIGuardrailVersionRequestTypeDef

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,
    *,
    assistantId: str,
    name: str,
    type: AIPromptTypeType,  # (1)
    templateConfiguration: AIPromptTemplateConfigurationTypeDef,  # (2)
    visibilityStatus: VisibilityStatusType,  # (3)
    templateType: AIPromptTemplateTypeType,  # (4)
    modelId: str,
    apiFormat: AIPromptAPIFormatType,  # (5)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
    description: str = ...,
) -> CreateAIPromptResponseTypeDef:  # (6)
    ...
  1. See AIPromptTypeType
  2. See AIPromptTemplateConfigurationTypeDef
  3. See VisibilityStatusType
  4. See AIPromptTemplateTypeType
  5. See AIPromptAPIFormatType
  6. See CreateAIPromptResponseTypeDef
# create_ai_prompt method usage example with argument unpacking

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

parent.create_ai_prompt(**kwargs)
  1. See CreateAIPromptRequestTypeDef

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,
    *,
    assistantId: str,
    aiPromptId: str,
    modifiedTime: TimestampTypeDef = ...,
    clientToken: str = ...,
) -> CreateAIPromptVersionResponseTypeDef:  # (1)
    ...
  1. See CreateAIPromptVersionResponseTypeDef
# create_ai_prompt_version method usage example with argument unpacking

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

parent.create_ai_prompt_version(**kwargs)
  1. See CreateAIPromptVersionRequestTypeDef

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 = ...,
    tags: Mapping[str, str] = ...,
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (2)
) -> CreateAssistantResponseTypeDef:  # (3)
    ...
  1. See AssistantTypeType
  2. See ServerSideEncryptionConfigurationTypeDef
  3. See CreateAssistantResponseTypeDef
# create_assistant method usage example with argument unpacking

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

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

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,
    associationType: AssociationTypeType,  # (1)
    association: AssistantAssociationInputDataTypeDef,  # (2)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAssistantAssociationResponseTypeDef:  # (3)
    ...
  1. See AssociationTypeType
  2. See AssistantAssociationInputDataTypeDef
  3. See CreateAssistantAssociationResponseTypeDef
# create_assistant_association method usage example with argument unpacking

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

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

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,
    title: str = ...,
    overrideLinkOutUri: str = ...,
    metadata: Mapping[str, str] = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateContentResponseTypeDef:  # (1)
    ...
  1. See CreateContentResponseTypeDef
# create_content method usage example with argument unpacking

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

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

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

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

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

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,
    *,
    name: str,
    knowledgeBaseType: KnowledgeBaseTypeType,  # (1)
    clientToken: str = ...,
    sourceConfiguration: SourceConfigurationUnionTypeDef = ...,  # (2)
    renderingConfiguration: RenderingConfigurationTypeDef = ...,  # (3)
    vectorIngestionConfiguration: VectorIngestionConfigurationUnionTypeDef = ...,  # (4)
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (5)
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateKnowledgeBaseResponseTypeDef:  # (6)
    ...
  1. See KnowledgeBaseTypeType
  2. See SourceConfigurationUnionTypeDef
  3. See RenderingConfigurationTypeDef
  4. See VectorIngestionConfigurationUnionTypeDef
  5. See ServerSideEncryptionConfigurationTypeDef
  6. See CreateKnowledgeBaseResponseTypeDef
# create_knowledge_base method usage example with argument unpacking

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

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

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,
    *,
    knowledgeBaseId: str,
    name: str,
    content: MessageTemplateContentProviderUnionTypeDef,  # (1)
    channelSubtype: ChannelSubtypeType,  # (2)
    description: str = ...,
    language: str = ...,
    defaultAttributes: MessageTemplateAttributesUnionTypeDef = ...,  # (3)
    groupingConfiguration: GroupingConfigurationUnionTypeDef = ...,  # (4)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateMessageTemplateResponseTypeDef:  # (5)
    ...
  1. See MessageTemplateContentProviderUnionTypeDef
  2. See ChannelSubtypeType
  3. See MessageTemplateAttributesUnionTypeDef
  4. See GroupingConfigurationUnionTypeDef
  5. See CreateMessageTemplateResponseTypeDef
# create_message_template method usage example with argument unpacking

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

parent.create_message_template(**kwargs)
  1. See CreateMessageTemplateRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    contentDisposition: ContentDispositionType,  # (1)
    name: str,
    body: str,
    clientToken: str = ...,
) -> CreateMessageTemplateAttachmentResponseTypeDef:  # (2)
    ...
  1. See ContentDispositionType
  2. See CreateMessageTemplateAttachmentResponseTypeDef
# create_message_template_attachment method usage example with argument unpacking

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

parent.create_message_template_attachment(**kwargs)
  1. See CreateMessageTemplateAttachmentRequestTypeDef

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: CreateMessageTemplateVersionRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.create_message_template_version(**kwargs)
  1. See CreateMessageTemplateVersionRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    name: str,
    content: QuickResponseDataProviderTypeDef,  # (1)
    contentType: str = ...,
    groupingConfiguration: GroupingConfigurationUnionTypeDef = ...,  # (2)
    description: str = ...,
    shortcutKey: str = ...,
    isActive: bool = ...,
    channels: Sequence[str] = ...,
    language: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateQuickResponseResponseTypeDef:  # (3)
    ...
  1. See QuickResponseDataProviderTypeDef
  2. See GroupingConfigurationUnionTypeDef
  3. See CreateQuickResponseResponseTypeDef
# create_quick_response method usage example with argument unpacking

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

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

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,
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
    tagFilter: TagFilterUnionTypeDef = ...,  # (1)
    aiAgentConfiguration: Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef] = ...,  # (2)
) -> CreateSessionResponseTypeDef:  # (3)
    ...
  1. See TagFilterUnionTypeDef
  2. See Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef]
  3. See CreateSessionResponseTypeDef
# create_session method usage example with argument unpacking

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

parent.create_session(**kwargs)
  1. See CreateSessionRequestTypeDef

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: DeactivateMessageTemplateRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
    "versionNumber": ...,
}

parent.deactivate_message_template(**kwargs)
  1. See DeactivateMessageTemplateRequestTypeDef

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,
    *,
    assistantId: str,
    aiAgentId: str,
) -> Dict[str, Any]:
    ...
# delete_ai_agent method usage example with argument unpacking

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

parent.delete_ai_agent(**kwargs)
  1. See DeleteAIAgentRequestTypeDef

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,
    *,
    assistantId: str,
    aiAgentId: str,
    versionNumber: int,
) -> Dict[str, Any]:
    ...
# delete_ai_agent_version method usage example with argument unpacking

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

parent.delete_ai_agent_version(**kwargs)
  1. See DeleteAIAgentVersionRequestTypeDef

delete_ai_guardrail#

Deletes an Amazon Q in Connect AI Guardrail.

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

# delete_ai_guardrail method definition

def delete_ai_guardrail(
    self,
    *,
    assistantId: str,
    aiGuardrailId: str,
) -> Dict[str, Any]:
    ...
# delete_ai_guardrail method usage example with argument unpacking

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

parent.delete_ai_guardrail(**kwargs)
  1. See DeleteAIGuardrailRequestTypeDef

delete_ai_guardrail_version#

Delete and Amazon Q in Connect AI Guardrail version.

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

# delete_ai_guardrail_version method definition

def delete_ai_guardrail_version(
    self,
    *,
    assistantId: str,
    aiGuardrailId: str,
    versionNumber: int,
) -> Dict[str, Any]:
    ...
# delete_ai_guardrail_version method usage example with argument unpacking

kwargs: DeleteAIGuardrailVersionRequestTypeDef = {  # (1)
    "assistantId": ...,
    "aiGuardrailId": ...,
    "versionNumber": ...,
}

parent.delete_ai_guardrail_version(**kwargs)
  1. See DeleteAIGuardrailVersionRequestTypeDef

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,
    *,
    assistantId: str,
    aiPromptId: str,
) -> Dict[str, Any]:
    ...
# delete_ai_prompt method usage example with argument unpacking

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

parent.delete_ai_prompt(**kwargs)
  1. See DeleteAIPromptRequestTypeDef

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,
    *,
    assistantId: str,
    aiPromptId: str,
    versionNumber: int,
) -> Dict[str, Any]:
    ...
# delete_ai_prompt_version method usage example with argument unpacking

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

parent.delete_ai_prompt_version(**kwargs)
  1. See DeleteAIPromptVersionRequestTypeDef

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: DeleteAssistantRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.delete_assistant(**kwargs)
  1. See DeleteAssistantRequestTypeDef

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: DeleteAssistantAssociationRequestTypeDef = {  # (1)
    "assistantAssociationId": ...,
    "assistantId": ...,
}

parent.delete_assistant_association(**kwargs)
  1. See DeleteAssistantAssociationRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    contentId: str,
) -> Dict[str, Any]:
    ...
# delete_content method usage example with argument unpacking

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

parent.delete_content(**kwargs)
  1. See DeleteContentRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    contentId: str,
    contentAssociationId: str,
) -> Dict[str, Any]:
    ...
# delete_content_association method usage example with argument unpacking

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

parent.delete_content_association(**kwargs)
  1. See DeleteContentAssociationRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    importJobId: str,
) -> Dict[str, Any]:
    ...
# delete_import_job method usage example with argument unpacking

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

parent.delete_import_job(**kwargs)
  1. See DeleteImportJobRequestTypeDef

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: DeleteKnowledgeBaseRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.delete_knowledge_base(**kwargs)
  1. See DeleteKnowledgeBaseRequestTypeDef

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: DeleteMessageTemplateRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "messageTemplateId": ...,
}

parent.delete_message_template(**kwargs)
  1. See DeleteMessageTemplateRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    attachmentId: str,
) -> Dict[str, Any]:
    ...
# delete_message_template_attachment method usage example with argument unpacking

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

parent.delete_message_template_attachment(**kwargs)
  1. See DeleteMessageTemplateAttachmentRequestTypeDef

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: DeleteQuickResponseRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "quickResponseId": ...,
}

parent.delete_quick_response(**kwargs)
  1. See DeleteQuickResponseRequestTypeDef

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,
    *,
    assistantId: str,
    aiAgentId: str,
) -> GetAIAgentResponseTypeDef:  # (1)
    ...
  1. See GetAIAgentResponseTypeDef
# get_ai_agent method usage example with argument unpacking

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

parent.get_ai_agent(**kwargs)
  1. See GetAIAgentRequestTypeDef

get_ai_guardrail#

Gets the Amazon Q in Connect AI Guardrail.

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

# get_ai_guardrail method definition

def get_ai_guardrail(
    self,
    *,
    assistantId: str,
    aiGuardrailId: str,
) -> GetAIGuardrailResponseTypeDef:  # (1)
    ...
  1. See GetAIGuardrailResponseTypeDef
# get_ai_guardrail method usage example with argument unpacking

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

parent.get_ai_guardrail(**kwargs)
  1. See GetAIGuardrailRequestTypeDef

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,
    *,
    assistantId: str,
    aiPromptId: str,
) -> GetAIPromptResponseTypeDef:  # (1)
    ...
  1. See GetAIPromptResponseTypeDef
# get_ai_prompt method usage example with argument unpacking

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

parent.get_ai_prompt(**kwargs)
  1. See GetAIPromptRequestTypeDef

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: GetAssistantRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.get_assistant(**kwargs)
  1. See GetAssistantRequestTypeDef

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: GetAssistantAssociationRequestTypeDef = {  # (1)
    "assistantAssociationId": ...,
    "assistantId": ...,
}

parent.get_assistant_association(**kwargs)
  1. See GetAssistantAssociationRequestTypeDef

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: GetContentRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.get_content(**kwargs)
  1. See GetContentRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    contentId: str,
    contentAssociationId: str,
) -> GetContentAssociationResponseTypeDef:  # (1)
    ...
  1. See GetContentAssociationResponseTypeDef
# get_content_association method usage example with argument unpacking

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

parent.get_content_association(**kwargs)
  1. See GetContentAssociationRequestTypeDef

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: GetContentSummaryRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.get_content_summary(**kwargs)
  1. See GetContentSummaryRequestTypeDef

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: GetImportJobRequestTypeDef = {  # (1)
    "importJobId": ...,
    "knowledgeBaseId": ...,
}

parent.get_import_job(**kwargs)
  1. See GetImportJobRequestTypeDef

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: GetKnowledgeBaseRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.get_knowledge_base(**kwargs)
  1. See GetKnowledgeBaseRequestTypeDef

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,
    *,
    messageTemplateId: str,
    knowledgeBaseId: str,
) -> GetMessageTemplateResponseTypeDef:  # (1)
    ...
  1. See GetMessageTemplateResponseTypeDef
# get_message_template method usage example with argument unpacking

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

parent.get_message_template(**kwargs)
  1. See GetMessageTemplateRequestTypeDef

get_next_message#

Retrieves next message on an Amazon Q in Connect session.

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

# get_next_message method definition

def get_next_message(
    self,
    *,
    assistantId: str,
    sessionId: str,
    nextMessageToken: str,
) -> GetNextMessageResponseTypeDef:  # (1)
    ...
  1. See GetNextMessageResponseTypeDef
# get_next_message method usage example with argument unpacking

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

parent.get_next_message(**kwargs)
  1. See GetNextMessageRequestTypeDef

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,
    *,
    quickResponseId: str,
    knowledgeBaseId: str,
) -> GetQuickResponseResponseTypeDef:  # (1)
    ...
  1. See GetQuickResponseResponseTypeDef
# get_quick_response method usage example with argument unpacking

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

parent.get_quick_response(**kwargs)
  1. See GetQuickResponseRequestTypeDef

get_recommendations#

This API will be discontinued starting June 1, 2024.

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 = ...,
    nextChunkToken: str = ...,
) -> GetRecommendationsResponseTypeDef:  # (1)
    ...
  1. See GetRecommendationsResponseTypeDef
# get_recommendations method usage example with argument unpacking

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

parent.get_recommendations(**kwargs)
  1. See GetRecommendationsRequestTypeDef

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: GetSessionRequestTypeDef = {  # (1)
    "assistantId": ...,
    "sessionId": ...,
}

parent.get_session(**kwargs)
  1. See GetSessionRequestTypeDef

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,
    *,
    assistantId: str,
    aiAgentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    origin: OriginType = ...,  # (1)
) -> ListAIAgentVersionsResponseTypeDef:  # (2)
    ...
  1. See OriginType
  2. See ListAIAgentVersionsResponseTypeDef
# list_ai_agent_versions method usage example with argument unpacking

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

parent.list_ai_agent_versions(**kwargs)
  1. See ListAIAgentVersionsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
    origin: OriginType = ...,  # (1)
) -> ListAIAgentsResponseTypeDef:  # (2)
    ...
  1. See OriginType
  2. See ListAIAgentsResponseTypeDef
# list_ai_agents method usage example with argument unpacking

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

parent.list_ai_agents(**kwargs)
  1. See ListAIAgentsRequestTypeDef

list_ai_guardrail_versions#

Lists AI Guardrail versions.

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

# list_ai_guardrail_versions method definition

def list_ai_guardrail_versions(
    self,
    *,
    assistantId: str,
    aiGuardrailId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAIGuardrailVersionsResponseTypeDef:  # (1)
    ...
  1. See ListAIGuardrailVersionsResponseTypeDef
# list_ai_guardrail_versions method usage example with argument unpacking

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

parent.list_ai_guardrail_versions(**kwargs)
  1. See ListAIGuardrailVersionsRequestTypeDef

list_ai_guardrails#

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

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

# list_ai_guardrails method definition

def list_ai_guardrails(
    self,
    *,
    assistantId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAIGuardrailsResponseTypeDef:  # (1)
    ...
  1. See ListAIGuardrailsResponseTypeDef
# list_ai_guardrails method usage example with argument unpacking

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

parent.list_ai_guardrails(**kwargs)
  1. See ListAIGuardrailsRequestTypeDef

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,
    *,
    assistantId: str,
    aiPromptId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    origin: OriginType = ...,  # (1)
) -> ListAIPromptVersionsResponseTypeDef:  # (2)
    ...
  1. See OriginType
  2. See ListAIPromptVersionsResponseTypeDef
# list_ai_prompt_versions method usage example with argument unpacking

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

parent.list_ai_prompt_versions(**kwargs)
  1. See ListAIPromptVersionsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
    origin: OriginType = ...,  # (1)
) -> ListAIPromptsResponseTypeDef:  # (2)
    ...
  1. See OriginType
  2. See ListAIPromptsResponseTypeDef
# list_ai_prompts method usage example with argument unpacking

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

parent.list_ai_prompts(**kwargs)
  1. See ListAIPromptsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssistantAssociationsResponseTypeDef:  # (1)
    ...
  1. See ListAssistantAssociationsResponseTypeDef
# list_assistant_associations method usage example with argument unpacking

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

parent.list_assistant_associations(**kwargs)
  1. See ListAssistantAssociationsRequestTypeDef

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,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssistantsResponseTypeDef:  # (1)
    ...
  1. See ListAssistantsResponseTypeDef
# list_assistants method usage example with argument unpacking

kwargs: ListAssistantsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_assistants(**kwargs)
  1. See ListAssistantsRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    contentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListContentAssociationsResponseTypeDef:  # (1)
    ...
  1. See ListContentAssociationsResponseTypeDef
# list_content_associations method usage example with argument unpacking

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

parent.list_content_associations(**kwargs)
  1. See ListContentAssociationsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListContentsResponseTypeDef:  # (1)
    ...
  1. See ListContentsResponseTypeDef
# list_contents method usage example with argument unpacking

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

parent.list_contents(**kwargs)
  1. See ListContentsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListImportJobsResponseTypeDef:  # (1)
    ...
  1. See ListImportJobsResponseTypeDef
# list_import_jobs method usage example with argument unpacking

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

parent.list_import_jobs(**kwargs)
  1. See ListImportJobsRequestTypeDef

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,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKnowledgeBasesResponseTypeDef:  # (1)
    ...
  1. See ListKnowledgeBasesResponseTypeDef
# list_knowledge_bases method usage example with argument unpacking

kwargs: ListKnowledgeBasesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_knowledge_bases(**kwargs)
  1. See ListKnowledgeBasesRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMessageTemplateVersionsResponseTypeDef:  # (1)
    ...
  1. See ListMessageTemplateVersionsResponseTypeDef
# list_message_template_versions method usage example with argument unpacking

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

parent.list_message_template_versions(**kwargs)
  1. See ListMessageTemplateVersionsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMessageTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListMessageTemplatesResponseTypeDef
# list_message_templates method usage example with argument unpacking

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

parent.list_message_templates(**kwargs)
  1. See ListMessageTemplatesRequestTypeDef

list_messages#

Lists messages on an Amazon Q in Connect session.

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

# list_messages method definition

def list_messages(
    self,
    *,
    assistantId: str,
    sessionId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMessagesResponseTypeDef:  # (1)
    ...
  1. See ListMessagesResponseTypeDef
# list_messages method usage example with argument unpacking

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

parent.list_messages(**kwargs)
  1. See ListMessagesRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListQuickResponsesResponseTypeDef:  # (1)
    ...
  1. See ListQuickResponsesResponseTypeDef
# list_quick_responses method usage example with argument unpacking

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

parent.list_quick_responses(**kwargs)
  1. See ListQuickResponsesRequestTypeDef

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: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

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,
    sessionId: str,
    recommendationIds: Sequence[str],
) -> NotifyRecommendationsReceivedResponseTypeDef:  # (1)
    ...
  1. See NotifyRecommendationsReceivedResponseTypeDef
# notify_recommendations_received method usage example with argument unpacking

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

parent.notify_recommendations_received(**kwargs)
  1. See NotifyRecommendationsReceivedRequestTypeDef

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,
    targetId: str,
    targetType: TargetTypeType,  # (1)
    contentFeedback: ContentFeedbackDataTypeDef,  # (2)
) -> PutFeedbackResponseTypeDef:  # (3)
    ...
  1. See TargetTypeType
  2. See ContentFeedbackDataTypeDef
  3. See PutFeedbackResponseTypeDef
# put_feedback method usage example with argument unpacking

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

parent.put_feedback(**kwargs)
  1. See PutFeedbackRequestTypeDef

query_assistant#

This API will be discontinued starting June 1, 2024.

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

# query_assistant method definition

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

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

parent.query_assistant(**kwargs)
  1. See QueryAssistantRequestTypeDef

remove_assistant_ai_agent#

Removes the AI Agent that is set for use by default 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,
    *,
    assistantId: str,
    aiAgentType: AIAgentTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See AIAgentTypeType
# remove_assistant_ai_agent method usage example with argument unpacking

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

parent.remove_assistant_ai_agent(**kwargs)
  1. See RemoveAssistantAIAgentRequestTypeDef

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: RemoveKnowledgeBaseTemplateUriRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.remove_knowledge_base_template_uri(**kwargs)
  1. See RemoveKnowledgeBaseTemplateUriRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    messageTemplateId: str,
    attributes: MessageTemplateAttributesUnionTypeDef,  # (1)
) -> RenderMessageTemplateResponseTypeDef:  # (2)
    ...
  1. See MessageTemplateAttributesUnionTypeDef
  2. See RenderMessageTemplateResponseTypeDef
# render_message_template method usage example with argument unpacking

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

parent.render_message_template(**kwargs)
  1. See RenderMessageTemplateRequestTypeDef

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)
    nextToken: str = ...,
    maxResults: int = ...,
) -> SearchContentResponseTypeDef:  # (2)
    ...
  1. See SearchExpressionTypeDef
  2. See SearchContentResponseTypeDef
# search_content method usage example with argument unpacking

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

parent.search_content(**kwargs)
  1. See SearchContentRequestTypeDef

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)
    nextToken: str = ...,
    maxResults: int = ...,
) -> SearchMessageTemplatesResponseTypeDef:  # (2)
    ...
  1. See MessageTemplateSearchExpressionTypeDef
  2. See SearchMessageTemplatesResponseTypeDef
# search_message_templates method usage example with argument unpacking

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

parent.search_message_templates(**kwargs)
  1. See SearchMessageTemplatesRequestTypeDef

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)
    nextToken: str = ...,
    maxResults: int = ...,
    attributes: Mapping[str, str] = ...,
) -> SearchQuickResponsesResponseTypeDef:  # (2)
    ...
  1. See QuickResponseSearchExpressionTypeDef
  2. See SearchQuickResponsesResponseTypeDef
# search_quick_responses method usage example with argument unpacking

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

parent.search_quick_responses(**kwargs)
  1. See SearchQuickResponsesRequestTypeDef

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)
    nextToken: str = ...,
    maxResults: int = ...,
) -> SearchSessionsResponseTypeDef:  # (2)
    ...
  1. See SearchExpressionTypeDef
  2. See SearchSessionsResponseTypeDef
# search_sessions method usage example with argument unpacking

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

parent.search_sessions(**kwargs)
  1. See SearchSessionsRequestTypeDef

send_message#

Submits a message to the Amazon Q in Connect session.

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

# send_message method definition

def send_message(
    self,
    *,
    assistantId: str,
    sessionId: str,
    type: MessageTypeType,  # (1)
    message: MessageInputTypeDef,  # (2)
    conversationContext: ConversationContextTypeDef = ...,  # (3)
    configuration: MessageConfigurationTypeDef = ...,  # (4)
    clientToken: str = ...,
) -> SendMessageResponseTypeDef:  # (5)
    ...
  1. See MessageTypeType
  2. See MessageInputTypeDef
  3. See ConversationContextTypeDef
  4. See MessageConfigurationTypeDef
  5. See SendMessageResponseTypeDef
# send_message method usage example with argument unpacking

kwargs: SendMessageRequestTypeDef = {  # (1)
    "assistantId": ...,
    "sessionId": ...,
    "type": ...,
    "message": ...,
}

parent.send_message(**kwargs)
  1. See SendMessageRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    contentType: str,
    presignedUrlTimeToLive: int = ...,
) -> StartContentUploadResponseTypeDef:  # (1)
    ...
  1. See StartContentUploadResponseTypeDef
# start_content_upload method usage example with argument unpacking

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

parent.start_content_upload(**kwargs)
  1. See StartContentUploadRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    importJobType: ImportJobTypeType,  # (1)
    uploadId: str,
    clientToken: str = ...,
    metadata: Mapping[str, str] = ...,
    externalSourceConfiguration: ExternalSourceConfigurationTypeDef = ...,  # (2)
) -> StartImportJobResponseTypeDef:  # (3)
    ...
  1. See ImportJobTypeType
  2. See ExternalSourceConfigurationTypeDef
  3. See StartImportJobResponseTypeDef
# start_import_job method usage example with argument unpacking

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

parent.start_import_job(**kwargs)
  1. See StartImportJobRequestTypeDef

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: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

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: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

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,
    *,
    assistantId: str,
    aiAgentId: str,
    visibilityStatus: VisibilityStatusType,  # (1)
    clientToken: str = ...,
    configuration: AIAgentConfigurationUnionTypeDef = ...,  # (2)
    description: str = ...,
) -> UpdateAIAgentResponseTypeDef:  # (3)
    ...
  1. See VisibilityStatusType
  2. See AIAgentConfigurationUnionTypeDef
  3. See UpdateAIAgentResponseTypeDef
# update_ai_agent method usage example with argument unpacking

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

parent.update_ai_agent(**kwargs)
  1. See UpdateAIAgentRequestTypeDef

update_ai_guardrail#

Updates an AI Guardrail.

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

# update_ai_guardrail method definition

def update_ai_guardrail(
    self,
    *,
    assistantId: str,
    aiGuardrailId: str,
    visibilityStatus: VisibilityStatusType,  # (1)
    blockedInputMessaging: str,
    blockedOutputsMessaging: str,
    clientToken: str = ...,
    description: str = ...,
    topicPolicyConfig: AIGuardrailTopicPolicyConfigUnionTypeDef = ...,  # (2)
    contentPolicyConfig: AIGuardrailContentPolicyConfigUnionTypeDef = ...,  # (3)
    wordPolicyConfig: AIGuardrailWordPolicyConfigUnionTypeDef = ...,  # (4)
    sensitiveInformationPolicyConfig: AIGuardrailSensitiveInformationPolicyConfigUnionTypeDef = ...,  # (5)
    contextualGroundingPolicyConfig: AIGuardrailContextualGroundingPolicyConfigUnionTypeDef = ...,  # (6)
) -> UpdateAIGuardrailResponseTypeDef:  # (7)
    ...
  1. See VisibilityStatusType
  2. See AIGuardrailTopicPolicyConfigUnionTypeDef
  3. See AIGuardrailContentPolicyConfigUnionTypeDef
  4. See AIGuardrailWordPolicyConfigUnionTypeDef
  5. See AIGuardrailSensitiveInformationPolicyConfigUnionTypeDef
  6. See AIGuardrailContextualGroundingPolicyConfigUnionTypeDef
  7. See UpdateAIGuardrailResponseTypeDef
# update_ai_guardrail method usage example with argument unpacking

kwargs: UpdateAIGuardrailRequestTypeDef = {  # (1)
    "assistantId": ...,
    "aiGuardrailId": ...,
    "visibilityStatus": ...,
    "blockedInputMessaging": ...,
    "blockedOutputsMessaging": ...,
}

parent.update_ai_guardrail(**kwargs)
  1. See UpdateAIGuardrailRequestTypeDef

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,
    *,
    assistantId: str,
    aiPromptId: str,
    visibilityStatus: VisibilityStatusType,  # (1)
    clientToken: str = ...,
    templateConfiguration: AIPromptTemplateConfigurationTypeDef = ...,  # (2)
    description: str = ...,
) -> UpdateAIPromptResponseTypeDef:  # (3)
    ...
  1. See VisibilityStatusType
  2. See AIPromptTemplateConfigurationTypeDef
  3. See UpdateAIPromptResponseTypeDef
# update_ai_prompt method usage example with argument unpacking

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

parent.update_ai_prompt(**kwargs)
  1. See UpdateAIPromptRequestTypeDef

update_assistant_ai_agent#

Updates the AI Agent that is set for use by default 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,
    *,
    assistantId: str,
    aiAgentType: AIAgentTypeType,  # (1)
    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: UpdateAssistantAIAgentRequestTypeDef = {  # (1)
    "assistantId": ...,
    "aiAgentType": ...,
    "configuration": ...,
}

parent.update_assistant_ai_agent(**kwargs)
  1. See UpdateAssistantAIAgentRequestTypeDef

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,
    *,
    knowledgeBaseId: str,
    contentId: str,
    revisionId: str = ...,
    title: str = ...,
    overrideLinkOutUri: str = ...,
    removeOverrideLinkOutUri: bool = ...,
    metadata: Mapping[str, str] = ...,
    uploadId: str = ...,
) -> UpdateContentResponseTypeDef:  # (1)
    ...
  1. See UpdateContentResponseTypeDef
# update_content method usage example with argument unpacking

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

parent.update_content(**kwargs)
  1. See UpdateContentRequestTypeDef

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: UpdateKnowledgeBaseTemplateUriRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "templateUri": ...,
}

parent.update_knowledge_base_template_uri(**kwargs)
  1. See UpdateKnowledgeBaseTemplateUriRequestTypeDef

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: MessageTemplateContentProviderUnionTypeDef = ...,  # (1)
    language: str = ...,
    defaultAttributes: MessageTemplateAttributesUnionTypeDef = ...,  # (2)
) -> UpdateMessageTemplateResponseTypeDef:  # (3)
    ...
  1. See MessageTemplateContentProviderUnionTypeDef
  2. See MessageTemplateAttributesUnionTypeDef
  3. See UpdateMessageTemplateResponseTypeDef
# update_message_template method usage example with argument unpacking

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

parent.update_message_template(**kwargs)
  1. See UpdateMessageTemplateRequestTypeDef

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,
    name: str = ...,
    description: str = ...,
    groupingConfiguration: GroupingConfigurationUnionTypeDef = ...,  # (1)
) -> UpdateMessageTemplateMetadataResponseTypeDef:  # (2)
    ...
  1. See GroupingConfigurationUnionTypeDef
  2. See UpdateMessageTemplateMetadataResponseTypeDef
# update_message_template_metadata method usage example with argument unpacking

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

parent.update_message_template_metadata(**kwargs)
  1. See UpdateMessageTemplateMetadataRequestTypeDef

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,
    name: str = ...,
    content: QuickResponseDataProviderTypeDef = ...,  # (1)
    contentType: str = ...,
    groupingConfiguration: GroupingConfigurationUnionTypeDef = ...,  # (2)
    removeGroupingConfiguration: bool = ...,
    description: str = ...,
    removeDescription: bool = ...,
    shortcutKey: str = ...,
    removeShortcutKey: bool = ...,
    isActive: bool = ...,
    channels: Sequence[str] = ...,
    language: str = ...,
) -> UpdateQuickResponseResponseTypeDef:  # (3)
    ...
  1. See QuickResponseDataProviderTypeDef
  2. See GroupingConfigurationUnionTypeDef
  3. See UpdateQuickResponseResponseTypeDef
# update_quick_response method usage example with argument unpacking

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

parent.update_quick_response(**kwargs)
  1. See UpdateQuickResponseRequestTypeDef

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,
    description: str = ...,
    tagFilter: TagFilterUnionTypeDef = ...,  # (1)
    aiAgentConfiguration: Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef] = ...,  # (2)
) -> UpdateSessionResponseTypeDef:  # (3)
    ...
  1. See TagFilterUnionTypeDef
  2. See Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef]
  3. See UpdateSessionResponseTypeDef
# update_session method usage example with argument unpacking

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

parent.update_session(**kwargs)
  1. See UpdateSessionRequestTypeDef

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,
    sessionId: str,
    data: Sequence[RuntimeSessionDataTypeDef],  # (1)
    namespace: SessionDataNamespaceType = ...,  # (2)
) -> UpdateSessionDataResponseTypeDef:  # (3)
    ...
  1. See Sequence[RuntimeSessionDataTypeDef]
  2. See SessionDataNamespaceType
  3. See UpdateSessionDataResponseTypeDef
# update_session_data method usage example with argument unpacking

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

parent.update_session_data(**kwargs)
  1. See UpdateSessionDataRequestTypeDef

get_paginator#

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