Awso_qbusiness_eioSourceval associate_permission :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.AssociatePermissionRequest.t ->
(Awso_qbusiness.Values.AssociatePermissionResponse.t,
Awso_qbusiness.Values.AssociatePermissionResponse.error)
Result.tval batch_delete_document :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.BatchDeleteDocumentRequest.t ->
(Awso_qbusiness.Values.BatchDeleteDocumentResponse.t,
Awso_qbusiness.Values.BatchDeleteDocumentResponse.error)
Result.tval batch_put_document :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.BatchPutDocumentRequest.t ->
(Awso_qbusiness.Values.BatchPutDocumentResponse.t,
Awso_qbusiness.Values.BatchPutDocumentResponse.error)
Result.tval cancel_subscription :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CancelSubscriptionRequest.t ->
(Awso_qbusiness.Values.CancelSubscriptionResponse.t,
Awso_qbusiness.Values.CancelSubscriptionResponse.error)
Result.tval chat :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ChatInput.t ->
(Awso_qbusiness.Values.ChatOutput.t, Awso_qbusiness.Values.ChatOutput.error)
Result.tval chat_sync :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ChatSyncInput.t ->
(Awso_qbusiness.Values.ChatSyncOutput.t,
Awso_qbusiness.Values.ChatSyncOutput.error)
Result.tval check_document_access :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CheckDocumentAccessRequest.t ->
(Awso_qbusiness.Values.CheckDocumentAccessResponse.t,
Awso_qbusiness.Values.CheckDocumentAccessResponse.error)
Result.tval create_anonymous_web_experience_url :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateAnonymousWebExperienceUrlRequest.t ->
(Awso_qbusiness.Values.CreateAnonymousWebExperienceUrlResponse.t,
Awso_qbusiness.Values.CreateAnonymousWebExperienceUrlResponse.error)
Result.tval create_application :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateApplicationRequest.t ->
(Awso_qbusiness.Values.CreateApplicationResponse.t,
Awso_qbusiness.Values.CreateApplicationResponse.error)
Result.tval create_chat_response_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateChatResponseConfigurationRequest.t ->
(Awso_qbusiness.Values.CreateChatResponseConfigurationResponse.t,
Awso_qbusiness.Values.CreateChatResponseConfigurationResponse.error)
Result.tval create_data_accessor :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateDataAccessorRequest.t ->
(Awso_qbusiness.Values.CreateDataAccessorResponse.t,
Awso_qbusiness.Values.CreateDataAccessorResponse.error)
Result.tval create_data_source :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateDataSourceRequest.t ->
(Awso_qbusiness.Values.CreateDataSourceResponse.t,
Awso_qbusiness.Values.CreateDataSourceResponse.error)
Result.tval create_index :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateIndexRequest.t ->
(Awso_qbusiness.Values.CreateIndexResponse.t,
Awso_qbusiness.Values.CreateIndexResponse.error)
Result.tval create_plugin :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreatePluginRequest.t ->
(Awso_qbusiness.Values.CreatePluginResponse.t,
Awso_qbusiness.Values.CreatePluginResponse.error)
Result.tval create_retriever :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateRetrieverRequest.t ->
(Awso_qbusiness.Values.CreateRetrieverResponse.t,
Awso_qbusiness.Values.CreateRetrieverResponse.error)
Result.tval create_subscription :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateSubscriptionRequest.t ->
(Awso_qbusiness.Values.CreateSubscriptionResponse.t,
Awso_qbusiness.Values.CreateSubscriptionResponse.error)
Result.tval create_user :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateUserRequest.t ->
(Awso_qbusiness.Values.CreateUserResponse.t,
Awso_qbusiness.Values.CreateUserResponse.error)
Result.tval create_web_experience :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.CreateWebExperienceRequest.t ->
(Awso_qbusiness.Values.CreateWebExperienceResponse.t,
Awso_qbusiness.Values.CreateWebExperienceResponse.error)
Result.tval delete_application :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteApplicationRequest.t ->
(Awso_qbusiness.Values.DeleteApplicationResponse.t,
Awso_qbusiness.Values.DeleteApplicationResponse.error)
Result.tval delete_attachment :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteAttachmentRequest.t ->
(Awso_qbusiness.Values.DeleteAttachmentResponse.t,
Awso_qbusiness.Values.DeleteAttachmentResponse.error)
Result.tval delete_chat_controls_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteChatControlsConfigurationRequest.t ->
(Awso_qbusiness.Values.DeleteChatControlsConfigurationResponse.t,
Awso_qbusiness.Values.DeleteChatControlsConfigurationResponse.error)
Result.tval delete_chat_response_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteChatResponseConfigurationRequest.t ->
(Awso_qbusiness.Values.DeleteChatResponseConfigurationResponse.t,
Awso_qbusiness.Values.DeleteChatResponseConfigurationResponse.error)
Result.tval delete_conversation :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteConversationRequest.t ->
(Awso_qbusiness.Values.DeleteConversationResponse.t,
Awso_qbusiness.Values.DeleteConversationResponse.error)
Result.tval delete_data_accessor :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteDataAccessorRequest.t ->
(Awso_qbusiness.Values.DeleteDataAccessorResponse.t,
Awso_qbusiness.Values.DeleteDataAccessorResponse.error)
Result.tval delete_data_source :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteDataSourceRequest.t ->
(Awso_qbusiness.Values.DeleteDataSourceResponse.t,
Awso_qbusiness.Values.DeleteDataSourceResponse.error)
Result.tval delete_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteGroupRequest.t ->
(Awso_qbusiness.Values.DeleteGroupResponse.t,
Awso_qbusiness.Values.DeleteGroupResponse.error)
Result.tval delete_index :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteIndexRequest.t ->
(Awso_qbusiness.Values.DeleteIndexResponse.t,
Awso_qbusiness.Values.DeleteIndexResponse.error)
Result.tval delete_plugin :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeletePluginRequest.t ->
(Awso_qbusiness.Values.DeletePluginResponse.t,
Awso_qbusiness.Values.DeletePluginResponse.error)
Result.tval delete_retriever :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteRetrieverRequest.t ->
(Awso_qbusiness.Values.DeleteRetrieverResponse.t,
Awso_qbusiness.Values.DeleteRetrieverResponse.error)
Result.tval delete_user :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteUserRequest.t ->
(Awso_qbusiness.Values.DeleteUserResponse.t,
Awso_qbusiness.Values.DeleteUserResponse.error)
Result.tval delete_web_experience :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DeleteWebExperienceRequest.t ->
(Awso_qbusiness.Values.DeleteWebExperienceResponse.t,
Awso_qbusiness.Values.DeleteWebExperienceResponse.error)
Result.tval disassociate_permission :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.DisassociatePermissionRequest.t ->
(Awso_qbusiness.Values.DisassociatePermissionResponse.t,
Awso_qbusiness.Values.DisassociatePermissionResponse.error)
Result.tval get_application :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetApplicationRequest.t ->
(Awso_qbusiness.Values.GetApplicationResponse.t,
Awso_qbusiness.Values.GetApplicationResponse.error)
Result.tval get_chat_controls_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetChatControlsConfigurationRequest.t ->
(Awso_qbusiness.Values.GetChatControlsConfigurationResponse.t,
Awso_qbusiness.Values.GetChatControlsConfigurationResponse.error)
Result.tval get_chat_response_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetChatResponseConfigurationRequest.t ->
(Awso_qbusiness.Values.GetChatResponseConfigurationResponse.t,
Awso_qbusiness.Values.GetChatResponseConfigurationResponse.error)
Result.tval get_data_accessor :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetDataAccessorRequest.t ->
(Awso_qbusiness.Values.GetDataAccessorResponse.t,
Awso_qbusiness.Values.GetDataAccessorResponse.error)
Result.tval get_data_source :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetDataSourceRequest.t ->
(Awso_qbusiness.Values.GetDataSourceResponse.t,
Awso_qbusiness.Values.GetDataSourceResponse.error)
Result.tval get_document_content :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetDocumentContentRequest.t ->
(Awso_qbusiness.Values.GetDocumentContentResponse.t,
Awso_qbusiness.Values.GetDocumentContentResponse.error)
Result.tval get_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetGroupRequest.t ->
(Awso_qbusiness.Values.GetGroupResponse.t,
Awso_qbusiness.Values.GetGroupResponse.error)
Result.tval get_index :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetIndexRequest.t ->
(Awso_qbusiness.Values.GetIndexResponse.t,
Awso_qbusiness.Values.GetIndexResponse.error)
Result.tval get_media :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetMediaRequest.t ->
(Awso_qbusiness.Values.GetMediaResponse.t,
Awso_qbusiness.Values.GetMediaResponse.error)
Result.tval get_plugin :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetPluginRequest.t ->
(Awso_qbusiness.Values.GetPluginResponse.t,
Awso_qbusiness.Values.GetPluginResponse.error)
Result.tval get_policy :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetPolicyRequest.t ->
(Awso_qbusiness.Values.GetPolicyResponse.t,
Awso_qbusiness.Values.GetPolicyResponse.error)
Result.tval get_retriever :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetRetrieverRequest.t ->
(Awso_qbusiness.Values.GetRetrieverResponse.t,
Awso_qbusiness.Values.GetRetrieverResponse.error)
Result.tval get_user :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetUserRequest.t ->
(Awso_qbusiness.Values.GetUserResponse.t,
Awso_qbusiness.Values.GetUserResponse.error)
Result.tval get_web_experience :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.GetWebExperienceRequest.t ->
(Awso_qbusiness.Values.GetWebExperienceResponse.t,
Awso_qbusiness.Values.GetWebExperienceResponse.error)
Result.tval list_applications :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListApplicationsRequest.t ->
(Awso_qbusiness.Values.ListApplicationsResponse.t,
Awso_qbusiness.Values.ListApplicationsResponse.error)
Result.tval list_attachments :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListAttachmentsRequest.t ->
(Awso_qbusiness.Values.ListAttachmentsResponse.t,
Awso_qbusiness.Values.ListAttachmentsResponse.error)
Result.tval list_chat_response_configurations :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListChatResponseConfigurationsRequest.t ->
(Awso_qbusiness.Values.ListChatResponseConfigurationsResponse.t,
Awso_qbusiness.Values.ListChatResponseConfigurationsResponse.error)
Result.tval list_conversations :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListConversationsRequest.t ->
(Awso_qbusiness.Values.ListConversationsResponse.t,
Awso_qbusiness.Values.ListConversationsResponse.error)
Result.tval list_data_accessors :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListDataAccessorsRequest.t ->
(Awso_qbusiness.Values.ListDataAccessorsResponse.t,
Awso_qbusiness.Values.ListDataAccessorsResponse.error)
Result.tval list_data_source_sync_jobs :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListDataSourceSyncJobsRequest.t ->
(Awso_qbusiness.Values.ListDataSourceSyncJobsResponse.t,
Awso_qbusiness.Values.ListDataSourceSyncJobsResponse.error)
Result.tval list_data_sources :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListDataSourcesRequest.t ->
(Awso_qbusiness.Values.ListDataSourcesResponse.t,
Awso_qbusiness.Values.ListDataSourcesResponse.error)
Result.tval list_documents :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListDocumentsRequest.t ->
(Awso_qbusiness.Values.ListDocumentsResponse.t,
Awso_qbusiness.Values.ListDocumentsResponse.error)
Result.tval list_groups :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListGroupsRequest.t ->
(Awso_qbusiness.Values.ListGroupsResponse.t,
Awso_qbusiness.Values.ListGroupsResponse.error)
Result.tval list_indices :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListIndicesRequest.t ->
(Awso_qbusiness.Values.ListIndicesResponse.t,
Awso_qbusiness.Values.ListIndicesResponse.error)
Result.tval list_messages :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListMessagesRequest.t ->
(Awso_qbusiness.Values.ListMessagesResponse.t,
Awso_qbusiness.Values.ListMessagesResponse.error)
Result.tval list_plugin_actions :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListPluginActionsRequest.t ->
(Awso_qbusiness.Values.ListPluginActionsResponse.t,
Awso_qbusiness.Values.ListPluginActionsResponse.error)
Result.tval list_plugin_type_actions :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListPluginTypeActionsRequest.t ->
(Awso_qbusiness.Values.ListPluginTypeActionsResponse.t,
Awso_qbusiness.Values.ListPluginTypeActionsResponse.error)
Result.tval list_plugin_type_metadata :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListPluginTypeMetadataRequest.t ->
(Awso_qbusiness.Values.ListPluginTypeMetadataResponse.t,
Awso_qbusiness.Values.ListPluginTypeMetadataResponse.error)
Result.tval list_plugins :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListPluginsRequest.t ->
(Awso_qbusiness.Values.ListPluginsResponse.t,
Awso_qbusiness.Values.ListPluginsResponse.error)
Result.tval list_retrievers :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListRetrieversRequest.t ->
(Awso_qbusiness.Values.ListRetrieversResponse.t,
Awso_qbusiness.Values.ListRetrieversResponse.error)
Result.tval list_subscriptions :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListSubscriptionsRequest.t ->
(Awso_qbusiness.Values.ListSubscriptionsResponse.t,
Awso_qbusiness.Values.ListSubscriptionsResponse.error)
Result.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListTagsForResourceRequest.t ->
(Awso_qbusiness.Values.ListTagsForResourceResponse.t,
Awso_qbusiness.Values.ListTagsForResourceResponse.error)
Result.tval list_web_experiences :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.ListWebExperiencesRequest.t ->
(Awso_qbusiness.Values.ListWebExperiencesResponse.t,
Awso_qbusiness.Values.ListWebExperiencesResponse.error)
Result.tval put_feedback :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.PutFeedbackRequest.t ->
(unit, unit) Result.tval put_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.PutGroupRequest.t ->
(Awso_qbusiness.Values.PutGroupResponse.t,
Awso_qbusiness.Values.PutGroupResponse.error)
Result.tval search_relevant_content :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.SearchRelevantContentRequest.t ->
(Awso_qbusiness.Values.SearchRelevantContentResponse.t,
Awso_qbusiness.Values.SearchRelevantContentResponse.error)
Result.tval start_data_source_sync_job :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.StartDataSourceSyncJobRequest.t ->
(Awso_qbusiness.Values.StartDataSourceSyncJobResponse.t,
Awso_qbusiness.Values.StartDataSourceSyncJobResponse.error)
Result.tval stop_data_source_sync_job :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.StopDataSourceSyncJobRequest.t ->
(Awso_qbusiness.Values.StopDataSourceSyncJobResponse.t,
Awso_qbusiness.Values.StopDataSourceSyncJobResponse.error)
Result.tval tag_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.TagResourceRequest.t ->
(Awso_qbusiness.Values.TagResourceResponse.t,
Awso_qbusiness.Values.TagResourceResponse.error)
Result.tval untag_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UntagResourceRequest.t ->
(Awso_qbusiness.Values.UntagResourceResponse.t,
Awso_qbusiness.Values.UntagResourceResponse.error)
Result.tval update_application :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateApplicationRequest.t ->
(Awso_qbusiness.Values.UpdateApplicationResponse.t,
Awso_qbusiness.Values.UpdateApplicationResponse.error)
Result.tval update_chat_controls_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateChatControlsConfigurationRequest.t ->
(Awso_qbusiness.Values.UpdateChatControlsConfigurationResponse.t,
Awso_qbusiness.Values.UpdateChatControlsConfigurationResponse.error)
Result.tval update_chat_response_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateChatResponseConfigurationRequest.t ->
(Awso_qbusiness.Values.UpdateChatResponseConfigurationResponse.t,
Awso_qbusiness.Values.UpdateChatResponseConfigurationResponse.error)
Result.tval update_data_accessor :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateDataAccessorRequest.t ->
(Awso_qbusiness.Values.UpdateDataAccessorResponse.t,
Awso_qbusiness.Values.UpdateDataAccessorResponse.error)
Result.tval update_data_source :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateDataSourceRequest.t ->
(Awso_qbusiness.Values.UpdateDataSourceResponse.t,
Awso_qbusiness.Values.UpdateDataSourceResponse.error)
Result.tval update_index :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateIndexRequest.t ->
(Awso_qbusiness.Values.UpdateIndexResponse.t,
Awso_qbusiness.Values.UpdateIndexResponse.error)
Result.tval update_plugin :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdatePluginRequest.t ->
(Awso_qbusiness.Values.UpdatePluginResponse.t,
Awso_qbusiness.Values.UpdatePluginResponse.error)
Result.tval update_retriever :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateRetrieverRequest.t ->
(Awso_qbusiness.Values.UpdateRetrieverResponse.t,
Awso_qbusiness.Values.UpdateRetrieverResponse.error)
Result.tval update_subscription :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateSubscriptionRequest.t ->
(Awso_qbusiness.Values.UpdateSubscriptionResponse.t,
Awso_qbusiness.Values.UpdateSubscriptionResponse.error)
Result.tval update_user :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateUserRequest.t ->
(Awso_qbusiness.Values.UpdateUserResponse.t,
Awso_qbusiness.Values.UpdateUserResponse.error)
Result.tval update_web_experience :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_qbusiness.Values.UpdateWebExperienceRequest.t ->
(Awso_qbusiness.Values.UpdateWebExperienceResponse.t,
Awso_qbusiness.Values.UpdateWebExperienceResponse.error)
Result.tinclude module type of struct include Awso_qbusiness.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
Provides information about a user associated with a principal.
Provides information about a group associated with the principal.
Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.
Used to configure access permissions for a document.
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
module DocumentAttributeValueStringValueString =
Awso_qbusiness.Values.DocumentAttributeValueStringValueStringmodule DocumentAttributeStringListValue =
Awso_qbusiness.Values.DocumentAttributeStringListValueThe value of a document attribute. You can only provide one value for a document attribute.
A document attribute or metadata field.
module AttributeFilter = Awso_qbusiness.Values.AttributeFilterEnables filtering of responses based on document attributes or metadata fields.
module AttributeFilters = Awso_qbusiness.Values.AttributeFiltersSpecifies filters to apply to an allowed action.
Specifies an allowed action and its associated filter configuration.
module ActionPayloadFieldNameSeparator =
Awso_qbusiness.Values.ActionPayloadFieldNameSeparatorA user input field in an plugin action execution payload.
Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.
module ActionReviewPayloadFieldArrayItemJsonSchema =
Awso_qbusiness.Values.ActionReviewPayloadFieldArrayItemJsonSchemamodule ActionReviewPayloadFieldAllowedValue =
Awso_qbusiness.Values.ActionReviewPayloadFieldAllowedValueInformation about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
module ActionReviewPayloadFieldAllowedValues =
Awso_qbusiness.Values.ActionReviewPayloadFieldAllowedValuesA user input field in an plugin action review payload.
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.
Summary information for an Amazon Q Business plugin action.
The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider. For more information, see Creating an Amazon Quick Suite integrated application.
Summary information for an Amazon Q Business application.
module AppliedAttachmentsConfiguration =
Awso_qbusiness.Values.AppliedAttachmentsConfigurationConfiguration information about the file upload during chat feature for your application.
module AppliedCreatorModeConfiguration =
Awso_qbusiness.Values.AppliedCreatorModeConfigurationThe creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience. For more information, see Admin controls and guardrails and Conversation settings.
module AppliedOrchestrationConfiguration =
Awso_qbusiness.Values.AppliedOrchestrationConfigurationThe chat orchestration specific admin controls configured for an Amazon Q Business application. Determines whether Amazon Q Business automatically routes chat requests across configured plugins and data sources in your Amazon Q Business application. For more information, see Chat orchestration settings.
Defines a condition that restricts when a permission is effective. Conditions allow you to control access based on specific attributes of the request.
Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.
The input failed to meet the constraints specified by Amazon Q Business in a specified field.
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
The request was denied due to throttling. Reduce the number of requests and try again.
You have exceeded the set limits for your Amazon Q Business service.
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.
Represents a group associated with a given user in the access control system.
Represents an associated user in the access control system.
Provides information about a Amazon Q Business request error.
The source reference for an existing attachment in an existing conversation.
The source reference for an existing attachment.
An attachment in an Amazon Q Business conversation.
This is either a file directly uploaded into a web experience chat or a reference to an existing attachment that is part of a web experience chat.
A file input event activated by a end user request to upload files into their web experience chat.
The details of a file uploaded during chat.
Configuration information for the file upload during chat feature.
Configuration settings for audio content extraction and processing.
Details about an audio source, including its identifier, format, and time information.
A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.
An authentication verification event activated by an end user request to use a custom plugin.
Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.
An authentication verification event response by a third party authentication server to Amazon Q Business.
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
Information about the basic authentication credentials used to configure a plugin.
A document deleted from an Amazon Q Business data source connector.
Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
Configuration settings for video content extraction and processing.
The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals.
The configuration for extracting information from media in documents.
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business. For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field. You can also use this with DocumentAttributeCondition .
module DocumentEnrichmentConditionOperator =
Awso_qbusiness.Values.DocumentEnrichmentConditionOperatorThe condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition. For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.
module InlineDocumentEnrichmentConfiguration =
Awso_qbusiness.Values.InlineDocumentEnrichmentConfigurationProvides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration . For more information, see Custom document enrichment.
module InlineDocumentEnrichmentConfigurations =
Awso_qbusiness.Values.InlineDocumentEnrichmentConfigurationsProvides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration. You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment.
module DocumentEnrichmentConfiguration =
Awso_qbusiness.Values.DocumentEnrichmentConfigurationProvides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment.
The contents of a document. Documents have size limitations. The maximum file size for a document is 50 MB. The maximum amount of text that can be extracted from a single document is 5 MB. For more information, see Supported document formats in Amazon Q Business.
A document in an Amazon Q Business application.
Adds one or more documents to an Amazon Q Business index. You use this API to: ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. add custom attributes to documents in an Amazon Q Business index. attach an access control list to the documents added to an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
Adds one or more documents to an Amazon Q Business index. You use this API to: ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. add custom attributes to documents in an Amazon Q Business index. attach an access control list to the documents added to an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
Provides information about the phrases blocked from chat by your chat control configuration.
module BlockedPhrasesConfigurationUpdate =
Awso_qbusiness.Values.BlockedPhrasesConfigurationUpdateUpdates a blocked phrases configuration in your Amazon Q Business application.
The container for browser extension configuration for an Amazon Q Business web experience.
Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.
The details of an Amazon Q Business subscription.
Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.
An input event for a end user message in an Amazon Q Business web experience.
The end of the streaming input for the Chat API.
Configuration information required to invoke chat in PLUGIN_MODE. For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
Configuration information for Amazon Q Business conversation modes. For more information, see Admin controls and guardrails and Conversation settings.
A configuration event activated by an end user request to select a specific chat mode.
The streaming input for the Chat API.
Starts or continues a streaming Amazon Q Business conversation.
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.
An output event for an AI-generated response in an Amazon Q Business web experience.
Details about a video source, including its identifier, format, and time information.
Details about an image source, including its identifier and format.
Container for details about different types of media sources (image, audio, or video).
Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
Provides information about a text extract in a chat response that can be attributed to a source document.
The documents used to generate an Amazon Q Business web experience response.
A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.
A failed file upload during web experience chat.
The streaming output for the Chat API.
Starts or continues a streaming Amazon Q Business conversation.
module ChatResponseConfigurationStatus =
Awso_qbusiness.Values.ChatResponseConfigurationStatusConfiguration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.
A set of instructions that define how Amazon Q Business should generate and format responses to user queries. This collection includes parameters for controlling response characteristics such as length, audience targeting, perspective, style, identity, tone, and custom instructions.
Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.
module ChatResponseConfigurationDetail =
Awso_qbusiness.Values.ChatResponseConfigurationDetailDetailed information about a chat response configuration, including comprehensive settings and parameters that define how Amazon Q Business generates and formats responses.
Starts or continues a non-streaming Amazon Q Business conversation.
Starts or continues a non-streaming Amazon Q Business conversation.
Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.
Represents a user in the document's ACL, used to define access permissions for individual users.
Represents a group in the document's ACL, used to define access permissions for multiple users collectively.
Represents a condition in the document's ACL, specifying access rules for users and groups.
Represents membership rules in the document's ACL, defining how users or groups are associated with access permissions.
Represents the Access Control List (ACL) for a document, containing both allowlist and denylist conditions.
Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.
A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.
The identifier of the data source Amazon Q Business will generate responses from.
Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
Specifies a retriever as the content source for a search.
Specifies the source of content to search in.
A conversation in an Amazon Q Business application.
module CreateAnonymousWebExperienceUrlRequest =
Awso_qbusiness.Values.CreateAnonymousWebExperienceUrlRequestCreates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
module CreateAnonymousWebExperienceUrlResponse =
Awso_qbusiness.Values.CreateAnonymousWebExperienceUrlResponseCreates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
Configuration information about Amazon Q Apps.
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users. An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps. When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.
Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users. An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps. When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.
module CreateChatResponseConfigurationRequest =
Awso_qbusiness.Values.CreateChatResponseConfigurationRequestCreates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.
module CreateChatResponseConfigurationResponse =
Awso_qbusiness.Values.CreateChatResponseConfigurationResponseCreates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.
module DataAccessorIdcTrustedTokenIssuerConfiguration =
Awso_qbusiness.Values.DataAccessorIdcTrustedTokenIssuerConfigurationConfiguration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.
module DataAccessorAuthenticationConfiguration =
Awso_qbusiness.Values.DataAccessorAuthenticationConfigurationA union type that contains the specific authentication configuration based on the authentication type selected.
module DataAccessorAuthenticationDetail =
Awso_qbusiness.Values.DataAccessorAuthenticationDetailContains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.
Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
Provides the configuration information for an Amazon Q Business data source.
Creates a data source connector for an Amazon Q Business application. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Creates a data source connector for an Amazon Q Business application. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Provides information about index capacity configuration.
Creates an Amazon Q Business index. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.
Creates an Amazon Q Business index. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.
module OAuth2ClientCredentialConfiguration =
Awso_qbusiness.Values.OAuth2ClientCredentialConfigurationInformation about the OAuth 2.0 authentication credential/token used to configure a plugin.
Information about invoking a custom plugin without any authentication or authorization requirement.
Information about the IAM Identity Center Application used to configure authentication for a plugin.
Authentication configuration information for an Amazon Q Business plugin.
Configuration information required to create a custom plugin.
Creates an Amazon Q Business plugin.
Creates an Amazon Q Business plugin.
module StringListAttributeBoostingConfiguration =
Awso_qbusiness.Values.StringListAttributeBoostingConfigurationProvides information on boosting STRING_LIST type document attributes. In the current boosting implementation, boosting focuses primarily on DATE attributes for recency and STRING attributes for source prioritization. STRING_LIST attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2. For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
module StringAttributeValueBoostingLevel =
Awso_qbusiness.Values.StringAttributeValueBoostingLevelmodule StringAttributeBoostingConfiguration =
Awso_qbusiness.Values.StringAttributeBoostingConfigurationProvides information on boosting STRING type document attributes. For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
module NumberAttributeBoostingConfiguration =
Awso_qbusiness.Values.NumberAttributeBoostingConfigurationProvides information on boosting NUMBER type document attributes. In the current boosting implementation, boosting focuses primarily on DATE attributes for recency and STRING attributes for source prioritization. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
module DateAttributeBoostingConfiguration =
Awso_qbusiness.Values.DateAttributeBoostingConfigurationProvides information on boosting DATE type document attributes. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
module DocumentAttributeBoostingConfiguration =
Awso_qbusiness.Values.DocumentAttributeBoostingConfigurationProvides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes. In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results. For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
module DocumentAttributeBoostingOverrideMap =
Awso_qbusiness.Values.DocumentAttributeBoostingOverrideMapConfiguration information for an Amazon Q Business index.
Stores an Amazon Kendra index as a retriever.
Provides information on how the retriever used for your Amazon Q Business application is configured.
Adds a retriever to your Amazon Q Business application.
Adds a retriever to your Amazon Q Business application.
A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.
Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.
Aliases attached to a user id within an Amazon Q Business application.
module CreateUserRequestUserAliasesList =
Awso_qbusiness.Values.CreateUserRequestUserAliasesListCreates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
module WebExperienceSamplePromptsControlMode =
Awso_qbusiness.Values.WebExperienceSamplePromptsControlModeInformation about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
module OpenIDConnectProviderConfiguration =
Awso_qbusiness.Values.OpenIDConnectProviderConfigurationInformation about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
Creates an Amazon Q Business web experience.
Creates an Amazon Q Business web experience.
Configuration information required to invoke chat in CREATOR_MODE. For more information, see Admin controls and guardrails and Conversation settings.
Provides summary information about a data accessor.
A data source in an Amazon Q Business application.
Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.
Provides information about an Amazon Q Business data source connector synchronization job.
Deletes an Amazon Q Business application.
Deletes an Amazon Q Business application.
Deletes an attachment associated with a specific Amazon Q Business conversation.
Deletes an attachment associated with a specific Amazon Q Business conversation.
module DeleteChatControlsConfigurationRequest =
Awso_qbusiness.Values.DeleteChatControlsConfigurationRequestDeletes chat controls configured for an existing Amazon Q Business application.
module DeleteChatControlsConfigurationResponse =
Awso_qbusiness.Values.DeleteChatControlsConfigurationResponseDeletes chat controls configured for an existing Amazon Q Business application.
module DeleteChatResponseConfigurationRequest =
Awso_qbusiness.Values.DeleteChatResponseConfigurationRequestDeletes a specified chat response configuration from an Amazon Q Business application.
module DeleteChatResponseConfigurationResponse =
Awso_qbusiness.Values.DeleteChatResponseConfigurationResponseDeletes a specified chat response configuration from an Amazon Q Business application.
Deletes an Amazon Q Business web experience conversation.
Deletes an Amazon Q Business web experience conversation.
Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.
Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.
Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.
Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results. If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results. If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.
Deletes an Amazon Q Business index.
Deletes an Amazon Q Business index.
Deletes an Amazon Q Business plugin.
Deletes an Amazon Q Business plugin.
Deletes the retriever used by an Amazon Q Business application.
Deletes the retriever used by an Amazon Q Business application.
Deletes a user by email id.
Deletes a user by email id.
Deletes an Amazon Q Business web experience.
Deletes an Amazon Q Business web experience.
Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.
Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.
module DocumentMetadataConfigurationName =
Awso_qbusiness.Values.DocumentMetadataConfigurationNameConfiguration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
module DocumentAttributeConfigurations =
Awso_qbusiness.Values.DocumentAttributeConfigurationsThe details of a document within an Amazon Q Business index.
Gets information about an existing Amazon Q Business application.
Gets information about an existing Amazon Q Business application.
module MaxResultsIntegerForGetTopicConfigurations =
Awso_qbusiness.Values.MaxResultsIntegerForGetTopicConfigurationsmodule GetChatControlsConfigurationRequest =
Awso_qbusiness.Values.GetChatControlsConfigurationRequestGets information about chat controls configured for an existing Amazon Q Business application.
Provides information about users and group names associated with a topic control rule.
Provides configuration information about a rule.
Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.
The topic specific controls configured for an Amazon Q Business application.
module HallucinationReductionConfiguration =
Awso_qbusiness.Values.HallucinationReductionConfigurationConfiguration information required to setup hallucination reduction. For more information, see hallucination reduction. The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.
module GetChatControlsConfigurationResponse =
Awso_qbusiness.Values.GetChatControlsConfigurationResponseGets information about chat controls configured for an existing Amazon Q Business application.
module GetChatResponseConfigurationRequest =
Awso_qbusiness.Values.GetChatResponseConfigurationRequestRetrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.
module GetChatResponseConfigurationResponse =
Awso_qbusiness.Values.GetChatResponseConfigurationResponseRetrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.
Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.
Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.
Gets information about an existing Amazon Q Business data source connector.
Gets information about an existing Amazon Q Business data source connector.
Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.
Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.
Describes a group by group name.
Provides the details of a group's status.
Describes a group by group name.
Gets information about an existing Amazon Q Business index.
Provides information about text documents in an index.
Provides information about the number of documents in an index.
Gets information about an existing Amazon Q Business index.
Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals.
The requested media object is too large to be returned.
Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals.
Gets information about an existing Amazon Q Business plugin.
Gets information about an existing Amazon Q Business plugin.
Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.
Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.
Gets information about an existing retriever used by an Amazon Q Business application.
Gets information about an existing retriever used by an Amazon Q Business application.
Describes the universally unique identifier (UUID) associated with a local user in a data source.
Describes the universally unique identifier (UUID) associated with a local user in a data source.
Gets information about an existing Amazon Q Business web experience.
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.
Gets information about an existing Amazon Q Business web experience.
The users that belong to a group.
The sub groups that belong to a group.
A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.
Summary information for groups.
Summary information for your Amazon Q Business index.
module MaxResultsIntegerForListApplications =
Awso_qbusiness.Values.MaxResultsIntegerForListApplicationsLists Amazon Q Business applications. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.
Lists Amazon Q Business applications. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.
module MaxResultsIntegerForListAttachments =
Awso_qbusiness.Values.MaxResultsIntegerForListAttachmentsGets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.
Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.
module ListChatResponseConfigurationsRequest =
Awso_qbusiness.Values.ListChatResponseConfigurationsRequestRetrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.
module ListChatResponseConfigurationsResponse =
Awso_qbusiness.Values.ListChatResponseConfigurationsResponseRetrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.
module MaxResultsIntegerForListConversations =
Awso_qbusiness.Values.MaxResultsIntegerForListConversationsLists one or more Amazon Q Business conversations.
Lists one or more Amazon Q Business conversations.
module MaxResultsIntegerForListDataAccessors =
Awso_qbusiness.Values.MaxResultsIntegerForListDataAccessorsLists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.
Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.
module MaxResultsIntegerForListDataSourcesSyncJobs =
Awso_qbusiness.Values.MaxResultsIntegerForListDataSourcesSyncJobsGet information about an Amazon Q Business data source connector synchronization.
Get information about an Amazon Q Business data source connector synchronization.
module MaxResultsIntegerForListDataSources =
Awso_qbusiness.Values.MaxResultsIntegerForListDataSourcesLists the Amazon Q Business data source connectors that you have created.
Lists the Amazon Q Business data source connectors that you have created.
module MaxResultsIntegerForListDocuments =
Awso_qbusiness.Values.MaxResultsIntegerForListDocumentsA list of documents attached to an index.
A list of documents attached to an index.
module MaxResultsIntegerForListGroupsRequest =
Awso_qbusiness.Values.MaxResultsIntegerForListGroupsRequestProvides a list of groups that are mapped to users.
Provides a list of groups that are mapped to users.
module MaxResultsIntegerForListIndices =
Awso_qbusiness.Values.MaxResultsIntegerForListIndicesLists the Amazon Q Business indices you have created.
Lists the Amazon Q Business indices you have created.
module MaxResultsIntegerForListMessages =
Awso_qbusiness.Values.MaxResultsIntegerForListMessagesGets a list of messages associated with an Amazon Q Business web experience.
A message in an Amazon Q Business web experience.
Gets a list of messages associated with an Amazon Q Business web experience.
module MaxResultsIntegerForListPluginActions =
Awso_qbusiness.Values.MaxResultsIntegerForListPluginActionsLists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.
Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.
module MaxResultsIntegerForListPluginTypeActions =
Awso_qbusiness.Values.MaxResultsIntegerForListPluginTypeActionsLists configured Amazon Q Business actions for any plugin type—both built-in and custom.
Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.
module MaxResultsIntegerForListPluginTypeMetadata =
Awso_qbusiness.Values.MaxResultsIntegerForListPluginTypeMetadataLists metadata for all Amazon Q Business plugin types.
Summary metadata information for a Amazon Q Business plugin.
module ListPluginTypeMetadataSummaries =
Awso_qbusiness.Values.ListPluginTypeMetadataSummariesLists metadata for all Amazon Q Business plugin types.
module MaxResultsIntegerForListPlugins =
Awso_qbusiness.Values.MaxResultsIntegerForListPluginsLists configured Amazon Q Business plugins.
Information about an Amazon Q Business plugin and its configuration.
Lists configured Amazon Q Business plugins.
module MaxResultsIntegerForListRetrieversRequest =
Awso_qbusiness.Values.MaxResultsIntegerForListRetrieversRequestLists the retriever used by an Amazon Q Business application.
Summary information for the retriever used for your Amazon Q Business application.
Lists the retriever used by an Amazon Q Business application.
module MaxResultsIntegerForListSubscriptions =
Awso_qbusiness.Values.MaxResultsIntegerForListSubscriptionsLists all subscriptions created in an Amazon Q Business application.
Information about an Amazon Q Business subscription. Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
Lists all subscriptions created in an Amazon Q Business application.
Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
module MaxResultsIntegerForListWebExperiencesRequest =
Awso_qbusiness.Values.MaxResultsIntegerForListWebExperiencesRequestLists one or more Amazon Q Business Web Experiences.
Provides information for an Amazon Q Business web experience.
Lists one or more Amazon Q Business Web Experiences.
End user feedback on an AI-generated web experience chat message usefulness.
Configuration information required to enable chat orchestration for your Amazon Q Business application. Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
Create, or updates, a mapping of users—who have access to a document—to groups. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results. There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.
Create, or updates, a mapping of users—who have access to a document—to groups. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results. There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.
Provides information about the relevance score of content.
Represents a piece of content that is relevant to a search query.
Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.
Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.
Stops an Amazon Q Business data source connector synchronization job already in progress.
Stops an Amazon Q Business data source connector synchronization job already in progress.
Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.
Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.
Removes a tag from an Amazon Q Business application or a data source.
Removes a tag from an Amazon Q Business application or a data source.
Updates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.
Updates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.
module UpdateChatControlsConfigurationRequest =
Awso_qbusiness.Values.UpdateChatControlsConfigurationRequestUpdates a set of chat controls configured for an existing Amazon Q Business application.
module UpdateChatControlsConfigurationResponse =
Awso_qbusiness.Values.UpdateChatControlsConfigurationResponseUpdates a set of chat controls configured for an existing Amazon Q Business application.
module UpdateChatResponseConfigurationRequest =
Awso_qbusiness.Values.UpdateChatResponseConfigurationRequestUpdates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.
module UpdateChatResponseConfigurationResponse =
Awso_qbusiness.Values.UpdateChatResponseConfigurationResponseUpdates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.
Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.
Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.
Updates an existing Amazon Q Business data source connector.
Updates an existing Amazon Q Business data source connector.
Updates an Amazon Q Business index.
Updates an Amazon Q Business index.
Updates an Amazon Q Business plugin.
Updates an Amazon Q Business plugin.
Updates the retriever used for your Amazon Q Business application.
Updates the retriever used for your Amazon Q Business application.
Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
Updates a information associated with a user id.
Updates a information associated with a user id.
Updates an Amazon Q Business web experience.
Updates an Amazon Q Business web experience.