com.amazonaws.services.qconnect

Class AmazonQConnectClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.qconnect.AmazonQConnectClient

All Implemented Interfaces:

AmazonQConnect

Direct Known Subclasses:

AmazonQConnectAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonQConnectClient
extends AmazonWebServiceClient
implements AmazonQConnect

Client for accessing Amazon Q Connect. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.qconnect.AmazonQConnect

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonQConnectClientBuilder	builder()
CreateAssistantResult	createAssistant(CreateAssistantRequest request) Creates an Amazon Q in Connect assistant.
CreateAssistantAssociationResult	createAssistantAssociation(CreateAssistantAssociationRequest request) Creates an association between an Amazon Q in Connect assistant and another resource.
CreateContentResult	createContent(CreateContentRequest request) Creates Amazon Q in Connect content.
CreateContentAssociationResult	createContentAssociation(CreateContentAssociationRequest request) Creates an association between a content resource in a knowledge base and step-by-step guides.
CreateKnowledgeBaseResult	createKnowledgeBase(CreateKnowledgeBaseRequest request) Creates a knowledge base.
CreateQuickResponseResult	createQuickResponse(CreateQuickResponseRequest request) Creates an Amazon Q in Connect quick response.
CreateSessionResult	createSession(CreateSessionRequest request) Creates a session.
DeleteAssistantResult	deleteAssistant(DeleteAssistantRequest request) Deletes an assistant.
DeleteAssistantAssociationResult	deleteAssistantAssociation(DeleteAssistantAssociationRequest request) Deletes an assistant association.
DeleteContentResult	deleteContent(DeleteContentRequest request) Deletes the content.
DeleteContentAssociationResult	deleteContentAssociation(DeleteContentAssociationRequest request) Deletes the content association.
DeleteImportJobResult	deleteImportJob(DeleteImportJobRequest request) Deletes the quick response import job.
DeleteKnowledgeBaseResult	deleteKnowledgeBase(DeleteKnowledgeBaseRequest request) Deletes the knowledge base.
DeleteQuickResponseResult	deleteQuickResponse(DeleteQuickResponseRequest request) Deletes a quick response.
GetAssistantResult	getAssistant(GetAssistantRequest request) Retrieves information about an assistant.
GetAssistantAssociationResult	getAssistantAssociation(GetAssistantAssociationRequest request) 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 request) Retrieves content, including a pre-signed URL to download the content.
GetContentAssociationResult	getContentAssociation(GetContentAssociationRequest request) Returns the content association.
GetContentSummaryResult	getContentSummary(GetContentSummaryRequest request) Retrieves summary information about the content.
GetImportJobResult	getImportJob(GetImportJobRequest request) Retrieves the started import job.
GetKnowledgeBaseResult	getKnowledgeBase(GetKnowledgeBaseRequest request) Retrieves information about the knowledge base.
GetQuickResponseResult	getQuickResponse(GetQuickResponseRequest request) Retrieves the quick response.
GetRecommendationsResult	getRecommendations(GetRecommendationsRequest request) Deprecated.
GetSessionResult	getSession(GetSessionRequest request) Retrieves information for a specified session.
ListAssistantAssociationsResult	listAssistantAssociations(ListAssistantAssociationsRequest request) Lists information about assistant associations.
ListAssistantsResult	listAssistants(ListAssistantsRequest request) Lists information about assistants.
ListContentAssociationsResult	listContentAssociations(ListContentAssociationsRequest request) Lists the content associations.
ListContentsResult	listContents(ListContentsRequest request) Lists the content.
ListImportJobsResult	listImportJobs(ListImportJobsRequest request) Lists information about import jobs.
ListKnowledgeBasesResult	listKnowledgeBases(ListKnowledgeBasesRequest request) Lists the knowledge bases.
ListQuickResponsesResult	listQuickResponses(ListQuickResponsesRequest request) Lists information about quick response.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags for the specified resource.
NotifyRecommendationsReceivedResult	notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest request) Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
PutFeedbackResult	putFeedback(PutFeedbackRequest request) Provides feedback against the specified assistant for the specified target.
QueryAssistantResult	queryAssistant(QueryAssistantRequest request) Deprecated.
RemoveKnowledgeBaseTemplateUriResult	removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest request) Removes a URI template from a knowledge base.
SearchContentResult	searchContent(SearchContentRequest request) Searches for content in a specified knowledge base.
SearchQuickResponsesResult	searchQuickResponses(SearchQuickResponsesRequest request) Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
SearchSessionsResult	searchSessions(SearchSessionsRequest request) Searches for sessions.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartContentUploadResult	startContentUpload(StartContentUploadRequest request) Get a URL to upload content to a knowledge base.
StartImportJobResult	startImportJob(StartImportJobRequest request) Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.
TagResourceResult	tagResource(TagResourceRequest request) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified resource.
UpdateContentResult	updateContent(UpdateContentRequest request) Updates information about the content.
UpdateKnowledgeBaseTemplateUriResult	updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest request) Updates the template URI of a knowledge base.
UpdateQuickResponseResult	updateQuickResponse(UpdateQuickResponseRequest request) Updates an existing Amazon Q in Connect quick response.
UpdateSessionResult	updateSession(UpdateSessionRequest request) Updates a session.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonQConnectClientBuilder builder()

