QConnect module#
Index > QConnect
Auto-generated documentation for QConnect type annotations stubs module mypy-boto3-qconnect.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and QConnect
.
From PyPI with pip#
Install boto3-stubs
for QConnect
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[qconnect]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[qconnect]'
# standalone installation
python -m pip install mypy-boto3-qconnect
How to uninstall#
python -m pip uninstall -y mypy-boto3-qconnect
Usage#
Code samples can be found in Examples.
QConnectClient#
Type annotations and code completion for boto3.client("qconnect")
as QConnectClient
boto3 documentation
# QConnectClient usage example
from boto3.session import Session
from mypy_boto3_qconnect.client import QConnectClient
def get_client() -> QConnectClient:
return Session().client("qconnect")
Paginators#
Type annotations and code completion for paginators
from boto3.client("qconnect").get_paginator("...")
.
# ListAssistantAssociationsPaginator usage example
from boto3.session import Session
from mypy_boto3_qconnect.paginator import ListAssistantAssociationsPaginator
def get_list_assistant_associations_paginator() -> ListAssistantAssociationsPaginator:
return Session().client("qconnect").get_paginator("list_assistant_associations"))
- ListAssistantAssociationsPaginator
- ListAssistantsPaginator
- ListContentAssociationsPaginator
- ListContentsPaginator
- ListImportJobsPaginator
- ListKnowledgeBasesPaginator
- ListQuickResponsesPaginator
- QueryAssistantPaginator
- SearchContentPaginator
- SearchQuickResponsesPaginator
- SearchSessionsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AssistantCapabilityTypeType usage example
from mypy_boto3_qconnect.literals import AssistantCapabilityTypeType
def get_value() -> AssistantCapabilityTypeType:
return "V1"
- AssistantCapabilityTypeType
- AssistantStatusType
- AssistantTypeType
- AssociationTypeType
- ContentAssociationTypeType
- ContentStatusType
- ExternalSourceType
- FilterFieldType
- FilterOperatorType
- ImportJobStatusType
- ImportJobTypeType
- KnowledgeBaseStatusType
- KnowledgeBaseTypeType
- ListAssistantAssociationsPaginatorName
- ListAssistantsPaginatorName
- ListContentAssociationsPaginatorName
- ListContentsPaginatorName
- ListImportJobsPaginatorName
- ListKnowledgeBasesPaginatorName
- ListQuickResponsesPaginatorName
- OrderType
- PriorityType
- QueryAssistantPaginatorName
- QueryConditionComparisonOperatorType
- QueryConditionFieldNameType
- QueryResultTypeType
- QuickResponseFilterOperatorType
- QuickResponseQueryOperatorType
- QuickResponseStatusType
- RecommendationSourceTypeType
- RecommendationTriggerTypeType
- RecommendationTypeType
- RelevanceLevelType
- RelevanceType
- SearchContentPaginatorName
- SearchQuickResponsesPaginatorName
- SearchSessionsPaginatorName
- SourceContentTypeType
- TargetTypeType
- QConnectServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AmazonConnectGuideAssociationDataTypeDef
- AppIntegrationsConfigurationExtraOutputTypeDef
- AppIntegrationsConfigurationOutputTypeDef
- AppIntegrationsConfigurationTypeDef
- AssistantAssociationInputDataTypeDef
- KnowledgeBaseAssociationDataTypeDef
- AssistantCapabilityConfigurationTypeDef
- AssistantIntegrationConfigurationTypeDef
- ServerSideEncryptionConfigurationTypeDef
- ConnectConfigurationTypeDef
- RankingDataTypeDef
- ContentDataTypeDef
- GenerativeContentFeedbackDataTypeDef
- ContentReferenceTypeDef
- ContentSummaryTypeDef
- ResponseMetadataTypeDef
- CreateContentRequestRequestTypeDef
- RenderingConfigurationTypeDef
- GroupingConfigurationTypeDef
- QuickResponseDataProviderTypeDef
- GenerativeReferenceTypeDef
- DeleteAssistantAssociationRequestRequestTypeDef
- DeleteAssistantRequestRequestTypeDef
- DeleteContentAssociationRequestRequestTypeDef
- DeleteContentRequestRequestTypeDef
- DeleteImportJobRequestRequestTypeDef
- DeleteKnowledgeBaseRequestRequestTypeDef
- DeleteQuickResponseRequestRequestTypeDef
- HighlightTypeDef
- FilterTypeDef
- GetAssistantAssociationRequestRequestTypeDef
- GetAssistantRequestRequestTypeDef
- GetContentAssociationRequestRequestTypeDef
- GetContentRequestRequestTypeDef
- GetContentSummaryRequestRequestTypeDef
- GetImportJobRequestRequestTypeDef
- GetKnowledgeBaseRequestRequestTypeDef
- GetQuickResponseRequestRequestTypeDef
- GetRecommendationsRequestRequestTypeDef
- GetSessionRequestRequestTypeDef
- GroupingConfigurationExtraOutputTypeDef
- GroupingConfigurationOutputTypeDef
- PaginatorConfigTypeDef
- ListAssistantAssociationsRequestRequestTypeDef
- ListAssistantsRequestRequestTypeDef
- ListContentAssociationsRequestRequestTypeDef
- ListContentsRequestRequestTypeDef
- ListImportJobsRequestRequestTypeDef
- ListKnowledgeBasesRequestRequestTypeDef
- ListQuickResponsesRequestRequestTypeDef
- QuickResponseSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- NotifyRecommendationsReceivedErrorTypeDef
- NotifyRecommendationsReceivedRequestRequestTypeDef
- TagConditionTypeDef
- QueryConditionItemTypeDef
- QueryRecommendationTriggerDataTypeDef
- QuickResponseContentProviderTypeDef
- QuickResponseFilterFieldTypeDef
- QuickResponseOrderFieldTypeDef
- QuickResponseQueryFieldTypeDef
- RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef
- SessionSummaryTypeDef
- SessionIntegrationConfigurationTypeDef
- StartContentUploadRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateContentRequestRequestTypeDef
- UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef
- ContentAssociationContentsTypeDef
- SourceConfigurationExtraOutputTypeDef
- SourceConfigurationOutputTypeDef
- SourceConfigurationTypeDef
- CreateAssistantAssociationRequestRequestTypeDef
- AssistantAssociationOutputDataTypeDef
- AssistantDataTypeDef
- AssistantSummaryTypeDef
- CreateAssistantRequestRequestTypeDef
- ConfigurationTypeDef
- GenerativeDataDetailsTypeDef
- ContentFeedbackDataTypeDef
- CreateContentResponseTypeDef
- GetContentResponseTypeDef
- GetContentSummaryResponseTypeDef
- ListContentsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- SearchContentResponseTypeDef
- StartContentUploadResponseTypeDef
- UpdateContentResponseTypeDef
- CreateQuickResponseRequestRequestTypeDef
- UpdateQuickResponseRequestRequestTypeDef
- DataReferenceTypeDef
- DocumentTextTypeDef
- SearchExpressionTypeDef
- GroupingConfigurationUnionTypeDef
- ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef
- ListAssistantsRequestListAssistantsPaginateTypeDef
- ListContentAssociationsRequestListContentAssociationsPaginateTypeDef
- ListContentsRequestListContentsPaginateTypeDef
- ListImportJobsRequestListImportJobsPaginateTypeDef
- ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef
- ListQuickResponsesRequestListQuickResponsesPaginateTypeDef
- ListQuickResponsesResponseTypeDef
- NotifyRecommendationsReceivedResponseTypeDef
- OrConditionOutputTypeDef
- OrConditionTypeDef
- QueryConditionTypeDef
- RecommendationTriggerDataTypeDef
- QuickResponseContentsTypeDef
- QuickResponseSearchExpressionTypeDef
- SearchSessionsResponseTypeDef
- ContentAssociationDataTypeDef
- ContentAssociationSummaryTypeDef
- CreateContentAssociationRequestRequestTypeDef
- KnowledgeBaseDataTypeDef
- KnowledgeBaseSummaryTypeDef
- CreateKnowledgeBaseRequestRequestTypeDef
- SourceConfigurationUnionTypeDef
- AssistantAssociationDataTypeDef
- AssistantAssociationSummaryTypeDef
- CreateAssistantResponseTypeDef
- GetAssistantResponseTypeDef
- ListAssistantsResponseTypeDef
- ExternalSourceConfigurationTypeDef
- PutFeedbackRequestRequestTypeDef
- PutFeedbackResponseTypeDef
- DataSummaryTypeDef
- DocumentTypeDef
- TextDataTypeDef
- SearchContentRequestRequestTypeDef
- SearchContentRequestSearchContentPaginateTypeDef
- SearchSessionsRequestRequestTypeDef
- SearchSessionsRequestSearchSessionsPaginateTypeDef
- TagFilterOutputTypeDef
- TagFilterTypeDef
- QueryAssistantRequestQueryAssistantPaginateTypeDef
- QueryAssistantRequestRequestTypeDef
- RecommendationTriggerTypeDef
- QuickResponseDataTypeDef
- QuickResponseSearchResultDataTypeDef
- SearchQuickResponsesRequestRequestTypeDef
- SearchQuickResponsesRequestSearchQuickResponsesPaginateTypeDef
- CreateContentAssociationResponseTypeDef
- GetContentAssociationResponseTypeDef
- ListContentAssociationsResponseTypeDef
- CreateKnowledgeBaseResponseTypeDef
- GetKnowledgeBaseResponseTypeDef
- UpdateKnowledgeBaseTemplateUriResponseTypeDef
- ListKnowledgeBasesResponseTypeDef
- CreateAssistantAssociationResponseTypeDef
- GetAssistantAssociationResponseTypeDef
- ListAssistantAssociationsResponseTypeDef
- ImportJobDataTypeDef
- ImportJobSummaryTypeDef
- StartImportJobRequestRequestTypeDef
- RecommendationDataTypeDef
- ResultDataTypeDef
- ContentDataDetailsTypeDef
- SourceContentDataDetailsTypeDef
- SessionDataTypeDef
- CreateSessionRequestRequestTypeDef
- TagFilterUnionTypeDef
- UpdateSessionRequestRequestTypeDef
- CreateQuickResponseResponseTypeDef
- GetQuickResponseResponseTypeDef
- UpdateQuickResponseResponseTypeDef
- SearchQuickResponsesResponseTypeDef
- GetImportJobResponseTypeDef
- StartImportJobResponseTypeDef
- ListImportJobsResponseTypeDef
- GetRecommendationsResponseTypeDef
- QueryAssistantResponseTypeDef
- DataDetailsTypeDef
- CreateSessionResponseTypeDef
- GetSessionResponseTypeDef
- UpdateSessionResponseTypeDef