QBusiness module#
Index > QBusiness
Auto-generated documentation for QBusiness type annotations stubs module types-aiobotocore-qbusiness.
How to install#
From PyPI with pip#
Install types-aioboto3
for QBusiness
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-lite[qbusiness]'
# standalone installation
python -m pip install types-aiobotocore-qbusiness
How to uninstall#
python -m pip uninstall -y types-aiobotocore-qbusiness
Usage#
Code samples can be found in Examples.
QBusinessClient#
Type annotations and code completion for session.client("qbusiness")
as QBusinessClient
boto3 documentation
# QBusinessClient usage example
from aioboto3.session import Session
from types_aiobotocore_qbusiness.client import QBusinessClient
session = Session()
async with session.client("qbusiness") as client:
client: QBusinessClient
Paginators#
Type annotations and code completion for
paginators
from session.client("qbusiness").get_paginator("...")
.
# GetChatControlsConfigurationPaginator usage example
from types_aiobotocore_qbusiness.paginator import GetChatControlsConfigurationPaginator
def get_get_chat_controls_configuration_paginator() -> GetChatControlsConfigurationPaginator:
return client.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.
# ActionPayloadFieldTypeType usage example
from types_aiobotocore_qbusiness.literals import ActionPayloadFieldTypeType
def get_value() -> ActionPayloadFieldTypeType:
return "ARRAY"
- ActionPayloadFieldTypeType
- ApplicationStatusType
- AttachmentStatusType
- AttachmentsControlModeType
- AttributeTypeType
- AttributeValueOperatorType
- ContentTypeType
- DataSourceStatusType
- DataSourceSyncJobStatusType
- DocumentContentOperatorType
- DocumentEnrichmentConditionOperatorType
- DocumentStatusType
- ErrorCodeType
- GetChatControlsConfigurationPaginatorName
- GroupStatusType
- IndexStatusType
- ListApplicationsPaginatorName
- ListConversationsPaginatorName
- ListDataSourceSyncJobsPaginatorName
- ListDataSourcesPaginatorName
- ListDocumentsPaginatorName
- ListGroupsPaginatorName
- ListIndicesPaginatorName
- ListMessagesPaginatorName
- ListPluginsPaginatorName
- ListRetrieversPaginatorName
- ListWebExperiencesPaginatorName
- MemberRelationType
- MembershipTypeType
- MessageTypeType
- MessageUsefulnessReasonType
- MessageUsefulnessType
- PluginStateType
- PluginTypeType
- ReadAccessTypeType
- ResponseScopeType
- RetrieverStatusType
- RetrieverTypeType
- RuleTypeType
- StatusType
- WebExperienceSamplePromptsControlModeType
- WebExperienceStatusType
- QBusinessServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ActionExecutionPayloadFieldPaginatorTypeDef
- ActionExecutionPayloadFieldTypeDef
- ActionReviewPayloadFieldAllowedValueTypeDef
- ApplicationTypeDef
- AppliedAttachmentsConfigurationTypeDef
- BlobTypeDef
- ErrorDetailTypeDef
- AttachmentsConfigurationTypeDef
- BasicAuthConfigurationTypeDef
- DeleteDocumentTypeDef
- ResponseMetadataTypeDef
- BlockedPhrasesConfigurationTypeDef
- BlockedPhrasesConfigurationUpdateTypeDef
- ContentBlockerRuleTypeDef
- EligibleDataSourceTypeDef
- ConversationTypeDef
- EncryptionConfigurationTypeDef
- TagTypeDef
- DataSourceVpcConfigurationTypeDef
- IndexCapacityConfigurationTypeDef
- UserAliasTypeDef
- DataSourceSyncJobMetricsTypeDef
- DataSourceTypeDef
- DeleteApplicationRequestRequestTypeDef
- DeleteChatControlsConfigurationRequestRequestTypeDef
- DeleteConversationRequestRequestTypeDef
- DeleteDataSourceRequestRequestTypeDef
- DeleteGroupRequestRequestTypeDef
- DeleteIndexRequestRequestTypeDef
- DeletePluginRequestRequestTypeDef
- DeleteRetrieverRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- DeleteWebExperienceRequestRequestTypeDef
- DocumentAttributeConfigurationTypeDef
- TimestampTypeDef
- S3TypeDef
- GetApplicationRequestRequestTypeDef
- PaginatorConfigTypeDef
- GetChatControlsConfigurationRequestRequestTypeDef
- GetDataSourceRequestRequestTypeDef
- GetGroupRequestRequestTypeDef
- GetIndexRequestRequestTypeDef
- GetPluginRequestRequestTypeDef
- GetRetrieverRequestRequestTypeDef
- GetUserRequestRequestTypeDef
- GetWebExperienceRequestRequestTypeDef
- MemberGroupTypeDef
- MemberUserTypeDef
- GroupSummaryTypeDef
- TextDocumentStatisticsTypeDef
- IndexTypeDef
- KendraIndexConfigurationTypeDef
- ListApplicationsRequestRequestTypeDef
- ListConversationsRequestRequestTypeDef
- ListDataSourcesRequestRequestTypeDef
- ListDocumentsRequestRequestTypeDef
- ListIndicesRequestRequestTypeDef
- ListMessagesRequestRequestTypeDef
- ListPluginsRequestRequestTypeDef
- PluginTypeDef
- ListRetrieversRequestRequestTypeDef
- RetrieverTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListWebExperiencesRequestRequestTypeDef
- WebExperienceTypeDef
- NativeIndexConfigurationTypeDef
- OAuth2ClientCredentialConfigurationTypeDef
- PrincipalGroupTypeDef
- PrincipalUserTypeDef
- UsersAndGroupsTypeDef
- SamlConfigurationTypeDef
- TextSegmentTypeDef
- StartDataSourceSyncJobRequestRequestTypeDef
- StopDataSourceSyncJobRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- ActionExecutionPaginatorTypeDef
- ActionExecutionTypeDef
- ActionReviewPayloadFieldTypeDef
- AttachmentInputTypeDef
- AttachmentOutputTypeDef
- DocumentDetailsTypeDef
- FailedDocumentTypeDef
- GroupStatusDetailTypeDef
- UpdateApplicationRequestRequestTypeDef
- BatchDeleteDocumentRequestRequestTypeDef
- CreateApplicationResponseTypeDef
- CreateDataSourceResponseTypeDef
- CreateIndexResponseTypeDef
- CreatePluginResponseTypeDef
- CreateRetrieverResponseTypeDef
- CreateWebExperienceResponseTypeDef
- EmptyResponseMetadataTypeDef
- ListApplicationsResponseTypeDef
- StartDataSourceSyncJobResponseTypeDef
- ContentRetrievalRuleTypeDef
- ListConversationsResponseTypeDef
- GetApplicationResponseTypeDef
- CreateApplicationRequestRequestTypeDef
- CreateWebExperienceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- CreateIndexRequestRequestTypeDef
- CreateUserRequestRequestTypeDef
- GetUserResponseTypeDef
- UpdateUserRequestRequestTypeDef
- UpdateUserResponseTypeDef
- DataSourceSyncJobTypeDef
- ListDataSourcesResponseTypeDef
- UpdateIndexRequestRequestTypeDef
- DocumentAttributeValueTypeDef
- ListDataSourceSyncJobsRequestRequestTypeDef
- ListGroupsRequestRequestTypeDef
- MessageUsefulnessFeedbackTypeDef
- DocumentContentTypeDef
- GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef
- ListApplicationsRequestListApplicationsPaginateTypeDef
- ListConversationsRequestListConversationsPaginateTypeDef
- ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef
- ListDataSourcesRequestListDataSourcesPaginateTypeDef
- ListDocumentsRequestListDocumentsPaginateTypeDef
- ListGroupsRequestListGroupsPaginateTypeDef
- ListIndicesRequestListIndicesPaginateTypeDef
- ListMessagesRequestListMessagesPaginateTypeDef
- ListPluginsRequestListPluginsPaginateTypeDef
- ListRetrieversRequestListRetrieversPaginateTypeDef
- ListWebExperiencesRequestListWebExperiencesPaginateTypeDef
- GroupMembersTypeDef
- ListGroupsResponseTypeDef
- IndexStatisticsTypeDef
- ListIndicesResponseTypeDef
- ListPluginsResponseTypeDef
- ListRetrieversResponseTypeDef
- ListWebExperiencesResponseTypeDef
- RetrieverConfigurationTypeDef
- PluginAuthConfigurationTypeDef
- PrincipalTypeDef
- WebExperienceAuthConfigurationTypeDef
- SourceAttributionTypeDef
- ActionReviewTypeDef
- ChatSyncInputRequestTypeDef
- ListDocumentsResponseTypeDef
- BatchDeleteDocumentResponseTypeDef
- BatchPutDocumentResponseTypeDef
- GetGroupResponseTypeDef
- RuleConfigurationTypeDef
- ListDataSourceSyncJobsResponseTypeDef
- DocumentAttributeConditionTypeDef
- DocumentAttributeTargetTypeDef
- DocumentAttributeTypeDef
- PutFeedbackRequestRequestTypeDef
- PutGroupRequestRequestTypeDef
- GetIndexResponseTypeDef
- CreateRetrieverRequestRequestTypeDef
- GetRetrieverResponseTypeDef
- UpdateRetrieverRequestRequestTypeDef
- CreatePluginRequestRequestTypeDef
- GetPluginResponseTypeDef
- UpdatePluginRequestRequestTypeDef
- AccessControlTypeDef
- GetWebExperienceResponseTypeDef
- UpdateWebExperienceRequestRequestTypeDef
- ChatSyncOutputTypeDef
- MessagePaginatorTypeDef
- MessageTypeDef
- RuleTypeDef
- HookConfigurationTypeDef
- InlineDocumentEnrichmentConfigurationTypeDef
- AttributeFilterTypeDef
- AccessConfigurationTypeDef
- ListMessagesResponsePaginatorTypeDef
- ListMessagesResponseTypeDef
- TopicConfigurationTypeDef
- DocumentEnrichmentConfigurationTypeDef
- GetChatControlsConfigurationResponseTypeDef
- UpdateChatControlsConfigurationRequestRequestTypeDef
- CreateDataSourceRequestRequestTypeDef
- DocumentTypeDef
- GetDataSourceResponseTypeDef
- UpdateDataSourceRequestRequestTypeDef
- BatchPutDocumentRequestRequestTypeDef