QBusiness¶
Installation¶
To install the QBusiness client:
Bidirectional streaming¶
This client supports bidirectional event streams, which require the HTTP client from the AWS Common Runtime (CRT). To use this feature, install the package with the awscrt extra:
Then pass an AWSCRTHTTPClient instance as the transport when you resolve the config.
Clients¶
The package provides a synchronous client, QBusinessClient, and an asynchronous client, AsyncQBusinessClient. Both clients use the same models.
Operations that use event streams are available only on AsyncQBusinessClient. They are marked Async only under Operations.
QBusinessClient
¶
QBusinessClient(config: QBusinessConfig | None = None, plugins: list[Plugin] | None = None)
Bases: Client[QBusinessConfig]
This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .
For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.
The following resources provide additional information about using the Amazon Q Business API:
AsyncQBusinessClient
¶
AsyncQBusinessClient(config: AsyncQBusinessConfig | None = None, plugins: list[Plugin] | None = None)
Bases: AsyncClient[AsyncQBusinessConfig]
This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .
For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.
The following resources provide additional information about using the Amazon Q Business API:
Operations¶
associate_permissionbatch_delete_documentbatch_put_documentcancel_subscriptionchatAsync onlychat_synccheck_document_accesscreate_anonymous_web_experience_urlcreate_applicationcreate_chat_response_configurationcreate_data_accessorcreate_data_sourcecreate_indexcreate_plugincreate_retrievercreate_subscriptioncreate_usercreate_web_experiencedelete_applicationdelete_attachmentdelete_chat_controls_configurationdelete_chat_response_configurationdelete_conversationdelete_data_accessordelete_data_sourcedelete_groupdelete_indexdelete_plugindelete_retrieverdelete_userdelete_web_experiencedisassociate_permissionget_applicationget_chat_controls_configurationget_chat_response_configurationget_data_accessorget_data_sourceget_document_contentget_groupget_indexget_mediaget_pluginget_policyget_retrieverget_userget_web_experiencelist_applicationslist_attachmentslist_chat_response_configurationslist_conversationslist_data_accessorslist_data_source_sync_jobslist_data_sourceslist_documentslist_groupslist_indiceslist_messageslist_plugin_actionslist_plugin_type_actionslist_plugin_type_metadatalist_pluginslist_retrieverslist_subscriptionslist_tags_for_resourcelist_web_experiencesput_feedbackput_groupsearch_relevant_contentstart_data_source_sync_jobstop_data_source_sync_jobtag_resourceuntag_resourceupdate_applicationupdate_chat_controls_configurationupdate_chat_response_configurationupdate_data_accessorupdate_data_sourceupdate_indexupdate_pluginupdate_retrieverupdate_subscriptionupdate_userupdate_web_experience
Configuration¶
QBusinessConfig
dataclass
¶
Bases: AwsConfig
QBusiness configuration.
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: IdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.protocols to select the protocol, e.g. protocol=AwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
classmethod
¶
resolve(*, profile: str | None = None, fs: FileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_QBusinessConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[QBusinessConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
AsyncQBusinessConfig
dataclass
¶
Bases: AsyncAwsConfig
QBusiness configuration (async-resolved).
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: AsyncIdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.aio.protocols to select the protocol, e.g. protocol=AsyncAwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
async
classmethod
¶
resolve(*, profile: str | None = None, fs: AsyncFileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_AsyncQBusinessConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[AsyncQBusinessConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
Structures¶
AccessConfigurationAccessControlActionConfigurationActionExecutionActionExecutionEventActionExecutionPayloadFieldActionFilterConfigurationActionReviewActionReviewEventActionReviewPayloadFieldActionReviewPayloadFieldAllowedValueActionSummaryApplicationAppliedAttachmentsConfigurationAppliedCreatorModeConfigurationAppliedOrchestrationConfigurationAssociatedGroupAssociatedUserAttachmentAttachmentInputAttachmentInputEventAttachmentOutputAttachmentsConfigurationAttributeFilterAudioExtractionConfigurationAudioSourceDetailsAuthChallengeRequestAuthChallengeRequestEventAuthChallengeResponseAuthChallengeResponseEventAutoSubscriptionConfigurationBasicAuthConfigurationBlockedPhrasesConfigurationBlockedPhrasesConfigurationUpdateBrowserExtensionConfigurationChatResponseConfigurationChatResponseConfigurationDetailConfigurationEventContentBlockerRuleContentRetrievalRuleConversationConversationSourceCreatorModeConfigurationCustomPluginConfigurationCustomizationConfigurationDataAccessorDataAccessorAuthenticationDetailDataAccessorIdcTrustedTokenIssuerConfigurationDataSourceDataSourceSyncJobDataSourceSyncJobMetricsDataSourceVpcConfigurationDateAttributeBoostingConfigurationDeleteDocumentDocumentDocumentAclDocumentAclConditionDocumentAclGroupDocumentAclMembershipDocumentAclUserDocumentAttributeDocumentAttributeConditionDocumentAttributeConfigurationDocumentAttributeTargetDocumentDetailsDocumentEnrichmentConfigurationEligibleDataSourceEncryptionConfigurationEndOfInputEventErrorDetailFailedAttachmentEventFailedDocumentGroupMembersGroupStatusDetailGroupSummaryHallucinationReductionConfigurationHookConfigurationIdcAuthConfigurationImageExtractionConfigurationImageSourceDetailsIndexIndexCapacityConfigurationIndexStatisticsInlineDocumentEnrichmentConfigurationInstructionCollectionKendraIndexConfigurationMediaExtractionConfigurationMemberGroupMemberUserMessageMessageUsefulnessFeedbackMetadataEventNativeIndexConfigurationNoAuthConfigurationNumberAttributeBoostingConfigurationOAuth2ClientCredentialConfigurationOpenIDConnectProviderConfigurationOrchestrationConfigurationPermissionConditionPersonalizationConfigurationPluginPluginConfigurationPluginTypeMetadataSummaryPrincipalGroupPrincipalUserQAppsConfigurationQuickSightConfigurationRelevantContentResponseConfigurationRetrieverRetrieverContentSourceRuleS3SamlConfigurationSamlProviderConfigurationScoreAttributesSnippetExcerptSourceAttributionStringAttributeBoostingConfigurationStringListAttributeBoostingConfigurationSubscriptionSubscriptionDetailsTagTextDocumentStatisticsTextInputEventTextOutputEventTextSegmentTopicConfigurationUserAliasUsersAndGroupsValidationExceptionFieldVideoExtractionConfigurationVideoSourceDetailsWebExperience
Dictionaries¶
AccessConfigurationDictAccessControlDictActionConfigurationDictActionExecutionDictActionExecutionPayloadFieldDictActionFilterConfigurationDictAttachmentInputDictAttachmentsConfigurationDictAttributeFilterDictAudioExtractionConfigurationDictAuthChallengeResponseDictAutoSubscriptionConfigurationDictBasicAuthConfigurationDictBlockedPhrasesConfigurationUpdateDictBrowserExtensionConfigurationDictContentBlockerRuleDictContentRetrievalRuleDictConversationSourceDictCreatorModeConfigurationDictCustomPluginConfigurationDictCustomizationConfigurationDictDataAccessorAuthenticationDetailDictDataAccessorIdcTrustedTokenIssuerConfigurationDictDataSourceVpcConfigurationDictDateAttributeBoostingConfigurationDictDeleteDocumentDictDocumentAttributeConditionDictDocumentAttributeConfigurationDictDocumentAttributeDictDocumentAttributeTargetDictDocumentDictDocumentEnrichmentConfigurationDictEligibleDataSourceDictEncryptionConfigurationDictGroupMembersDictHallucinationReductionConfigurationDictHookConfigurationDictIdcAuthConfigurationDictImageExtractionConfigurationDictIndexCapacityConfigurationDictInlineDocumentEnrichmentConfigurationDictInstructionCollectionDictKendraIndexConfigurationDictMediaExtractionConfigurationDictMemberGroupDictMemberUserDictMessageUsefulnessFeedbackDictNativeIndexConfigurationDictNoAuthConfigurationDictNumberAttributeBoostingConfigurationDictOAuth2ClientCredentialConfigurationDictOpenIDConnectProviderConfigurationDictOrchestrationConfigurationDictPermissionConditionDictPersonalizationConfigurationDictPluginConfigurationDictPrincipalGroupDictPrincipalUserDictQAppsConfigurationDictQuickSightConfigurationDictResponseConfigurationDictRetrieverContentSourceDictRuleDictS3DictSamlConfigurationDictSamlProviderConfigurationDictStringAttributeBoostingConfigurationDictStringListAttributeBoostingConfigurationDictTagDictTopicConfigurationDictUserAliasDictUsersAndGroupsDictVideoExtractionConfigurationDict
Errors¶
AccessDeniedExceptionConflictExceptionExternalResourceExceptionInternalServerExceptionLicenseNotFoundExceptionMediaTooLargeExceptionResourceNotFoundExceptionServiceErrorServiceQuotaExceededExceptionThrottlingExceptionValidationException
Unions¶
APISchemaAPISchemaDictChatInputStreamChatModeConfigurationChatModeConfigurationDictChatOutputStreamContentSourceContentSourceDictCopyFromSourceCopyFromSourceDictDataAccessorAuthenticationConfigurationDataAccessorAuthenticationConfigurationDictDocumentAttributeBoostingConfigurationDocumentAttributeBoostingConfigurationDictDocumentAttributeValueDocumentAttributeValueDictDocumentContentDocumentContentDictIdentityProviderConfigurationIdentityProviderConfigurationDictPluginAuthConfigurationPluginAuthConfigurationDictPrincipalPrincipalDictRetrieverConfigurationRetrieverConfigurationDictRuleConfigurationRuleConfigurationDictSourceDetailsSubscriptionPrincipalSubscriptionPrincipalDictWebExperienceAuthConfigurationWebExperienceAuthConfigurationDict
Enums¶
APISchemaTypeActionPayloadFieldTypeApplicationStatusAttachmentStatusAttachmentsControlModeAttributeTypeAttributeValueOperatorAudioExtractionStatusAudioExtractionTypeAutoSubscriptionStatusChatModeChatResponseConfigurationStatusContentTypeCreatorModeControlDataAccessorAuthenticationTypeDataSourceStatusDataSourceSyncJobStatusDocumentAttributeBoostingLevelDocumentContentOperatorDocumentEnrichmentConditionOperatorDocumentStatusErrorCodeGroupStatusHallucinationReductionControlIdentityTypeImageExtractionStatusIndexStatusIndexTypeMemberRelationMembershipTypeMessageTypeMessageUsefulnessMessageUsefulnessReasonNumberAttributeBoostingTypeOrchestrationControlOutputFormatPermissionConditionOperatorPersonalizationControlModePluginBuildStatusPluginStatePluginTypePluginTypeCategoryQAppsControlModeReadAccessTypeResponseConfigurationTypeResponseScopeRetrieverStatusRetrieverTypeRuleTypeScoreConfidenceStatusStringAttributeValueBoostingLevelSubscriptionTypeSystemMessageTypeValidationExceptionReasonVideoExtractionStatusVideoExtractionTypeWebExperienceSamplePromptsControlModeWebExperienceStatus