QConnect module#
Index > QConnect
Auto-generated documentation for QConnect type annotations stubs module mypy-boto3-qconnect.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3-stubs
AWS SDK. - Add
QConnect
service. - Use provided commands to install generated packages.
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("...")
.
# ListAIAgentVersionsPaginator usage example
from boto3.session import Session
from mypy_boto3_qconnect.paginator import ListAIAgentVersionsPaginator
def get_list_ai_agent_versions_paginator() -> ListAIAgentVersionsPaginator:
return Session().client("qconnect").get_paginator("list_ai_agent_versions"))
- ListAIAgentVersionsPaginator
- ListAIAgentsPaginator
- ListAIGuardrailVersionsPaginator
- ListAIGuardrailsPaginator
- ListAIPromptVersionsPaginator
- ListAIPromptsPaginator
- ListAssistantAssociationsPaginator
- ListAssistantsPaginator
- ListContentAssociationsPaginator
- ListContentsPaginator
- ListImportJobsPaginator
- ListKnowledgeBasesPaginator
- ListMessageTemplateVersionsPaginator
- ListMessageTemplatesPaginator
- ListMessagesPaginator
- ListQuickResponsesPaginator
- QueryAssistantPaginator
- SearchContentPaginator
- SearchMessageTemplatesPaginator
- SearchQuickResponsesPaginator
- SearchSessionsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AIAgentAssociationConfigurationTypeType usage example
from mypy_boto3_qconnect.literals import AIAgentAssociationConfigurationTypeType
def get_value() -> AIAgentAssociationConfigurationTypeType:
return "KNOWLEDGE_BASE"
- AIAgentAssociationConfigurationTypeType
- AIAgentTypeType
- AIPromptAPIFormatType
- AIPromptTemplateTypeType
- AIPromptTypeType
- AssistantCapabilityTypeType
- AssistantStatusType
- AssistantTypeType
- AssociationTypeType
- ChannelSubtypeType
- ChunkingStrategyType
- ContentAssociationTypeType
- ContentDispositionType
- ContentStatusType
- ConversationStatusReasonType
- ConversationStatusType
- ExternalSourceType
- FilterFieldType
- FilterOperatorType
- GuardrailContentFilterTypeType
- GuardrailContextualGroundingFilterTypeType
- GuardrailFilterStrengthType
- GuardrailManagedWordsTypeType
- GuardrailPiiEntityTypeType
- GuardrailSensitiveInformationActionType
- GuardrailTopicTypeType
- ImportJobStatusType
- ImportJobTypeType
- KnowledgeBaseSearchTypeType
- KnowledgeBaseStatusType
- KnowledgeBaseTypeType
- ListAIAgentVersionsPaginatorName
- ListAIAgentsPaginatorName
- ListAIGuardrailVersionsPaginatorName
- ListAIGuardrailsPaginatorName
- ListAIPromptVersionsPaginatorName
- ListAIPromptsPaginatorName
- ListAssistantAssociationsPaginatorName
- ListAssistantsPaginatorName
- ListContentAssociationsPaginatorName
- ListContentsPaginatorName
- ListImportJobsPaginatorName
- ListKnowledgeBasesPaginatorName
- ListMessageTemplateVersionsPaginatorName
- ListMessageTemplatesPaginatorName
- ListMessagesPaginatorName
- ListQuickResponsesPaginatorName
- MessageTemplateAttributeTypeType
- MessageTemplateFilterOperatorType
- MessageTemplateQueryOperatorType
- MessageTypeType
- OrderType
- OriginType
- ParsingStrategyType
- ParticipantType
- PriorityType
- QueryAssistantPaginatorName
- QueryConditionComparisonOperatorType
- QueryConditionFieldNameType
- QueryResultTypeType
- QuickResponseFilterOperatorType
- QuickResponseQueryOperatorType
- QuickResponseStatusType
- RecommendationSourceTypeType
- RecommendationTriggerTypeType
- RecommendationTypeType
- ReferenceTypeType
- RelevanceLevelType
- RelevanceType
- SearchContentPaginatorName
- SearchMessageTemplatesPaginatorName
- SearchQuickResponsesPaginatorName
- SearchSessionsPaginatorName
- SessionDataNamespaceType
- SourceContentTypeType
- StatusType
- SyncStatusType
- TargetTypeType
- VisibilityStatusType
- WebScopeTypeType
- QConnectServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AIAgentConfigurationDataTypeDef
- GuardrailContentFilterConfigTypeDef
- GuardrailContextualGroundingFilterConfigTypeDef
- GuardrailPiiEntityConfigTypeDef
- GuardrailRegexConfigTypeDef
- AIGuardrailSummaryTypeDef
- GuardrailTopicConfigOutputTypeDef
- GuardrailTopicConfigTypeDef
- GuardrailManagedWordsConfigTypeDef
- GuardrailWordConfigTypeDef
- AIPromptSummaryTypeDef
- TextFullAIPromptEditTemplateConfigurationTypeDef
- ActivateMessageTemplateRequestTypeDef
- ResponseMetadataTypeDef
- AgentAttributesTypeDef
- AmazonConnectGuideAssociationDataTypeDef
- AppIntegrationsConfigurationOutputTypeDef
- AppIntegrationsConfigurationTypeDef
- AssistantAssociationInputDataTypeDef
- KnowledgeBaseAssociationDataTypeDef
- AssistantCapabilityConfigurationTypeDef
- AssistantIntegrationConfigurationTypeDef
- ServerSideEncryptionConfigurationTypeDef
- ParsingPromptTypeDef
- FixedSizeChunkingConfigurationTypeDef
- SemanticChunkingConfigurationTypeDef
- CitationSpanTypeDef
- ConnectConfigurationTypeDef
- RankingDataTypeDef
- ContentDataTypeDef
- GenerativeContentFeedbackDataTypeDef
- ContentReferenceTypeDef
- ContentSummaryTypeDef
- SelfServiceConversationHistoryTypeDef
- ConversationStateTypeDef
- TimestampTypeDef
- CreateContentRequestTypeDef
- RenderingConfigurationTypeDef
- CreateMessageTemplateAttachmentRequestTypeDef
- MessageTemplateAttachmentTypeDef
- CreateMessageTemplateVersionRequestTypeDef
- QuickResponseDataProviderTypeDef
- CustomerProfileAttributesOutputTypeDef
- CustomerProfileAttributesTypeDef
- IntentDetectedDataDetailsTypeDef
- GenerativeReferenceTypeDef
- DeactivateMessageTemplateRequestTypeDef
- DeleteAIAgentRequestTypeDef
- DeleteAIAgentVersionRequestTypeDef
- DeleteAIGuardrailRequestTypeDef
- DeleteAIGuardrailVersionRequestTypeDef
- DeleteAIPromptRequestTypeDef
- DeleteAIPromptVersionRequestTypeDef
- DeleteAssistantAssociationRequestTypeDef
- DeleteAssistantRequestTypeDef
- DeleteContentAssociationRequestTypeDef
- DeleteContentRequestTypeDef
- DeleteImportJobRequestTypeDef
- DeleteKnowledgeBaseRequestTypeDef
- DeleteMessageTemplateAttachmentRequestTypeDef
- DeleteMessageTemplateRequestTypeDef
- DeleteQuickResponseRequestTypeDef
- HighlightTypeDef
- EmailHeaderTypeDef
- MessageTemplateBodyContentProviderTypeDef
- GroupingConfigurationOutputTypeDef
- FilterTypeDef
- GetAIAgentRequestTypeDef
- GetAIGuardrailRequestTypeDef
- GetAIPromptRequestTypeDef
- GetAssistantAssociationRequestTypeDef
- GetAssistantRequestTypeDef
- GetContentAssociationRequestTypeDef
- GetContentRequestTypeDef
- GetContentSummaryRequestTypeDef
- GetImportJobRequestTypeDef
- GetKnowledgeBaseRequestTypeDef
- GetMessageTemplateRequestTypeDef
- GetNextMessageRequestTypeDef
- GetQuickResponseRequestTypeDef
- GetRecommendationsRequestTypeDef
- GetSessionRequestTypeDef
- GroupingConfigurationTypeDef
- HierarchicalChunkingLevelConfigurationTypeDef
- IntentInputDataTypeDef
- PaginatorConfigTypeDef
- ListAIAgentVersionsRequestTypeDef
- ListAIAgentsRequestTypeDef
- ListAIGuardrailVersionsRequestTypeDef
- ListAIGuardrailsRequestTypeDef
- ListAIPromptVersionsRequestTypeDef
- ListAIPromptsRequestTypeDef
- ListAssistantAssociationsRequestTypeDef
- ListAssistantsRequestTypeDef
- ListContentAssociationsRequestTypeDef
- ListContentsRequestTypeDef
- ListImportJobsRequestTypeDef
- ListKnowledgeBasesRequestTypeDef
- ListMessageTemplateVersionsRequestTypeDef
- MessageTemplateVersionSummaryTypeDef
- ListMessageTemplatesRequestTypeDef
- MessageTemplateSummaryTypeDef
- ListMessagesRequestTypeDef
- ListQuickResponsesRequestTypeDef
- QuickResponseSummaryTypeDef
- ListTagsForResourceRequestTypeDef
- TextMessageTypeDef
- MessageTemplateFilterFieldTypeDef
- MessageTemplateOrderFieldTypeDef
- MessageTemplateQueryFieldTypeDef
- NotifyRecommendationsReceivedErrorTypeDef
- NotifyRecommendationsReceivedRequestTypeDef
- TagConditionTypeDef
- QueryConditionItemTypeDef
- QueryTextInputDataTypeDef
- QueryRecommendationTriggerDataTypeDef
- QuickResponseContentProviderTypeDef
- QuickResponseFilterFieldTypeDef
- QuickResponseOrderFieldTypeDef
- QuickResponseQueryFieldTypeDef
- RemoveAssistantAIAgentRequestTypeDef
- RemoveKnowledgeBaseTemplateUriRequestTypeDef
- RuntimeSessionDataValueTypeDef
- SessionSummaryTypeDef
- SeedUrlTypeDef
- SessionIntegrationConfigurationTypeDef
- StartContentUploadRequestTypeDef
- SystemEndpointAttributesTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateContentRequestTypeDef
- UpdateKnowledgeBaseTemplateUriRequestTypeDef
- WebCrawlerLimitsTypeDef
- UpdateAssistantAIAgentRequestTypeDef
- AIGuardrailContentPolicyConfigOutputTypeDef
- AIGuardrailContentPolicyConfigTypeDef
- AIGuardrailContextualGroundingPolicyConfigOutputTypeDef
- AIGuardrailContextualGroundingPolicyConfigTypeDef
- AIGuardrailSensitiveInformationPolicyConfigOutputTypeDef
- AIGuardrailSensitiveInformationPolicyConfigTypeDef
- AIGuardrailVersionSummaryTypeDef
- AIGuardrailTopicPolicyConfigOutputTypeDef
- AIGuardrailTopicPolicyConfigTypeDef
- AIGuardrailWordPolicyConfigOutputTypeDef
- AIGuardrailWordPolicyConfigTypeDef
- AIPromptVersionSummaryTypeDef
- AIPromptTemplateConfigurationTypeDef
- ActivateMessageTemplateResponseTypeDef
- DeactivateMessageTemplateResponseTypeDef
- ListAIGuardrailsResponseTypeDef
- ListAIPromptsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- SendMessageResponseTypeDef
- StartContentUploadResponseTypeDef
- ContentAssociationContentsTypeDef
- CreateAssistantAssociationRequestTypeDef
- AssistantAssociationOutputDataTypeDef
- AssistantDataTypeDef
- AssistantSummaryTypeDef
- CreateAssistantRequestTypeDef
- BedrockFoundationModelConfigurationForParsingTypeDef
- ConfigurationTypeDef
- GenerativeDataDetailsPaginatorTypeDef
- GenerativeDataDetailsTypeDef
- CreateContentResponseTypeDef
- GetContentResponseTypeDef
- UpdateContentResponseTypeDef
- ContentFeedbackDataTypeDef
- GetContentSummaryResponseTypeDef
- ListContentsResponseTypeDef
- SearchContentResponseTypeDef
- ConversationContextTypeDef
- CreateAIAgentVersionRequestTypeDef
- CreateAIGuardrailVersionRequestTypeDef
- CreateAIPromptVersionRequestTypeDef
- CreateMessageTemplateAttachmentResponseTypeDef
- DataReferenceTypeDef
- DocumentTextTypeDef
- EmailMessageTemplateContentBodyTypeDef
- SMSMessageTemplateContentBodyTypeDef
- MessageTemplateSearchResultDataTypeDef
- SearchExpressionTypeDef
- GroupingConfigurationUnionTypeDef
- HierarchicalChunkingConfigurationOutputTypeDef
- HierarchicalChunkingConfigurationTypeDef
- ListAIAgentVersionsRequestPaginateTypeDef
- ListAIAgentsRequestPaginateTypeDef
- ListAIGuardrailVersionsRequestPaginateTypeDef
- ListAIGuardrailsRequestPaginateTypeDef
- ListAIPromptVersionsRequestPaginateTypeDef
- ListAIPromptsRequestPaginateTypeDef
- ListAssistantAssociationsRequestPaginateTypeDef
- ListAssistantsRequestPaginateTypeDef
- ListContentAssociationsRequestPaginateTypeDef
- ListContentsRequestPaginateTypeDef
- ListImportJobsRequestPaginateTypeDef
- ListKnowledgeBasesRequestPaginateTypeDef
- ListMessageTemplateVersionsRequestPaginateTypeDef
- ListMessageTemplatesRequestPaginateTypeDef
- ListMessagesRequestPaginateTypeDef
- ListQuickResponsesRequestPaginateTypeDef
- ListMessageTemplateVersionsResponseTypeDef
- ListMessageTemplatesResponseTypeDef
- ListQuickResponsesResponseTypeDef
- MessageDataTypeDef
- MessageTemplateSearchExpressionTypeDef
- NotifyRecommendationsReceivedResponseTypeDef
- OrConditionOutputTypeDef
- OrConditionTypeDef
- QueryConditionTypeDef
- QueryInputDataTypeDef
- RecommendationTriggerDataTypeDef
- QuickResponseContentsTypeDef
- QuickResponseSearchExpressionTypeDef
- RuntimeSessionDataTypeDef
- SearchSessionsResponseTypeDef
- UrlConfigurationOutputTypeDef
- UrlConfigurationTypeDef
- SystemAttributesTypeDef
- AIGuardrailContentPolicyConfigUnionTypeDef
- AIGuardrailContextualGroundingPolicyConfigUnionTypeDef
- AIGuardrailSensitiveInformationPolicyConfigUnionTypeDef
- ListAIGuardrailVersionsResponseTypeDef
- AIGuardrailTopicPolicyConfigUnionTypeDef
- AIGuardrailDataTypeDef
- AIGuardrailWordPolicyConfigUnionTypeDef
- ListAIPromptVersionsResponseTypeDef
- AIPromptDataTypeDef
- CreateAIPromptRequestTypeDef
- UpdateAIPromptRequestTypeDef
- ContentAssociationDataTypeDef
- ContentAssociationSummaryTypeDef
- CreateContentAssociationRequestTypeDef
- AssistantAssociationDataTypeDef
- AssistantAssociationSummaryTypeDef
- CreateAssistantResponseTypeDef
- GetAssistantResponseTypeDef
- UpdateAssistantAIAgentResponseTypeDef
- ListAssistantsResponseTypeDef
- ParsingConfigurationTypeDef
- ExternalSourceConfigurationTypeDef
- PutFeedbackRequestTypeDef
- PutFeedbackResponseTypeDef
- DocumentTypeDef
- TextDataTypeDef
- EmailMessageTemplateContentOutputTypeDef
- EmailMessageTemplateContentTypeDef
- SMSMessageTemplateContentTypeDef
- SearchMessageTemplatesResponseTypeDef
- SearchContentRequestPaginateTypeDef
- SearchContentRequestTypeDef
- SearchSessionsRequestPaginateTypeDef
- SearchSessionsRequestTypeDef
- CreateQuickResponseRequestTypeDef
- UpdateMessageTemplateMetadataRequestTypeDef
- UpdateQuickResponseRequestTypeDef
- ChunkingConfigurationOutputTypeDef
- ChunkingConfigurationTypeDef
- MessageInputTypeDef
- MessageOutputTypeDef
- SearchMessageTemplatesRequestPaginateTypeDef
- SearchMessageTemplatesRequestTypeDef
- TagFilterOutputTypeDef
- TagFilterTypeDef
- QueryAssistantRequestPaginateTypeDef
- QueryAssistantRequestTypeDef
- RecommendationTriggerTypeDef
- QuickResponseDataTypeDef
- QuickResponseSearchResultDataTypeDef
- SearchQuickResponsesRequestPaginateTypeDef
- SearchQuickResponsesRequestTypeDef
- UpdateSessionDataRequestTypeDef
- UpdateSessionDataResponseTypeDef
- WebCrawlerConfigurationOutputTypeDef
- WebCrawlerConfigurationTypeDef
- MessageTemplateAttributesOutputTypeDef
- MessageTemplateAttributesTypeDef
- CreateAIGuardrailResponseTypeDef
- CreateAIGuardrailVersionResponseTypeDef
- GetAIGuardrailResponseTypeDef
- UpdateAIGuardrailResponseTypeDef
- CreateAIGuardrailRequestTypeDef
- UpdateAIGuardrailRequestTypeDef
- CreateAIPromptResponseTypeDef
- CreateAIPromptVersionResponseTypeDef
- GetAIPromptResponseTypeDef
- UpdateAIPromptResponseTypeDef
- CreateContentAssociationResponseTypeDef
- GetContentAssociationResponseTypeDef
- ListContentAssociationsResponseTypeDef
- CreateAssistantAssociationResponseTypeDef
- GetAssistantAssociationResponseTypeDef
- ListAssistantAssociationsResponseTypeDef
- ImportJobDataTypeDef
- ImportJobSummaryTypeDef
- StartImportJobRequestTypeDef
- ContentDataDetailsTypeDef
- SourceContentDataDetailsTypeDef
- MessageTemplateContentProviderOutputTypeDef
- MessageTemplateContentProviderTypeDef
- VectorIngestionConfigurationOutputTypeDef
- VectorIngestionConfigurationTypeDef
- SendMessageRequestTypeDef
- GetNextMessageResponseTypeDef
- ListMessagesResponseTypeDef
- KnowledgeBaseAssociationConfigurationDataOutputTypeDef
- SessionDataTypeDef
- KnowledgeBaseAssociationConfigurationDataTypeDef
- TagFilterUnionTypeDef
- CreateQuickResponseResponseTypeDef
- GetQuickResponseResponseTypeDef
- UpdateQuickResponseResponseTypeDef
- SearchQuickResponsesResponseTypeDef
- ManagedSourceConfigurationOutputTypeDef
- ManagedSourceConfigurationTypeDef
- MessageTemplateAttributesUnionTypeDef
- GetImportJobResponseTypeDef
- StartImportJobResponseTypeDef
- ListImportJobsResponseTypeDef
- DataDetailsPaginatorTypeDef
- DataDetailsTypeDef
- ExtendedMessageTemplateDataTypeDef
- MessageTemplateDataTypeDef
- RenderMessageTemplateResponseTypeDef
- MessageTemplateContentProviderUnionTypeDef
- VectorIngestionConfigurationUnionTypeDef
- AssociationConfigurationDataOutputTypeDef
- CreateSessionResponseTypeDef
- GetSessionResponseTypeDef
- UpdateSessionResponseTypeDef
- AssociationConfigurationDataTypeDef
- CreateSessionRequestTypeDef
- UpdateSessionRequestTypeDef
- SourceConfigurationOutputTypeDef
- SourceConfigurationTypeDef
- RenderMessageTemplateRequestTypeDef
- DataSummaryPaginatorTypeDef
- DataSummaryTypeDef
- CreateMessageTemplateVersionResponseTypeDef
- GetMessageTemplateResponseTypeDef
- CreateMessageTemplateResponseTypeDef
- UpdateMessageTemplateMetadataResponseTypeDef
- UpdateMessageTemplateResponseTypeDef
- CreateMessageTemplateRequestTypeDef
- UpdateMessageTemplateRequestTypeDef
- AssociationConfigurationOutputTypeDef
- AssociationConfigurationTypeDef
- KnowledgeBaseDataTypeDef
- KnowledgeBaseSummaryTypeDef
- SourceConfigurationUnionTypeDef
- ResultDataPaginatorTypeDef
- RecommendationDataTypeDef
- ResultDataTypeDef
- AnswerRecommendationAIAgentConfigurationOutputTypeDef
- ManualSearchAIAgentConfigurationOutputTypeDef
- SelfServiceAIAgentConfigurationOutputTypeDef
- AnswerRecommendationAIAgentConfigurationTypeDef
- ManualSearchAIAgentConfigurationTypeDef
- SelfServiceAIAgentConfigurationTypeDef
- CreateKnowledgeBaseResponseTypeDef
- GetKnowledgeBaseResponseTypeDef
- UpdateKnowledgeBaseTemplateUriResponseTypeDef
- ListKnowledgeBasesResponseTypeDef
- CreateKnowledgeBaseRequestTypeDef
- QueryAssistantResponsePaginatorTypeDef
- GetRecommendationsResponseTypeDef
- QueryAssistantResponseTypeDef
- AIAgentConfigurationOutputTypeDef
- AIAgentConfigurationTypeDef
- AIAgentDataTypeDef
- AIAgentSummaryTypeDef
- AIAgentConfigurationUnionTypeDef
- CreateAIAgentResponseTypeDef
- CreateAIAgentVersionResponseTypeDef
- GetAIAgentResponseTypeDef
- UpdateAIAgentResponseTypeDef
- AIAgentVersionSummaryTypeDef
- ListAIAgentsResponseTypeDef
- CreateAIAgentRequestTypeDef
- UpdateAIAgentRequestTypeDef
- ListAIAgentVersionsResponseTypeDef