createAssistant

public CreateAssistantResult createAssistant(CreateAssistantRequest request)

Creates an Amazon Q in Connect assistant.

Specified by:

createAssistant in interface AmazonQConnect

Parameters:

createAssistantRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

createAssistantAssociation

public CreateAssistantAssociationResult createAssistantAssociation(CreateAssistantAssociationRequest request)

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.

Specified by:

createAssistantAssociation in interface AmazonQConnect

Parameters:

createAssistantAssociationRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

createContent

public CreateContentResult createContent(CreateContentRequest request)

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

Specified by:

createContent in interface AmazonQConnect

Parameters:

createContentRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

createContentAssociation

public CreateContentAssociationResult createContentAssociation(CreateContentAssociationRequest request)

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.

Specified by:

createContentAssociation in interface AmazonQConnect

Parameters:

createContentAssociationRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

createKnowledgeBase

public CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest request)

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:

1. Call DeleteKnowledgeBase.

2. Call DeleteDataIntegration.

3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

4. Call CreateKnowledgeBase.

Specified by:

createKnowledgeBase in interface AmazonQConnect

Parameters:

createKnowledgeBaseRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

createQuickResponse

public CreateQuickResponseResult createQuickResponse(CreateQuickResponseRequest request)

Creates an Amazon Q in Connect quick response.

Specified by:

createQuickResponse in interface AmazonQConnect

Parameters:

createQuickResponseRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

createSession

public CreateSessionResult createSession(CreateSessionRequest request)

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.

Specified by:

createSession in interface AmazonQConnect

Parameters:

createSessionRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

deleteAssistant

public DeleteAssistantResult deleteAssistant(DeleteAssistantRequest request)

Deletes an assistant.

Specified by:

deleteAssistant in interface AmazonQConnect

Parameters:

deleteAssistantRequest -

Returns:

Result of the DeleteAssistant operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteAssistantAssociation

public DeleteAssistantAssociationResult deleteAssistantAssociation(DeleteAssistantAssociationRequest request)

Deletes an assistant association.

Specified by:

deleteAssistantAssociation in interface AmazonQConnect

Parameters:

deleteAssistantAssociationRequest -

Returns:

Result of the DeleteAssistantAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteContent

public DeleteContentResult deleteContent(DeleteContentRequest request)

Deletes the content.

Specified by:

deleteContent in interface AmazonQConnect

Parameters:

deleteContentRequest -

Returns:

Result of the DeleteContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteContentAssociation

public DeleteContentAssociationResult deleteContentAssociation(DeleteContentAssociationRequest request)

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.

Specified by:

deleteContentAssociation in interface AmazonQConnect

Parameters:

deleteContentAssociationRequest -

Returns:

Result of the DeleteContentAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteImportJob

public DeleteImportJobResult deleteImportJob(DeleteImportJobRequest request)

Deletes the quick response import job.

Specified by:

deleteImportJob in interface AmazonQConnect

Parameters:

deleteImportJobRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

deleteKnowledgeBase

public DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)

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.

Specified by:

deleteKnowledgeBase in interface AmazonQConnect

Parameters:

deleteKnowledgeBaseRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

