@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonQConnectAsync extends AmazonQConnect
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonQConnectAsync instead.
Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection.
Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in
Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).
Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.
Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.
Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.
ENDPOINT_PREFIXcreateAssistant, createAssistantAssociation, createContent, createContentAssociation, createKnowledgeBase, createQuickResponse, createSession, deleteAssistant, deleteAssistantAssociation, deleteContent, deleteContentAssociation, deleteImportJob, deleteKnowledgeBase, deleteQuickResponse, getAssistant, getAssistantAssociation, getCachedResponseMetadata, getContent, getContentAssociation, getContentSummary, getImportJob, getKnowledgeBase, getQuickResponse, getRecommendations, getSession, listAssistantAssociations, listAssistants, listContentAssociations, listContents, listImportJobs, listKnowledgeBases, listQuickResponses, listTagsForResource, notifyRecommendationsReceived, putFeedback, queryAssistant, removeKnowledgeBaseTemplateUri, searchContent, searchQuickResponses, searchSessions, shutdown, startContentUpload, startImportJob, tagResource, untagResource, updateContent, updateKnowledgeBaseTemplateUri, updateQuickResponse, updateSessionFuture<CreateAssistantResult> createAssistantAsync(CreateAssistantRequest createAssistantRequest)
Creates an Amazon Q in Connect assistant.
createAssistantRequest - Future<CreateAssistantResult> createAssistantAsync(CreateAssistantRequest createAssistantRequest, AsyncHandler<CreateAssistantRequest,CreateAssistantResult> asyncHandler)
Creates an Amazon Q in Connect assistant.
createAssistantRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAssistantAssociationResult> createAssistantAssociationAsync(CreateAssistantAssociationRequest createAssistantAssociationRequest)
Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
createAssistantAssociationRequest - Future<CreateAssistantAssociationResult> createAssistantAssociationAsync(CreateAssistantAssociationRequest createAssistantAssociationRequest, AsyncHandler<CreateAssistantAssociationRequest,CreateAssistantAssociationResult> asyncHandler)
Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
createAssistantAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateContentResult> createContentAsync(CreateContentRequest createContentRequest)
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
createContentRequest - Future<CreateContentResult> createContentAsync(CreateContentRequest createContentRequest, AsyncHandler<CreateContentRequest,CreateContentResult> asyncHandler)
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
createContentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateContentAssociationResult> createContentAssociationAsync(CreateContentAssociationRequest createContentAssociationRequest)
Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.
After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.
Note the following limitations:
You can create only one content association for each content resource in a knowledge base.
You can associate a step-by-step guide with multiple content resources.
For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
createContentAssociationRequest - Future<CreateContentAssociationResult> createContentAssociationAsync(CreateContentAssociationRequest createContentAssociationRequest, AsyncHandler<CreateContentAssociationRequest,CreateContentAssociationResult> asyncHandler)
Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.
After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.
Note the following limitations:
You can create only one content association for each content resource in a knowledge base.
You can associate a step-by-step guide with multiple content resources.
For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
createContentAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateKnowledgeBaseResult> createKnowledgeBaseAsync(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)
Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations
DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an
InvalidRequestException error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
Call DeleteKnowledgeBase.
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
createKnowledgeBaseRequest - Future<CreateKnowledgeBaseResult> createKnowledgeBaseAsync(CreateKnowledgeBaseRequest createKnowledgeBaseRequest, AsyncHandler<CreateKnowledgeBaseRequest,CreateKnowledgeBaseResult> asyncHandler)
Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations
DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an
InvalidRequestException error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
Call DeleteKnowledgeBase.
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
createKnowledgeBaseRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateQuickResponseResult> createQuickResponseAsync(CreateQuickResponseRequest createQuickResponseRequest)
Creates an Amazon Q in Connect quick response.
createQuickResponseRequest - Future<CreateQuickResponseResult> createQuickResponseAsync(CreateQuickResponseRequest createQuickResponseRequest, AsyncHandler<CreateQuickResponseRequest,CreateQuickResponseResult> asyncHandler)
Creates an Amazon Q in Connect quick response.
createQuickResponseRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateSessionResult> createSessionAsync(CreateSessionRequest createSessionRequest)
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
createSessionRequest - Future<CreateSessionResult> createSessionAsync(CreateSessionRequest createSessionRequest, AsyncHandler<CreateSessionRequest,CreateSessionResult> asyncHandler)
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
createSessionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAssistantResult> deleteAssistantAsync(DeleteAssistantRequest deleteAssistantRequest)
Deletes an assistant.
deleteAssistantRequest - Future<DeleteAssistantResult> deleteAssistantAsync(DeleteAssistantRequest deleteAssistantRequest, AsyncHandler<DeleteAssistantRequest,DeleteAssistantResult> asyncHandler)
Deletes an assistant.
deleteAssistantRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAssistantAssociationResult> deleteAssistantAssociationAsync(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest)
Deletes an assistant association.
deleteAssistantAssociationRequest - Future<DeleteAssistantAssociationResult> deleteAssistantAssociationAsync(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest, AsyncHandler<DeleteAssistantAssociationRequest,DeleteAssistantAssociationResult> asyncHandler)
Deletes an assistant association.
deleteAssistantAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteContentResult> deleteContentAsync(DeleteContentRequest deleteContentRequest)
Deletes the content.
deleteContentRequest - Future<DeleteContentResult> deleteContentAsync(DeleteContentRequest deleteContentRequest, AsyncHandler<DeleteContentRequest,DeleteContentResult> asyncHandler)
Deletes the content.
deleteContentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteContentAssociationResult> deleteContentAssociationAsync(DeleteContentAssociationRequest deleteContentAssociationRequest)
Deletes the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
deleteContentAssociationRequest - Future<DeleteContentAssociationResult> deleteContentAssociationAsync(DeleteContentAssociationRequest deleteContentAssociationRequest, AsyncHandler<DeleteContentAssociationRequest,DeleteContentAssociationResult> asyncHandler)
Deletes the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
deleteContentAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteImportJobResult> deleteImportJobAsync(DeleteImportJobRequest deleteImportJobRequest)
Deletes the quick response import job.
deleteImportJobRequest - Future<DeleteImportJobResult> deleteImportJobAsync(DeleteImportJobRequest deleteImportJobRequest, AsyncHandler<DeleteImportJobRequest,DeleteImportJobResult> asyncHandler)
Deletes the quick response import job.
deleteImportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteKnowledgeBaseResult> deleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)
Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
deleteKnowledgeBaseRequest - Future<DeleteKnowledgeBaseResult> deleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest, AsyncHandler<DeleteKnowledgeBaseRequest,DeleteKnowledgeBaseResult> asyncHandler)
Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
deleteKnowledgeBaseRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteQuickResponseResult> deleteQuickResponseAsync(DeleteQuickResponseRequest deleteQuickResponseRequest)
Deletes a quick response.
deleteQuickResponseRequest - Future<DeleteQuickResponseResult> deleteQuickResponseAsync(DeleteQuickResponseRequest deleteQuickResponseRequest, AsyncHandler<DeleteQuickResponseRequest,DeleteQuickResponseResult> asyncHandler)
Deletes a quick response.
deleteQuickResponseRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAssistantResult> getAssistantAsync(GetAssistantRequest getAssistantRequest)
Retrieves information about an assistant.
getAssistantRequest - Future<GetAssistantResult> getAssistantAsync(GetAssistantRequest getAssistantRequest, AsyncHandler<GetAssistantRequest,GetAssistantResult> asyncHandler)
Retrieves information about an assistant.
getAssistantRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAssistantAssociationResult> getAssistantAssociationAsync(GetAssistantAssociationRequest getAssistantAssociationRequest)
Retrieves information about an assistant association.
getAssistantAssociationRequest - Future<GetAssistantAssociationResult> getAssistantAssociationAsync(GetAssistantAssociationRequest getAssistantAssociationRequest, AsyncHandler<GetAssistantAssociationRequest,GetAssistantAssociationResult> asyncHandler)
Retrieves information about an assistant association.
getAssistantAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetContentResult> getContentAsync(GetContentRequest getContentRequest)
Retrieves content, including a pre-signed URL to download the content.
getContentRequest - Future<GetContentResult> getContentAsync(GetContentRequest getContentRequest, AsyncHandler<GetContentRequest,GetContentResult> asyncHandler)
Retrieves content, including a pre-signed URL to download the content.
getContentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetContentAssociationResult> getContentAssociationAsync(GetContentAssociationRequest getContentAssociationRequest)
Returns the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
getContentAssociationRequest - Future<GetContentAssociationResult> getContentAssociationAsync(GetContentAssociationRequest getContentAssociationRequest, AsyncHandler<GetContentAssociationRequest,GetContentAssociationResult> asyncHandler)
Returns the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
getContentAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetContentSummaryResult> getContentSummaryAsync(GetContentSummaryRequest getContentSummaryRequest)
Retrieves summary information about the content.
getContentSummaryRequest - Future<GetContentSummaryResult> getContentSummaryAsync(GetContentSummaryRequest getContentSummaryRequest, AsyncHandler<GetContentSummaryRequest,GetContentSummaryResult> asyncHandler)
Retrieves summary information about the content.
getContentSummaryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetImportJobResult> getImportJobAsync(GetImportJobRequest getImportJobRequest)
Retrieves the started import job.
getImportJobRequest - Future<GetImportJobResult> getImportJobAsync(GetImportJobRequest getImportJobRequest, AsyncHandler<GetImportJobRequest,GetImportJobResult> asyncHandler)
Retrieves the started import job.
getImportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetKnowledgeBaseResult> getKnowledgeBaseAsync(GetKnowledgeBaseRequest getKnowledgeBaseRequest)
Retrieves information about the knowledge base.
getKnowledgeBaseRequest - Future<GetKnowledgeBaseResult> getKnowledgeBaseAsync(GetKnowledgeBaseRequest getKnowledgeBaseRequest, AsyncHandler<GetKnowledgeBaseRequest,GetKnowledgeBaseResult> asyncHandler)
Retrieves information about the knowledge base.
getKnowledgeBaseRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetQuickResponseResult> getQuickResponseAsync(GetQuickResponseRequest getQuickResponseRequest)
Retrieves the quick response.
getQuickResponseRequest - Future<GetQuickResponseResult> getQuickResponseAsync(GetQuickResponseRequest getQuickResponseRequest, AsyncHandler<GetQuickResponseRequest,GetQuickResponseResult> asyncHandler)
Retrieves the quick response.
getQuickResponseRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.@Deprecated Future<GetRecommendationsResult> getRecommendationsAsync(GetRecommendationsRequest getRecommendationsRequest)
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent
calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds
parameter. Short poll is the default behavior and only returns recommendations already available. To perform a
manual query against an assistant, use QueryAssistant.
getRecommendationsRequest - @Deprecated Future<GetRecommendationsResult> getRecommendationsAsync(GetRecommendationsRequest getRecommendationsRequest, AsyncHandler<GetRecommendationsRequest,GetRecommendationsResult> asyncHandler)
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent
calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds
parameter. Short poll is the default behavior and only returns recommendations already available. To perform a
manual query against an assistant, use QueryAssistant.
getRecommendationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSessionResult> getSessionAsync(GetSessionRequest getSessionRequest)
Retrieves information for a specified session.
getSessionRequest - Future<GetSessionResult> getSessionAsync(GetSessionRequest getSessionRequest, AsyncHandler<GetSessionRequest,GetSessionResult> asyncHandler)
Retrieves information for a specified session.
getSessionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssistantAssociationsResult> listAssistantAssociationsAsync(ListAssistantAssociationsRequest listAssistantAssociationsRequest)
Lists information about assistant associations.
listAssistantAssociationsRequest - Future<ListAssistantAssociationsResult> listAssistantAssociationsAsync(ListAssistantAssociationsRequest listAssistantAssociationsRequest, AsyncHandler<ListAssistantAssociationsRequest,ListAssistantAssociationsResult> asyncHandler)
Lists information about assistant associations.
listAssistantAssociationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssistantsResult> listAssistantsAsync(ListAssistantsRequest listAssistantsRequest)
Lists information about assistants.
listAssistantsRequest - Future<ListAssistantsResult> listAssistantsAsync(ListAssistantsRequest listAssistantsRequest, AsyncHandler<ListAssistantsRequest,ListAssistantsResult> asyncHandler)
Lists information about assistants.
listAssistantsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListContentAssociationsResult> listContentAssociationsAsync(ListContentAssociationsRequest listContentAssociationsRequest)
Lists the content associations.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
listContentAssociationsRequest - Future<ListContentAssociationsResult> listContentAssociationsAsync(ListContentAssociationsRequest listContentAssociationsRequest, AsyncHandler<ListContentAssociationsRequest,ListContentAssociationsResult> asyncHandler)
Lists the content associations.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
listContentAssociationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListContentsResult> listContentsAsync(ListContentsRequest listContentsRequest)
Lists the content.
listContentsRequest - Future<ListContentsResult> listContentsAsync(ListContentsRequest listContentsRequest, AsyncHandler<ListContentsRequest,ListContentsResult> asyncHandler)
Lists the content.
listContentsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListImportJobsResult> listImportJobsAsync(ListImportJobsRequest listImportJobsRequest)
Lists information about import jobs.
listImportJobsRequest - Future<ListImportJobsResult> listImportJobsAsync(ListImportJobsRequest listImportJobsRequest, AsyncHandler<ListImportJobsRequest,ListImportJobsResult> asyncHandler)
Lists information about import jobs.
listImportJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListKnowledgeBasesResult> listKnowledgeBasesAsync(ListKnowledgeBasesRequest listKnowledgeBasesRequest)
Lists the knowledge bases.
listKnowledgeBasesRequest - Future<ListKnowledgeBasesResult> listKnowledgeBasesAsync(ListKnowledgeBasesRequest listKnowledgeBasesRequest, AsyncHandler<ListKnowledgeBasesRequest,ListKnowledgeBasesResult> asyncHandler)
Lists the knowledge bases.
listKnowledgeBasesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListQuickResponsesResult> listQuickResponsesAsync(ListQuickResponsesRequest listQuickResponsesRequest)
Lists information about quick response.
listQuickResponsesRequest - Future<ListQuickResponsesResult> listQuickResponsesAsync(ListQuickResponsesRequest listQuickResponsesRequest, AsyncHandler<ListQuickResponsesRequest,ListQuickResponsesResult> asyncHandler)
Lists information about quick response.
listQuickResponsesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags for the specified resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<NotifyRecommendationsReceivedResult> notifyRecommendationsReceivedAsync(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest)
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate
recommendations.
notifyRecommendationsReceivedRequest - Future<NotifyRecommendationsReceivedResult> notifyRecommendationsReceivedAsync(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest, AsyncHandler<NotifyRecommendationsReceivedRequest,NotifyRecommendationsReceivedResult> asyncHandler)
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate
recommendations.
notifyRecommendationsReceivedRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutFeedbackResult> putFeedbackAsync(PutFeedbackRequest putFeedbackRequest)
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
putFeedbackRequest - Future<PutFeedbackResult> putFeedbackAsync(PutFeedbackRequest putFeedbackRequest, AsyncHandler<PutFeedbackRequest,PutFeedbackResult> asyncHandler)
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
putFeedbackRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.@Deprecated Future<QueryAssistantResult> queryAssistantAsync(QueryAssistantRequest queryAssistantRequest)
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
queryAssistantRequest - @Deprecated Future<QueryAssistantResult> queryAssistantAsync(QueryAssistantRequest queryAssistantRequest, AsyncHandler<QueryAssistantRequest,QueryAssistantResult> asyncHandler)
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
queryAssistantRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemoveKnowledgeBaseTemplateUriResult> removeKnowledgeBaseTemplateUriAsync(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest)
Removes a URI template from a knowledge base.
removeKnowledgeBaseTemplateUriRequest - Future<RemoveKnowledgeBaseTemplateUriResult> removeKnowledgeBaseTemplateUriAsync(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest, AsyncHandler<RemoveKnowledgeBaseTemplateUriRequest,RemoveKnowledgeBaseTemplateUriResult> asyncHandler)
Removes a URI template from a knowledge base.
removeKnowledgeBaseTemplateUriRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchContentResult> searchContentAsync(SearchContentRequest searchContentRequest)
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
searchContentRequest - Future<SearchContentResult> searchContentAsync(SearchContentRequest searchContentRequest, AsyncHandler<SearchContentRequest,SearchContentResult> asyncHandler)
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
searchContentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchQuickResponsesResult> searchQuickResponsesAsync(SearchQuickResponsesRequest searchQuickResponsesRequest)
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
searchQuickResponsesRequest - Future<SearchQuickResponsesResult> searchQuickResponsesAsync(SearchQuickResponsesRequest searchQuickResponsesRequest, AsyncHandler<SearchQuickResponsesRequest,SearchQuickResponsesResult> asyncHandler)
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
searchQuickResponsesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchSessionsResult> searchSessionsAsync(SearchSessionsRequest searchSessionsRequest)
Searches for sessions.
searchSessionsRequest - Future<SearchSessionsResult> searchSessionsAsync(SearchSessionsRequest searchSessionsRequest, AsyncHandler<SearchSessionsRequest,SearchSessionsResult> asyncHandler)
Searches for sessions.
searchSessionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartContentUploadResult> startContentUploadAsync(StartContentUploadRequest startContentUploadRequest)
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
startContentUploadRequest - Future<StartContentUploadResult> startContentUploadAsync(StartContentUploadRequest startContentUploadRequest, AsyncHandler<StartContentUploadRequest,StartContentUploadResult> asyncHandler)
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
startContentUploadRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartImportJobResult> startImportJobAsync(StartImportJobRequest startImportJobRequest)
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
startImportJobRequest - Future<StartImportJobResult> startImportJobAsync(StartImportJobRequest startImportJobRequest, AsyncHandler<StartImportJobRequest,StartImportJobResult> asyncHandler)
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
startImportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds the specified tags to the specified resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the specified tags from the specified resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateContentResult> updateContentAsync(UpdateContentRequest updateContentRequest)
Updates information about the content.
updateContentRequest - Future<UpdateContentResult> updateContentAsync(UpdateContentRequest updateContentRequest, AsyncHandler<UpdateContentRequest,UpdateContentResult> asyncHandler)
Updates information about the content.
updateContentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateKnowledgeBaseTemplateUriResult> updateKnowledgeBaseTemplateUriAsync(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest)
Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL.
Include a single variable in ${variable} format; this interpolated by Amazon Q in Connect using
ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can
set the template URI to
https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
updateKnowledgeBaseTemplateUriRequest - Future<UpdateKnowledgeBaseTemplateUriResult> updateKnowledgeBaseTemplateUriAsync(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest, AsyncHandler<UpdateKnowledgeBaseTemplateUriRequest,UpdateKnowledgeBaseTemplateUriResult> asyncHandler)
Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL.
Include a single variable in ${variable} format; this interpolated by Amazon Q in Connect using
ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can
set the template URI to
https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
updateKnowledgeBaseTemplateUriRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateQuickResponseResult> updateQuickResponseAsync(UpdateQuickResponseRequest updateQuickResponseRequest)
Updates an existing Amazon Q in Connect quick response.
updateQuickResponseRequest - Future<UpdateQuickResponseResult> updateQuickResponseAsync(UpdateQuickResponseRequest updateQuickResponseRequest, AsyncHandler<UpdateQuickResponseRequest,UpdateQuickResponseResult> asyncHandler)
Updates an existing Amazon Q in Connect quick response.
updateQuickResponseRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateSessionResult> updateSessionAsync(UpdateSessionRequest updateSessionRequest)
Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
updateSessionRequest - Future<UpdateSessionResult> updateSessionAsync(UpdateSessionRequest updateSessionRequest, AsyncHandler<UpdateSessionRequest,UpdateSessionResult> asyncHandler)
Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
updateSessionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.