QBusiness module#
Index > QBusiness
Auto-generated documentation for QBusiness type annotations stubs module mypy-boto3-qbusiness.
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 QBusiness
.
From PyPI with pip#
Install boto3-stubs
for QBusiness
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[qbusiness]'
# 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[qbusiness]'
# standalone installation
python -m pip install mypy-boto3-qbusiness
How to uninstall#
python -m pip uninstall -y mypy-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 mypy_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 mypy_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
- ListConversationsPaginator
- ListDataSourceSyncJobsPaginator
- ListDataSourcesPaginator
- ListDocumentsPaginator
- ListGroupsPaginator
- ListIndicesPaginator
- ListMessagesPaginator
- ListPluginsPaginator
- ListRetrieversPaginator
- ListWebExperiencesPaginator
Literals#
Type annotations for literals used in methods and schema.
# APISchemaTypeType usage example
from mypy_boto3_qbusiness.literals import APISchemaTypeType
def get_value() -> APISchemaTypeType:
return "OPEN_API_V3"
- APISchemaTypeType
- ActionPayloadFieldTypeType
- ApplicationStatusType
- AttachmentStatusType
- AttachmentsControlModeType
- AttributeTypeType
- AttributeValueOperatorType
- AutoSubscriptionStatusType
- ChatModeType
- ContentTypeType
- CreatorModeControlType
- DataSourceStatusType
- DataSourceSyncJobStatusType
- DocumentAttributeBoostingLevelType
- DocumentContentOperatorType
- DocumentEnrichmentConditionOperatorType
- DocumentStatusType
- ErrorCodeType
- GetChatControlsConfigurationPaginatorName
- GroupStatusType
- IdentityTypeType
- IndexStatusType
- IndexTypeType
- ListApplicationsPaginatorName
- ListConversationsPaginatorName
- ListDataSourceSyncJobsPaginatorName
- ListDataSourcesPaginatorName
- ListDocumentsPaginatorName
- ListGroupsPaginatorName
- ListIndicesPaginatorName
- ListMessagesPaginatorName
- ListPluginsPaginatorName
- ListRetrieversPaginatorName
- ListWebExperiencesPaginatorName
- MemberRelationType
- MembershipTypeType
- MessageTypeType
- MessageUsefulnessReasonType
- MessageUsefulnessType
- NumberAttributeBoostingTypeType
- PersonalizationControlModeType
- PluginBuildStatusType
- PluginStateType
- PluginTypeType
- QAppsControlModeType
- ReadAccessTypeType
- ResponseScopeType
- RetrieverStatusType
- RetrieverTypeType
- RuleTypeType
- 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
- ApplicationTypeDef
- AppliedAttachmentsConfigurationTypeDef
- AppliedCreatorModeConfigurationTypeDef
- BlobTypeDef
- ErrorDetailTypeDef
- AttachmentsConfigurationTypeDef
- AuthChallengeRequestTypeDef
- AuthChallengeResponseTypeDef
- AutoSubscriptionConfigurationTypeDef
- BasicAuthConfigurationTypeDef
- DeleteDocumentTypeDef
- ResponseMetadataTypeDef
- BlockedPhrasesConfigurationTypeDef
- BlockedPhrasesConfigurationUpdateTypeDef
- PluginConfigurationTypeDef
- ContentBlockerRuleTypeDef
- EligibleDataSourceTypeDef
- ConversationTypeDef
- EncryptionConfigurationTypeDef
- PersonalizationConfigurationTypeDef
- QAppsConfigurationTypeDef
- TagTypeDef
- DataSourceVpcConfigurationTypeDef
- IndexCapacityConfigurationTypeDef
- UserAliasTypeDef
- CreatorModeConfigurationTypeDef
- DataSourceSyncJobMetricsTypeDef
- DataSourceTypeDef
- DataSourceVpcConfigurationOutputTypeDef
- DateAttributeBoostingConfigurationTypeDef
- DeleteApplicationRequestRequestTypeDef
- DeleteChatControlsConfigurationRequestRequestTypeDef
- DeleteConversationRequestRequestTypeDef
- DeleteDataSourceRequestRequestTypeDef
- DeleteGroupRequestRequestTypeDef
- DeleteIndexRequestRequestTypeDef
- DeletePluginRequestRequestTypeDef
- DeleteRetrieverRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- DeleteWebExperienceRequestRequestTypeDef
- NumberAttributeBoostingConfigurationTypeDef
- StringAttributeBoostingConfigurationOutputTypeDef
- StringListAttributeBoostingConfigurationTypeDef
- DocumentAttributeValueOutputTypeDef
- DocumentAttributeConfigurationTypeDef
- TimestampTypeDef
- GetApplicationRequestRequestTypeDef
- PaginatorConfigTypeDef
- GetChatControlsConfigurationRequestRequestTypeDef
- GetDataSourceRequestRequestTypeDef
- GetGroupRequestRequestTypeDef
- GetIndexRequestRequestTypeDef
- GetPluginRequestRequestTypeDef
- GetRetrieverRequestRequestTypeDef
- GetUserRequestRequestTypeDef
- GetWebExperienceRequestRequestTypeDef
- MemberGroupTypeDef
- MemberUserTypeDef
- GroupSummaryTypeDef
- OpenIDConnectProviderConfigurationTypeDef
- SamlProviderConfigurationTypeDef
- TextDocumentStatisticsTypeDef
- IndexTypeDef
- KendraIndexConfigurationTypeDef
- ListApplicationsRequestRequestTypeDef
- ListConversationsRequestRequestTypeDef
- ListDataSourcesRequestRequestTypeDef
- ListDocumentsRequestRequestTypeDef
- ListIndicesRequestRequestTypeDef
- ListMessagesRequestRequestTypeDef
- ListPluginsRequestRequestTypeDef
- PluginTypeDef
- ListRetrieversRequestRequestTypeDef
- RetrieverTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListWebExperiencesRequestRequestTypeDef
- WebExperienceTypeDef
- OAuth2ClientCredentialConfigurationTypeDef
- PrincipalGroupTypeDef
- PrincipalUserTypeDef
- UsersAndGroupsOutputTypeDef
- SamlConfigurationTypeDef
- SnippetExcerptTypeDef
- StartDataSourceSyncJobRequestRequestTypeDef
- StopDataSourceSyncJobRequestRequestTypeDef
- StringAttributeBoostingConfigurationTypeDef
- UntagResourceRequestRequestTypeDef
- UsersAndGroupsTypeDef
- APISchemaTypeDef
- ActionExecutionOutputTypeDef
- ActionExecutionPayloadFieldUnionTypeDef
- ActionReviewPayloadFieldTypeDef
- AttachmentInputTypeDef
- DocumentContentTypeDef
- AttachmentOutputTypeDef
- DocumentDetailsTypeDef
- FailedDocumentTypeDef
- GroupStatusDetailTypeDef
- BatchDeleteDocumentRequestRequestTypeDef
- CreateApplicationResponseTypeDef
- CreateDataSourceResponseTypeDef
- CreateIndexResponseTypeDef
- CreatePluginResponseTypeDef
- CreateRetrieverResponseTypeDef
- CreateWebExperienceResponseTypeDef
- EmptyResponseMetadataTypeDef
- ListApplicationsResponseTypeDef
- StartDataSourceSyncJobResponseTypeDef
- ChatModeConfigurationTypeDef
- ContentRetrievalRuleOutputTypeDef
- ContentRetrievalRuleTypeDef
- ListConversationsResponseTypeDef
- GetApplicationResponseTypeDef
- UpdateApplicationRequestRequestTypeDef
- CreateApplicationRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- CreateIndexRequestRequestTypeDef
- CreateUserRequestRequestTypeDef
- GetUserResponseTypeDef
- UpdateUserRequestRequestTypeDef
- UpdateUserResponseTypeDef
- DataSourceSyncJobTypeDef
- ListDataSourcesResponseTypeDef
- DocumentAttributeBoostingConfigurationOutputTypeDef
- DocumentAttributeConditionOutputTypeDef
- DocumentAttributeTargetOutputTypeDef
- UpdateIndexRequestRequestTypeDef
- DocumentAttributeValueTypeDef
- ListDataSourceSyncJobsRequestRequestTypeDef
- ListGroupsRequestRequestTypeDef
- MessageUsefulnessFeedbackTypeDef
- GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef
- ListApplicationsRequestListApplicationsPaginateTypeDef
- ListConversationsRequestListConversationsPaginateTypeDef
- ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef
- ListDataSourcesRequestListDataSourcesPaginateTypeDef
- ListDocumentsRequestListDocumentsPaginateTypeDef
- ListGroupsRequestListGroupsPaginateTypeDef
- ListIndicesRequestListIndicesPaginateTypeDef
- ListMessagesRequestListMessagesPaginateTypeDef
- ListPluginsRequestListPluginsPaginateTypeDef
- ListRetrieversRequestListRetrieversPaginateTypeDef
- ListWebExperiencesRequestListWebExperiencesPaginateTypeDef
- GroupMembersTypeDef
- ListGroupsResponseTypeDef
- IdentityProviderConfigurationTypeDef
- IndexStatisticsTypeDef
- ListIndicesResponseTypeDef
- ListPluginsResponseTypeDef
- ListRetrieversResponseTypeDef
- ListWebExperiencesResponseTypeDef
- PluginAuthConfigurationOutputTypeDef
- PluginAuthConfigurationTypeDef
- PrincipalTypeDef
- WebExperienceAuthConfigurationTypeDef
- TextSegmentTypeDef
- StringAttributeBoostingConfigurationUnionTypeDef
- UsersAndGroupsUnionTypeDef
- CustomPluginConfigurationTypeDef
- ActionExecutionTypeDef
- ActionReviewTypeDef
- ListDocumentsResponseTypeDef
- BatchDeleteDocumentResponseTypeDef
- BatchPutDocumentResponseTypeDef
- GetGroupResponseTypeDef
- RuleConfigurationOutputTypeDef
- ContentRetrievalRuleUnionTypeDef
- ListDataSourceSyncJobsResponseTypeDef
- NativeIndexConfigurationOutputTypeDef
- HookConfigurationOutputTypeDef
- InlineDocumentEnrichmentConfigurationOutputTypeDef
- DocumentAttributeValueUnionTypeDef
- PutFeedbackRequestRequestTypeDef
- PutGroupRequestRequestTypeDef
- CreateWebExperienceRequestRequestTypeDef
- GetIndexResponseTypeDef
- AccessControlTypeDef
- GetWebExperienceResponseTypeDef
- UpdateWebExperienceRequestRequestTypeDef
- SourceAttributionTypeDef
- DocumentAttributeBoostingConfigurationTypeDef
- CreatePluginRequestRequestTypeDef
- GetPluginResponseTypeDef
- UpdatePluginRequestRequestTypeDef
- RuleOutputTypeDef
- RuleConfigurationTypeDef
- RetrieverConfigurationOutputTypeDef
- DocumentEnrichmentConfigurationOutputTypeDef
- DocumentAttributeConditionTypeDef
- DocumentAttributeTargetTypeDef
- DocumentAttributeTypeDef
- AccessConfigurationTypeDef
- ChatSyncOutputTypeDef
- MessageTypeDef
- DocumentAttributeBoostingConfigurationUnionTypeDef
- TopicConfigurationOutputTypeDef
- RuleConfigurationUnionTypeDef
- GetRetrieverResponseTypeDef
- GetDataSourceResponseTypeDef
- DocumentAttributeConditionUnionTypeDef
- DocumentAttributeTargetUnionTypeDef
- AttributeFilterTypeDef
- ListMessagesResponseTypeDef
- NativeIndexConfigurationTypeDef
- GetChatControlsConfigurationResponseTypeDef
- RuleTypeDef
- HookConfigurationTypeDef
- InlineDocumentEnrichmentConfigurationTypeDef
- ChatSyncInputRequestTypeDef
- NativeIndexConfigurationUnionTypeDef
- RuleUnionTypeDef
- HookConfigurationUnionTypeDef
- InlineDocumentEnrichmentConfigurationUnionTypeDef
- RetrieverConfigurationTypeDef
- TopicConfigurationTypeDef
- DocumentEnrichmentConfigurationTypeDef
- CreateRetrieverRequestRequestTypeDef
- UpdateRetrieverRequestRequestTypeDef
- TopicConfigurationUnionTypeDef
- CreateDataSourceRequestRequestTypeDef
- DocumentEnrichmentConfigurationUnionTypeDef
- UpdateDataSourceRequestRequestTypeDef
- UpdateChatControlsConfigurationRequestRequestTypeDef
- DocumentTypeDef
- BatchPutDocumentRequestRequestTypeDef