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.35.86' 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
- 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
- ListWebExperiencesPaginatorName
- MemberRelationType
- MembershipTypeType
- MessageTypeType
- MessageUsefulnessReasonType
- MessageUsefulnessType
- NumberAttributeBoostingTypeType
- 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
- AssociatePermissionRequestRequestTypeDef
- ResponseMetadataTypeDef
- BlobTypeDef
- ErrorDetailTypeDef
- AttachmentsConfigurationTypeDef
- AuthChallengeRequestEventTypeDef
- AuthChallengeRequestTypeDef
- AuthChallengeResponseEventTypeDef
- AuthChallengeResponseTypeDef
- AutoSubscriptionConfigurationTypeDef
- BasicAuthConfigurationTypeDef
- DeleteDocumentTypeDef
- BlockedPhrasesConfigurationTypeDef
- BlockedPhrasesConfigurationUpdateTypeDef
- BrowserExtensionConfigurationOutputTypeDef
- BrowserExtensionConfigurationTypeDef
- TextInputEventTypeDef
- PluginConfigurationTypeDef
- TextOutputEventTypeDef
- ContentBlockerRuleTypeDef
- EligibleDataSourceTypeDef
- RetrieverContentSourceTypeDef
- ConversationSourceTypeDef
- ConversationTypeDef
- EncryptionConfigurationTypeDef
- PersonalizationConfigurationTypeDef
- QAppsConfigurationTypeDef
- TagTypeDef
- DataSourceVpcConfigurationTypeDef
- IndexCapacityConfigurationTypeDef
- UserAliasTypeDef
- CustomizationConfigurationTypeDef
- CreatorModeConfigurationTypeDef
- DataAccessorTypeDef
- DataSourceSyncJobMetricsTypeDef
- DataSourceTypeDef
- DataSourceVpcConfigurationOutputTypeDef
- DateAttributeBoostingConfigurationTypeDef
- DeleteApplicationRequestRequestTypeDef
- DeleteChatControlsConfigurationRequestRequestTypeDef
- DeleteConversationRequestRequestTypeDef
- DeleteDataAccessorRequestRequestTypeDef
- DeleteDataSourceRequestRequestTypeDef
- DeleteGroupRequestRequestTypeDef
- DeleteIndexRequestRequestTypeDef
- DeletePluginRequestRequestTypeDef
- DeleteRetrieverRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- DeleteWebExperienceRequestRequestTypeDef
- DisassociatePermissionRequestRequestTypeDef
- NumberAttributeBoostingConfigurationTypeDef
- StringAttributeBoostingConfigurationOutputTypeDef
- StringListAttributeBoostingConfigurationTypeDef
- DocumentAttributeValueOutputTypeDef
- DocumentAttributeConfigurationTypeDef
- TimestampTypeDef
- GetApplicationRequestRequestTypeDef
- PaginatorConfigTypeDef
- GetChatControlsConfigurationRequestRequestTypeDef
- GetDataAccessorRequestRequestTypeDef
- GetDataSourceRequestRequestTypeDef
- GetGroupRequestRequestTypeDef
- GetIndexRequestRequestTypeDef
- GetMediaRequestRequestTypeDef
- GetPluginRequestRequestTypeDef
- GetPolicyRequestRequestTypeDef
- GetRetrieverRequestRequestTypeDef
- GetUserRequestRequestTypeDef
- GetWebExperienceRequestRequestTypeDef
- MemberGroupTypeDef
- MemberUserTypeDef
- GroupSummaryTypeDef
- IdcAuthConfigurationTypeDef
- OpenIDConnectProviderConfigurationTypeDef
- SamlProviderConfigurationTypeDef
- ImageExtractionConfigurationTypeDef
- TextDocumentStatisticsTypeDef
- IndexTypeDef
- KendraIndexConfigurationTypeDef
- ListApplicationsRequestRequestTypeDef
- ListAttachmentsRequestRequestTypeDef
- ListConversationsRequestRequestTypeDef
- ListDataAccessorsRequestRequestTypeDef
- ListDataSourcesRequestRequestTypeDef
- ListDocumentsRequestRequestTypeDef
- ListIndicesRequestRequestTypeDef
- ListMessagesRequestRequestTypeDef
- ListPluginActionsRequestRequestTypeDef
- ListPluginTypeActionsRequestRequestTypeDef
- ListPluginTypeMetadataRequestRequestTypeDef
- PluginTypeMetadataSummaryTypeDef
- ListPluginsRequestRequestTypeDef
- PluginTypeDef
- ListRetrieversRequestRequestTypeDef
- RetrieverTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListWebExperiencesRequestRequestTypeDef
- WebExperienceTypeDef
- OAuth2ClientCredentialConfigurationTypeDef
- PrincipalGroupTypeDef
- PrincipalUserTypeDef
- ScoreAttributesTypeDef
- UsersAndGroupsOutputTypeDef
- SamlConfigurationTypeDef
- SnippetExcerptTypeDef
- StartDataSourceSyncJobRequestRequestTypeDef
- StopDataSourceSyncJobRequestRequestTypeDef
- StringAttributeBoostingConfigurationTypeDef
- UntagResourceRequestRequestTypeDef
- UsersAndGroupsTypeDef
- APISchemaTypeDef
- ActionExecutionOutputTypeDef
- ActionExecutionPayloadFieldUnionTypeDef
- ActionReviewPayloadFieldTypeDef
- ApplicationTypeDef
- AssociatePermissionResponseTypeDef
- CreateApplicationResponseTypeDef
- CreateDataAccessorResponseTypeDef
- CreateDataSourceResponseTypeDef
- CreateIndexResponseTypeDef
- CreatePluginResponseTypeDef
- CreateRetrieverResponseTypeDef
- CreateWebExperienceResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetMediaResponseTypeDef
- GetPolicyResponseTypeDef
- ListPluginActionsResponseTypeDef
- ListPluginTypeActionsResponseTypeDef
- StartDataSourceSyncJobResponseTypeDef
- DocumentContentTypeDef
- AttachmentOutputTypeDef
- DocumentDetailsTypeDef
- FailedDocumentTypeDef
- GroupStatusDetailTypeDef
- BatchDeleteDocumentRequestRequestTypeDef
- ChatModeConfigurationTypeDef
- ContentRetrievalRuleOutputTypeDef
- ContentRetrievalRuleTypeDef
- ContentSourceTypeDef
- CopyFromSourceTypeDef
- ListConversationsResponseTypeDef
- GetApplicationResponseTypeDef
- UpdateApplicationRequestRequestTypeDef
- CreateApplicationRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- CreateIndexRequestRequestTypeDef
- CreateUserRequestRequestTypeDef
- GetUserResponseTypeDef
- UpdateUserRequestRequestTypeDef
- UpdateUserResponseTypeDef
- ListDataAccessorsResponseTypeDef
- DataSourceSyncJobTypeDef
- ListDataSourcesResponseTypeDef
- DocumentAttributeBoostingConfigurationOutputTypeDef
- DocumentAttributeConditionOutputTypeDef
- DocumentAttributeOutputTypeDef
- DocumentAttributeTargetOutputTypeDef
- UpdateIndexRequestRequestTypeDef
- DocumentAttributeValueTypeDef
- ListDataSourceSyncJobsRequestRequestTypeDef
- ListGroupsRequestRequestTypeDef
- MessageUsefulnessFeedbackTypeDef
- GetChatControlsConfigurationRequestPaginateTypeDef
- ListApplicationsRequestPaginateTypeDef
- ListAttachmentsRequestPaginateTypeDef
- ListConversationsRequestPaginateTypeDef
- ListDataAccessorsRequestPaginateTypeDef
- ListDataSourceSyncJobsRequestPaginateTypeDef
- ListDataSourcesRequestPaginateTypeDef
- ListDocumentsRequestPaginateTypeDef
- ListGroupsRequestPaginateTypeDef
- ListIndicesRequestPaginateTypeDef
- ListMessagesRequestPaginateTypeDef
- ListPluginActionsRequestPaginateTypeDef
- ListPluginTypeActionsRequestPaginateTypeDef
- ListPluginTypeMetadataRequestPaginateTypeDef
- ListPluginsRequestPaginateTypeDef
- ListRetrieversRequestPaginateTypeDef
- ListWebExperiencesRequestPaginateTypeDef
- GroupMembersTypeDef
- ListGroupsResponseTypeDef
- IdentityProviderConfigurationTypeDef
- MediaExtractionConfigurationTypeDef
- IndexStatisticsTypeDef
- ListIndicesResponseTypeDef
- ListPluginTypeMetadataResponseTypeDef
- ListPluginsResponseTypeDef
- ListRetrieversResponseTypeDef
- ListWebExperiencesResponseTypeDef
- PluginAuthConfigurationOutputTypeDef
- PluginAuthConfigurationTypeDef
- PrincipalTypeDef
- WebExperienceAuthConfigurationTypeDef
- TextSegmentTypeDef
- StringAttributeBoostingConfigurationUnionTypeDef
- UsersAndGroupsUnionTypeDef
- CustomPluginConfigurationTypeDef
- ActionExecutionEventTypeDef
- ActionExecutionTypeDef
- ActionReviewEventTypeDef
- ActionReviewTypeDef
- ListApplicationsResponseTypeDef
- FailedAttachmentEventTypeDef
- ListDocumentsResponseTypeDef
- BatchDeleteDocumentResponseTypeDef
- BatchPutDocumentResponseTypeDef
- GetGroupResponseTypeDef
- RuleConfigurationOutputTypeDef
- ContentRetrievalRuleUnionTypeDef
- AttachmentInputTypeDef
- AttachmentTypeDef
- ListDataSourceSyncJobsResponseTypeDef
- NativeIndexConfigurationOutputTypeDef
- HookConfigurationOutputTypeDef
- AttributeFilterOutputTypeDef
- RelevantContentTypeDef
- InlineDocumentEnrichmentConfigurationOutputTypeDef
- DocumentAttributeValueUnionTypeDef
- PutFeedbackRequestRequestTypeDef
- PutGroupRequestRequestTypeDef
- CreateWebExperienceRequestRequestTypeDef
- GetIndexResponseTypeDef
- AccessControlTypeDef
- GetWebExperienceResponseTypeDef
- UpdateWebExperienceRequestRequestTypeDef
- SourceAttributionTypeDef
- DocumentAttributeBoostingConfigurationTypeDef
- CreatePluginRequestRequestTypeDef
- GetPluginResponseTypeDef
- UpdatePluginRequestRequestTypeDef
- RuleOutputTypeDef
- RuleConfigurationTypeDef
- AttachmentInputEventTypeDef
- ListAttachmentsResponseTypeDef
- RetrieverConfigurationOutputTypeDef
- ActionFilterConfigurationOutputTypeDef
- SearchRelevantContentResponseTypeDef
- DocumentEnrichmentConfigurationOutputTypeDef
- DocumentAttributeConditionTypeDef
- DocumentAttributeTargetTypeDef
- DocumentAttributeTypeDef
- AccessConfigurationTypeDef
- ChatSyncOutputTypeDef
- MessageTypeDef
- MetadataEventTypeDef
- DocumentAttributeBoostingConfigurationUnionTypeDef
- TopicConfigurationOutputTypeDef
- RuleConfigurationUnionTypeDef
- GetRetrieverResponseTypeDef
- ActionConfigurationOutputTypeDef
- GetDataSourceResponseTypeDef
- DocumentAttributeConditionUnionTypeDef
- DocumentAttributeTargetUnionTypeDef
- DocumentAttributeUnionTypeDef
- ListMessagesResponseTypeDef
- ChatOutputStreamTypeDef
- NativeIndexConfigurationTypeDef
- GetChatControlsConfigurationResponseTypeDef
- RuleTypeDef
- GetDataAccessorResponseTypeDef
- HookConfigurationTypeDef
- InlineDocumentEnrichmentConfigurationTypeDef
- AttributeFilterPaginatorTypeDef
- AttributeFilterTypeDef
- ChatOutputTypeDef
- NativeIndexConfigurationUnionTypeDef
- RuleUnionTypeDef
- HookConfigurationUnionTypeDef
- InlineDocumentEnrichmentConfigurationUnionTypeDef
- SearchRelevantContentRequestPaginateTypeDef
- AttributeFilterUnionTypeDef
- ChatSyncInputRequestTypeDef
- SearchRelevantContentRequestRequestTypeDef
- RetrieverConfigurationTypeDef
- TopicConfigurationTypeDef
- DocumentEnrichmentConfigurationTypeDef
- ActionFilterConfigurationTypeDef
- ConfigurationEventTypeDef
- CreateRetrieverRequestRequestTypeDef
- UpdateRetrieverRequestRequestTypeDef
- TopicConfigurationUnionTypeDef
- CreateDataSourceRequestRequestTypeDef
- DocumentEnrichmentConfigurationUnionTypeDef
- UpdateDataSourceRequestRequestTypeDef
- ActionFilterConfigurationUnionTypeDef
- ChatInputStreamTypeDef
- UpdateChatControlsConfigurationRequestRequestTypeDef
- DocumentTypeDef
- ActionConfigurationTypeDef
- ChatInputRequestTypeDef
- BatchPutDocumentRequestRequestTypeDef
- ActionConfigurationUnionTypeDef
- UpdateDataAccessorRequestRequestTypeDef
- CreateDataAccessorRequestRequestTypeDef