@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonConnectWisdomClient extends AmazonWebServiceClient implements AmazonConnectWisdom
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
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
public static AmazonConnectWisdomClientBuilder builder()
public CreateAssistantResult createAssistant(CreateAssistantRequest request)
Creates an Amazon Connect Wisdom assistant.
createAssistant
in interface AmazonConnectWisdom
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.public CreateAssistantAssociationResult createAssistantAssociation(CreateAssistantAssociationRequest request)
Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
createAssistantAssociation
in interface AmazonConnectWisdom
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.public CreateContentResult createContent(CreateContentRequest request)
Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
createContent
in interface AmazonConnectWisdom
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.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:
Call DeleteKnowledgeBase .
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
createKnowledgeBase
in interface AmazonConnectWisdom
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.public CreateQuickResponseResult createQuickResponse(CreateQuickResponseRequest request)
Creates a Wisdom quick response.
createQuickResponse
in interface AmazonConnectWisdom
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.public CreateSessionResult createSession(CreateSessionRequest request)
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
createSession
in interface AmazonConnectWisdom
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.ResourceNotFoundException
- The specified resource does not exist.public DeleteAssistantResult deleteAssistant(DeleteAssistantRequest request)
Deletes an assistant.
deleteAssistant
in interface AmazonConnectWisdom
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.public DeleteAssistantAssociationResult deleteAssistantAssociation(DeleteAssistantAssociationRequest request)
Deletes an assistant association.
deleteAssistantAssociation
in interface AmazonConnectWisdom
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.public DeleteContentResult deleteContent(DeleteContentRequest request)
Deletes the content.
deleteContent
in interface AmazonConnectWisdom
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.public DeleteImportJobResult deleteImportJob(DeleteImportJobRequest request)
Deletes the quick response import job.
deleteImportJob
in interface AmazonConnectWisdom
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.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.
deleteKnowledgeBase
in interface AmazonConnectWisdom
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.public DeleteQuickResponseResult deleteQuickResponse(DeleteQuickResponseRequest request)
Deletes a quick response.
deleteQuickResponse
in interface AmazonConnectWisdom
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.public GetAssistantResult getAssistant(GetAssistantRequest request)
Retrieves information about an assistant.
getAssistant
in interface AmazonConnectWisdom
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.public GetAssistantAssociationResult getAssistantAssociation(GetAssistantAssociationRequest request)
Retrieves information about an assistant association.
getAssistantAssociation
in interface AmazonConnectWisdom
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.public GetContentResult getContent(GetContentRequest request)
Retrieves content, including a pre-signed URL to download the content.
getContent
in interface AmazonConnectWisdom
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.public GetContentSummaryResult getContentSummary(GetContentSummaryRequest request)
Retrieves summary information about the content.
getContentSummary
in interface AmazonConnectWisdom
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.public GetImportJobResult getImportJob(GetImportJobRequest request)
Retrieves the started import job.
getImportJob
in interface AmazonConnectWisdom
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.public GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest request)
Retrieves information about the knowledge base.
getKnowledgeBase
in interface AmazonConnectWisdom
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.public GetQuickResponseResult getQuickResponse(GetQuickResponseRequest request)
Retrieves the quick response.
getQuickResponse
in interface AmazonConnectWisdom
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 public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)
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.
getRecommendations
in interface AmazonConnectWisdom
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.public GetSessionResult getSession(GetSessionRequest request)
Retrieves information for a specified session.
getSession
in interface AmazonConnectWisdom
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.public ListAssistantAssociationsResult listAssistantAssociations(ListAssistantAssociationsRequest request)
Lists information about assistant associations.
listAssistantAssociations
in interface AmazonConnectWisdom
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.public ListAssistantsResult listAssistants(ListAssistantsRequest request)
Lists information about assistants.
listAssistants
in interface AmazonConnectWisdom
listAssistantsRequest
- ValidationException
- The input fails to satisfy the constraints specified by a service.AccessDeniedException
- You do not have sufficient access to perform this action.public ListContentsResult listContents(ListContentsRequest request)
Lists the content.
listContents
in interface AmazonConnectWisdom
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.public ListImportJobsResult listImportJobs(ListImportJobsRequest request)
Lists information about import jobs.
listImportJobs
in interface AmazonConnectWisdom
listImportJobsRequest
- ValidationException
- The input fails to satisfy the constraints specified by a service.AccessDeniedException
- You do not have sufficient access to perform this action.public ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest request)
Lists the knowledge bases.
listKnowledgeBases
in interface AmazonConnectWisdom
listKnowledgeBasesRequest
- ValidationException
- The input fails to satisfy the constraints specified by a service.AccessDeniedException
- You do not have sufficient access to perform this action.public ListQuickResponsesResult listQuickResponses(ListQuickResponsesRequest request)
Lists information about quick response.
listQuickResponses
in interface AmazonConnectWisdom
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
listTagsForResource
in interface AmazonConnectWisdom
listTagsForResourceRequest
- ResourceNotFoundException
- The specified resource does not exist.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.
notifyRecommendationsReceived
in interface AmazonConnectWisdom
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.@Deprecated public QueryAssistantResult queryAssistant(QueryAssistantRequest request)
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
queryAssistant
in interface AmazonConnectWisdom
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.public RemoveKnowledgeBaseTemplateUriResult removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest request)
Removes a URI template from a knowledge base.
removeKnowledgeBaseTemplateUri
in interface AmazonConnectWisdom
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.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.
searchContent
in interface AmazonConnectWisdom
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.public SearchQuickResponsesResult searchQuickResponses(SearchQuickResponsesRequest request)
Searches existing Wisdom quick responses in a Wisdom knowledge base.
searchQuickResponses
in interface AmazonConnectWisdom
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.public SearchSessionsResult searchSessions(SearchSessionsRequest request)
Searches for sessions.
searchSessions
in interface AmazonConnectWisdom
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.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.
startContentUpload
in interface AmazonConnectWisdom
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.public StartImportJobResult startImportJob(StartImportJobRequest request)
Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
For importing Wisdom 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.
startImportJob
in interface AmazonConnectWisdom
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.public TagResourceResult tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
tagResource
in interface AmazonConnectWisdom
tagResourceRequest
- TooManyTagsException
- Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.ResourceNotFoundException
- The specified resource does not exist.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
untagResource
in interface AmazonConnectWisdom
untagResourceRequest
- ResourceNotFoundException
- The specified resource does not exist.public UpdateContentResult updateContent(UpdateContentRequest request)
Updates information about the content.
updateContent
in interface AmazonConnectWisdom
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.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 Wisdom 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
.
updateKnowledgeBaseTemplateUri
in interface AmazonConnectWisdom
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.public UpdateQuickResponseResult updateQuickResponse(UpdateQuickResponseRequest request)
Updates an existing Wisdom quick response.
updateQuickResponse
in interface AmazonConnectWisdom
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonConnectWisdom
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonConnectWisdom
shutdown
in class AmazonWebServiceClient