QBusiness module#
Index > QBusiness
Auto-generated documentation for QBusiness type annotations stubs module types-boto3-qbusiness.
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
AWS SDK. - Add
QBusiness
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 QBusiness
.
From PyPI with pip#
Install types-boto3
for QBusiness
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[qbusiness]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[qbusiness]'
# standalone installation
python -m pip install types-boto3-qbusiness
How to uninstall#
python -m pip uninstall -y types-boto3-qbusiness
Usage#
Code samples can be found in Examples.
QBusinessClient#
Type annotations and code completion for boto3.client("qbusiness")
as QBusinessClient
boto3 documentation
# QBusinessClient usage example
from boto3.session import Session
from types_boto3_qbusiness.client import QBusinessClient
def get_client() -> QBusinessClient:
return Session().client("qbusiness")
Paginators#
Type annotations and code completion for paginators
from boto3.client("qbusiness").get_paginator("...")
.
# GetChatControlsConfigurationPaginator usage example
from boto3.session import Session
from types_boto3_qbusiness.paginator import GetChatControlsConfigurationPaginator
def get_get_chat_controls_configuration_paginator() -> GetChatControlsConfigurationPaginator:
return Session().client("qbusiness").get_paginator("get_chat_controls_configuration"))
- GetChatControlsConfigurationPaginator
- ListApplicationsPaginator
- ListAttachmentsPaginator
- ListConversationsPaginator
- ListDataAccessorsPaginator
- ListDataSourceSyncJobsPaginator
- ListDataSourcesPaginator
- ListDocumentsPaginator
- ListGroupsPaginator
- ListIndicesPaginator
- ListMessagesPaginator
- ListPluginActionsPaginator
- ListPluginTypeActionsPaginator
- ListPluginTypeMetadataPaginator
- ListPluginsPaginator
- ListRetrieversPaginator
- ListSubscriptionsPaginator
- ListWebExperiencesPaginator
- SearchRelevantContentPaginator
Literals#
Type annotations for literals used in methods and schema.
# APISchemaTypeType usage example
from types_boto3_qbusiness.literals import APISchemaTypeType
def get_value() -> APISchemaTypeType:
return "OPEN_API_V3"
- APISchemaTypeType
- ActionPayloadFieldTypeType
- ApplicationStatusType
- AttachmentStatusType
- AttachmentsControlModeType
- AttributeTypeType
- AttributeValueOperatorType
- AutoSubscriptionStatusType
- BrowserExtensionType
- ChatModeType
- ContentTypeType
- CreatorModeControlType
- DataSourceStatusType
- DataSourceSyncJobStatusType
- DocumentAttributeBoostingLevelType
- DocumentContentOperatorType
- DocumentEnrichmentConditionOperatorType
- DocumentStatusType
- ErrorCodeType
- GetChatControlsConfigurationPaginatorName
- GroupStatusType
- IdentityTypeType
- ImageExtractionStatusType
- IndexStatusType
- IndexTypeType
- ListApplicationsPaginatorName
- ListAttachmentsPaginatorName
- ListConversationsPaginatorName
- ListDataAccessorsPaginatorName
- ListDataSourceSyncJobsPaginatorName
- ListDataSourcesPaginatorName
- ListDocumentsPaginatorName
- ListGroupsPaginatorName
- ListIndicesPaginatorName
- ListMessagesPaginatorName
- ListPluginActionsPaginatorName
- ListPluginTypeActionsPaginatorName
- ListPluginTypeMetadataPaginatorName
- ListPluginsPaginatorName
- ListRetrieversPaginatorName
- ListSubscriptionsPaginatorName
- ListWebExperiencesPaginatorName
- MemberRelationType
- MembershipTypeType
- MessageTypeType
- MessageUsefulnessReasonType
- MessageUsefulnessType
- NumberAttributeBoostingTypeType
- OrchestrationControlType
- PersonalizationControlModeType
- PluginBuildStatusType
- PluginStateType
- PluginTypeCategoryType
- PluginTypeType
- QAppsControlModeType
- ReadAccessTypeType
- ResponseScopeType
- RetrieverStatusType
- RetrieverTypeType
- RuleTypeType
- ScoreConfidenceType
- SearchRelevantContentPaginatorName
- StatusType
- StringAttributeValueBoostingLevelType
- SubscriptionTypeType
- WebExperienceSamplePromptsControlModeType
- WebExperienceStatusType
- QBusinessServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- S3TypeDef
- ActionExecutionPayloadFieldOutputTypeDef
- ActionExecutionPayloadFieldTypeDef
- ActionReviewPayloadFieldAllowedValueTypeDef
- ActionSummaryTypeDef
- QuickSightConfigurationTypeDef
- AppliedAttachmentsConfigurationTypeDef
- AppliedCreatorModeConfigurationTypeDef
- AppliedOrchestrationConfigurationTypeDef
- AssociatePermissionRequestTypeDef
- ResponseMetadataTypeDef
- BlobTypeDef
- ErrorDetailTypeDef
- AttachmentsConfigurationTypeDef
- AuthChallengeRequestEventTypeDef
- AuthChallengeRequestTypeDef
- AuthChallengeResponseEventTypeDef
- AuthChallengeResponseTypeDef
- AutoSubscriptionConfigurationTypeDef
- BasicAuthConfigurationTypeDef
- DeleteDocumentTypeDef
- BlockedPhrasesConfigurationTypeDef
- BlockedPhrasesConfigurationUpdateTypeDef
- BrowserExtensionConfigurationOutputTypeDef
- BrowserExtensionConfigurationTypeDef
- CancelSubscriptionRequestTypeDef
- SubscriptionDetailsTypeDef
- TextInputEventTypeDef
- PluginConfigurationTypeDef
- TextOutputEventTypeDef
- ContentBlockerRuleTypeDef
- EligibleDataSourceTypeDef
- RetrieverContentSourceTypeDef
- ConversationSourceTypeDef
- ConversationTypeDef
- EncryptionConfigurationTypeDef
- PersonalizationConfigurationTypeDef
- QAppsConfigurationTypeDef
- TagTypeDef
- IndexCapacityConfigurationTypeDef
- SubscriptionPrincipalTypeDef
- UserAliasTypeDef
- CustomizationConfigurationTypeDef
- CreatorModeConfigurationTypeDef
- DataAccessorTypeDef
- DataSourceSyncJobMetricsTypeDef
- DataSourceTypeDef
- DataSourceVpcConfigurationOutputTypeDef
- DataSourceVpcConfigurationTypeDef
- DateAttributeBoostingConfigurationTypeDef
- DeleteApplicationRequestTypeDef
- DeleteChatControlsConfigurationRequestTypeDef
- DeleteConversationRequestTypeDef
- DeleteDataAccessorRequestTypeDef
- DeleteDataSourceRequestTypeDef
- DeleteGroupRequestTypeDef
- DeleteIndexRequestTypeDef
- DeletePluginRequestTypeDef
- DeleteRetrieverRequestTypeDef
- DeleteUserRequestTypeDef
- DeleteWebExperienceRequestTypeDef
- DisassociatePermissionRequestTypeDef
- NumberAttributeBoostingConfigurationTypeDef
- StringAttributeBoostingConfigurationOutputTypeDef
- StringListAttributeBoostingConfigurationTypeDef
- StringAttributeBoostingConfigurationTypeDef
- DocumentAttributeValueOutputTypeDef
- DocumentAttributeConfigurationTypeDef
- TimestampTypeDef
- GetApplicationRequestTypeDef
- PaginatorConfigTypeDef
- GetChatControlsConfigurationRequestTypeDef
- GetDataAccessorRequestTypeDef
- GetDataSourceRequestTypeDef
- GetGroupRequestTypeDef
- GetIndexRequestTypeDef
- GetMediaRequestTypeDef
- GetPluginRequestTypeDef
- GetPolicyRequestTypeDef
- GetRetrieverRequestTypeDef
- GetUserRequestTypeDef
- GetWebExperienceRequestTypeDef
- MemberGroupTypeDef
- MemberUserTypeDef
- GroupSummaryTypeDef
- IdcAuthConfigurationTypeDef
- OpenIDConnectProviderConfigurationTypeDef
- SamlProviderConfigurationTypeDef
- ImageExtractionConfigurationTypeDef
- TextDocumentStatisticsTypeDef
- IndexTypeDef
- KendraIndexConfigurationTypeDef
- ListApplicationsRequestTypeDef
- ListAttachmentsRequestTypeDef
- ListConversationsRequestTypeDef
- ListDataAccessorsRequestTypeDef
- ListDataSourcesRequestTypeDef
- ListDocumentsRequestTypeDef
- ListIndicesRequestTypeDef
- ListMessagesRequestTypeDef
- ListPluginActionsRequestTypeDef
- ListPluginTypeActionsRequestTypeDef
- ListPluginTypeMetadataRequestTypeDef
- PluginTypeMetadataSummaryTypeDef
- ListPluginsRequestTypeDef
- PluginTypeDef
- ListRetrieversRequestTypeDef
- RetrieverTypeDef
- ListSubscriptionsRequestTypeDef
- ListTagsForResourceRequestTypeDef
- ListWebExperiencesRequestTypeDef
- WebExperienceTypeDef
- OAuth2ClientCredentialConfigurationTypeDef
- OrchestrationConfigurationTypeDef
- PrincipalGroupTypeDef
- PrincipalUserTypeDef
- ScoreAttributesTypeDef
- UsersAndGroupsOutputTypeDef
- SamlConfigurationTypeDef
- SnippetExcerptTypeDef
- StartDataSourceSyncJobRequestTypeDef
- StopDataSourceSyncJobRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateSubscriptionRequestTypeDef
- UsersAndGroupsTypeDef
- APISchemaTypeDef
- ActionExecutionOutputTypeDef
- ActionExecutionPayloadFieldUnionTypeDef
- ActionExecutionTypeDef
- ActionReviewPayloadFieldTypeDef
- ApplicationTypeDef
- AssociatePermissionResponseTypeDef
- CreateApplicationResponseTypeDef
- CreateDataAccessorResponseTypeDef
- CreateDataSourceResponseTypeDef
- CreateIndexResponseTypeDef
- CreatePluginResponseTypeDef
- CreateRetrieverResponseTypeDef
- CreateWebExperienceResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetMediaResponseTypeDef
- GetPolicyResponseTypeDef
- ListPluginActionsResponseTypeDef
- ListPluginTypeActionsResponseTypeDef
- StartDataSourceSyncJobResponseTypeDef
- DocumentContentTypeDef
- AttachmentOutputTypeDef
- DocumentDetailsTypeDef
- FailedDocumentTypeDef
- GroupStatusDetailTypeDef
- BatchDeleteDocumentRequestTypeDef
- BrowserExtensionConfigurationUnionTypeDef
- CancelSubscriptionResponseTypeDef
- CreateSubscriptionResponseTypeDef
- UpdateSubscriptionResponseTypeDef
- ChatModeConfigurationTypeDef
- ContentRetrievalRuleOutputTypeDef
- ContentRetrievalRuleTypeDef
- ContentSourceTypeDef
- CopyFromSourceTypeDef
- ListConversationsResponseTypeDef
- GetApplicationResponseTypeDef
- UpdateApplicationRequestTypeDef
- CreateApplicationRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestTypeDef
- CreateIndexRequestTypeDef
- CreateSubscriptionRequestTypeDef
- SubscriptionTypeDef
- CreateUserRequestTypeDef
- GetUserResponseTypeDef
- UpdateUserRequestTypeDef
- UpdateUserResponseTypeDef
- ListDataAccessorsResponseTypeDef
- DataSourceSyncJobTypeDef
- ListDataSourcesResponseTypeDef
- DataSourceVpcConfigurationUnionTypeDef
- DocumentAttributeBoostingConfigurationOutputTypeDef
- DocumentAttributeBoostingConfigurationTypeDef
- DocumentAttributeConditionOutputTypeDef
- DocumentAttributeOutputTypeDef
- DocumentAttributeTargetOutputTypeDef
- UpdateIndexRequestTypeDef
- DocumentAttributeValueTypeDef
- ListDataSourceSyncJobsRequestTypeDef
- ListGroupsRequestTypeDef
- MessageUsefulnessFeedbackTypeDef
- GetChatControlsConfigurationRequestPaginateTypeDef
- ListApplicationsRequestPaginateTypeDef
- ListAttachmentsRequestPaginateTypeDef
- ListConversationsRequestPaginateTypeDef
- ListDataAccessorsRequestPaginateTypeDef
- ListDataSourceSyncJobsRequestPaginateTypeDef
- ListDataSourcesRequestPaginateTypeDef
- ListDocumentsRequestPaginateTypeDef
- ListGroupsRequestPaginateTypeDef
- ListIndicesRequestPaginateTypeDef
- ListMessagesRequestPaginateTypeDef
- ListPluginActionsRequestPaginateTypeDef
- ListPluginTypeActionsRequestPaginateTypeDef
- ListPluginTypeMetadataRequestPaginateTypeDef
- ListPluginsRequestPaginateTypeDef
- ListRetrieversRequestPaginateTypeDef
- ListSubscriptionsRequestPaginateTypeDef
- ListWebExperiencesRequestPaginateTypeDef
- GroupMembersTypeDef
- ListGroupsResponseTypeDef
- IdentityProviderConfigurationTypeDef
- MediaExtractionConfigurationTypeDef
- IndexStatisticsTypeDef
- ListIndicesResponseTypeDef
- ListPluginTypeMetadataResponseTypeDef
- ListPluginsResponseTypeDef
- ListRetrieversResponseTypeDef
- ListWebExperiencesResponseTypeDef
- PluginAuthConfigurationOutputTypeDef
- PluginAuthConfigurationTypeDef
- PrincipalTypeDef
- WebExperienceAuthConfigurationTypeDef
- TextSegmentTypeDef
- UsersAndGroupsUnionTypeDef
- CustomPluginConfigurationTypeDef
- ActionExecutionEventTypeDef
- ActionExecutionUnionTypeDef
- ActionReviewEventTypeDef
- ActionReviewTypeDef
- ListApplicationsResponseTypeDef
- FailedAttachmentEventTypeDef
- ListDocumentsResponseTypeDef
- BatchDeleteDocumentResponseTypeDef
- BatchPutDocumentResponseTypeDef
- GetGroupResponseTypeDef
- RuleConfigurationOutputTypeDef
- ContentRetrievalRuleUnionTypeDef
- AttachmentInputTypeDef
- AttachmentTypeDef
- ListSubscriptionsResponseTypeDef
- ListDataSourceSyncJobsResponseTypeDef
- NativeIndexConfigurationOutputTypeDef
- NativeIndexConfigurationTypeDef
- HookConfigurationOutputTypeDef
- AttributeFilterOutputTypeDef
- RelevantContentTypeDef
- InlineDocumentEnrichmentConfigurationOutputTypeDef
- DocumentAttributeValueUnionTypeDef
- PutFeedbackRequestTypeDef
- PutGroupRequestTypeDef
- CreateWebExperienceRequestTypeDef
- GetIndexResponseTypeDef
- PluginAuthConfigurationUnionTypeDef
- AccessControlTypeDef
- GetWebExperienceResponseTypeDef
- UpdateWebExperienceRequestTypeDef
- SourceAttributionTypeDef
- GetPluginResponseTypeDef
- RuleOutputTypeDef
- RuleConfigurationTypeDef
- AttachmentInputEventTypeDef
- ListAttachmentsResponseTypeDef
- RetrieverConfigurationOutputTypeDef
- RetrieverConfigurationTypeDef
- ActionFilterConfigurationOutputTypeDef
- SearchRelevantContentResponseTypeDef
- DocumentEnrichmentConfigurationOutputTypeDef
- DocumentAttributeConditionTypeDef
- DocumentAttributeTargetTypeDef
- DocumentAttributeTypeDef
- CreatePluginRequestTypeDef
- UpdatePluginRequestTypeDef
- AccessConfigurationTypeDef
- ChatSyncOutputTypeDef
- MessageTypeDef
- MetadataEventTypeDef
- TopicConfigurationOutputTypeDef
- RuleConfigurationUnionTypeDef
- GetRetrieverResponseTypeDef
- RetrieverConfigurationUnionTypeDef
- ActionConfigurationOutputTypeDef
- GetDataSourceResponseTypeDef
- DocumentAttributeConditionUnionTypeDef
- DocumentAttributeTargetUnionTypeDef
- DocumentAttributeUnionTypeDef
- ListMessagesResponseTypeDef
- ChatOutputStreamTypeDef
- GetChatControlsConfigurationResponseTypeDef
- RuleTypeDef
- CreateRetrieverRequestTypeDef
- UpdateRetrieverRequestTypeDef
- GetDataAccessorResponseTypeDef
- HookConfigurationTypeDef
- InlineDocumentEnrichmentConfigurationTypeDef
- AttributeFilterPaginatorTypeDef
- AttributeFilterTypeDef
- ChatOutputTypeDef
- RuleUnionTypeDef
- HookConfigurationUnionTypeDef
- InlineDocumentEnrichmentConfigurationUnionTypeDef
- SearchRelevantContentRequestPaginateTypeDef
- AttributeFilterUnionTypeDef
- TopicConfigurationTypeDef
- DocumentEnrichmentConfigurationTypeDef
- ActionFilterConfigurationTypeDef
- ChatSyncInputTypeDef
- ConfigurationEventTypeDef
- SearchRelevantContentRequestTypeDef
- TopicConfigurationUnionTypeDef
- DocumentEnrichmentConfigurationUnionTypeDef
- ActionFilterConfigurationUnionTypeDef
- ChatInputStreamTypeDef
- UpdateChatControlsConfigurationRequestTypeDef
- CreateDataSourceRequestTypeDef
- DocumentTypeDef
- UpdateDataSourceRequestTypeDef
- ActionConfigurationTypeDef
- ChatInputTypeDef
- BatchPutDocumentRequestTypeDef
- ActionConfigurationUnionTypeDef
- CreateDataAccessorRequestTypeDef
- UpdateDataAccessorRequestTypeDef