aws-sdk
Version:
AWS SDK for JavaScript
818 lines • 119 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class QConnect extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: QConnect.Types.ClientConfiguration)
config: Config & QConnect.Types.ClientConfiguration;
/**
* Creates an Amazon Q in Connect assistant.
*/
createAssistant(params: QConnect.Types.CreateAssistantRequest, callback?: (err: AWSError, data: QConnect.Types.CreateAssistantResponse) => void): Request<QConnect.Types.CreateAssistantResponse, AWSError>;
/**
* Creates an Amazon Q in Connect assistant.
*/
createAssistant(callback?: (err: AWSError, data: QConnect.Types.CreateAssistantResponse) => void): Request<QConnect.Types.CreateAssistantResponse, AWSError>;
/**
* 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.
*/
createAssistantAssociation(params: QConnect.Types.CreateAssistantAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.CreateAssistantAssociationResponse) => void): Request<QConnect.Types.CreateAssistantAssociationResponse, AWSError>;
/**
* 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.
*/
createAssistantAssociation(callback?: (err: AWSError, data: QConnect.Types.CreateAssistantAssociationResponse) => void): Request<QConnect.Types.CreateAssistantAssociationResponse, AWSError>;
/**
* Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
*/
createContent(params: QConnect.Types.CreateContentRequest, callback?: (err: AWSError, data: QConnect.Types.CreateContentResponse) => void): Request<QConnect.Types.CreateContentResponse, AWSError>;
/**
* Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
*/
createContent(callback?: (err: AWSError, data: QConnect.Types.CreateContentResponse) => void): Request<QConnect.Types.CreateContentResponse, AWSError>;
/**
* 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.
*/
createContentAssociation(params: QConnect.Types.CreateContentAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.CreateContentAssociationResponse) => void): Request<QConnect.Types.CreateContentAssociationResponse, AWSError>;
/**
* 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.
*/
createContentAssociation(callback?: (err: AWSError, data: QConnect.Types.CreateContentAssociationResponse) => void): Request<QConnect.Types.CreateContentAssociationResponse, AWSError>;
/**
* 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(params: QConnect.Types.CreateKnowledgeBaseRequest, callback?: (err: AWSError, data: QConnect.Types.CreateKnowledgeBaseResponse) => void): Request<QConnect.Types.CreateKnowledgeBaseResponse, AWSError>;
/**
* 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(callback?: (err: AWSError, data: QConnect.Types.CreateKnowledgeBaseResponse) => void): Request<QConnect.Types.CreateKnowledgeBaseResponse, AWSError>;
/**
* Creates an Amazon Q in Connect quick response.
*/
createQuickResponse(params: QConnect.Types.CreateQuickResponseRequest, callback?: (err: AWSError, data: QConnect.Types.CreateQuickResponseResponse) => void): Request<QConnect.Types.CreateQuickResponseResponse, AWSError>;
/**
* Creates an Amazon Q in Connect quick response.
*/
createQuickResponse(callback?: (err: AWSError, data: QConnect.Types.CreateQuickResponseResponse) => void): Request<QConnect.Types.CreateQuickResponseResponse, AWSError>;
/**
* 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.
*/
createSession(params: QConnect.Types.CreateSessionRequest, callback?: (err: AWSError, data: QConnect.Types.CreateSessionResponse) => void): Request<QConnect.Types.CreateSessionResponse, AWSError>;
/**
* 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.
*/
createSession(callback?: (err: AWSError, data: QConnect.Types.CreateSessionResponse) => void): Request<QConnect.Types.CreateSessionResponse, AWSError>;
/**
* Deletes an assistant.
*/
deleteAssistant(params: QConnect.Types.DeleteAssistantRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteAssistantResponse) => void): Request<QConnect.Types.DeleteAssistantResponse, AWSError>;
/**
* Deletes an assistant.
*/
deleteAssistant(callback?: (err: AWSError, data: QConnect.Types.DeleteAssistantResponse) => void): Request<QConnect.Types.DeleteAssistantResponse, AWSError>;
/**
* Deletes an assistant association.
*/
deleteAssistantAssociation(params: QConnect.Types.DeleteAssistantAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteAssistantAssociationResponse) => void): Request<QConnect.Types.DeleteAssistantAssociationResponse, AWSError>;
/**
* Deletes an assistant association.
*/
deleteAssistantAssociation(callback?: (err: AWSError, data: QConnect.Types.DeleteAssistantAssociationResponse) => void): Request<QConnect.Types.DeleteAssistantAssociationResponse, AWSError>;
/**
* Deletes the content.
*/
deleteContent(params: QConnect.Types.DeleteContentRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteContentResponse) => void): Request<QConnect.Types.DeleteContentResponse, AWSError>;
/**
* Deletes the content.
*/
deleteContent(callback?: (err: AWSError, data: QConnect.Types.DeleteContentResponse) => void): Request<QConnect.Types.DeleteContentResponse, AWSError>;
/**
* 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.
*/
deleteContentAssociation(params: QConnect.Types.DeleteContentAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteContentAssociationResponse) => void): Request<QConnect.Types.DeleteContentAssociationResponse, AWSError>;
/**
* 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.
*/
deleteContentAssociation(callback?: (err: AWSError, data: QConnect.Types.DeleteContentAssociationResponse) => void): Request<QConnect.Types.DeleteContentAssociationResponse, AWSError>;
/**
* Deletes the quick response import job.
*/
deleteImportJob(params: QConnect.Types.DeleteImportJobRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteImportJobResponse) => void): Request<QConnect.Types.DeleteImportJobResponse, AWSError>;
/**
* Deletes the quick response import job.
*/
deleteImportJob(callback?: (err: AWSError, data: QConnect.Types.DeleteImportJobResponse) => void): Request<QConnect.Types.DeleteImportJobResponse, AWSError>;
/**
* 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(params: QConnect.Types.DeleteKnowledgeBaseRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteKnowledgeBaseResponse) => void): Request<QConnect.Types.DeleteKnowledgeBaseResponse, AWSError>;
/**
* 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(callback?: (err: AWSError, data: QConnect.Types.DeleteKnowledgeBaseResponse) => void): Request<QConnect.Types.DeleteKnowledgeBaseResponse, AWSError>;
/**
* Deletes a quick response.
*/
deleteQuickResponse(params: QConnect.Types.DeleteQuickResponseRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteQuickResponseResponse) => void): Request<QConnect.Types.DeleteQuickResponseResponse, AWSError>;
/**
* Deletes a quick response.
*/
deleteQuickResponse(callback?: (err: AWSError, data: QConnect.Types.DeleteQuickResponseResponse) => void): Request<QConnect.Types.DeleteQuickResponseResponse, AWSError>;
/**
* Retrieves information about an assistant.
*/
getAssistant(params: QConnect.Types.GetAssistantRequest, callback?: (err: AWSError, data: QConnect.Types.GetAssistantResponse) => void): Request<QConnect.Types.GetAssistantResponse, AWSError>;
/**
* Retrieves information about an assistant.
*/
getAssistant(callback?: (err: AWSError, data: QConnect.Types.GetAssistantResponse) => void): Request<QConnect.Types.GetAssistantResponse, AWSError>;
/**
* Retrieves information about an assistant association.
*/
getAssistantAssociation(params: QConnect.Types.GetAssistantAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.GetAssistantAssociationResponse) => void): Request<QConnect.Types.GetAssistantAssociationResponse, AWSError>;
/**
* Retrieves information about an assistant association.
*/
getAssistantAssociation(callback?: (err: AWSError, data: QConnect.Types.GetAssistantAssociationResponse) => void): Request<QConnect.Types.GetAssistantAssociationResponse, AWSError>;
/**
* Retrieves content, including a pre-signed URL to download the content.
*/
getContent(params: QConnect.Types.GetContentRequest, callback?: (err: AWSError, data: QConnect.Types.GetContentResponse) => void): Request<QConnect.Types.GetContentResponse, AWSError>;
/**
* Retrieves content, including a pre-signed URL to download the content.
*/
getContent(callback?: (err: AWSError, data: QConnect.Types.GetContentResponse) => void): Request<QConnect.Types.GetContentResponse, AWSError>;
/**
* 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.
*/
getContentAssociation(params: QConnect.Types.GetContentAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.GetContentAssociationResponse) => void): Request<QConnect.Types.GetContentAssociationResponse, AWSError>;
/**
* 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.
*/
getContentAssociation(callback?: (err: AWSError, data: QConnect.Types.GetContentAssociationResponse) => void): Request<QConnect.Types.GetContentAssociationResponse, AWSError>;
/**
* Retrieves summary information about the content.
*/
getContentSummary(params: QConnect.Types.GetContentSummaryRequest, callback?: (err: AWSError, data: QConnect.Types.GetContentSummaryResponse) => void): Request<QConnect.Types.GetContentSummaryResponse, AWSError>;
/**
* Retrieves summary information about the content.
*/
getContentSummary(callback?: (err: AWSError, data: QConnect.Types.GetContentSummaryResponse) => void): Request<QConnect.Types.GetContentSummaryResponse, AWSError>;
/**
* Retrieves the started import job.
*/
getImportJob(params: QConnect.Types.GetImportJobRequest, callback?: (err: AWSError, data: QConnect.Types.GetImportJobResponse) => void): Request<QConnect.Types.GetImportJobResponse, AWSError>;
/**
* Retrieves the started import job.
*/
getImportJob(callback?: (err: AWSError, data: QConnect.Types.GetImportJobResponse) => void): Request<QConnect.Types.GetImportJobResponse, AWSError>;
/**
* Retrieves information about the knowledge base.
*/
getKnowledgeBase(params: QConnect.Types.GetKnowledgeBaseRequest, callback?: (err: AWSError, data: QConnect.Types.GetKnowledgeBaseResponse) => void): Request<QConnect.Types.GetKnowledgeBaseResponse, AWSError>;
/**
* Retrieves information about the knowledge base.
*/
getKnowledgeBase(callback?: (err: AWSError, data: QConnect.Types.GetKnowledgeBaseResponse) => void): Request<QConnect.Types.GetKnowledgeBaseResponse, AWSError>;
/**
* Retrieves the quick response.
*/
getQuickResponse(params: QConnect.Types.GetQuickResponseRequest, callback?: (err: AWSError, data: QConnect.Types.GetQuickResponseResponse) => void): Request<QConnect.Types.GetQuickResponseResponse, AWSError>;
/**
* Retrieves the quick response.
*/
getQuickResponse(callback?: (err: AWSError, data: QConnect.Types.GetQuickResponseResponse) => void): Request<QConnect.Types.GetQuickResponseResponse, AWSError>;
/**
* 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.
*/
getRecommendations(params: QConnect.Types.GetRecommendationsRequest, callback?: (err: AWSError, data: QConnect.Types.GetRecommendationsResponse) => void): Request<QConnect.Types.GetRecommendationsResponse, AWSError>;
/**
* 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.
*/
getRecommendations(callback?: (err: AWSError, data: QConnect.Types.GetRecommendationsResponse) => void): Request<QConnect.Types.GetRecommendationsResponse, AWSError>;
/**
* Retrieves information for a specified session.
*/
getSession(params: QConnect.Types.GetSessionRequest, callback?: (err: AWSError, data: QConnect.Types.GetSessionResponse) => void): Request<QConnect.Types.GetSessionResponse, AWSError>;
/**
* Retrieves information for a specified session.
*/
getSession(callback?: (err: AWSError, data: QConnect.Types.GetSessionResponse) => void): Request<QConnect.Types.GetSessionResponse, AWSError>;
/**
* Lists information about assistant associations.
*/
listAssistantAssociations(params: QConnect.Types.ListAssistantAssociationsRequest, callback?: (err: AWSError, data: QConnect.Types.ListAssistantAssociationsResponse) => void): Request<QConnect.Types.ListAssistantAssociationsResponse, AWSError>;
/**
* Lists information about assistant associations.
*/
listAssistantAssociations(callback?: (err: AWSError, data: QConnect.Types.ListAssistantAssociationsResponse) => void): Request<QConnect.Types.ListAssistantAssociationsResponse, AWSError>;
/**
* Lists information about assistants.
*/
listAssistants(params: QConnect.Types.ListAssistantsRequest, callback?: (err: AWSError, data: QConnect.Types.ListAssistantsResponse) => void): Request<QConnect.Types.ListAssistantsResponse, AWSError>;
/**
* Lists information about assistants.
*/
listAssistants(callback?: (err: AWSError, data: QConnect.Types.ListAssistantsResponse) => void): Request<QConnect.Types.ListAssistantsResponse, AWSError>;
/**
* 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.
*/
listContentAssociations(params: QConnect.Types.ListContentAssociationsRequest, callback?: (err: AWSError, data: QConnect.Types.ListContentAssociationsResponse) => void): Request<QConnect.Types.ListContentAssociationsResponse, AWSError>;
/**
* 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.
*/
listContentAssociations(callback?: (err: AWSError, data: QConnect.Types.ListContentAssociationsResponse) => void): Request<QConnect.Types.ListContentAssociationsResponse, AWSError>;
/**
* Lists the content.
*/
listContents(params: QConnect.Types.ListContentsRequest, callback?: (err: AWSError, data: QConnect.Types.ListContentsResponse) => void): Request<QConnect.Types.ListContentsResponse, AWSError>;
/**
* Lists the content.
*/
listContents(callback?: (err: AWSError, data: QConnect.Types.ListContentsResponse) => void): Request<QConnect.Types.ListContentsResponse, AWSError>;
/**
* Lists information about import jobs.
*/
listImportJobs(params: QConnect.Types.ListImportJobsRequest, callback?: (err: AWSError, data: QConnect.Types.ListImportJobsResponse) => void): Request<QConnect.Types.ListImportJobsResponse, AWSError>;
/**
* Lists information about import jobs.
*/
listImportJobs(callback?: (err: AWSError, data: QConnect.Types.ListImportJobsResponse) => void): Request<QConnect.Types.ListImportJobsResponse, AWSError>;
/**
* Lists the knowledge bases.
*/
listKnowledgeBases(params: QConnect.Types.ListKnowledgeBasesRequest, callback?: (err: AWSError, data: QConnect.Types.ListKnowledgeBasesResponse) => void): Request<QConnect.Types.ListKnowledgeBasesResponse, AWSError>;
/**
* Lists the knowledge bases.
*/
listKnowledgeBases(callback?: (err: AWSError, data: QConnect.Types.ListKnowledgeBasesResponse) => void): Request<QConnect.Types.ListKnowledgeBasesResponse, AWSError>;
/**
* Lists information about quick response.
*/
listQuickResponses(params: QConnect.Types.ListQuickResponsesRequest, callback?: (err: AWSError, data: QConnect.Types.ListQuickResponsesResponse) => void): Request<QConnect.Types.ListQuickResponsesResponse, AWSError>;
/**
* Lists information about quick response.
*/
listQuickResponses(callback?: (err: AWSError, data: QConnect.Types.ListQuickResponsesResponse) => void): Request<QConnect.Types.ListQuickResponsesResponse, AWSError>;
/**
* Lists the tags for the specified resource.
*/
listTagsForResource(params: QConnect.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: QConnect.Types.ListTagsForResourceResponse) => void): Request<QConnect.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags for the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: QConnect.Types.ListTagsForResourceResponse) => void): Request<QConnect.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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(params: QConnect.Types.NotifyRecommendationsReceivedRequest, callback?: (err: AWSError, data: QConnect.Types.NotifyRecommendationsReceivedResponse) => void): Request<QConnect.Types.NotifyRecommendationsReceivedResponse, AWSError>;
/**
* 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(callback?: (err: AWSError, data: QConnect.Types.NotifyRecommendationsReceivedResponse) => void): Request<QConnect.Types.NotifyRecommendationsReceivedResponse, AWSError>;
/**
* Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
*/
putFeedback(params: QConnect.Types.PutFeedbackRequest, callback?: (err: AWSError, data: QConnect.Types.PutFeedbackResponse) => void): Request<QConnect.Types.PutFeedbackResponse, AWSError>;
/**
* Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
*/
putFeedback(callback?: (err: AWSError, data: QConnect.Types.PutFeedbackResponse) => void): Request<QConnect.Types.PutFeedbackResponse, AWSError>;
/**
* 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.
*/
queryAssistant(params: QConnect.Types.QueryAssistantRequest, callback?: (err: AWSError, data: QConnect.Types.QueryAssistantResponse) => void): Request<QConnect.Types.QueryAssistantResponse, AWSError>;
/**
* 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.
*/
queryAssistant(callback?: (err: AWSError, data: QConnect.Types.QueryAssistantResponse) => void): Request<QConnect.Types.QueryAssistantResponse, AWSError>;
/**
* Removes a URI template from a knowledge base.
*/
removeKnowledgeBaseTemplateUri(params: QConnect.Types.RemoveKnowledgeBaseTemplateUriRequest, callback?: (err: AWSError, data: QConnect.Types.RemoveKnowledgeBaseTemplateUriResponse) => void): Request<QConnect.Types.RemoveKnowledgeBaseTemplateUriResponse, AWSError>;
/**
* Removes a URI template from a knowledge base.
*/
removeKnowledgeBaseTemplateUri(callback?: (err: AWSError, data: QConnect.Types.RemoveKnowledgeBaseTemplateUriResponse) => void): Request<QConnect.Types.RemoveKnowledgeBaseTemplateUriResponse, AWSError>;
/**
* Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
*/
searchContent(params: QConnect.Types.SearchContentRequest, callback?: (err: AWSError, data: QConnect.Types.SearchContentResponse) => void): Request<QConnect.Types.SearchContentResponse, AWSError>;
/**
* Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
*/
searchContent(callback?: (err: AWSError, data: QConnect.Types.SearchContentResponse) => void): Request<QConnect.Types.SearchContentResponse, AWSError>;
/**
* Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
*/
searchQuickResponses(params: QConnect.Types.SearchQuickResponsesRequest, callback?: (err: AWSError, data: QConnect.Types.SearchQuickResponsesResponse) => void): Request<QConnect.Types.SearchQuickResponsesResponse, AWSError>;
/**
* Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
*/
searchQuickResponses(callback?: (err: AWSError, data: QConnect.Types.SearchQuickResponsesResponse) => void): Request<QConnect.Types.SearchQuickResponsesResponse, AWSError>;
/**
* Searches for sessions.
*/
searchSessions(params: QConnect.Types.SearchSessionsRequest, callback?: (err: AWSError, data: QConnect.Types.SearchSessionsResponse) => void): Request<QConnect.Types.SearchSessionsResponse, AWSError>;
/**
* Searches for sessions.
*/
searchSessions(callback?: (err: AWSError, data: QConnect.Types.SearchSessionsResponse) => void): Request<QConnect.Types.SearchSessionsResponse, AWSError>;
/**
* 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(params: QConnect.Types.StartContentUploadRequest, callback?: (err: AWSError, data: QConnect.Types.StartContentUploadResponse) => void): Request<QConnect.Types.StartContentUploadResponse, AWSError>;
/**
* 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(callback?: (err: AWSError, data: QConnect.Types.StartContentUploadResponse) => void): Request<QConnect.Types.StartContentUploadResponse, AWSError>;
/**
* 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.
*/
startImportJob(params: QConnect.Types.StartImportJobRequest, callback?: (err: AWSError, data: QConnect.Types.StartImportJobResponse) => void): Request<QConnect.Types.StartImportJobResponse, AWSError>;
/**
* 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.
*/
startImportJob(callback?: (err: AWSError, data: QConnect.Types.StartImportJobResponse) => void): Request<QConnect.Types.StartImportJobResponse, AWSError>;
/**
* Adds the specified tags to the specified resource.
*/
tagResource(params: QConnect.Types.TagResourceRequest, callback?: (err: AWSError, data: QConnect.Types.TagResourceResponse) => void): Request<QConnect.Types.TagResourceResponse, AWSError>;
/**
* Adds the specified tags to the specified resource.
*/
tagResource(callback?: (err: AWSError, data: QConnect.Types.TagResourceResponse) => void): Request<QConnect.Types.TagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified resource.
*/
untagResource(params: QConnect.Types.UntagResourceRequest, callback?: (err: AWSError, data: QConnect.Types.UntagResourceResponse) => void): Request<QConnect.Types.UntagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified resource.
*/
untagResource(callback?: (err: AWSError, data: QConnect.Types.UntagResourceResponse) => void): Request<QConnect.Types.UntagResourceResponse, AWSError>;
/**
* Updates information about the content.
*/
updateContent(params: QConnect.Types.UpdateContentRequest, callback?: (err: AWSError, data: QConnect.Types.UpdateContentResponse) => void): Request<QConnect.Types.UpdateContentResponse, AWSError>;
/**
* Updates information about the content.
*/
updateContent(callback?: (err: AWSError, data: QConnect.Types.UpdateContentResponse) => void): Request<QConnect.Types.UpdateContentResponse, AWSError>;
/**
* 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.
*/
updateKnowledgeBaseTemplateUri(params: QConnect.Types.UpdateKnowledgeBaseTemplateUriRequest, callback?: (err: AWSError, data: QConnect.Types.UpdateKnowledgeBaseTemplateUriResponse) => void): Request<QConnect.Types.UpdateKnowledgeBaseTemplateUriResponse, AWSError>;
/**
* 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.
*/
updateKnowledgeBaseTemplateUri(callback?: (err: AWSError, data: QConnect.Types.UpdateKnowledgeBaseTemplateUriResponse) => void): Request<QConnect.Types.UpdateKnowledgeBaseTemplateUriResponse, AWSError>;
/**
* Updates an existing Amazon Q in Connect quick response.
*/
updateQuickResponse(params: QConnect.Types.UpdateQuickResponseRequest, callback?: (err: AWSError, data: QConnect.Types.UpdateQuickResponseResponse) => void): Request<QConnect.Types.UpdateQuickResponseResponse, AWSError>;
/**
* Updates an existing Amazon Q in Connect quick response.
*/
updateQuickResponse(callback?: (err: AWSError, data: QConnect.Types.UpdateQuickResponseResponse) => void): Request<QConnect.Types.UpdateQuickResponseResponse, AWSError>;
/**
* 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.
*/
updateSession(params: QConnect.Types.UpdateSessionRequest, callback?: (err: AWSError, data: QConnect.Types.UpdateSessionResponse) => void): Request<QConnect.Types.UpdateSessionResponse, AWSError>;
/**
* 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.
*/
updateSession(callback?: (err: AWSError, data: QConnect.Types.UpdateSessionResponse) => void): Request<QConnect.Types.UpdateSessionResponse, AWSError>;
}
declare namespace QConnect {
export interface AmazonConnectGuideAssociationData {
/**
* The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
*/
flowId?: GenericArn;
}
export type AndConditions = TagCondition[];
export interface AppIntegrationsConfiguration {
/**
* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields. For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields. For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields. For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt. For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name. The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
*/
appIntegrationArn: GenericArn;
/**
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted. For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active. For Zendesk, you must include at least id, title, updated_at, and draft. Make sure to include additional fields. These fields are indexed and used to source recommendations.
*/
objectFields?: ObjectFieldsList;
}
export type Arn = string;
export interface AssistantAssociationData {
/**
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*/
assistantArn: Arn;
/**
* The Amazon Resource Name (ARN) of the assistant association.
*/
assistantAssociationArn: Arn;
/**
* The identifier of the assistant association.
*/
assistantAssociationId: Uuid;
/**
* The identifier of the Amazon Q in Connect assistant.
*/
assistantId: Uuid;
/**
* A union type that currently has a single argument, the knowledge base ID.
*/
associationData: AssistantAssociationOutputData;
/**
* The type of association.
*/
associationType: AssociationType;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export interface AssistantAssociationInputData {
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
*/
knowledgeBaseId?: Uuid;
}
export interface AssistantAssociationOutputData {
/**
* The knowledge base where output data is sent.
*/
knowledgeBaseAssociation?: KnowledgeBaseAssociationData;
}
export interface AssistantAssociationSummary {
/**
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*/
assistantArn: Arn;
/**
* The Amazon Resource Name (ARN) of the assistant association.
*/
assistantAssociationArn: Arn;
/**
* The identifier of the assistant association.
*/
assistantAssociationId: Uuid;
/**
* The identifier of the Amazon Q in Connect assistant.
*/
assistantId: Uuid;
/**
* The association data.
*/
associationData: AssistantAssociationOutputData;
/**
* The type of association.
*/
associationType: AssociationType;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export type AssistantAssociationSummaryList = AssistantAssociationSummary[];
export interface AssistantCapabilityConfiguration {
/**
* The type of Amazon Q in Connect assistant capability.
*/
type?: AssistantCapabilityType;
}
export type AssistantCapabilityType = "V1"|"V2"|string;
export interface AssistantData {
/**
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*/
assistantArn: Arn;
/**
* The identifier of the Amazon Q in Connect assistant.
*/
assistantId: Uuid;
/**
* The configuration information for the Amazon Q in Connect assistant capability.
*/
capabilityConfiguration?: AssistantCapabilityConfiguration;
/**
* The description.
*/
description?: Description;
/**
* The configuration information for the Amazon Q in Connect assistant integration.
*/
integrationConfiguration?: AssistantIntegrationConfiguration;
/**
* The name.
*/
name: Name;
/**
* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
*/
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
/**
* The status of the assistant.
*/
status: AssistantStatus;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The type of assistant.
*/
type: AssistantType;
}
export interface AssistantIntegrationConfiguration {
/**
* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
*/
topicIntegrationArn?: GenericArn;
}
export type AssistantList = AssistantSummary[];
export type AssistantStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|string;
export interface AssistantSummary {
/**
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*/
assistantArn: Arn;
/**
* The identifier of the Amazon Q in Connect assistant.
*/
assistantId: Uuid;
/**
* The configuration information for the Amazon Q in Connect assistant capability.
*/
capabilityConfiguration?: AssistantCapabilityConfiguration;
/**
* The description of the assistant.
*/
description?: Description;
/**
* The configuration information for the Amazon Q in Connect assistant integration.
*/
integrationConfiguration?: AssistantIntegrationConfiguration;
/**
* The name of the assistant.
*/
name: Name;
/**
* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
*/
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
/**
* The status of the assistant.
*/
status: AssistantStatus;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The type of the assistant.
*/
type: AssistantType;
}
export type AssistantType = "AGENT"|string;
export type AssociationType = "KNOWLEDGE_BASE"|string;
export type Boolean = boolean;
export type Channel = string;
export type Channels = Channel[];
export type ClientToken = string;
export interface Configuration {
/**
* The configuration information of the Amazon Connect data source.
*/
connectConfiguration?: ConnectConfiguration;
}
export interface ConnectConfiguration {
/**
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
*/
instanceId?: NonEmptyString;
}
export type ContactAttributeKey = string;
export type ContactAttributeKeys = ContactAttributeKey[];
export type ContactAttributeValue = string;
export type ContactAttributes = {[key: string]: ContactAttributeValue};
export interface ContentAssociationContents {
/**
* The data of the step-by-step guide association.
*/
amazonConnectGuideAssociation?: AmazonConnectGuideAssociationData;
}
export interface ContentAssociationData {
/**
* The content association.
*/
associationData: ContentAssociationContents;
/**
* The type of association.
*/
associationType: ContentAssociationType;
/**
* The Amazon Resource Name (ARN) of the content.
*/
contentArn: Arn;
/**
* The Amazon Resource Name (ARN) of the content association.
*/
contentAssociationArn: Arn;
/**
* The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
contentAssociationId: Uuid;
/**
* The identifier of the content.
*/
contentId: Uuid;
/**
* The Amazon Resource Name (ARN) of the knowledge base.
*/
knowledgeBaseArn: Arn;
/**
* The identifier of the knowledge base.
*/
knowledgeBaseId: Uuid;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export interface ContentAssociationSummary {
/**
* The content association.
*/
associationData: ContentAssociationContents;
/**
* The type of association.
*/
associationType: ContentAssociationType;
/**
* The Amazon Resource Name (ARN) of the content.
*/
contentArn: Arn;
/**
* The Amazon Resource Name (ARN) of the content association.
*/
contentAssociationArn: Arn;
/**
* The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
contentAssociationId: Uuid;
/**
* The identifier of the content.
*/
contentId: Uuid;
/**
* The Amazon Resource Name (ARN) of the knowledge base.
*/
knowledgeBaseArn: Arn;
/**
* The identifier of the knowledge base.
*/
knowledgeBaseId: Uuid;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export type ContentAssociationSummaryList = ContentAssociationSummary[];
export type ContentAssociationType = "AMAZON_CONNECT_GUIDE"|string;
export interface ContentData {
/**
* The Amazon Resource Name (ARN) of the content.
*/
contentArn: Arn;
/**
* The identifier of the content.
*/
contentId: Uuid;
/**
* The media type of the content.
*/
contentType: ContentType;
/**
* The Amazon Resource Name (ARN) of the knowledge base.
*/
knowledgeBaseArn: Arn;
/**
* The identifier of the knowledge base.
*/
knowledgeBaseId: Uuid;
/**
* The URI of the content.
*/
linkOutUri?: Uri;
/**
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
*/
metadata: ContentMetadata;
/**
* The name of the content.
*/
name: Name;
/**
* The identifier of the content revision.
*/
revisionId: NonEmptyString;
/**
* The status of the content.
*/
status: ContentStatus;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The title of the content.
*/
title: ContentTitle;
/**
* The URL of the content.
*/
url: Url;
/**
* The expiration time of the URL as an epoch timestamp.
*/
urlExpiry: SyntheticTimestamp_epoch_seconds;
}
export interface ContentDataDetails {
/**
* Details about the content ranking data.
*/
rankingData: RankingData;
/**
* Details about the content text data.
*/
textData: TextData;
}
export interface ContentFeedbackData {
/**
* Information about the feedback for a generative target type.
*/
generativeContentFeedbackData?: GenerativeContentFeedbackData;
}
export type ContentMetadata = {[key: string]: NonEmptyString};
export interface ContentReference {
/**
* The Amazon Resource Name (ARN) of the content.
*/
contentArn?: Arn;
/**
* The identifier of the content.
*/
contentId?: Uuid;
/**
* The Amazon Resource Name (ARN) of the knowledge base.
*/
knowledgeBaseArn?: Arn;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
*/
knowledgeBaseId?: Uuid;
}
export type ContentStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|"UPDATE_FAILED"|string;
export interface ContentSummary {
/**
* The Amazon Resource Name (ARN) of the content.
*/
contentArn: Arn;
/**
* The identifier of the content.
*/
contentId: Uuid;
/**
* The media type of the content.
*/
contentType: ContentType;
/**
* The Amazon Resource Name (ARN) of the knowledge base.
*/
knowledgeBaseArn: Arn;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
*/
knowledgeBaseId: Uuid;
/**
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
*/
metadata: ContentMetadata;
/**
* The name of the content.
*/
name: Name;
/**
* The identifier of the revision of the content.
*/
revisionId: NonEmptyString;
/**
* The status of the content.
*/
statu