deleteQuickResponse

public DeleteQuickResponseResult deleteQuickResponse(DeleteQuickResponseRequest request)

Deletes a quick response.

Specified by:

deleteQuickResponse in interface AmazonQConnect

Parameters:

deleteQuickResponseRequest -

Returns:

Result of the DeleteQuickResponse operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAssistant

public GetAssistantResult getAssistant(GetAssistantRequest request)

Retrieves information about an assistant.

Specified by:

getAssistant in interface AmazonQConnect

Parameters:

getAssistantRequest -

Returns:

Result of the GetAssistant operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAssistantAssociation

public GetAssistantAssociationResult getAssistantAssociation(GetAssistantAssociationRequest request)

Retrieves information about an assistant association.

Specified by:

getAssistantAssociation in interface AmazonQConnect

Parameters:

getAssistantAssociationRequest -

Returns:

Result of the GetAssistantAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getContent

public GetContentResult getContent(GetContentRequest request)

Retrieves content, including a pre-signed URL to download the content.

Specified by:

getContent in interface AmazonQConnect

Parameters:

getContentRequest -

Returns:

Result of the GetContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getContentAssociation

public GetContentAssociationResult getContentAssociation(GetContentAssociationRequest request)

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.

Specified by:

getContentAssociation in interface AmazonQConnect

Parameters:

getContentAssociationRequest -

Returns:

Result of the GetContentAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getContentSummary

public GetContentSummaryResult getContentSummary(GetContentSummaryRequest request)

Retrieves summary information about the content.

Specified by:

getContentSummary in interface AmazonQConnect

Parameters:

getContentSummaryRequest -

Returns:

Result of the GetContentSummary operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getImportJob

public GetImportJobResult getImportJob(GetImportJobRequest request)

Retrieves the started import job.

Specified by:

getImportJob in interface AmazonQConnect

Parameters:

getImportJobRequest -

Returns:

Result of the GetImportJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getKnowledgeBase

public GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest request)

Retrieves information about the knowledge base.

Specified by:

getKnowledgeBase in interface AmazonQConnect

Parameters:

getKnowledgeBaseRequest -

Returns:

Result of the GetKnowledgeBase operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getQuickResponse

public GetQuickResponseResult getQuickResponse(GetQuickResponseRequest request)

Retrieves the quick response.

Specified by:

getQuickResponse in interface AmazonQConnect

Parameters:

getQuickResponseRequest -

Returns:

Result of the GetQuickResponse operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getRecommendations

@Deprecated
public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)

Deprecated.

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.

Specified by:

getRecommendations in interface AmazonQConnect

Parameters:

getRecommendationsRequest -

Returns:

Result of the GetRecommendations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSession

public GetSessionResult getSession(GetSessionRequest request)

Retrieves information for a specified session.

Specified by:

getSession in interface AmazonQConnect

Parameters:

getSessionRequest -

Returns:

Result of the GetSession operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAssistantAssociations

public ListAssistantAssociationsResult listAssistantAssociations(ListAssistantAssociationsRequest request)

Lists information about assistant associations.

Specified by:

listAssistantAssociations in interface AmazonQConnect

Parameters:

listAssistantAssociationsRequest -

Returns:

Result of the ListAssistantAssociations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAssistants

public ListAssistantsResult listAssistants(ListAssistantsRequest request)

Lists information about assistants.

Specified by:

listAssistants in interface AmazonQConnect

Parameters:

listAssistantsRequest -

Returns:

Result of the ListAssistants operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listContentAssociations

public ListContentAssociationsResult listContentAssociations(ListContentAssociationsRequest request)

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.

Specified by:

listContentAssociations in interface AmazonQConnect

Parameters:

listContentAssociationsRequest -

Returns:

Result of the ListContentAssociations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listContents

public ListContentsResult listContents(ListContentsRequest request)

Lists the content.

Specified by:

listContents in interface AmazonQConnect

Parameters:

listContentsRequest -

Returns:

Result of the ListContents operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listImportJobs

public ListImportJobsResult listImportJobs(ListImportJobsRequest request)

Lists information about import jobs.

Specified by:

listImportJobs in interface AmazonQConnect

Parameters:

listImportJobsRequest -

Returns:

