com.amazonaws.services.qconnect.AmazonQConnect Maven / Gradle / Ivy
Show all versions of aws-java-sdk-qconnect Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.qconnect;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.qconnect.model.*;
/**
* Interface for accessing Amazon Q Connect.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.qconnect.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonQConnect {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "wisdom";
/**
*
* Creates an Amazon Q in Connect assistant.
*
*
* @param createAssistantRequest
* @return Result of the CreateAssistant operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonQConnect.CreateAssistant
* @see AWS API
* Documentation
*/
CreateAssistantResult createAssistant(CreateAssistantRequest createAssistantRequest);
/**
*
* 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.
*
*
* @param createAssistantAssociationRequest
* @return Result of the CreateAssistantAssociation operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.CreateAssistantAssociation
* @see AWS API Documentation
*/
CreateAssistantAssociationResult createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest);
/**
*
* Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
*
*
* @param createContentRequest
* @return Result of the CreateContent operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.CreateContent
* @see AWS API
* Documentation
*/
CreateContentResult createContent(CreateContentRequest createContentRequest);
/**
*
* 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.
*
*
* @param createContentAssociationRequest
* @return Result of the CreateContentAssociation operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The throttling limit has been exceeded.
* @sample AmazonQConnect.CreateContentAssociation
* @see AWS API Documentation
*/
CreateContentAssociationResult createContentAssociation(CreateContentAssociationRequest createContentAssociationRequest);
/**
*
* 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.
*
*
*
*
*
* @param createKnowledgeBaseRequest
* @return Result of the CreateKnowledgeBase operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonQConnect.CreateKnowledgeBase
* @see AWS
* API Documentation
*/
CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest);
/**
*
* Creates an Amazon Q in Connect quick response.
*
*
* @param createQuickResponseRequest
* @return Result of the CreateQuickResponse operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.CreateQuickResponse
* @see AWS
* API Documentation
*/
CreateQuickResponseResult createQuickResponse(CreateQuickResponseRequest createQuickResponseRequest);
/**
*
* 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.
*
*
* @param createSessionRequest
* @return Result of the CreateSession operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.CreateSession
* @see AWS API
* Documentation
*/
CreateSessionResult createSession(CreateSessionRequest createSessionRequest);
/**
*
* Deletes an assistant.
*
*
* @param deleteAssistantRequest
* @return Result of the DeleteAssistant operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.DeleteAssistant
* @see AWS API
* Documentation
*/
DeleteAssistantResult deleteAssistant(DeleteAssistantRequest deleteAssistantRequest);
/**
*
* Deletes an assistant association.
*
*
* @param deleteAssistantAssociationRequest
* @return Result of the DeleteAssistantAssociation operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.DeleteAssistantAssociation
* @see AWS API Documentation
*/
DeleteAssistantAssociationResult deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest);
/**
*
* Deletes the content.
*
*
* @param deleteContentRequest
* @return Result of the DeleteContent operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.DeleteContent
* @see AWS API
* Documentation
*/
DeleteContentResult deleteContent(DeleteContentRequest deleteContentRequest);
/**
*
* 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.
*
*
* @param deleteContentAssociationRequest
* @return Result of the DeleteContentAssociation operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.DeleteContentAssociation
* @see AWS API Documentation
*/
DeleteContentAssociationResult deleteContentAssociation(DeleteContentAssociationRequest deleteContentAssociationRequest);
/**
*
* Deletes the quick response import job.
*
*
* @param deleteImportJobRequest
* @return Result of the DeleteImportJob operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.DeleteImportJob
* @see AWS API
* Documentation
*/
DeleteImportJobResult deleteImportJob(DeleteImportJobRequest deleteImportJobRequest);
/**
*
* 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.
*
*
*
* @param deleteKnowledgeBaseRequest
* @return Result of the DeleteKnowledgeBase operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.DeleteKnowledgeBase
* @see AWS
* API Documentation
*/
DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest);
/**
*
* Deletes a quick response.
*
*
* @param deleteQuickResponseRequest
* @return Result of the DeleteQuickResponse operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.DeleteQuickResponse
* @see AWS
* API Documentation
*/
DeleteQuickResponseResult deleteQuickResponse(DeleteQuickResponseRequest deleteQuickResponseRequest);
/**
*
* Retrieves information about an assistant.
*
*
* @param getAssistantRequest
* @return Result of the GetAssistant operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetAssistant
* @see AWS API
* Documentation
*/
GetAssistantResult getAssistant(GetAssistantRequest getAssistantRequest);
/**
*
* Retrieves information about an assistant association.
*
*
* @param getAssistantAssociationRequest
* @return Result of the GetAssistantAssociation operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetAssistantAssociation
* @see AWS API Documentation
*/
GetAssistantAssociationResult getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest);
/**
*
* Retrieves content, including a pre-signed URL to download the content.
*
*
* @param getContentRequest
* @return Result of the GetContent operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetContent
* @see AWS API
* Documentation
*/
GetContentResult getContent(GetContentRequest getContentRequest);
/**
*
* 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.
*
*
* @param getContentAssociationRequest
* @return Result of the GetContentAssociation operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetContentAssociation
* @see AWS
* API Documentation
*/
GetContentAssociationResult getContentAssociation(GetContentAssociationRequest getContentAssociationRequest);
/**
*
* Retrieves summary information about the content.
*
*
* @param getContentSummaryRequest
* @return Result of the GetContentSummary operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetContentSummary
* @see AWS API
* Documentation
*/
GetContentSummaryResult getContentSummary(GetContentSummaryRequest getContentSummaryRequest);
/**
*
* Retrieves the started import job.
*
*
* @param getImportJobRequest
* @return Result of the GetImportJob operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetImportJob
* @see AWS API
* Documentation
*/
GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest);
/**
*
* Retrieves information about the knowledge base.
*
*
* @param getKnowledgeBaseRequest
* @return Result of the GetKnowledgeBase operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetKnowledgeBase
* @see AWS API
* Documentation
*/
GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest);
/**
*
* Retrieves the quick response.
*
*
* @param getQuickResponseRequest
* @return Result of the GetQuickResponse operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetQuickResponse
* @see AWS API
* Documentation
*/
GetQuickResponseResult getQuickResponse(GetQuickResponseRequest getQuickResponseRequest);
/**
*
*
* 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.
*
*
* @param getRecommendationsRequest
* @return Result of the GetRecommendations operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetRecommendations
* @see AWS
* API Documentation
*/
@Deprecated
GetRecommendationsResult getRecommendations(GetRecommendationsRequest getRecommendationsRequest);
/**
*
* Retrieves information for a specified session.
*
*
* @param getSessionRequest
* @return Result of the GetSession operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.GetSession
* @see AWS API
* Documentation
*/
GetSessionResult getSession(GetSessionRequest getSessionRequest);
/**
*
* Lists information about assistant associations.
*
*
* @param listAssistantAssociationsRequest
* @return Result of the ListAssistantAssociations operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.ListAssistantAssociations
* @see AWS API Documentation
*/
ListAssistantAssociationsResult listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest);
/**
*
* Lists information about assistants.
*
*
* @param listAssistantsRequest
* @return Result of the ListAssistants operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonQConnect.ListAssistants
* @see AWS API
* Documentation
*/
ListAssistantsResult listAssistants(ListAssistantsRequest listAssistantsRequest);
/**
*
* 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.
*
*
* @param listContentAssociationsRequest
* @return Result of the ListContentAssociations operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.ListContentAssociations
* @see AWS API Documentation
*/
ListContentAssociationsResult listContentAssociations(ListContentAssociationsRequest listContentAssociationsRequest);
/**
*
* Lists the content.
*
*
* @param listContentsRequest
* @return Result of the ListContents operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.ListContents
* @see AWS API
* Documentation
*/
ListContentsResult listContents(ListContentsRequest listContentsRequest);
/**
*
* Lists information about import jobs.
*
*
* @param listImportJobsRequest
* @return Result of the ListImportJobs operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonQConnect.ListImportJobs
* @see AWS API
* Documentation
*/
ListImportJobsResult listImportJobs(ListImportJobsRequest listImportJobsRequest);
/**
*
* Lists the knowledge bases.
*
*
* @param listKnowledgeBasesRequest
* @return Result of the ListKnowledgeBases operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonQConnect.ListKnowledgeBases
* @see AWS
* API Documentation
*/
ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest);
/**
*
* Lists information about quick response.
*
*
* @param listQuickResponsesRequest
* @return Result of the ListQuickResponses operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.ListQuickResponses
* @see AWS
* API Documentation
*/
ListQuickResponsesResult listQuickResponses(ListQuickResponsesRequest listQuickResponsesRequest);
/**
*
* Lists the tags for the specified resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
*
*
* @param notifyRecommendationsReceivedRequest
* @return Result of the NotifyRecommendationsReceived operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.NotifyRecommendationsReceived
* @see AWS API Documentation
*/
NotifyRecommendationsReceivedResult notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest);
/**
*
* Provides feedback against the specified assistant for the specified target. This API only supports generative
* targets.
*
*
* @param putFeedbackRequest
* @return Result of the PutFeedback operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.PutFeedback
* @see AWS API
* Documentation
*/
PutFeedbackResult putFeedback(PutFeedbackRequest putFeedbackRequest);
/**
*
*
* 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.
*
*
* @param queryAssistantRequest
* @return Result of the QueryAssistant operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.QueryAssistant
* @see AWS API
* Documentation
*/
@Deprecated
QueryAssistantResult queryAssistant(QueryAssistantRequest queryAssistantRequest);
/**
*
* Removes a URI template from a knowledge base.
*
*
* @param removeKnowledgeBaseTemplateUriRequest
* @return Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.RemoveKnowledgeBaseTemplateUri
* @see AWS API Documentation
*/
RemoveKnowledgeBaseTemplateUriResult removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest);
/**
*
* Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
*
*
* @param searchContentRequest
* @return Result of the SearchContent operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.SearchContent
* @see AWS API
* Documentation
*/
SearchContentResult searchContent(SearchContentRequest searchContentRequest);
/**
*
* Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
*
*
* @param searchQuickResponsesRequest
* @return Result of the SearchQuickResponses operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.SearchQuickResponses
* @see AWS
* API Documentation
*/
SearchQuickResponsesResult searchQuickResponses(SearchQuickResponsesRequest searchQuickResponsesRequest);
/**
*
* Searches for sessions.
*
*
* @param searchSessionsRequest
* @return Result of the SearchSessions operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.SearchSessions
* @see AWS API
* Documentation
*/
SearchSessionsResult searchSessions(SearchSessionsRequest searchSessionsRequest);
/**
*
* 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.
*
*
* @param startContentUploadRequest
* @return Result of the StartContentUpload operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.StartContentUpload
* @see AWS
* API Documentation
*/
StartContentUploadResult startContentUpload(StartContentUploadRequest startContentUploadRequest);
/**
*
* 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.
*
*
*
*
* @param startImportJobRequest
* @return Result of the StartImportJob operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.StartImportJob
* @see AWS API
* Documentation
*/
StartImportJobResult startImportJob(StartImportJobRequest startImportJobRequest);
/**
*
* Adds the specified tags to the specified resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws TooManyTagsException
* Amazon Q in Connect throws this exception if you have too many tags in your tag set.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes the specified tags from the specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates information about the content.
*
*
* @param updateContentRequest
* @return Result of the UpdateContent operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws PreconditionFailedException
* The provided revisionId does not match, indicating the content has been modified since it
* was last read.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.UpdateContent
* @see AWS API
* Documentation
*/
UpdateContentResult updateContent(UpdateContentRequest updateContentRequest);
/**
*
* 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.
*
*
* @param updateKnowledgeBaseTemplateUriRequest
* @return Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.UpdateKnowledgeBaseTemplateUri
* @see AWS API Documentation
*/
UpdateKnowledgeBaseTemplateUriResult updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest);
/**
*
* Updates an existing Amazon Q in Connect quick response.
*
*
* @param updateQuickResponseRequest
* @return Result of the UpdateQuickResponse operation returned by the service.
* @throws 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.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws PreconditionFailedException
* The provided revisionId does not match, indicating the content has been modified since it
* was last read.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.UpdateQuickResponse
* @see AWS
* API Documentation
*/
UpdateQuickResponseResult updateQuickResponse(UpdateQuickResponseRequest updateQuickResponseRequest);
/**
*
* 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.
*
*
* @param updateSessionRequest
* @return Result of the UpdateSession operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by a service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AmazonQConnect.UpdateSession
* @see AWS API
* Documentation
*/
UpdateSessionResult updateSession(UpdateSessionRequest updateSessionRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}