@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonQConnect
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonQConnect 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateAssistantResult |
createAssistant(CreateAssistantRequest createAssistantRequest)
Creates an Amazon Q in Connect assistant.
|
CreateAssistantAssociationResult |
createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest)
Creates an association between an Amazon Q in Connect assistant and another resource.
|
CreateContentResult |
createContent(CreateContentRequest createContentRequest)
Creates Amazon Q in Connect content.
|
CreateContentAssociationResult |
createContentAssociation(CreateContentAssociationRequest createContentAssociationRequest)
Creates an association between a content resource in a knowledge base and step-by-step
guides.
|
CreateKnowledgeBaseResult |
createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)
Creates a knowledge base.
|
CreateQuickResponseResult |
createQuickResponse(CreateQuickResponseRequest createQuickResponseRequest)
Creates an Amazon Q in Connect quick response.
|
CreateSessionResult |
createSession(CreateSessionRequest createSessionRequest)
Creates a session.
|
DeleteAssistantResult |
deleteAssistant(DeleteAssistantRequest deleteAssistantRequest)
Deletes an assistant.
|
DeleteAssistantAssociationResult |
deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest)
Deletes an assistant association.
|
DeleteContentResult |
deleteContent(DeleteContentRequest deleteContentRequest)
Deletes the content.
|
DeleteContentAssociationResult |
deleteContentAssociation(DeleteContentAssociationRequest deleteContentAssociationRequest)
Deletes the content association.
|
DeleteImportJobResult |
deleteImportJob(DeleteImportJobRequest deleteImportJobRequest)
Deletes the quick response import job.
|
DeleteKnowledgeBaseResult |
deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)
Deletes the knowledge base.
|
DeleteQuickResponseResult |
deleteQuickResponse(DeleteQuickResponseRequest deleteQuickResponseRequest)
Deletes a quick response.
|
GetAssistantResult |
getAssistant(GetAssistantRequest getAssistantRequest)
Retrieves information about an assistant.
|
GetAssistantAssociationResult |
getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest)
Retrieves information about an assistant association.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetContentResult |
getContent(GetContentRequest getContentRequest)
Retrieves content, including a pre-signed URL to download the content.
|
GetContentAssociationResult |
getContentAssociation(GetContentAssociationRequest getContentAssociationRequest)
Returns the content association.
|
GetContentSummaryResult |
getContentSummary(GetContentSummaryRequest getContentSummaryRequest)
Retrieves summary information about the content.
|
GetImportJobResult |
getImportJob(GetImportJobRequest getImportJobRequest)
Retrieves the started import job.
|
GetKnowledgeBaseResult |
getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)
Retrieves information about the knowledge base.
|
GetQuickResponseResult |
getQuickResponse(GetQuickResponseRequest getQuickResponseRequest)
Retrieves the quick response.
|
GetRecommendationsResult |
getRecommendations(GetRecommendationsRequest getRecommendationsRequest)
Deprecated.
|
GetSessionResult |
getSession(GetSessionRequest getSessionRequest)
Retrieves information for a specified session.
|
ListAssistantAssociationsResult |
listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest)
Lists information about assistant associations.
|
ListAssistantsResult |
listAssistants(ListAssistantsRequest listAssistantsRequest)
Lists information about assistants.
|
ListContentAssociationsResult |
listContentAssociations(ListContentAssociationsRequest listContentAssociationsRequest)
Lists the content associations.
|
ListContentsResult |
listContents(ListContentsRequest listContentsRequest)
Lists the content.
|
ListImportJobsResult |
listImportJobs(ListImportJobsRequest listImportJobsRequest)
Lists information about import jobs.
|
ListKnowledgeBasesResult |
listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)
Lists the knowledge bases.
|
ListQuickResponsesResult |
listQuickResponses(ListQuickResponsesRequest listQuickResponsesRequest)
Lists information about quick response.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
|
NotifyRecommendationsReceivedResult |
notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest)
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
|
PutFeedbackResult |
putFeedback(PutFeedbackRequest putFeedbackRequest)
Provides feedback against the specified assistant for the specified target.
|
QueryAssistantResult |
queryAssistant(QueryAssistantRequest queryAssistantRequest)
Deprecated.
|
RemoveKnowledgeBaseTemplateUriResult |
removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest)
Removes a URI template from a knowledge base.
|
SearchContentResult |
searchContent(SearchContentRequest searchContentRequest)
Searches for content in a specified knowledge base.
|
SearchQuickResponsesResult |
searchQuickResponses(SearchQuickResponsesRequest searchQuickResponsesRequest)
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
|
SearchSessionsResult |
searchSessions(SearchSessionsRequest searchSessionsRequest)
Searches for sessions.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartContentUploadResult |
startContentUpload(StartContentUploadRequest startContentUploadRequest)
Get a URL to upload content to a knowledge base.
|
StartImportJobResult |
startImportJob(StartImportJobRequest startImportJobRequest)
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
|
UpdateContentResult |
updateContent(UpdateContentRequest updateContentRequest)
Updates information about the content.
|
UpdateKnowledgeBaseTemplateUriResult |
updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest)
Updates the template URI of a knowledge base.
|
UpdateQuickResponseResult |
updateQuickResponse(UpdateQuickResponseRequest updateQuickResponseRequest)
Updates an existing Amazon Q in Connect quick response.
|
UpdateSessionResult |
updateSession(UpdateSessionRequest updateSessionRequest)
Updates a session.
|
static final String ENDPOINT_PREFIX
CreateAssistantResult createAssistant(CreateAssistantRequest createAssistantRequest)
Creates an Amazon Q in Connect assistant.
createAssistantRequest - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use service quotas to request a service quota increase.AccessDeniedException - You do not have sufficient access to perform this action.CreateAssistantAssociationResult createAssistantAssociation(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 - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use service quotas to request a service quota increase.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.CreateContentResult createContent(CreateContentRequest createContentRequest)
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
createContentRequest - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use service quotas to request a service quota increase.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.CreateContentAssociationResult createContentAssociation(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 - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use service quotas to request a service quota increase.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.ThrottlingException - The throttling limit has been exceeded.CreateKnowledgeBaseResult createKnowledgeBase(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 - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use service quotas to request a service quota increase.AccessDeniedException - You do not have sufficient access to perform this action.CreateQuickResponseResult createQuickResponse(CreateQuickResponseRequest createQuickResponseRequest)
Creates an Amazon Q in Connect quick response.
createQuickResponseRequest - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use service quotas to request a service quota increase.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.CreateSessionResult createSession(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 - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.DeleteAssistantResult deleteAssistant(DeleteAssistantRequest deleteAssistantRequest)
Deletes an assistant.
deleteAssistantRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.DeleteAssistantAssociationResult deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest)
Deletes an assistant association.
deleteAssistantAssociationRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.DeleteContentResult deleteContent(DeleteContentRequest deleteContentRequest)
Deletes the content.
deleteContentRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.DeleteContentAssociationResult deleteContentAssociation(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 - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.DeleteImportJobResult deleteImportJob(DeleteImportJobRequest deleteImportJobRequest)
Deletes the quick response import job.
deleteImportJobRequest - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.DeleteKnowledgeBaseResult deleteKnowledgeBase(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 - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.DeleteQuickResponseResult deleteQuickResponse(DeleteQuickResponseRequest deleteQuickResponseRequest)
Deletes a quick response.
deleteQuickResponseRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetAssistantResult getAssistant(GetAssistantRequest getAssistantRequest)
Retrieves information about an assistant.
getAssistantRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetAssistantAssociationResult getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest)
Retrieves information about an assistant association.
getAssistantAssociationRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetContentResult getContent(GetContentRequest getContentRequest)
Retrieves content, including a pre-signed URL to download the content.
getContentRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetContentAssociationResult getContentAssociation(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 - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetContentSummaryResult getContentSummary(GetContentSummaryRequest getContentSummaryRequest)
Retrieves summary information about the content.
getContentSummaryRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)
Retrieves the started import job.
getImportJobRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)
Retrieves information about the knowledge base.
getKnowledgeBaseRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetQuickResponseResult getQuickResponse(GetQuickResponseRequest getQuickResponseRequest)
Retrieves the quick response.
getQuickResponseRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.@Deprecated GetRecommendationsResult getRecommendations(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 - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.GetSessionResult getSession(GetSessionRequest getSessionRequest)
Retrieves information for a specified session.
getSessionRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.ListAssistantAssociationsResult listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest)
Lists information about assistant associations.
listAssistantAssociationsRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.ListAssistantsResult listAssistants(ListAssistantsRequest listAssistantsRequest)
Lists information about assistants.
listAssistantsRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ListContentAssociationsResult listContentAssociations(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 - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.ListContentsResult listContents(ListContentsRequest listContentsRequest)
Lists the content.
listContentsRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.ListImportJobsResult listImportJobs(ListImportJobsRequest listImportJobsRequest)
Lists information about import jobs.
listImportJobsRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)
Lists the knowledge bases.
listKnowledgeBasesRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ListQuickResponsesResult listQuickResponses(ListQuickResponsesRequest listQuickResponsesRequest)
Lists information about quick response.
listQuickResponsesRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
listTagsForResourceRequest - ResourceNotFoundException - The specified resource does not exist.NotifyRecommendationsReceivedResult notifyRecommendationsReceived(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 - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.PutFeedbackResult putFeedback(PutFeedbackRequest putFeedbackRequest)
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
putFeedbackRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.@Deprecated QueryAssistantResult queryAssistant(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 - RequestTimeoutException - The request reached the service more than 15 minutes after the date stamp on the request or more than 15
minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request
is more than 15 minutes in the future.ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.RemoveKnowledgeBaseTemplateUriResult removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest)
Removes a URI template from a knowledge base.
removeKnowledgeBaseTemplateUriRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.SearchContentResult searchContent(SearchContentRequest searchContentRequest)
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
searchContentRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.SearchQuickResponsesResult searchQuickResponses(SearchQuickResponsesRequest searchQuickResponsesRequest)
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
searchQuickResponsesRequest - RequestTimeoutException - The request reached the service more than 15 minutes after the date stamp on the request or more than 15
minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request
is more than 15 minutes in the future.ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.SearchSessionsResult searchSessions(SearchSessionsRequest searchSessionsRequest)
Searches for sessions.
searchSessionsRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.StartContentUploadResult startContentUpload(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 - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.StartImportJobResult startImportJob(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 - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use service quotas to request a service quota increase.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
tagResourceRequest - TooManyTagsException - Amazon Q in Connect throws this exception if you have too many tags in your tag set.ResourceNotFoundException - The specified resource does not exist.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
untagResourceRequest - ResourceNotFoundException - The specified resource does not exist.UpdateContentResult updateContent(UpdateContentRequest updateContentRequest)
Updates information about the content.
updateContentRequest - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.PreconditionFailedException - The provided revisionId does not match, indicating the content has been modified since it
was last read.ResourceNotFoundException - The specified resource does not exist.UpdateKnowledgeBaseTemplateUriResult updateKnowledgeBaseTemplateUri(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 - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.UpdateQuickResponseResult updateQuickResponse(UpdateQuickResponseRequest updateQuickResponseRequest)
Updates an existing Amazon Q in Connect quick response.
updateQuickResponseRequest - ConflictException - The request could not be processed because of conflict in the current state of the resource. For example,
if you're using a Create API (such as CreateAssistant) that accepts name, a
conflicting resource (usually with the same name) is being created or mutated.ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.PreconditionFailedException - The provided revisionId does not match, indicating the content has been modified since it
was last read.ResourceNotFoundException - The specified resource does not exist.UpdateSessionResult updateSession(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 - ValidationException - The input fails to satisfy the constraints specified by a service.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The specified resource does not exist.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.