Result of the ListImportJobs operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listKnowledgeBases

public ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest request)

Lists the knowledge bases.

Specified by:

listKnowledgeBases in interface AmazonQConnect

Parameters:

listKnowledgeBasesRequest -

Returns:

Result of the ListKnowledgeBases operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listQuickResponses

public ListQuickResponsesResult listQuickResponses(ListQuickResponsesRequest request)

Lists information about quick response.

Specified by:

listQuickResponses in interface AmazonQConnect

Parameters:

listQuickResponsesRequest -

Returns:

Result of the ListQuickResponses operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AmazonQConnect

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

notifyRecommendationsReceived

public NotifyRecommendationsReceivedResult notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest request)

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.

Specified by:

notifyRecommendationsReceived in interface AmazonQConnect

Parameters:

notifyRecommendationsReceivedRequest -

Returns:

Result of the NotifyRecommendationsReceived operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putFeedback

public PutFeedbackResult putFeedback(PutFeedbackRequest request)

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

Specified by:

putFeedback in interface AmazonQConnect

Parameters:

putFeedbackRequest -

Returns:

Result of the PutFeedback operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

queryAssistant

@Deprecated
public QueryAssistantResult queryAssistant(QueryAssistantRequest request)

Deprecated.

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.

Specified by:

queryAssistant in interface AmazonQConnect

Parameters:

queryAssistantRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

removeKnowledgeBaseTemplateUri

public RemoveKnowledgeBaseTemplateUriResult removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest request)

Removes a URI template from a knowledge base.

Specified by:

removeKnowledgeBaseTemplateUri in interface AmazonQConnect

Parameters:

removeKnowledgeBaseTemplateUriRequest -

Returns:

Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

searchContent

public SearchContentResult searchContent(SearchContentRequest request)

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

Specified by:

searchContent in interface AmazonQConnect

Parameters:

searchContentRequest -

Returns:

Result of the SearchContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

searchQuickResponses

public SearchQuickResponsesResult searchQuickResponses(SearchQuickResponsesRequest request)

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

Specified by:

searchQuickResponses in interface AmazonQConnect

Parameters:

searchQuickResponsesRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

searchSessions

public SearchSessionsResult searchSessions(SearchSessionsRequest request)

Searches for sessions.

Specified by:

searchSessions in interface AmazonQConnect

Parameters:

searchSessionsRequest -

Returns:

Result of the SearchSessions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startContentUpload

public StartContentUploadResult startContentUpload(StartContentUploadRequest request)

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.

Specified by:

startContentUpload in interface AmazonQConnect

Parameters:

startContentUploadRequest -

Returns:

Result of the StartContentUpload operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startImportJob

public StartImportJobResult startImportJob(StartImportJobRequest request)

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.

Specified by:

startImportJob in interface AmazonQConnect

Parameters:

startImportJobRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds the specified tags to the specified resource.

Specified by:

tagResource in interface AmazonQConnect

Parameters:

tagResourceRequest -

Returns:

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.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the specified tags from the specified resource.

Specified by:

untagResource in interface AmazonQConnect

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

updateContent

public UpdateContentResult updateContent(UpdateContentRequest request)

Updates information about the content.

Specified by:

updateContent in interface AmazonQConnect

Parameters:

updateContentRequest -

Returns:

Result of the UpdateContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateKnowledgeBaseTemplateUri

public UpdateKnowledgeBaseTemplateUriResult updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest request)

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.

Specified by:

updateKnowledgeBaseTemplateUri in interface AmazonQConnect

Parameters:

updateKnowledgeBaseTemplateUriRequest -

Returns:

Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateQuickResponse

public UpdateQuickResponseResult updateQuickResponse(UpdateQuickResponseRequest request)

Updates an existing Amazon Q in Connect quick response.

Specified by:

updateQuickResponse in interface AmazonQConnect

Parameters:

updateQuickResponseRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

updateSession

public UpdateSessionResult updateSession(UpdateSessionRequest request)

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.

Specified by:

updateSession in interface AmazonQConnect

Parameters:

updateSessionRequest -

Returns:

Result of the UpdateSession operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonQConnect

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonQConnect

Overrides:

shutdown in class AmazonWebServiceClient