cdk-lambda-subminute 2.0.310 → 2.0.312
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +3 -3
- package/lib/cdk-lambda-subminute.js +3 -3
- package/node_modules/aws-sdk/CHANGELOG.md +68 -1
- package/node_modules/aws-sdk/README.md +1 -3
- package/node_modules/aws-sdk/apis/accessanalyzer-2019-11-01.min.json +429 -86
- package/node_modules/aws-sdk/apis/accessanalyzer-2019-11-01.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/amp-2020-08-01.min.json +320 -3
- package/node_modules/aws-sdk/apis/amp-2020-08-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/amp-2020-08-01.waiters2.json +33 -0
- package/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json +141 -6
- package/node_modules/aws-sdk/apis/b2bi-2022-06-23.examples.json +714 -0
- package/node_modules/aws-sdk/apis/b2bi-2022-06-23.min.json +1095 -0
- package/node_modules/aws-sdk/apis/b2bi-2022-06-23.paginators.json +28 -0
- package/node_modules/aws-sdk/apis/backup-2018-11-15.min.json +855 -84
- package/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json +18 -0
- package/node_modules/aws-sdk/apis/bcm-data-exports-2023-11-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/bcm-data-exports-2023-11-26.min.json +470 -0
- package/node_modules/aws-sdk/apis/bcm-data-exports-2023-11-26.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/bedrock-2023-04-20.min.json +91 -71
- package/node_modules/aws-sdk/apis/bedrock-agent-2023-06-05.examples.json +5 -0
- package/node_modules/aws-sdk/apis/bedrock-agent-2023-06-05.min.json +2322 -0
- package/node_modules/aws-sdk/apis/bedrock-agent-2023-06-05.paginators.json +52 -0
- package/node_modules/aws-sdk/apis/bedrock-agent-runtime-2023-07-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/bedrock-agent-runtime-2023-07-26.min.json +697 -0
- package/node_modules/aws-sdk/apis/bedrock-agent-runtime-2023-07-26.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/bedrock-runtime-2023-09-30.min.json +18 -18
- package/node_modules/aws-sdk/apis/bedrock-runtime-2023-09-30.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +67 -24
- package/node_modules/aws-sdk/apis/codestar-connections-2019-12-01.min.json +590 -3
- package/node_modules/aws-sdk/apis/codestar-connections-2019-12-01.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/compute-optimizer-2019-11-01.min.json +243 -39
- package/node_modules/aws-sdk/apis/config-2014-11-12.min.json +204 -169
- package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +1180 -417
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +11 -0
- package/node_modules/aws-sdk/apis/controltower-2018-05-10.min.json +317 -13
- package/node_modules/aws-sdk/apis/controltower-2018-05-10.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/cost-optimization-hub-2022-07-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/cost-optimization-hub-2022-07-26.min.json +757 -0
- package/node_modules/aws-sdk/apis/cost-optimization-hub-2022-07-26.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/customer-profiles-2020-08-15.min.json +129 -84
- package/node_modules/aws-sdk/apis/detective-2018-10-26.min.json +294 -0
- package/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json +108 -107
- package/node_modules/aws-sdk/apis/eks-2017-11-01.min.json +211 -4
- package/node_modules/aws-sdk/apis/eks-2017-11-01.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/eks-auth-2023-11-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/eks-auth-2023-11-26.min.json +104 -0
- package/node_modules/aws-sdk/apis/eks-auth-2023-11-26.paginators.json +4 -0
- package/node_modules/aws-sdk/apis/eks-auth-2023-11-26.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json +481 -132
- package/node_modules/aws-sdk/apis/elasticache-2015-02-02.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.min.json +71 -33
- package/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.paginators.json +18 -3
- package/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.min.json +403 -75
- package/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.paginators.json +15 -0
- package/node_modules/aws-sdk/apis/fis-2020-12-01.min.json +366 -15
- package/node_modules/aws-sdk/apis/fis-2020-12-01.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/freetier-2023-09-07.examples.json +5 -0
- package/node_modules/aws-sdk/apis/freetier-2023-09-07.min.json +105 -0
- package/node_modules/aws-sdk/apis/freetier-2023-09-07.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +259 -135
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +64 -0
- package/node_modules/aws-sdk/apis/iotfleetwise-2021-06-17.min.json +159 -33
- package/node_modules/aws-sdk/apis/lakeformation-2017-03-31.min.json +126 -35
- package/node_modules/aws-sdk/apis/logs-2014-03-28.min.json +310 -36
- package/node_modules/aws-sdk/apis/logs-2014-03-28.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.min.json +58 -50
- package/node_modules/aws-sdk/apis/metadata.json +39 -0
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.min.json +633 -331
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +85 -52
- package/node_modules/aws-sdk/apis/personalize-events-2018-03-22.min.json +97 -5
- package/node_modules/aws-sdk/apis/personalize-runtime-2018-05-22.min.json +68 -11
- package/node_modules/aws-sdk/apis/qbusiness-2023-11-27.examples.json +5 -0
- package/node_modules/aws-sdk/apis/qbusiness-2023-11-27.min.json +3025 -0
- package/node_modules/aws-sdk/apis/qbusiness-2023-11-27.paginators.json +76 -0
- package/node_modules/aws-sdk/apis/qconnect-2020-10-19.examples.json +5 -0
- package/node_modules/aws-sdk/apis/qconnect-2020-10-19.min.json +2499 -0
- package/node_modules/aws-sdk/apis/qconnect-2020-10-19.paginators.json +64 -0
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +398 -268
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +14 -2
- package/node_modules/aws-sdk/apis/repostspace-2022-05-13.examples.json +5 -0
- package/node_modules/aws-sdk/apis/repostspace-2022-05-13.min.json +447 -0
- package/node_modules/aws-sdk/apis/repostspace-2022-05-13.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/runtime.lex.v2-2020-08-07.min.json +25 -24
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +147 -147
- package/node_modules/aws-sdk/apis/s3-2006-03-01.min.json +694 -186
- package/node_modules/aws-sdk/apis/s3-2006-03-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json +1336 -314
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.paginators.json +15 -0
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.min.json +111 -50
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.examples.json +526 -10
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +1057 -352
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/states-2016-11-23.min.json +85 -0
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +268 -70
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json +119 -96
- package/node_modules/aws-sdk/apis/workspaces-thin-client-2023-08-22.examples.json +5 -0
- package/node_modules/aws-sdk/apis/workspaces-thin-client-2023-08-22.min.json +777 -0
- package/node_modules/aws-sdk/apis/workspaces-thin-client-2023-08-22.paginators.json +22 -0
- package/node_modules/aws-sdk/clients/accessanalyzer.d.ts +387 -7
- package/node_modules/aws-sdk/clients/all.d.ts +11 -0
- package/node_modules/aws-sdk/clients/all.js +12 -1
- package/node_modules/aws-sdk/clients/amp.d.ts +322 -0
- package/node_modules/aws-sdk/clients/appsync.d.ts +169 -0
- package/node_modules/aws-sdk/clients/b2bi.d.ts +1388 -0
- package/node_modules/aws-sdk/clients/b2bi.js +18 -0
- package/node_modules/aws-sdk/clients/backup.d.ts +848 -45
- package/node_modules/aws-sdk/clients/bcmdataexports.d.ts +589 -0
- package/node_modules/aws-sdk/clients/bcmdataexports.js +18 -0
- package/node_modules/aws-sdk/clients/bedrock.d.ts +53 -17
- package/node_modules/aws-sdk/clients/bedrockagent.d.ts +1258 -0
- package/node_modules/aws-sdk/clients/bedrockagent.js +18 -0
- package/node_modules/aws-sdk/clients/bedrockagentruntime.d.ts +439 -0
- package/node_modules/aws-sdk/clients/bedrockagentruntime.js +18 -0
- package/node_modules/aws-sdk/clients/bedrockruntime.d.ts +13 -13
- package/node_modules/aws-sdk/clients/bedrockruntime.js +1 -0
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +76 -2
- package/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts +413 -1
- package/node_modules/aws-sdk/clients/codestarconnections.d.ts +727 -0
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +307 -6
- package/node_modules/aws-sdk/clients/configservice.d.ts +60 -11
- package/node_modules/aws-sdk/clients/connect.d.ts +886 -20
- package/node_modules/aws-sdk/clients/controltower.d.ts +319 -25
- package/node_modules/aws-sdk/clients/costoptimizationhub.d.ts +1283 -0
- package/node_modules/aws-sdk/clients/costoptimizationhub.js +18 -0
- package/node_modules/aws-sdk/clients/customerprofiles.d.ts +40 -0
- package/node_modules/aws-sdk/clients/detective.d.ts +469 -0
- package/node_modules/aws-sdk/clients/ecs.d.ts +10 -5
- package/node_modules/aws-sdk/clients/efs.d.ts +75 -33
- package/node_modules/aws-sdk/clients/eks.d.ts +237 -15
- package/node_modules/aws-sdk/clients/eksauth.d.ts +124 -0
- package/node_modules/aws-sdk/clients/eksauth.js +19 -0
- package/node_modules/aws-sdk/clients/elasticache.d.ts +484 -12
- package/node_modules/aws-sdk/clients/elbv2.d.ts +433 -4
- package/node_modules/aws-sdk/clients/fis.d.ts +383 -3
- package/node_modules/aws-sdk/clients/freetier.d.ts +149 -0
- package/node_modules/aws-sdk/clients/freetier.js +18 -0
- package/node_modules/aws-sdk/clients/fsx.d.ts +194 -21
- package/node_modules/aws-sdk/clients/glue.d.ts +3 -3
- package/node_modules/aws-sdk/clients/guardduty.d.ts +82 -11
- package/node_modules/aws-sdk/clients/iotfleetwise.d.ts +198 -13
- package/node_modules/aws-sdk/clients/lakeformation.d.ts +118 -2
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +343 -2
- package/node_modules/aws-sdk/clients/lexruntimev2.d.ts +14 -9
- package/node_modules/aws-sdk/clients/managedblockchain.d.ts +26 -5
- package/node_modules/aws-sdk/clients/personalize.d.ts +65 -20
- package/node_modules/aws-sdk/clients/personalizeevents.d.ts +102 -12
- package/node_modules/aws-sdk/clients/personalizeruntime.d.ts +72 -2
- package/node_modules/aws-sdk/clients/qbusiness.d.ts +3231 -0
- package/node_modules/aws-sdk/clients/qbusiness.js +18 -0
- package/node_modules/aws-sdk/clients/qconnect.d.ts +2552 -0
- package/node_modules/aws-sdk/clients/qconnect.js +18 -0
- package/node_modules/aws-sdk/clients/quicksight.d.ts +124 -0
- package/node_modules/aws-sdk/clients/rds.d.ts +80 -80
- package/node_modules/aws-sdk/clients/redshift.d.ts +16 -0
- package/node_modules/aws-sdk/clients/repostspace.d.ts +458 -0
- package/node_modules/aws-sdk/clients/repostspace.js +18 -0
- package/node_modules/aws-sdk/clients/s3.d.ts +795 -666
- package/node_modules/aws-sdk/clients/s3control.d.ts +976 -138
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +94 -5
- package/node_modules/aws-sdk/clients/securityhub.d.ts +908 -15
- package/node_modules/aws-sdk/clients/stepfunctions.d.ts +153 -8
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +312 -46
- package/node_modules/aws-sdk/clients/workspaces.d.ts +43 -1
- package/node_modules/aws-sdk/clients/workspacesthinclient.d.ts +895 -0
- package/node_modules/aws-sdk/clients/workspacesthinclient.js +18 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +2 -2
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +512 -91
- package/node_modules/aws-sdk/dist/aws-sdk.js +4382 -1316
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +105 -104
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +22 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +3 -3
@@ -0,0 +1,2552 @@
|
|
1
|
+
import {Request} from '../lib/request';
|
2
|
+
import {Response} from '../lib/response';
|
3
|
+
import {AWSError} from '../lib/error';
|
4
|
+
import {Service} from '../lib/service';
|
5
|
+
import {ServiceConfigurationOptions} from '../lib/service';
|
6
|
+
import {ConfigBase as Config} from '../lib/config-base';
|
7
|
+
interface Blob {}
|
8
|
+
declare class QConnect extends Service {
|
9
|
+
/**
|
10
|
+
* Constructs a service object. This object has one method for each API operation.
|
11
|
+
*/
|
12
|
+
constructor(options?: QConnect.Types.ClientConfiguration)
|
13
|
+
config: Config & QConnect.Types.ClientConfiguration;
|
14
|
+
/**
|
15
|
+
* Creates an Amazon Q in Connect assistant.
|
16
|
+
*/
|
17
|
+
createAssistant(params: QConnect.Types.CreateAssistantRequest, callback?: (err: AWSError, data: QConnect.Types.CreateAssistantResponse) => void): Request<QConnect.Types.CreateAssistantResponse, AWSError>;
|
18
|
+
/**
|
19
|
+
* Creates an Amazon Q in Connect assistant.
|
20
|
+
*/
|
21
|
+
createAssistant(callback?: (err: AWSError, data: QConnect.Types.CreateAssistantResponse) => void): Request<QConnect.Types.CreateAssistantResponse, AWSError>;
|
22
|
+
/**
|
23
|
+
* 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.
|
24
|
+
*/
|
25
|
+
createAssistantAssociation(params: QConnect.Types.CreateAssistantAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.CreateAssistantAssociationResponse) => void): Request<QConnect.Types.CreateAssistantAssociationResponse, AWSError>;
|
26
|
+
/**
|
27
|
+
* 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.
|
28
|
+
*/
|
29
|
+
createAssistantAssociation(callback?: (err: AWSError, data: QConnect.Types.CreateAssistantAssociationResponse) => void): Request<QConnect.Types.CreateAssistantAssociationResponse, AWSError>;
|
30
|
+
/**
|
31
|
+
* Creates Amazon Q content. Before to calling this API, use StartContentUpload to upload an asset.
|
32
|
+
*/
|
33
|
+
createContent(params: QConnect.Types.CreateContentRequest, callback?: (err: AWSError, data: QConnect.Types.CreateContentResponse) => void): Request<QConnect.Types.CreateContentResponse, AWSError>;
|
34
|
+
/**
|
35
|
+
* Creates Amazon Q content. Before to calling this API, use StartContentUpload to upload an asset.
|
36
|
+
*/
|
37
|
+
createContent(callback?: (err: AWSError, data: QConnect.Types.CreateContentResponse) => void): Request<QConnect.Types.CreateContentResponse, AWSError>;
|
38
|
+
/**
|
39
|
+
* 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.
|
40
|
+
*/
|
41
|
+
createKnowledgeBase(params: QConnect.Types.CreateKnowledgeBaseRequest, callback?: (err: AWSError, data: QConnect.Types.CreateKnowledgeBaseResponse) => void): Request<QConnect.Types.CreateKnowledgeBaseResponse, AWSError>;
|
42
|
+
/**
|
43
|
+
* 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.
|
44
|
+
*/
|
45
|
+
createKnowledgeBase(callback?: (err: AWSError, data: QConnect.Types.CreateKnowledgeBaseResponse) => void): Request<QConnect.Types.CreateKnowledgeBaseResponse, AWSError>;
|
46
|
+
/**
|
47
|
+
* Creates a Amazon Q quick response.
|
48
|
+
*/
|
49
|
+
createQuickResponse(params: QConnect.Types.CreateQuickResponseRequest, callback?: (err: AWSError, data: QConnect.Types.CreateQuickResponseResponse) => void): Request<QConnect.Types.CreateQuickResponseResponse, AWSError>;
|
50
|
+
/**
|
51
|
+
* Creates a Amazon Q quick response.
|
52
|
+
*/
|
53
|
+
createQuickResponse(callback?: (err: AWSError, data: QConnect.Types.CreateQuickResponseResponse) => void): Request<QConnect.Types.CreateQuickResponseResponse, AWSError>;
|
54
|
+
/**
|
55
|
+
* Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q session for each contact on which Amazon Q is enabled.
|
56
|
+
*/
|
57
|
+
createSession(params: QConnect.Types.CreateSessionRequest, callback?: (err: AWSError, data: QConnect.Types.CreateSessionResponse) => void): Request<QConnect.Types.CreateSessionResponse, AWSError>;
|
58
|
+
/**
|
59
|
+
* Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q session for each contact on which Amazon Q is enabled.
|
60
|
+
*/
|
61
|
+
createSession(callback?: (err: AWSError, data: QConnect.Types.CreateSessionResponse) => void): Request<QConnect.Types.CreateSessionResponse, AWSError>;
|
62
|
+
/**
|
63
|
+
* Deletes an assistant.
|
64
|
+
*/
|
65
|
+
deleteAssistant(params: QConnect.Types.DeleteAssistantRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteAssistantResponse) => void): Request<QConnect.Types.DeleteAssistantResponse, AWSError>;
|
66
|
+
/**
|
67
|
+
* Deletes an assistant.
|
68
|
+
*/
|
69
|
+
deleteAssistant(callback?: (err: AWSError, data: QConnect.Types.DeleteAssistantResponse) => void): Request<QConnect.Types.DeleteAssistantResponse, AWSError>;
|
70
|
+
/**
|
71
|
+
* Deletes an assistant association.
|
72
|
+
*/
|
73
|
+
deleteAssistantAssociation(params: QConnect.Types.DeleteAssistantAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteAssistantAssociationResponse) => void): Request<QConnect.Types.DeleteAssistantAssociationResponse, AWSError>;
|
74
|
+
/**
|
75
|
+
* Deletes an assistant association.
|
76
|
+
*/
|
77
|
+
deleteAssistantAssociation(callback?: (err: AWSError, data: QConnect.Types.DeleteAssistantAssociationResponse) => void): Request<QConnect.Types.DeleteAssistantAssociationResponse, AWSError>;
|
78
|
+
/**
|
79
|
+
* Deletes the content.
|
80
|
+
*/
|
81
|
+
deleteContent(params: QConnect.Types.DeleteContentRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteContentResponse) => void): Request<QConnect.Types.DeleteContentResponse, AWSError>;
|
82
|
+
/**
|
83
|
+
* Deletes the content.
|
84
|
+
*/
|
85
|
+
deleteContent(callback?: (err: AWSError, data: QConnect.Types.DeleteContentResponse) => void): Request<QConnect.Types.DeleteContentResponse, AWSError>;
|
86
|
+
/**
|
87
|
+
* Deletes the quick response import job.
|
88
|
+
*/
|
89
|
+
deleteImportJob(params: QConnect.Types.DeleteImportJobRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteImportJobResponse) => void): Request<QConnect.Types.DeleteImportJobResponse, AWSError>;
|
90
|
+
/**
|
91
|
+
* Deletes the quick response import job.
|
92
|
+
*/
|
93
|
+
deleteImportJob(callback?: (err: AWSError, data: QConnect.Types.DeleteImportJobResponse) => void): Request<QConnect.Types.DeleteImportJobResponse, AWSError>;
|
94
|
+
/**
|
95
|
+
* 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.
|
96
|
+
*/
|
97
|
+
deleteKnowledgeBase(params: QConnect.Types.DeleteKnowledgeBaseRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteKnowledgeBaseResponse) => void): Request<QConnect.Types.DeleteKnowledgeBaseResponse, AWSError>;
|
98
|
+
/**
|
99
|
+
* 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.
|
100
|
+
*/
|
101
|
+
deleteKnowledgeBase(callback?: (err: AWSError, data: QConnect.Types.DeleteKnowledgeBaseResponse) => void): Request<QConnect.Types.DeleteKnowledgeBaseResponse, AWSError>;
|
102
|
+
/**
|
103
|
+
* Deletes a quick response.
|
104
|
+
*/
|
105
|
+
deleteQuickResponse(params: QConnect.Types.DeleteQuickResponseRequest, callback?: (err: AWSError, data: QConnect.Types.DeleteQuickResponseResponse) => void): Request<QConnect.Types.DeleteQuickResponseResponse, AWSError>;
|
106
|
+
/**
|
107
|
+
* Deletes a quick response.
|
108
|
+
*/
|
109
|
+
deleteQuickResponse(callback?: (err: AWSError, data: QConnect.Types.DeleteQuickResponseResponse) => void): Request<QConnect.Types.DeleteQuickResponseResponse, AWSError>;
|
110
|
+
/**
|
111
|
+
* Retrieves information about an assistant.
|
112
|
+
*/
|
113
|
+
getAssistant(params: QConnect.Types.GetAssistantRequest, callback?: (err: AWSError, data: QConnect.Types.GetAssistantResponse) => void): Request<QConnect.Types.GetAssistantResponse, AWSError>;
|
114
|
+
/**
|
115
|
+
* Retrieves information about an assistant.
|
116
|
+
*/
|
117
|
+
getAssistant(callback?: (err: AWSError, data: QConnect.Types.GetAssistantResponse) => void): Request<QConnect.Types.GetAssistantResponse, AWSError>;
|
118
|
+
/**
|
119
|
+
* Retrieves information about an assistant association.
|
120
|
+
*/
|
121
|
+
getAssistantAssociation(params: QConnect.Types.GetAssistantAssociationRequest, callback?: (err: AWSError, data: QConnect.Types.GetAssistantAssociationResponse) => void): Request<QConnect.Types.GetAssistantAssociationResponse, AWSError>;
|
122
|
+
/**
|
123
|
+
* Retrieves information about an assistant association.
|
124
|
+
*/
|
125
|
+
getAssistantAssociation(callback?: (err: AWSError, data: QConnect.Types.GetAssistantAssociationResponse) => void): Request<QConnect.Types.GetAssistantAssociationResponse, AWSError>;
|
126
|
+
/**
|
127
|
+
* Retrieves content, including a pre-signed URL to download the content.
|
128
|
+
*/
|
129
|
+
getContent(params: QConnect.Types.GetContentRequest, callback?: (err: AWSError, data: QConnect.Types.GetContentResponse) => void): Request<QConnect.Types.GetContentResponse, AWSError>;
|
130
|
+
/**
|
131
|
+
* Retrieves content, including a pre-signed URL to download the content.
|
132
|
+
*/
|
133
|
+
getContent(callback?: (err: AWSError, data: QConnect.Types.GetContentResponse) => void): Request<QConnect.Types.GetContentResponse, AWSError>;
|
134
|
+
/**
|
135
|
+
* Retrieves summary information about the content.
|
136
|
+
*/
|
137
|
+
getContentSummary(params: QConnect.Types.GetContentSummaryRequest, callback?: (err: AWSError, data: QConnect.Types.GetContentSummaryResponse) => void): Request<QConnect.Types.GetContentSummaryResponse, AWSError>;
|
138
|
+
/**
|
139
|
+
* Retrieves summary information about the content.
|
140
|
+
*/
|
141
|
+
getContentSummary(callback?: (err: AWSError, data: QConnect.Types.GetContentSummaryResponse) => void): Request<QConnect.Types.GetContentSummaryResponse, AWSError>;
|
142
|
+
/**
|
143
|
+
* Retrieves the started import job.
|
144
|
+
*/
|
145
|
+
getImportJob(params: QConnect.Types.GetImportJobRequest, callback?: (err: AWSError, data: QConnect.Types.GetImportJobResponse) => void): Request<QConnect.Types.GetImportJobResponse, AWSError>;
|
146
|
+
/**
|
147
|
+
* Retrieves the started import job.
|
148
|
+
*/
|
149
|
+
getImportJob(callback?: (err: AWSError, data: QConnect.Types.GetImportJobResponse) => void): Request<QConnect.Types.GetImportJobResponse, AWSError>;
|
150
|
+
/**
|
151
|
+
* Retrieves information about the knowledge base.
|
152
|
+
*/
|
153
|
+
getKnowledgeBase(params: QConnect.Types.GetKnowledgeBaseRequest, callback?: (err: AWSError, data: QConnect.Types.GetKnowledgeBaseResponse) => void): Request<QConnect.Types.GetKnowledgeBaseResponse, AWSError>;
|
154
|
+
/**
|
155
|
+
* Retrieves information about the knowledge base.
|
156
|
+
*/
|
157
|
+
getKnowledgeBase(callback?: (err: AWSError, data: QConnect.Types.GetKnowledgeBaseResponse) => void): Request<QConnect.Types.GetKnowledgeBaseResponse, AWSError>;
|
158
|
+
/**
|
159
|
+
* Retrieves the quick response.
|
160
|
+
*/
|
161
|
+
getQuickResponse(params: QConnect.Types.GetQuickResponseRequest, callback?: (err: AWSError, data: QConnect.Types.GetQuickResponseResponse) => void): Request<QConnect.Types.GetQuickResponseResponse, AWSError>;
|
162
|
+
/**
|
163
|
+
* Retrieves the quick response.
|
164
|
+
*/
|
165
|
+
getQuickResponse(callback?: (err: AWSError, data: QConnect.Types.GetQuickResponseResponse) => void): Request<QConnect.Types.GetQuickResponseResponse, AWSError>;
|
166
|
+
/**
|
167
|
+
* 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.
|
168
|
+
*/
|
169
|
+
getRecommendations(params: QConnect.Types.GetRecommendationsRequest, callback?: (err: AWSError, data: QConnect.Types.GetRecommendationsResponse) => void): Request<QConnect.Types.GetRecommendationsResponse, AWSError>;
|
170
|
+
/**
|
171
|
+
* 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.
|
172
|
+
*/
|
173
|
+
getRecommendations(callback?: (err: AWSError, data: QConnect.Types.GetRecommendationsResponse) => void): Request<QConnect.Types.GetRecommendationsResponse, AWSError>;
|
174
|
+
/**
|
175
|
+
* Retrieves information for a specified session.
|
176
|
+
*/
|
177
|
+
getSession(params: QConnect.Types.GetSessionRequest, callback?: (err: AWSError, data: QConnect.Types.GetSessionResponse) => void): Request<QConnect.Types.GetSessionResponse, AWSError>;
|
178
|
+
/**
|
179
|
+
* Retrieves information for a specified session.
|
180
|
+
*/
|
181
|
+
getSession(callback?: (err: AWSError, data: QConnect.Types.GetSessionResponse) => void): Request<QConnect.Types.GetSessionResponse, AWSError>;
|
182
|
+
/**
|
183
|
+
* Lists information about assistant associations.
|
184
|
+
*/
|
185
|
+
listAssistantAssociations(params: QConnect.Types.ListAssistantAssociationsRequest, callback?: (err: AWSError, data: QConnect.Types.ListAssistantAssociationsResponse) => void): Request<QConnect.Types.ListAssistantAssociationsResponse, AWSError>;
|
186
|
+
/**
|
187
|
+
* Lists information about assistant associations.
|
188
|
+
*/
|
189
|
+
listAssistantAssociations(callback?: (err: AWSError, data: QConnect.Types.ListAssistantAssociationsResponse) => void): Request<QConnect.Types.ListAssistantAssociationsResponse, AWSError>;
|
190
|
+
/**
|
191
|
+
* Lists information about assistants.
|
192
|
+
*/
|
193
|
+
listAssistants(params: QConnect.Types.ListAssistantsRequest, callback?: (err: AWSError, data: QConnect.Types.ListAssistantsResponse) => void): Request<QConnect.Types.ListAssistantsResponse, AWSError>;
|
194
|
+
/**
|
195
|
+
* Lists information about assistants.
|
196
|
+
*/
|
197
|
+
listAssistants(callback?: (err: AWSError, data: QConnect.Types.ListAssistantsResponse) => void): Request<QConnect.Types.ListAssistantsResponse, AWSError>;
|
198
|
+
/**
|
199
|
+
* Lists the content.
|
200
|
+
*/
|
201
|
+
listContents(params: QConnect.Types.ListContentsRequest, callback?: (err: AWSError, data: QConnect.Types.ListContentsResponse) => void): Request<QConnect.Types.ListContentsResponse, AWSError>;
|
202
|
+
/**
|
203
|
+
* Lists the content.
|
204
|
+
*/
|
205
|
+
listContents(callback?: (err: AWSError, data: QConnect.Types.ListContentsResponse) => void): Request<QConnect.Types.ListContentsResponse, AWSError>;
|
206
|
+
/**
|
207
|
+
* Lists information about import jobs.
|
208
|
+
*/
|
209
|
+
listImportJobs(params: QConnect.Types.ListImportJobsRequest, callback?: (err: AWSError, data: QConnect.Types.ListImportJobsResponse) => void): Request<QConnect.Types.ListImportJobsResponse, AWSError>;
|
210
|
+
/**
|
211
|
+
* Lists information about import jobs.
|
212
|
+
*/
|
213
|
+
listImportJobs(callback?: (err: AWSError, data: QConnect.Types.ListImportJobsResponse) => void): Request<QConnect.Types.ListImportJobsResponse, AWSError>;
|
214
|
+
/**
|
215
|
+
* Lists the knowledge bases.
|
216
|
+
*/
|
217
|
+
listKnowledgeBases(params: QConnect.Types.ListKnowledgeBasesRequest, callback?: (err: AWSError, data: QConnect.Types.ListKnowledgeBasesResponse) => void): Request<QConnect.Types.ListKnowledgeBasesResponse, AWSError>;
|
218
|
+
/**
|
219
|
+
* Lists the knowledge bases.
|
220
|
+
*/
|
221
|
+
listKnowledgeBases(callback?: (err: AWSError, data: QConnect.Types.ListKnowledgeBasesResponse) => void): Request<QConnect.Types.ListKnowledgeBasesResponse, AWSError>;
|
222
|
+
/**
|
223
|
+
* Lists information about quick response.
|
224
|
+
*/
|
225
|
+
listQuickResponses(params: QConnect.Types.ListQuickResponsesRequest, callback?: (err: AWSError, data: QConnect.Types.ListQuickResponsesResponse) => void): Request<QConnect.Types.ListQuickResponsesResponse, AWSError>;
|
226
|
+
/**
|
227
|
+
* Lists information about quick response.
|
228
|
+
*/
|
229
|
+
listQuickResponses(callback?: (err: AWSError, data: QConnect.Types.ListQuickResponsesResponse) => void): Request<QConnect.Types.ListQuickResponsesResponse, AWSError>;
|
230
|
+
/**
|
231
|
+
* Lists the tags for the specified resource.
|
232
|
+
*/
|
233
|
+
listTagsForResource(params: QConnect.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: QConnect.Types.ListTagsForResourceResponse) => void): Request<QConnect.Types.ListTagsForResourceResponse, AWSError>;
|
234
|
+
/**
|
235
|
+
* Lists the tags for the specified resource.
|
236
|
+
*/
|
237
|
+
listTagsForResource(callback?: (err: AWSError, data: QConnect.Types.ListTagsForResourceResponse) => void): Request<QConnect.Types.ListTagsForResourceResponse, AWSError>;
|
238
|
+
/**
|
239
|
+
* 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.
|
240
|
+
*/
|
241
|
+
notifyRecommendationsReceived(params: QConnect.Types.NotifyRecommendationsReceivedRequest, callback?: (err: AWSError, data: QConnect.Types.NotifyRecommendationsReceivedResponse) => void): Request<QConnect.Types.NotifyRecommendationsReceivedResponse, AWSError>;
|
242
|
+
/**
|
243
|
+
* 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.
|
244
|
+
*/
|
245
|
+
notifyRecommendationsReceived(callback?: (err: AWSError, data: QConnect.Types.NotifyRecommendationsReceivedResponse) => void): Request<QConnect.Types.NotifyRecommendationsReceivedResponse, AWSError>;
|
246
|
+
/**
|
247
|
+
* Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
|
248
|
+
*/
|
249
|
+
queryAssistant(params: QConnect.Types.QueryAssistantRequest, callback?: (err: AWSError, data: QConnect.Types.QueryAssistantResponse) => void): Request<QConnect.Types.QueryAssistantResponse, AWSError>;
|
250
|
+
/**
|
251
|
+
* Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
|
252
|
+
*/
|
253
|
+
queryAssistant(callback?: (err: AWSError, data: QConnect.Types.QueryAssistantResponse) => void): Request<QConnect.Types.QueryAssistantResponse, AWSError>;
|
254
|
+
/**
|
255
|
+
* Removes a URI template from a knowledge base.
|
256
|
+
*/
|
257
|
+
removeKnowledgeBaseTemplateUri(params: QConnect.Types.RemoveKnowledgeBaseTemplateUriRequest, callback?: (err: AWSError, data: QConnect.Types.RemoveKnowledgeBaseTemplateUriResponse) => void): Request<QConnect.Types.RemoveKnowledgeBaseTemplateUriResponse, AWSError>;
|
258
|
+
/**
|
259
|
+
* Removes a URI template from a knowledge base.
|
260
|
+
*/
|
261
|
+
removeKnowledgeBaseTemplateUri(callback?: (err: AWSError, data: QConnect.Types.RemoveKnowledgeBaseTemplateUriResponse) => void): Request<QConnect.Types.RemoveKnowledgeBaseTemplateUriResponse, AWSError>;
|
262
|
+
/**
|
263
|
+
* Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
|
264
|
+
*/
|
265
|
+
searchContent(params: QConnect.Types.SearchContentRequest, callback?: (err: AWSError, data: QConnect.Types.SearchContentResponse) => void): Request<QConnect.Types.SearchContentResponse, AWSError>;
|
266
|
+
/**
|
267
|
+
* Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
|
268
|
+
*/
|
269
|
+
searchContent(callback?: (err: AWSError, data: QConnect.Types.SearchContentResponse) => void): Request<QConnect.Types.SearchContentResponse, AWSError>;
|
270
|
+
/**
|
271
|
+
* Searches existing Amazon Q quick responses in a Amazon Q knowledge base.
|
272
|
+
*/
|
273
|
+
searchQuickResponses(params: QConnect.Types.SearchQuickResponsesRequest, callback?: (err: AWSError, data: QConnect.Types.SearchQuickResponsesResponse) => void): Request<QConnect.Types.SearchQuickResponsesResponse, AWSError>;
|
274
|
+
/**
|
275
|
+
* Searches existing Amazon Q quick responses in a Amazon Q knowledge base.
|
276
|
+
*/
|
277
|
+
searchQuickResponses(callback?: (err: AWSError, data: QConnect.Types.SearchQuickResponsesResponse) => void): Request<QConnect.Types.SearchQuickResponsesResponse, AWSError>;
|
278
|
+
/**
|
279
|
+
* Searches for sessions.
|
280
|
+
*/
|
281
|
+
searchSessions(params: QConnect.Types.SearchSessionsRequest, callback?: (err: AWSError, data: QConnect.Types.SearchSessionsResponse) => void): Request<QConnect.Types.SearchSessionsResponse, AWSError>;
|
282
|
+
/**
|
283
|
+
* Searches for sessions.
|
284
|
+
*/
|
285
|
+
searchSessions(callback?: (err: AWSError, data: QConnect.Types.SearchSessionsResponse) => void): Request<QConnect.Types.SearchSessionsResponse, AWSError>;
|
286
|
+
/**
|
287
|
+
* 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.
|
288
|
+
*/
|
289
|
+
startContentUpload(params: QConnect.Types.StartContentUploadRequest, callback?: (err: AWSError, data: QConnect.Types.StartContentUploadResponse) => void): Request<QConnect.Types.StartContentUploadResponse, AWSError>;
|
290
|
+
/**
|
291
|
+
* 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.
|
292
|
+
*/
|
293
|
+
startContentUpload(callback?: (err: AWSError, data: QConnect.Types.StartContentUploadResponse) => void): Request<QConnect.Types.StartContentUploadResponse, AWSError>;
|
294
|
+
/**
|
295
|
+
* Start an asynchronous job to import Amazon Q 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 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.
|
296
|
+
*/
|
297
|
+
startImportJob(params: QConnect.Types.StartImportJobRequest, callback?: (err: AWSError, data: QConnect.Types.StartImportJobResponse) => void): Request<QConnect.Types.StartImportJobResponse, AWSError>;
|
298
|
+
/**
|
299
|
+
* Start an asynchronous job to import Amazon Q 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 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.
|
300
|
+
*/
|
301
|
+
startImportJob(callback?: (err: AWSError, data: QConnect.Types.StartImportJobResponse) => void): Request<QConnect.Types.StartImportJobResponse, AWSError>;
|
302
|
+
/**
|
303
|
+
* Adds the specified tags to the specified resource.
|
304
|
+
*/
|
305
|
+
tagResource(params: QConnect.Types.TagResourceRequest, callback?: (err: AWSError, data: QConnect.Types.TagResourceResponse) => void): Request<QConnect.Types.TagResourceResponse, AWSError>;
|
306
|
+
/**
|
307
|
+
* Adds the specified tags to the specified resource.
|
308
|
+
*/
|
309
|
+
tagResource(callback?: (err: AWSError, data: QConnect.Types.TagResourceResponse) => void): Request<QConnect.Types.TagResourceResponse, AWSError>;
|
310
|
+
/**
|
311
|
+
* Removes the specified tags from the specified resource.
|
312
|
+
*/
|
313
|
+
untagResource(params: QConnect.Types.UntagResourceRequest, callback?: (err: AWSError, data: QConnect.Types.UntagResourceResponse) => void): Request<QConnect.Types.UntagResourceResponse, AWSError>;
|
314
|
+
/**
|
315
|
+
* Removes the specified tags from the specified resource.
|
316
|
+
*/
|
317
|
+
untagResource(callback?: (err: AWSError, data: QConnect.Types.UntagResourceResponse) => void): Request<QConnect.Types.UntagResourceResponse, AWSError>;
|
318
|
+
/**
|
319
|
+
* Updates information about the content.
|
320
|
+
*/
|
321
|
+
updateContent(params: QConnect.Types.UpdateContentRequest, callback?: (err: AWSError, data: QConnect.Types.UpdateContentResponse) => void): Request<QConnect.Types.UpdateContentResponse, AWSError>;
|
322
|
+
/**
|
323
|
+
* Updates information about the content.
|
324
|
+
*/
|
325
|
+
updateContent(callback?: (err: AWSError, data: QConnect.Types.UpdateContentResponse) => void): Request<QConnect.Types.UpdateContentResponse, AWSError>;
|
326
|
+
/**
|
327
|
+
* 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 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.
|
328
|
+
*/
|
329
|
+
updateKnowledgeBaseTemplateUri(params: QConnect.Types.UpdateKnowledgeBaseTemplateUriRequest, callback?: (err: AWSError, data: QConnect.Types.UpdateKnowledgeBaseTemplateUriResponse) => void): Request<QConnect.Types.UpdateKnowledgeBaseTemplateUriResponse, AWSError>;
|
330
|
+
/**
|
331
|
+
* 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 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.
|
332
|
+
*/
|
333
|
+
updateKnowledgeBaseTemplateUri(callback?: (err: AWSError, data: QConnect.Types.UpdateKnowledgeBaseTemplateUriResponse) => void): Request<QConnect.Types.UpdateKnowledgeBaseTemplateUriResponse, AWSError>;
|
334
|
+
/**
|
335
|
+
* Updates an existing Amazon Q quick response.
|
336
|
+
*/
|
337
|
+
updateQuickResponse(params: QConnect.Types.UpdateQuickResponseRequest, callback?: (err: AWSError, data: QConnect.Types.UpdateQuickResponseResponse) => void): Request<QConnect.Types.UpdateQuickResponseResponse, AWSError>;
|
338
|
+
/**
|
339
|
+
* Updates an existing Amazon Q quick response.
|
340
|
+
*/
|
341
|
+
updateQuickResponse(callback?: (err: AWSError, data: QConnect.Types.UpdateQuickResponseResponse) => void): Request<QConnect.Types.UpdateQuickResponseResponse, AWSError>;
|
342
|
+
}
|
343
|
+
declare namespace QConnect {
|
344
|
+
export interface AppIntegrationsConfiguration {
|
345
|
+
/**
|
346
|
+
* 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.
|
347
|
+
*/
|
348
|
+
appIntegrationArn: GenericArn;
|
349
|
+
/**
|
350
|
+
* The fields from the source that are made available to your agents in Amazon Q. 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.
|
351
|
+
*/
|
352
|
+
objectFields?: ObjectFieldsList;
|
353
|
+
}
|
354
|
+
export type Arn = string;
|
355
|
+
export interface AssistantAssociationData {
|
356
|
+
/**
|
357
|
+
* The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
358
|
+
*/
|
359
|
+
assistantArn: Arn;
|
360
|
+
/**
|
361
|
+
* The Amazon Resource Name (ARN) of the assistant association.
|
362
|
+
*/
|
363
|
+
assistantAssociationArn: Arn;
|
364
|
+
/**
|
365
|
+
* The identifier of the assistant association.
|
366
|
+
*/
|
367
|
+
assistantAssociationId: Uuid;
|
368
|
+
/**
|
369
|
+
* The identifier of the Amazon Q assistant.
|
370
|
+
*/
|
371
|
+
assistantId: Uuid;
|
372
|
+
/**
|
373
|
+
* A union type that currently has a single argument, the knowledge base ID.
|
374
|
+
*/
|
375
|
+
associationData: AssistantAssociationOutputData;
|
376
|
+
/**
|
377
|
+
* The type of association.
|
378
|
+
*/
|
379
|
+
associationType: AssociationType;
|
380
|
+
/**
|
381
|
+
* The tags used to organize, track, or control access for this resource.
|
382
|
+
*/
|
383
|
+
tags?: Tags;
|
384
|
+
}
|
385
|
+
export interface AssistantAssociationInputData {
|
386
|
+
/**
|
387
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
388
|
+
*/
|
389
|
+
knowledgeBaseId?: Uuid;
|
390
|
+
}
|
391
|
+
export interface AssistantAssociationOutputData {
|
392
|
+
/**
|
393
|
+
* The knowledge base where output data is sent.
|
394
|
+
*/
|
395
|
+
knowledgeBaseAssociation?: KnowledgeBaseAssociationData;
|
396
|
+
}
|
397
|
+
export interface AssistantAssociationSummary {
|
398
|
+
/**
|
399
|
+
* The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
400
|
+
*/
|
401
|
+
assistantArn: Arn;
|
402
|
+
/**
|
403
|
+
* The Amazon Resource Name (ARN) of the assistant association.
|
404
|
+
*/
|
405
|
+
assistantAssociationArn: Arn;
|
406
|
+
/**
|
407
|
+
* The identifier of the assistant association.
|
408
|
+
*/
|
409
|
+
assistantAssociationId: Uuid;
|
410
|
+
/**
|
411
|
+
* The identifier of the Amazon Q assistant.
|
412
|
+
*/
|
413
|
+
assistantId: Uuid;
|
414
|
+
/**
|
415
|
+
* The association data.
|
416
|
+
*/
|
417
|
+
associationData: AssistantAssociationOutputData;
|
418
|
+
/**
|
419
|
+
* The type of association.
|
420
|
+
*/
|
421
|
+
associationType: AssociationType;
|
422
|
+
/**
|
423
|
+
* The tags used to organize, track, or control access for this resource.
|
424
|
+
*/
|
425
|
+
tags?: Tags;
|
426
|
+
}
|
427
|
+
export type AssistantAssociationSummaryList = AssistantAssociationSummary[];
|
428
|
+
export interface AssistantCapabilityConfiguration {
|
429
|
+
/**
|
430
|
+
* The type of Amazon Q assistant capability.
|
431
|
+
*/
|
432
|
+
type?: AssistantCapabilityType;
|
433
|
+
}
|
434
|
+
export type AssistantCapabilityType = "V1"|"V2"|string;
|
435
|
+
export interface AssistantData {
|
436
|
+
/**
|
437
|
+
* The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
438
|
+
*/
|
439
|
+
assistantArn: Arn;
|
440
|
+
/**
|
441
|
+
* The identifier of the Amazon Q assistant.
|
442
|
+
*/
|
443
|
+
assistantId: Uuid;
|
444
|
+
/**
|
445
|
+
* The configuration information for the Amazon Q assistant capability.
|
446
|
+
*/
|
447
|
+
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
448
|
+
/**
|
449
|
+
* The description.
|
450
|
+
*/
|
451
|
+
description?: Description;
|
452
|
+
/**
|
453
|
+
* The configuration information for the Amazon Q assistant integration.
|
454
|
+
*/
|
455
|
+
integrationConfiguration?: AssistantIntegrationConfiguration;
|
456
|
+
/**
|
457
|
+
* The name.
|
458
|
+
*/
|
459
|
+
name: Name;
|
460
|
+
/**
|
461
|
+
* 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. To use Amazon Q 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, see Enable Amazon Q in Connect for your instance.
|
462
|
+
*/
|
463
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
464
|
+
/**
|
465
|
+
* The status of the assistant.
|
466
|
+
*/
|
467
|
+
status: AssistantStatus;
|
468
|
+
/**
|
469
|
+
* The tags used to organize, track, or control access for this resource.
|
470
|
+
*/
|
471
|
+
tags?: Tags;
|
472
|
+
/**
|
473
|
+
* The type of assistant.
|
474
|
+
*/
|
475
|
+
type: AssistantType;
|
476
|
+
}
|
477
|
+
export interface AssistantIntegrationConfiguration {
|
478
|
+
/**
|
479
|
+
* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
|
480
|
+
*/
|
481
|
+
topicIntegrationArn?: GenericArn;
|
482
|
+
}
|
483
|
+
export type AssistantList = AssistantSummary[];
|
484
|
+
export type AssistantStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|string;
|
485
|
+
export interface AssistantSummary {
|
486
|
+
/**
|
487
|
+
* The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
488
|
+
*/
|
489
|
+
assistantArn: Arn;
|
490
|
+
/**
|
491
|
+
* The identifier of the Amazon Q assistant.
|
492
|
+
*/
|
493
|
+
assistantId: Uuid;
|
494
|
+
/**
|
495
|
+
* The configuration information for the Amazon Q assistant capability.
|
496
|
+
*/
|
497
|
+
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
498
|
+
/**
|
499
|
+
* The description of the assistant.
|
500
|
+
*/
|
501
|
+
description?: Description;
|
502
|
+
/**
|
503
|
+
* The configuration information for the Amazon Q assistant integration.
|
504
|
+
*/
|
505
|
+
integrationConfiguration?: AssistantIntegrationConfiguration;
|
506
|
+
/**
|
507
|
+
* The name of the assistant.
|
508
|
+
*/
|
509
|
+
name: Name;
|
510
|
+
/**
|
511
|
+
* 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. To use Amazon Q 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, see Enable Amazon Q in Connect for your instance.
|
512
|
+
*/
|
513
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
514
|
+
/**
|
515
|
+
* The status of the assistant.
|
516
|
+
*/
|
517
|
+
status: AssistantStatus;
|
518
|
+
/**
|
519
|
+
* The tags used to organize, track, or control access for this resource.
|
520
|
+
*/
|
521
|
+
tags?: Tags;
|
522
|
+
/**
|
523
|
+
* The type of the assistant.
|
524
|
+
*/
|
525
|
+
type: AssistantType;
|
526
|
+
}
|
527
|
+
export type AssistantType = "AGENT"|string;
|
528
|
+
export type AssociationType = "KNOWLEDGE_BASE"|string;
|
529
|
+
export type Boolean = boolean;
|
530
|
+
export type Channel = string;
|
531
|
+
export type Channels = Channel[];
|
532
|
+
export type ClientToken = string;
|
533
|
+
export interface Configuration {
|
534
|
+
/**
|
535
|
+
* The configuration information of the Amazon Connect data source.
|
536
|
+
*/
|
537
|
+
connectConfiguration?: ConnectConfiguration;
|
538
|
+
}
|
539
|
+
export interface ConnectConfiguration {
|
540
|
+
/**
|
541
|
+
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
|
542
|
+
*/
|
543
|
+
instanceId?: NonEmptyString;
|
544
|
+
}
|
545
|
+
export type ContactAttributeKey = string;
|
546
|
+
export type ContactAttributeKeys = ContactAttributeKey[];
|
547
|
+
export type ContactAttributeValue = string;
|
548
|
+
export type ContactAttributes = {[key: string]: ContactAttributeValue};
|
549
|
+
export interface ContentData {
|
550
|
+
/**
|
551
|
+
* The Amazon Resource Name (ARN) of the content.
|
552
|
+
*/
|
553
|
+
contentArn: Arn;
|
554
|
+
/**
|
555
|
+
* The identifier of the content.
|
556
|
+
*/
|
557
|
+
contentId: Uuid;
|
558
|
+
/**
|
559
|
+
* The media type of the content.
|
560
|
+
*/
|
561
|
+
contentType: ContentType;
|
562
|
+
/**
|
563
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
564
|
+
*/
|
565
|
+
knowledgeBaseArn: Arn;
|
566
|
+
/**
|
567
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
568
|
+
*/
|
569
|
+
knowledgeBaseId: Uuid;
|
570
|
+
/**
|
571
|
+
* The URI of the content.
|
572
|
+
*/
|
573
|
+
linkOutUri?: Uri;
|
574
|
+
/**
|
575
|
+
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.
|
576
|
+
*/
|
577
|
+
metadata: ContentMetadata;
|
578
|
+
/**
|
579
|
+
* The name of the content.
|
580
|
+
*/
|
581
|
+
name: Name;
|
582
|
+
/**
|
583
|
+
* The identifier of the content revision.
|
584
|
+
*/
|
585
|
+
revisionId: NonEmptyString;
|
586
|
+
/**
|
587
|
+
* The status of the content.
|
588
|
+
*/
|
589
|
+
status: ContentStatus;
|
590
|
+
/**
|
591
|
+
* The tags used to organize, track, or control access for this resource.
|
592
|
+
*/
|
593
|
+
tags?: Tags;
|
594
|
+
/**
|
595
|
+
* The title of the content.
|
596
|
+
*/
|
597
|
+
title: ContentTitle;
|
598
|
+
/**
|
599
|
+
* The URL of the content.
|
600
|
+
*/
|
601
|
+
url: Url;
|
602
|
+
/**
|
603
|
+
* The expiration time of the URL as an epoch timestamp.
|
604
|
+
*/
|
605
|
+
urlExpiry: SyntheticTimestamp_epoch_seconds;
|
606
|
+
}
|
607
|
+
export interface ContentDataDetails {
|
608
|
+
/**
|
609
|
+
* Details about the content ranking data.
|
610
|
+
*/
|
611
|
+
rankingData: RankingData;
|
612
|
+
/**
|
613
|
+
* Details about the content text data.
|
614
|
+
*/
|
615
|
+
textData: TextData;
|
616
|
+
}
|
617
|
+
export type ContentMetadata = {[key: string]: NonEmptyString};
|
618
|
+
export interface ContentReference {
|
619
|
+
/**
|
620
|
+
* The Amazon Resource Name (ARN) of the content.
|
621
|
+
*/
|
622
|
+
contentArn?: Arn;
|
623
|
+
/**
|
624
|
+
* The identifier of the content.
|
625
|
+
*/
|
626
|
+
contentId?: Uuid;
|
627
|
+
/**
|
628
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
629
|
+
*/
|
630
|
+
knowledgeBaseArn?: Arn;
|
631
|
+
/**
|
632
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
633
|
+
*/
|
634
|
+
knowledgeBaseId?: Uuid;
|
635
|
+
}
|
636
|
+
export type ContentStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|"UPDATE_FAILED"|string;
|
637
|
+
export interface ContentSummary {
|
638
|
+
/**
|
639
|
+
* The Amazon Resource Name (ARN) of the content.
|
640
|
+
*/
|
641
|
+
contentArn: Arn;
|
642
|
+
/**
|
643
|
+
* The identifier of the content.
|
644
|
+
*/
|
645
|
+
contentId: Uuid;
|
646
|
+
/**
|
647
|
+
* The media type of the content.
|
648
|
+
*/
|
649
|
+
contentType: ContentType;
|
650
|
+
/**
|
651
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
652
|
+
*/
|
653
|
+
knowledgeBaseArn: Arn;
|
654
|
+
/**
|
655
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
656
|
+
*/
|
657
|
+
knowledgeBaseId: Uuid;
|
658
|
+
/**
|
659
|
+
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.
|
660
|
+
*/
|
661
|
+
metadata: ContentMetadata;
|
662
|
+
/**
|
663
|
+
* The name of the content.
|
664
|
+
*/
|
665
|
+
name: Name;
|
666
|
+
/**
|
667
|
+
* The identifier of the revision of the content.
|
668
|
+
*/
|
669
|
+
revisionId: NonEmptyString;
|
670
|
+
/**
|
671
|
+
* The status of the content.
|
672
|
+
*/
|
673
|
+
status: ContentStatus;
|
674
|
+
/**
|
675
|
+
* The tags used to organize, track, or control access for this resource.
|
676
|
+
*/
|
677
|
+
tags?: Tags;
|
678
|
+
/**
|
679
|
+
* The title of the content.
|
680
|
+
*/
|
681
|
+
title: ContentTitle;
|
682
|
+
}
|
683
|
+
export type ContentSummaryList = ContentSummary[];
|
684
|
+
export type ContentTitle = string;
|
685
|
+
export type ContentType = string;
|
686
|
+
export interface CreateAssistantAssociationRequest {
|
687
|
+
/**
|
688
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
689
|
+
*/
|
690
|
+
assistantId: UuidOrArn;
|
691
|
+
/**
|
692
|
+
* The identifier of the associated resource.
|
693
|
+
*/
|
694
|
+
association: AssistantAssociationInputData;
|
695
|
+
/**
|
696
|
+
* The type of association.
|
697
|
+
*/
|
698
|
+
associationType: AssociationType;
|
699
|
+
/**
|
700
|
+
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
|
701
|
+
*/
|
702
|
+
clientToken?: ClientToken;
|
703
|
+
/**
|
704
|
+
* The tags used to organize, track, or control access for this resource.
|
705
|
+
*/
|
706
|
+
tags?: Tags;
|
707
|
+
}
|
708
|
+
export interface CreateAssistantAssociationResponse {
|
709
|
+
/**
|
710
|
+
* The assistant association.
|
711
|
+
*/
|
712
|
+
assistantAssociation?: AssistantAssociationData;
|
713
|
+
}
|
714
|
+
export interface CreateAssistantRequest {
|
715
|
+
/**
|
716
|
+
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
|
717
|
+
*/
|
718
|
+
clientToken?: ClientToken;
|
719
|
+
/**
|
720
|
+
* The description of the assistant.
|
721
|
+
*/
|
722
|
+
description?: Description;
|
723
|
+
/**
|
724
|
+
* The name of the assistant.
|
725
|
+
*/
|
726
|
+
name: Name;
|
727
|
+
/**
|
728
|
+
* The configuration information for the customer managed key used for encryption. The customer managed 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. To use Amazon Q 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, see Enable Amazon Q in Connect for your instance.
|
729
|
+
*/
|
730
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
731
|
+
/**
|
732
|
+
* The tags used to organize, track, or control access for this resource.
|
733
|
+
*/
|
734
|
+
tags?: Tags;
|
735
|
+
/**
|
736
|
+
* The type of assistant.
|
737
|
+
*/
|
738
|
+
type: AssistantType;
|
739
|
+
}
|
740
|
+
export interface CreateAssistantResponse {
|
741
|
+
/**
|
742
|
+
* Information about the assistant.
|
743
|
+
*/
|
744
|
+
assistant?: AssistantData;
|
745
|
+
}
|
746
|
+
export interface CreateContentRequest {
|
747
|
+
/**
|
748
|
+
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
|
749
|
+
*/
|
750
|
+
clientToken?: NonEmptyString;
|
751
|
+
/**
|
752
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
753
|
+
*/
|
754
|
+
knowledgeBaseId: UuidOrArn;
|
755
|
+
/**
|
756
|
+
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.
|
757
|
+
*/
|
758
|
+
metadata?: ContentMetadata;
|
759
|
+
/**
|
760
|
+
* The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
|
761
|
+
*/
|
762
|
+
name: Name;
|
763
|
+
/**
|
764
|
+
* The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
|
765
|
+
*/
|
766
|
+
overrideLinkOutUri?: Uri;
|
767
|
+
/**
|
768
|
+
* The tags used to organize, track, or control access for this resource.
|
769
|
+
*/
|
770
|
+
tags?: Tags;
|
771
|
+
/**
|
772
|
+
* The title of the content. If not set, the title is equal to the name.
|
773
|
+
*/
|
774
|
+
title?: ContentTitle;
|
775
|
+
/**
|
776
|
+
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
|
777
|
+
*/
|
778
|
+
uploadId: UploadId;
|
779
|
+
}
|
780
|
+
export interface CreateContentResponse {
|
781
|
+
/**
|
782
|
+
* The content.
|
783
|
+
*/
|
784
|
+
content?: ContentData;
|
785
|
+
}
|
786
|
+
export interface CreateKnowledgeBaseRequest {
|
787
|
+
/**
|
788
|
+
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
|
789
|
+
*/
|
790
|
+
clientToken?: NonEmptyString;
|
791
|
+
/**
|
792
|
+
* The description.
|
793
|
+
*/
|
794
|
+
description?: Description;
|
795
|
+
/**
|
796
|
+
* The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
|
797
|
+
*/
|
798
|
+
knowledgeBaseType: KnowledgeBaseType;
|
799
|
+
/**
|
800
|
+
* The name of the knowledge base.
|
801
|
+
*/
|
802
|
+
name: Name;
|
803
|
+
/**
|
804
|
+
* Information about how to render the content.
|
805
|
+
*/
|
806
|
+
renderingConfiguration?: RenderingConfiguration;
|
807
|
+
/**
|
808
|
+
* 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. For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.
|
809
|
+
*/
|
810
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
811
|
+
/**
|
812
|
+
* The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
|
813
|
+
*/
|
814
|
+
sourceConfiguration?: SourceConfiguration;
|
815
|
+
/**
|
816
|
+
* The tags used to organize, track, or control access for this resource.
|
817
|
+
*/
|
818
|
+
tags?: Tags;
|
819
|
+
}
|
820
|
+
export interface CreateKnowledgeBaseResponse {
|
821
|
+
/**
|
822
|
+
* The knowledge base.
|
823
|
+
*/
|
824
|
+
knowledgeBase?: KnowledgeBaseData;
|
825
|
+
}
|
826
|
+
export interface CreateQuickResponseRequest {
|
827
|
+
/**
|
828
|
+
* The Amazon Connect channels this quick response applies to.
|
829
|
+
*/
|
830
|
+
channels?: Channels;
|
831
|
+
/**
|
832
|
+
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
|
833
|
+
*/
|
834
|
+
clientToken?: NonEmptyString;
|
835
|
+
/**
|
836
|
+
* The content of the quick response.
|
837
|
+
*/
|
838
|
+
content: QuickResponseDataProvider;
|
839
|
+
/**
|
840
|
+
* The media type of the quick response content. Use application/x.quickresponse;format=plain for a quick response written in plain text. Use application/x.quickresponse;format=markdown for a quick response written in richtext.
|
841
|
+
*/
|
842
|
+
contentType?: QuickResponseType;
|
843
|
+
/**
|
844
|
+
* The description of the quick response.
|
845
|
+
*/
|
846
|
+
description?: QuickResponseDescription;
|
847
|
+
/**
|
848
|
+
* The configuration information of the user groups that the quick response is accessible to.
|
849
|
+
*/
|
850
|
+
groupingConfiguration?: GroupingConfiguration;
|
851
|
+
/**
|
852
|
+
* Whether the quick response is active.
|
853
|
+
*/
|
854
|
+
isActive?: Boolean;
|
855
|
+
/**
|
856
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
857
|
+
*/
|
858
|
+
knowledgeBaseId: UuidOrArn;
|
859
|
+
/**
|
860
|
+
* The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
|
861
|
+
*/
|
862
|
+
language?: LanguageCode;
|
863
|
+
/**
|
864
|
+
* The name of the quick response.
|
865
|
+
*/
|
866
|
+
name: QuickResponseName;
|
867
|
+
/**
|
868
|
+
* The shortcut key of the quick response. The value should be unique across the knowledge base.
|
869
|
+
*/
|
870
|
+
shortcutKey?: ShortCutKey;
|
871
|
+
/**
|
872
|
+
* The tags used to organize, track, or control access for this resource.
|
873
|
+
*/
|
874
|
+
tags?: Tags;
|
875
|
+
}
|
876
|
+
export interface CreateQuickResponseResponse {
|
877
|
+
/**
|
878
|
+
* The quick response.
|
879
|
+
*/
|
880
|
+
quickResponse?: QuickResponseData;
|
881
|
+
}
|
882
|
+
export interface CreateSessionRequest {
|
883
|
+
/**
|
884
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
885
|
+
*/
|
886
|
+
assistantId: UuidOrArn;
|
887
|
+
/**
|
888
|
+
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
|
889
|
+
*/
|
890
|
+
clientToken?: ClientToken;
|
891
|
+
/**
|
892
|
+
* The description.
|
893
|
+
*/
|
894
|
+
description?: Description;
|
895
|
+
/**
|
896
|
+
* The name of the session.
|
897
|
+
*/
|
898
|
+
name: Name;
|
899
|
+
/**
|
900
|
+
* The tags used to organize, track, or control access for this resource.
|
901
|
+
*/
|
902
|
+
tags?: Tags;
|
903
|
+
}
|
904
|
+
export interface CreateSessionResponse {
|
905
|
+
/**
|
906
|
+
* The session.
|
907
|
+
*/
|
908
|
+
session?: SessionData;
|
909
|
+
}
|
910
|
+
export interface DataDetails {
|
911
|
+
/**
|
912
|
+
* Details about the content data.
|
913
|
+
*/
|
914
|
+
contentData?: ContentDataDetails;
|
915
|
+
/**
|
916
|
+
* Details about the generative data.
|
917
|
+
*/
|
918
|
+
generativeData?: GenerativeDataDetails;
|
919
|
+
/**
|
920
|
+
* Details about the content data.
|
921
|
+
*/
|
922
|
+
sourceContentData?: SourceContentDataDetails;
|
923
|
+
}
|
924
|
+
export interface DataReference {
|
925
|
+
contentReference?: ContentReference;
|
926
|
+
/**
|
927
|
+
* Reference information about the generative content.
|
928
|
+
*/
|
929
|
+
generativeReference?: GenerativeReference;
|
930
|
+
}
|
931
|
+
export interface DataSummary {
|
932
|
+
/**
|
933
|
+
* Details about the data.
|
934
|
+
*/
|
935
|
+
details: DataDetails;
|
936
|
+
/**
|
937
|
+
* Reference information about the content.
|
938
|
+
*/
|
939
|
+
reference: DataReference;
|
940
|
+
}
|
941
|
+
export type DataSummaryList = DataSummary[];
|
942
|
+
export interface DeleteAssistantAssociationRequest {
|
943
|
+
/**
|
944
|
+
* The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
945
|
+
*/
|
946
|
+
assistantAssociationId: UuidOrArn;
|
947
|
+
/**
|
948
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
949
|
+
*/
|
950
|
+
assistantId: UuidOrArn;
|
951
|
+
}
|
952
|
+
export interface DeleteAssistantAssociationResponse {
|
953
|
+
}
|
954
|
+
export interface DeleteAssistantRequest {
|
955
|
+
/**
|
956
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
957
|
+
*/
|
958
|
+
assistantId: UuidOrArn;
|
959
|
+
}
|
960
|
+
export interface DeleteAssistantResponse {
|
961
|
+
}
|
962
|
+
export interface DeleteContentRequest {
|
963
|
+
/**
|
964
|
+
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
965
|
+
*/
|
966
|
+
contentId: UuidOrArn;
|
967
|
+
/**
|
968
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
969
|
+
*/
|
970
|
+
knowledgeBaseId: UuidOrArn;
|
971
|
+
}
|
972
|
+
export interface DeleteContentResponse {
|
973
|
+
}
|
974
|
+
export interface DeleteImportJobRequest {
|
975
|
+
/**
|
976
|
+
* The identifier of the import job to be deleted.
|
977
|
+
*/
|
978
|
+
importJobId: Uuid;
|
979
|
+
/**
|
980
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
981
|
+
*/
|
982
|
+
knowledgeBaseId: UuidOrArn;
|
983
|
+
}
|
984
|
+
export interface DeleteImportJobResponse {
|
985
|
+
}
|
986
|
+
export interface DeleteKnowledgeBaseRequest {
|
987
|
+
/**
|
988
|
+
* The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
989
|
+
*/
|
990
|
+
knowledgeBaseId: UuidOrArn;
|
991
|
+
}
|
992
|
+
export interface DeleteKnowledgeBaseResponse {
|
993
|
+
}
|
994
|
+
export interface DeleteQuickResponseRequest {
|
995
|
+
/**
|
996
|
+
* The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
997
|
+
*/
|
998
|
+
knowledgeBaseId: UuidOrArn;
|
999
|
+
/**
|
1000
|
+
* The identifier of the quick response to delete.
|
1001
|
+
*/
|
1002
|
+
quickResponseId: UuidOrArn;
|
1003
|
+
}
|
1004
|
+
export interface DeleteQuickResponseResponse {
|
1005
|
+
}
|
1006
|
+
export type Description = string;
|
1007
|
+
export interface Document {
|
1008
|
+
/**
|
1009
|
+
* A reference to the content resource.
|
1010
|
+
*/
|
1011
|
+
contentReference: ContentReference;
|
1012
|
+
/**
|
1013
|
+
* The excerpt from the document.
|
1014
|
+
*/
|
1015
|
+
excerpt?: DocumentText;
|
1016
|
+
/**
|
1017
|
+
* The title of the document.
|
1018
|
+
*/
|
1019
|
+
title?: DocumentText;
|
1020
|
+
}
|
1021
|
+
export interface DocumentText {
|
1022
|
+
/**
|
1023
|
+
* Highlights in the document text.
|
1024
|
+
*/
|
1025
|
+
highlights?: Highlights;
|
1026
|
+
/**
|
1027
|
+
* Text in the document.
|
1028
|
+
*/
|
1029
|
+
text?: SensitiveString;
|
1030
|
+
}
|
1031
|
+
export type ExternalSource = "AMAZON_CONNECT"|string;
|
1032
|
+
export interface ExternalSourceConfiguration {
|
1033
|
+
/**
|
1034
|
+
* The configuration information of the external data source.
|
1035
|
+
*/
|
1036
|
+
configuration: Configuration;
|
1037
|
+
/**
|
1038
|
+
* The type of the external data source.
|
1039
|
+
*/
|
1040
|
+
source: ExternalSource;
|
1041
|
+
}
|
1042
|
+
export interface Filter {
|
1043
|
+
/**
|
1044
|
+
* The field on which to filter.
|
1045
|
+
*/
|
1046
|
+
field: FilterField;
|
1047
|
+
/**
|
1048
|
+
* The operator to use for comparing the field’s value with the provided value.
|
1049
|
+
*/
|
1050
|
+
operator: FilterOperator;
|
1051
|
+
/**
|
1052
|
+
* The desired field value on which to filter.
|
1053
|
+
*/
|
1054
|
+
value: NonEmptyString;
|
1055
|
+
}
|
1056
|
+
export type FilterField = "NAME"|string;
|
1057
|
+
export type FilterList = Filter[];
|
1058
|
+
export type FilterOperator = "EQUALS"|string;
|
1059
|
+
export interface GenerativeDataDetails {
|
1060
|
+
/**
|
1061
|
+
* The LLM response.
|
1062
|
+
*/
|
1063
|
+
completion: SensitiveString;
|
1064
|
+
/**
|
1065
|
+
* Details about the generative content ranking data.
|
1066
|
+
*/
|
1067
|
+
rankingData: RankingData;
|
1068
|
+
/**
|
1069
|
+
* The references used to generative the LLM response.
|
1070
|
+
*/
|
1071
|
+
references: DataSummaryList;
|
1072
|
+
}
|
1073
|
+
export interface GenerativeReference {
|
1074
|
+
/**
|
1075
|
+
* The identifier of the LLM model.
|
1076
|
+
*/
|
1077
|
+
generationId?: Uuid;
|
1078
|
+
/**
|
1079
|
+
* The identifier of the LLM model.
|
1080
|
+
*/
|
1081
|
+
modelId?: LlmModelId;
|
1082
|
+
}
|
1083
|
+
export type GenericArn = string;
|
1084
|
+
export interface GetAssistantAssociationRequest {
|
1085
|
+
/**
|
1086
|
+
* The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1087
|
+
*/
|
1088
|
+
assistantAssociationId: UuidOrArn;
|
1089
|
+
/**
|
1090
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1091
|
+
*/
|
1092
|
+
assistantId: UuidOrArn;
|
1093
|
+
}
|
1094
|
+
export interface GetAssistantAssociationResponse {
|
1095
|
+
/**
|
1096
|
+
* The assistant association.
|
1097
|
+
*/
|
1098
|
+
assistantAssociation?: AssistantAssociationData;
|
1099
|
+
}
|
1100
|
+
export interface GetAssistantRequest {
|
1101
|
+
/**
|
1102
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1103
|
+
*/
|
1104
|
+
assistantId: UuidOrArn;
|
1105
|
+
}
|
1106
|
+
export interface GetAssistantResponse {
|
1107
|
+
/**
|
1108
|
+
* Information about the assistant.
|
1109
|
+
*/
|
1110
|
+
assistant?: AssistantData;
|
1111
|
+
}
|
1112
|
+
export interface GetContentRequest {
|
1113
|
+
/**
|
1114
|
+
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1115
|
+
*/
|
1116
|
+
contentId: UuidOrArn;
|
1117
|
+
/**
|
1118
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1119
|
+
*/
|
1120
|
+
knowledgeBaseId: UuidOrArn;
|
1121
|
+
}
|
1122
|
+
export interface GetContentResponse {
|
1123
|
+
/**
|
1124
|
+
* The content.
|
1125
|
+
*/
|
1126
|
+
content?: ContentData;
|
1127
|
+
}
|
1128
|
+
export interface GetContentSummaryRequest {
|
1129
|
+
/**
|
1130
|
+
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1131
|
+
*/
|
1132
|
+
contentId: UuidOrArn;
|
1133
|
+
/**
|
1134
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1135
|
+
*/
|
1136
|
+
knowledgeBaseId: UuidOrArn;
|
1137
|
+
}
|
1138
|
+
export interface GetContentSummaryResponse {
|
1139
|
+
/**
|
1140
|
+
* The content summary.
|
1141
|
+
*/
|
1142
|
+
contentSummary?: ContentSummary;
|
1143
|
+
}
|
1144
|
+
export interface GetImportJobRequest {
|
1145
|
+
/**
|
1146
|
+
* The identifier of the import job to retrieve.
|
1147
|
+
*/
|
1148
|
+
importJobId: Uuid;
|
1149
|
+
/**
|
1150
|
+
* The identifier of the knowledge base that the import job belongs to.
|
1151
|
+
*/
|
1152
|
+
knowledgeBaseId: UuidOrArn;
|
1153
|
+
}
|
1154
|
+
export interface GetImportJobResponse {
|
1155
|
+
/**
|
1156
|
+
* The import job.
|
1157
|
+
*/
|
1158
|
+
importJob?: ImportJobData;
|
1159
|
+
}
|
1160
|
+
export interface GetKnowledgeBaseRequest {
|
1161
|
+
/**
|
1162
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1163
|
+
*/
|
1164
|
+
knowledgeBaseId: UuidOrArn;
|
1165
|
+
}
|
1166
|
+
export interface GetKnowledgeBaseResponse {
|
1167
|
+
/**
|
1168
|
+
* The knowledge base.
|
1169
|
+
*/
|
1170
|
+
knowledgeBase?: KnowledgeBaseData;
|
1171
|
+
}
|
1172
|
+
export interface GetQuickResponseRequest {
|
1173
|
+
/**
|
1174
|
+
* The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
|
1175
|
+
*/
|
1176
|
+
knowledgeBaseId: UuidOrArn;
|
1177
|
+
/**
|
1178
|
+
* The identifier of the quick response.
|
1179
|
+
*/
|
1180
|
+
quickResponseId: UuidOrArn;
|
1181
|
+
}
|
1182
|
+
export interface GetQuickResponseResponse {
|
1183
|
+
/**
|
1184
|
+
* The quick response.
|
1185
|
+
*/
|
1186
|
+
quickResponse?: QuickResponseData;
|
1187
|
+
}
|
1188
|
+
export interface GetRecommendationsRequest {
|
1189
|
+
/**
|
1190
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1191
|
+
*/
|
1192
|
+
assistantId: UuidOrArn;
|
1193
|
+
/**
|
1194
|
+
* The maximum number of results to return per page.
|
1195
|
+
*/
|
1196
|
+
maxResults?: MaxResults;
|
1197
|
+
/**
|
1198
|
+
* The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1199
|
+
*/
|
1200
|
+
sessionId: UuidOrArn;
|
1201
|
+
/**
|
1202
|
+
* The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.
|
1203
|
+
*/
|
1204
|
+
waitTimeSeconds?: WaitTimeSeconds;
|
1205
|
+
}
|
1206
|
+
export interface GetRecommendationsResponse {
|
1207
|
+
/**
|
1208
|
+
* The recommendations.
|
1209
|
+
*/
|
1210
|
+
recommendations: RecommendationList;
|
1211
|
+
/**
|
1212
|
+
* The triggers corresponding to recommendations.
|
1213
|
+
*/
|
1214
|
+
triggers?: RecommendationTriggerList;
|
1215
|
+
}
|
1216
|
+
export interface GetSessionRequest {
|
1217
|
+
/**
|
1218
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1219
|
+
*/
|
1220
|
+
assistantId: UuidOrArn;
|
1221
|
+
/**
|
1222
|
+
* The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1223
|
+
*/
|
1224
|
+
sessionId: UuidOrArn;
|
1225
|
+
}
|
1226
|
+
export interface GetSessionResponse {
|
1227
|
+
/**
|
1228
|
+
* The session.
|
1229
|
+
*/
|
1230
|
+
session?: SessionData;
|
1231
|
+
}
|
1232
|
+
export interface GroupingConfiguration {
|
1233
|
+
/**
|
1234
|
+
* The criteria used for grouping Amazon Q users. The following is the list of supported criteria values. RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
|
1235
|
+
*/
|
1236
|
+
criteria?: GroupingCriteria;
|
1237
|
+
/**
|
1238
|
+
* The list of values that define different groups of Amazon Q users. When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
|
1239
|
+
*/
|
1240
|
+
values?: GroupingValues;
|
1241
|
+
}
|
1242
|
+
export type GroupingCriteria = string;
|
1243
|
+
export type GroupingValue = string;
|
1244
|
+
export type GroupingValues = GroupingValue[];
|
1245
|
+
export type Headers = {[key: string]: NonEmptyString};
|
1246
|
+
export interface Highlight {
|
1247
|
+
/**
|
1248
|
+
* The offset for the start of the highlight.
|
1249
|
+
*/
|
1250
|
+
beginOffsetInclusive?: HighlightOffset;
|
1251
|
+
/**
|
1252
|
+
* The offset for the end of the highlight.
|
1253
|
+
*/
|
1254
|
+
endOffsetExclusive?: HighlightOffset;
|
1255
|
+
}
|
1256
|
+
export type HighlightOffset = number;
|
1257
|
+
export type Highlights = Highlight[];
|
1258
|
+
export interface ImportJobData {
|
1259
|
+
/**
|
1260
|
+
* The timestamp when the import job was created.
|
1261
|
+
*/
|
1262
|
+
createdTime: SyntheticTimestamp_epoch_seconds;
|
1263
|
+
externalSourceConfiguration?: ExternalSourceConfiguration;
|
1264
|
+
/**
|
1265
|
+
* The link to donwload the information of resource data that failed to be imported.
|
1266
|
+
*/
|
1267
|
+
failedRecordReport?: Url;
|
1268
|
+
/**
|
1269
|
+
* The identifier of the import job.
|
1270
|
+
*/
|
1271
|
+
importJobId: Uuid;
|
1272
|
+
/**
|
1273
|
+
* The type of the import job.
|
1274
|
+
*/
|
1275
|
+
importJobType: ImportJobType;
|
1276
|
+
/**
|
1277
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
1278
|
+
*/
|
1279
|
+
knowledgeBaseArn: Arn;
|
1280
|
+
/**
|
1281
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
1282
|
+
*/
|
1283
|
+
knowledgeBaseId: Uuid;
|
1284
|
+
/**
|
1285
|
+
* The timestamp when the import job data was last modified.
|
1286
|
+
*/
|
1287
|
+
lastModifiedTime: SyntheticTimestamp_epoch_seconds;
|
1288
|
+
/**
|
1289
|
+
* The metadata fields of the imported Amazon Q resources.
|
1290
|
+
*/
|
1291
|
+
metadata?: ContentMetadata;
|
1292
|
+
/**
|
1293
|
+
* The status of the import job.
|
1294
|
+
*/
|
1295
|
+
status: ImportJobStatus;
|
1296
|
+
/**
|
1297
|
+
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
|
1298
|
+
*/
|
1299
|
+
uploadId: UploadId;
|
1300
|
+
/**
|
1301
|
+
* The download link to the resource file that is uploaded to the import job.
|
1302
|
+
*/
|
1303
|
+
url: Url;
|
1304
|
+
/**
|
1305
|
+
* The expiration time of the URL as an epoch timestamp.
|
1306
|
+
*/
|
1307
|
+
urlExpiry: SyntheticTimestamp_epoch_seconds;
|
1308
|
+
}
|
1309
|
+
export type ImportJobList = ImportJobSummary[];
|
1310
|
+
export type ImportJobStatus = "START_IN_PROGRESS"|"FAILED"|"COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|string;
|
1311
|
+
export interface ImportJobSummary {
|
1312
|
+
/**
|
1313
|
+
* The timestamp when the import job was created.
|
1314
|
+
*/
|
1315
|
+
createdTime: SyntheticTimestamp_epoch_seconds;
|
1316
|
+
/**
|
1317
|
+
* The configuration information of the external source that the resource data are imported from.
|
1318
|
+
*/
|
1319
|
+
externalSourceConfiguration?: ExternalSourceConfiguration;
|
1320
|
+
/**
|
1321
|
+
* The identifier of the import job.
|
1322
|
+
*/
|
1323
|
+
importJobId: Uuid;
|
1324
|
+
/**
|
1325
|
+
* The type of import job.
|
1326
|
+
*/
|
1327
|
+
importJobType: ImportJobType;
|
1328
|
+
/**
|
1329
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
1330
|
+
*/
|
1331
|
+
knowledgeBaseArn: Arn;
|
1332
|
+
/**
|
1333
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
1334
|
+
*/
|
1335
|
+
knowledgeBaseId: Uuid;
|
1336
|
+
/**
|
1337
|
+
* The timestamp when the import job was last modified.
|
1338
|
+
*/
|
1339
|
+
lastModifiedTime: SyntheticTimestamp_epoch_seconds;
|
1340
|
+
/**
|
1341
|
+
* The metadata fields of the imported Amazon Q resources.
|
1342
|
+
*/
|
1343
|
+
metadata?: ContentMetadata;
|
1344
|
+
/**
|
1345
|
+
* The status of the import job.
|
1346
|
+
*/
|
1347
|
+
status: ImportJobStatus;
|
1348
|
+
/**
|
1349
|
+
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
|
1350
|
+
*/
|
1351
|
+
uploadId: UploadId;
|
1352
|
+
}
|
1353
|
+
export type ImportJobType = "QUICK_RESPONSES"|string;
|
1354
|
+
export interface KnowledgeBaseAssociationData {
|
1355
|
+
/**
|
1356
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
1357
|
+
*/
|
1358
|
+
knowledgeBaseArn?: Arn;
|
1359
|
+
/**
|
1360
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
1361
|
+
*/
|
1362
|
+
knowledgeBaseId?: Uuid;
|
1363
|
+
}
|
1364
|
+
export interface KnowledgeBaseData {
|
1365
|
+
/**
|
1366
|
+
* The description.
|
1367
|
+
*/
|
1368
|
+
description?: Description;
|
1369
|
+
/**
|
1370
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
1371
|
+
*/
|
1372
|
+
knowledgeBaseArn: Arn;
|
1373
|
+
/**
|
1374
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
1375
|
+
*/
|
1376
|
+
knowledgeBaseId: Uuid;
|
1377
|
+
/**
|
1378
|
+
* The type of knowledge base.
|
1379
|
+
*/
|
1380
|
+
knowledgeBaseType: KnowledgeBaseType;
|
1381
|
+
/**
|
1382
|
+
* An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
|
1383
|
+
*/
|
1384
|
+
lastContentModificationTime?: SyntheticTimestamp_epoch_seconds;
|
1385
|
+
/**
|
1386
|
+
* The name of the knowledge base.
|
1387
|
+
*/
|
1388
|
+
name: Name;
|
1389
|
+
/**
|
1390
|
+
* Information about how to render the content.
|
1391
|
+
*/
|
1392
|
+
renderingConfiguration?: RenderingConfiguration;
|
1393
|
+
/**
|
1394
|
+
* 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. For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.
|
1395
|
+
*/
|
1396
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
1397
|
+
/**
|
1398
|
+
* Source configuration information about the knowledge base.
|
1399
|
+
*/
|
1400
|
+
sourceConfiguration?: SourceConfiguration;
|
1401
|
+
/**
|
1402
|
+
* The status of the knowledge base.
|
1403
|
+
*/
|
1404
|
+
status: KnowledgeBaseStatus;
|
1405
|
+
/**
|
1406
|
+
* The tags used to organize, track, or control access for this resource.
|
1407
|
+
*/
|
1408
|
+
tags?: Tags;
|
1409
|
+
}
|
1410
|
+
export type KnowledgeBaseList = KnowledgeBaseSummary[];
|
1411
|
+
export type KnowledgeBaseStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|string;
|
1412
|
+
export interface KnowledgeBaseSummary {
|
1413
|
+
/**
|
1414
|
+
* The description of the knowledge base.
|
1415
|
+
*/
|
1416
|
+
description?: Description;
|
1417
|
+
/**
|
1418
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
1419
|
+
*/
|
1420
|
+
knowledgeBaseArn: Arn;
|
1421
|
+
/**
|
1422
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
1423
|
+
*/
|
1424
|
+
knowledgeBaseId: Uuid;
|
1425
|
+
/**
|
1426
|
+
* The type of knowledge base.
|
1427
|
+
*/
|
1428
|
+
knowledgeBaseType: KnowledgeBaseType;
|
1429
|
+
/**
|
1430
|
+
* The name of the knowledge base.
|
1431
|
+
*/
|
1432
|
+
name: Name;
|
1433
|
+
/**
|
1434
|
+
* Information about how to render the content.
|
1435
|
+
*/
|
1436
|
+
renderingConfiguration?: RenderingConfiguration;
|
1437
|
+
/**
|
1438
|
+
* 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. For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.
|
1439
|
+
*/
|
1440
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
1441
|
+
/**
|
1442
|
+
* Configuration information about the external data source.
|
1443
|
+
*/
|
1444
|
+
sourceConfiguration?: SourceConfiguration;
|
1445
|
+
/**
|
1446
|
+
* The status of the knowledge base summary.
|
1447
|
+
*/
|
1448
|
+
status: KnowledgeBaseStatus;
|
1449
|
+
/**
|
1450
|
+
* The tags used to organize, track, or control access for this resource.
|
1451
|
+
*/
|
1452
|
+
tags?: Tags;
|
1453
|
+
}
|
1454
|
+
export type KnowledgeBaseType = "EXTERNAL"|"CUSTOM"|"QUICK_RESPONSES"|string;
|
1455
|
+
export type LanguageCode = string;
|
1456
|
+
export interface ListAssistantAssociationsRequest {
|
1457
|
+
/**
|
1458
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1459
|
+
*/
|
1460
|
+
assistantId: UuidOrArn;
|
1461
|
+
/**
|
1462
|
+
* The maximum number of results to return per page.
|
1463
|
+
*/
|
1464
|
+
maxResults?: MaxResults;
|
1465
|
+
/**
|
1466
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1467
|
+
*/
|
1468
|
+
nextToken?: NextToken;
|
1469
|
+
}
|
1470
|
+
export interface ListAssistantAssociationsResponse {
|
1471
|
+
/**
|
1472
|
+
* Summary information about assistant associations.
|
1473
|
+
*/
|
1474
|
+
assistantAssociationSummaries: AssistantAssociationSummaryList;
|
1475
|
+
/**
|
1476
|
+
* If there are additional results, this is the token for the next set of results.
|
1477
|
+
*/
|
1478
|
+
nextToken?: NextToken;
|
1479
|
+
}
|
1480
|
+
export interface ListAssistantsRequest {
|
1481
|
+
/**
|
1482
|
+
* The maximum number of results to return per page.
|
1483
|
+
*/
|
1484
|
+
maxResults?: MaxResults;
|
1485
|
+
/**
|
1486
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1487
|
+
*/
|
1488
|
+
nextToken?: NextToken;
|
1489
|
+
}
|
1490
|
+
export interface ListAssistantsResponse {
|
1491
|
+
/**
|
1492
|
+
* Information about the assistants.
|
1493
|
+
*/
|
1494
|
+
assistantSummaries: AssistantList;
|
1495
|
+
/**
|
1496
|
+
* If there are additional results, this is the token for the next set of results.
|
1497
|
+
*/
|
1498
|
+
nextToken?: NextToken;
|
1499
|
+
}
|
1500
|
+
export interface ListContentsRequest {
|
1501
|
+
/**
|
1502
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1503
|
+
*/
|
1504
|
+
knowledgeBaseId: UuidOrArn;
|
1505
|
+
/**
|
1506
|
+
* The maximum number of results to return per page.
|
1507
|
+
*/
|
1508
|
+
maxResults?: MaxResults;
|
1509
|
+
/**
|
1510
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1511
|
+
*/
|
1512
|
+
nextToken?: NextToken;
|
1513
|
+
}
|
1514
|
+
export interface ListContentsResponse {
|
1515
|
+
/**
|
1516
|
+
* Information about the content.
|
1517
|
+
*/
|
1518
|
+
contentSummaries: ContentSummaryList;
|
1519
|
+
/**
|
1520
|
+
* If there are additional results, this is the token for the next set of results.
|
1521
|
+
*/
|
1522
|
+
nextToken?: NextToken;
|
1523
|
+
}
|
1524
|
+
export interface ListImportJobsRequest {
|
1525
|
+
/**
|
1526
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1527
|
+
*/
|
1528
|
+
knowledgeBaseId: UuidOrArn;
|
1529
|
+
/**
|
1530
|
+
* The maximum number of results to return per page.
|
1531
|
+
*/
|
1532
|
+
maxResults?: MaxResults;
|
1533
|
+
/**
|
1534
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1535
|
+
*/
|
1536
|
+
nextToken?: NonEmptyString;
|
1537
|
+
}
|
1538
|
+
export interface ListImportJobsResponse {
|
1539
|
+
/**
|
1540
|
+
* Summary information about the import jobs.
|
1541
|
+
*/
|
1542
|
+
importJobSummaries: ImportJobList;
|
1543
|
+
/**
|
1544
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1545
|
+
*/
|
1546
|
+
nextToken?: NonEmptyString;
|
1547
|
+
}
|
1548
|
+
export interface ListKnowledgeBasesRequest {
|
1549
|
+
/**
|
1550
|
+
* The maximum number of results to return per page.
|
1551
|
+
*/
|
1552
|
+
maxResults?: MaxResults;
|
1553
|
+
/**
|
1554
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1555
|
+
*/
|
1556
|
+
nextToken?: NonEmptyString;
|
1557
|
+
}
|
1558
|
+
export interface ListKnowledgeBasesResponse {
|
1559
|
+
/**
|
1560
|
+
* Information about the knowledge bases.
|
1561
|
+
*/
|
1562
|
+
knowledgeBaseSummaries: KnowledgeBaseList;
|
1563
|
+
/**
|
1564
|
+
* If there are additional results, this is the token for the next set of results.
|
1565
|
+
*/
|
1566
|
+
nextToken?: NonEmptyString;
|
1567
|
+
}
|
1568
|
+
export interface ListQuickResponsesRequest {
|
1569
|
+
/**
|
1570
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1571
|
+
*/
|
1572
|
+
knowledgeBaseId: UuidOrArn;
|
1573
|
+
/**
|
1574
|
+
* The maximum number of results to return per page.
|
1575
|
+
*/
|
1576
|
+
maxResults?: MaxResults;
|
1577
|
+
/**
|
1578
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1579
|
+
*/
|
1580
|
+
nextToken?: NonEmptyString;
|
1581
|
+
}
|
1582
|
+
export interface ListQuickResponsesResponse {
|
1583
|
+
/**
|
1584
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1585
|
+
*/
|
1586
|
+
nextToken?: NonEmptyString;
|
1587
|
+
/**
|
1588
|
+
* Summary information about the quick responses.
|
1589
|
+
*/
|
1590
|
+
quickResponseSummaries: QuickResponseSummaryList;
|
1591
|
+
}
|
1592
|
+
export interface ListTagsForResourceRequest {
|
1593
|
+
/**
|
1594
|
+
* The Amazon Resource Name (ARN) of the resource.
|
1595
|
+
*/
|
1596
|
+
resourceArn: Arn;
|
1597
|
+
}
|
1598
|
+
export interface ListTagsForResourceResponse {
|
1599
|
+
/**
|
1600
|
+
* The tags used to organize, track, or control access for this resource.
|
1601
|
+
*/
|
1602
|
+
tags?: Tags;
|
1603
|
+
}
|
1604
|
+
export type LlmModelId = string;
|
1605
|
+
export type MaxResults = number;
|
1606
|
+
export type Name = string;
|
1607
|
+
export type NextToken = string;
|
1608
|
+
export type NonEmptyString = string;
|
1609
|
+
export interface NotifyRecommendationsReceivedError {
|
1610
|
+
/**
|
1611
|
+
* A recommendation is causing an error.
|
1612
|
+
*/
|
1613
|
+
message?: NotifyRecommendationsReceivedErrorMessage;
|
1614
|
+
/**
|
1615
|
+
* The identifier of the recommendation that is in error.
|
1616
|
+
*/
|
1617
|
+
recommendationId?: RecommendationId;
|
1618
|
+
}
|
1619
|
+
export type NotifyRecommendationsReceivedErrorList = NotifyRecommendationsReceivedError[];
|
1620
|
+
export type NotifyRecommendationsReceivedErrorMessage = string;
|
1621
|
+
export interface NotifyRecommendationsReceivedRequest {
|
1622
|
+
/**
|
1623
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1624
|
+
*/
|
1625
|
+
assistantId: UuidOrArn;
|
1626
|
+
/**
|
1627
|
+
* The identifiers of the recommendations.
|
1628
|
+
*/
|
1629
|
+
recommendationIds: RecommendationIdList;
|
1630
|
+
/**
|
1631
|
+
* The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1632
|
+
*/
|
1633
|
+
sessionId: UuidOrArn;
|
1634
|
+
}
|
1635
|
+
export interface NotifyRecommendationsReceivedResponse {
|
1636
|
+
/**
|
1637
|
+
* The identifiers of recommendations that are causing errors.
|
1638
|
+
*/
|
1639
|
+
errors?: NotifyRecommendationsReceivedErrorList;
|
1640
|
+
/**
|
1641
|
+
* The identifiers of the recommendations.
|
1642
|
+
*/
|
1643
|
+
recommendationIds?: RecommendationIdList;
|
1644
|
+
}
|
1645
|
+
export type ObjectFieldsList = NonEmptyString[];
|
1646
|
+
export type Order = "ASC"|"DESC"|string;
|
1647
|
+
export type Priority = "HIGH"|"MEDIUM"|"LOW"|string;
|
1648
|
+
export interface QueryAssistantRequest {
|
1649
|
+
/**
|
1650
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1651
|
+
*/
|
1652
|
+
assistantId: UuidOrArn;
|
1653
|
+
/**
|
1654
|
+
* The maximum number of results to return per page.
|
1655
|
+
*/
|
1656
|
+
maxResults?: MaxResults;
|
1657
|
+
/**
|
1658
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
1659
|
+
*/
|
1660
|
+
nextToken?: NextToken;
|
1661
|
+
/**
|
1662
|
+
* Information about how to query content.
|
1663
|
+
*/
|
1664
|
+
queryCondition?: QueryConditionExpression;
|
1665
|
+
/**
|
1666
|
+
* The text to search for.
|
1667
|
+
*/
|
1668
|
+
queryText: QueryText;
|
1669
|
+
/**
|
1670
|
+
* The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1671
|
+
*/
|
1672
|
+
sessionId?: UuidOrArn;
|
1673
|
+
}
|
1674
|
+
export interface QueryAssistantResponse {
|
1675
|
+
/**
|
1676
|
+
* If there are additional results, this is the token for the next set of results.
|
1677
|
+
*/
|
1678
|
+
nextToken?: NextToken;
|
1679
|
+
/**
|
1680
|
+
* The results of the query.
|
1681
|
+
*/
|
1682
|
+
results: QueryResultsList;
|
1683
|
+
}
|
1684
|
+
export interface QueryCondition {
|
1685
|
+
/**
|
1686
|
+
* The condition for the query.
|
1687
|
+
*/
|
1688
|
+
single?: QueryConditionItem;
|
1689
|
+
}
|
1690
|
+
export type QueryConditionComparisonOperator = "EQUALS"|string;
|
1691
|
+
export type QueryConditionExpression = QueryCondition[];
|
1692
|
+
export type QueryConditionFieldName = "RESULT_TYPE"|string;
|
1693
|
+
export interface QueryConditionItem {
|
1694
|
+
/**
|
1695
|
+
* The comparison operator for query condition to query on.
|
1696
|
+
*/
|
1697
|
+
comparator: QueryConditionComparisonOperator;
|
1698
|
+
/**
|
1699
|
+
* The name of the field for query condition to query on.
|
1700
|
+
*/
|
1701
|
+
field: QueryConditionFieldName;
|
1702
|
+
/**
|
1703
|
+
* The value for the query condition to query on.
|
1704
|
+
*/
|
1705
|
+
value: NonEmptyString;
|
1706
|
+
}
|
1707
|
+
export interface QueryRecommendationTriggerData {
|
1708
|
+
/**
|
1709
|
+
* The text associated with the recommendation trigger.
|
1710
|
+
*/
|
1711
|
+
text?: QueryText;
|
1712
|
+
}
|
1713
|
+
export type QueryResultType = "KNOWLEDGE_CONTENT"|"GENERATIVE_ANSWER"|string;
|
1714
|
+
export type QueryResultsList = ResultData[];
|
1715
|
+
export type QueryText = string;
|
1716
|
+
export type QuickResponseContent = string;
|
1717
|
+
export interface QuickResponseContentProvider {
|
1718
|
+
/**
|
1719
|
+
* The content of the quick response.
|
1720
|
+
*/
|
1721
|
+
content?: QuickResponseContent;
|
1722
|
+
}
|
1723
|
+
export interface QuickResponseContents {
|
1724
|
+
markdown?: QuickResponseContentProvider;
|
1725
|
+
plainText?: QuickResponseContentProvider;
|
1726
|
+
}
|
1727
|
+
export interface QuickResponseData {
|
1728
|
+
/**
|
1729
|
+
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
|
1730
|
+
*/
|
1731
|
+
channels?: Channels;
|
1732
|
+
/**
|
1733
|
+
* The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext.
|
1734
|
+
*/
|
1735
|
+
contentType: QuickResponseType;
|
1736
|
+
/**
|
1737
|
+
* The contents of the quick response.
|
1738
|
+
*/
|
1739
|
+
contents?: QuickResponseContents;
|
1740
|
+
/**
|
1741
|
+
* The timestamp when the quick response was created.
|
1742
|
+
*/
|
1743
|
+
createdTime: SyntheticTimestamp_epoch_seconds;
|
1744
|
+
/**
|
1745
|
+
* The description of the quick response.
|
1746
|
+
*/
|
1747
|
+
description?: QuickResponseDescription;
|
1748
|
+
/**
|
1749
|
+
* The configuration information of the user groups that the quick response is accessible to.
|
1750
|
+
*/
|
1751
|
+
groupingConfiguration?: GroupingConfiguration;
|
1752
|
+
/**
|
1753
|
+
* Whether the quick response is active.
|
1754
|
+
*/
|
1755
|
+
isActive?: Boolean;
|
1756
|
+
/**
|
1757
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
1758
|
+
*/
|
1759
|
+
knowledgeBaseArn: Arn;
|
1760
|
+
/**
|
1761
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1762
|
+
*/
|
1763
|
+
knowledgeBaseId: Uuid;
|
1764
|
+
/**
|
1765
|
+
* The language code value for the language in which the quick response is written.
|
1766
|
+
*/
|
1767
|
+
language?: LanguageCode;
|
1768
|
+
/**
|
1769
|
+
* The Amazon Resource Name (ARN) of the user who last updated the quick response data.
|
1770
|
+
*/
|
1771
|
+
lastModifiedBy?: GenericArn;
|
1772
|
+
/**
|
1773
|
+
* The timestamp when the quick response data was last modified.
|
1774
|
+
*/
|
1775
|
+
lastModifiedTime: SyntheticTimestamp_epoch_seconds;
|
1776
|
+
/**
|
1777
|
+
* The name of the quick response.
|
1778
|
+
*/
|
1779
|
+
name: QuickResponseName;
|
1780
|
+
/**
|
1781
|
+
* The Amazon Resource Name (ARN) of the quick response.
|
1782
|
+
*/
|
1783
|
+
quickResponseArn: Arn;
|
1784
|
+
/**
|
1785
|
+
* The identifier of the quick response.
|
1786
|
+
*/
|
1787
|
+
quickResponseId: Uuid;
|
1788
|
+
/**
|
1789
|
+
* The shortcut key of the quick response. The value should be unique across the knowledge base.
|
1790
|
+
*/
|
1791
|
+
shortcutKey?: ShortCutKey;
|
1792
|
+
/**
|
1793
|
+
* The status of the quick response data.
|
1794
|
+
*/
|
1795
|
+
status: QuickResponseStatus;
|
1796
|
+
/**
|
1797
|
+
* The tags used to organize, track, or control access for this resource.
|
1798
|
+
*/
|
1799
|
+
tags?: Tags;
|
1800
|
+
}
|
1801
|
+
export interface QuickResponseDataProvider {
|
1802
|
+
/**
|
1803
|
+
* The content of the quick response.
|
1804
|
+
*/
|
1805
|
+
content?: QuickResponseContent;
|
1806
|
+
}
|
1807
|
+
export type QuickResponseDescription = string;
|
1808
|
+
export interface QuickResponseFilterField {
|
1809
|
+
/**
|
1810
|
+
* Whether to treat null value as a match for the attribute field.
|
1811
|
+
*/
|
1812
|
+
includeNoExistence?: Boolean;
|
1813
|
+
/**
|
1814
|
+
* The name of the attribute field to filter the quick responses by.
|
1815
|
+
*/
|
1816
|
+
name: NonEmptyString;
|
1817
|
+
/**
|
1818
|
+
* The operator to use for filtering.
|
1819
|
+
*/
|
1820
|
+
operator: QuickResponseFilterOperator;
|
1821
|
+
/**
|
1822
|
+
* The values of attribute field to filter the quick response by.
|
1823
|
+
*/
|
1824
|
+
values?: QuickResponseFilterValueList;
|
1825
|
+
}
|
1826
|
+
export type QuickResponseFilterFieldList = QuickResponseFilterField[];
|
1827
|
+
export type QuickResponseFilterOperator = "EQUALS"|"PREFIX"|string;
|
1828
|
+
export type QuickResponseFilterValue = string;
|
1829
|
+
export type QuickResponseFilterValueList = QuickResponseFilterValue[];
|
1830
|
+
export type QuickResponseName = string;
|
1831
|
+
export interface QuickResponseOrderField {
|
1832
|
+
/**
|
1833
|
+
* The name of the attribute to order the quick response query results by.
|
1834
|
+
*/
|
1835
|
+
name: NonEmptyString;
|
1836
|
+
/**
|
1837
|
+
* The order at which the quick responses are sorted by.
|
1838
|
+
*/
|
1839
|
+
order?: Order;
|
1840
|
+
}
|
1841
|
+
export interface QuickResponseQueryField {
|
1842
|
+
/**
|
1843
|
+
* Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
|
1844
|
+
*/
|
1845
|
+
allowFuzziness?: Boolean;
|
1846
|
+
/**
|
1847
|
+
* The name of the attribute to query the quick responses by.
|
1848
|
+
*/
|
1849
|
+
name: NonEmptyString;
|
1850
|
+
/**
|
1851
|
+
* The operator to use for matching attribute field values in the query.
|
1852
|
+
*/
|
1853
|
+
operator: QuickResponseQueryOperator;
|
1854
|
+
/**
|
1855
|
+
* The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
|
1856
|
+
*/
|
1857
|
+
priority?: Priority;
|
1858
|
+
/**
|
1859
|
+
* The values of the attribute to query the quick responses by.
|
1860
|
+
*/
|
1861
|
+
values: QuickResponseQueryValueList;
|
1862
|
+
}
|
1863
|
+
export type QuickResponseQueryFieldList = QuickResponseQueryField[];
|
1864
|
+
export type QuickResponseQueryOperator = "CONTAINS"|"CONTAINS_AND_PREFIX"|string;
|
1865
|
+
export type QuickResponseQueryValue = string;
|
1866
|
+
export type QuickResponseQueryValueList = QuickResponseQueryValue[];
|
1867
|
+
export interface QuickResponseSearchExpression {
|
1868
|
+
/**
|
1869
|
+
* The configuration of filtering rules applied to quick response query results.
|
1870
|
+
*/
|
1871
|
+
filters?: QuickResponseFilterFieldList;
|
1872
|
+
/**
|
1873
|
+
* The quick response attribute fields on which the query results are ordered.
|
1874
|
+
*/
|
1875
|
+
orderOnField?: QuickResponseOrderField;
|
1876
|
+
/**
|
1877
|
+
* The quick response query expressions.
|
1878
|
+
*/
|
1879
|
+
queries?: QuickResponseQueryFieldList;
|
1880
|
+
}
|
1881
|
+
export interface QuickResponseSearchResultData {
|
1882
|
+
/**
|
1883
|
+
* The user defined contact attributes that are resolved when the search result is returned.
|
1884
|
+
*/
|
1885
|
+
attributesInterpolated?: ContactAttributeKeys;
|
1886
|
+
/**
|
1887
|
+
* The user defined contact attributes that are not resolved when the search result is returned.
|
1888
|
+
*/
|
1889
|
+
attributesNotInterpolated?: ContactAttributeKeys;
|
1890
|
+
/**
|
1891
|
+
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
|
1892
|
+
*/
|
1893
|
+
channels?: Channels;
|
1894
|
+
/**
|
1895
|
+
* The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext.
|
1896
|
+
*/
|
1897
|
+
contentType: QuickResponseType;
|
1898
|
+
/**
|
1899
|
+
* The contents of the quick response.
|
1900
|
+
*/
|
1901
|
+
contents: QuickResponseContents;
|
1902
|
+
/**
|
1903
|
+
* The timestamp when the quick response was created.
|
1904
|
+
*/
|
1905
|
+
createdTime: SyntheticTimestamp_epoch_seconds;
|
1906
|
+
/**
|
1907
|
+
* The description of the quick response.
|
1908
|
+
*/
|
1909
|
+
description?: QuickResponseDescription;
|
1910
|
+
/**
|
1911
|
+
* The configuration information of the user groups that the quick response is accessible to.
|
1912
|
+
*/
|
1913
|
+
groupingConfiguration?: GroupingConfiguration;
|
1914
|
+
/**
|
1915
|
+
* Whether the quick response is active.
|
1916
|
+
*/
|
1917
|
+
isActive: Boolean;
|
1918
|
+
/**
|
1919
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
1920
|
+
*/
|
1921
|
+
knowledgeBaseArn: Arn;
|
1922
|
+
/**
|
1923
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
1924
|
+
*/
|
1925
|
+
knowledgeBaseId: Uuid;
|
1926
|
+
/**
|
1927
|
+
* The language code value for the language in which the quick response is written.
|
1928
|
+
*/
|
1929
|
+
language?: LanguageCode;
|
1930
|
+
/**
|
1931
|
+
* The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
|
1932
|
+
*/
|
1933
|
+
lastModifiedBy?: GenericArn;
|
1934
|
+
/**
|
1935
|
+
* The timestamp when the quick response search result data was last modified.
|
1936
|
+
*/
|
1937
|
+
lastModifiedTime: SyntheticTimestamp_epoch_seconds;
|
1938
|
+
/**
|
1939
|
+
* The name of the quick response.
|
1940
|
+
*/
|
1941
|
+
name: QuickResponseName;
|
1942
|
+
/**
|
1943
|
+
* The Amazon Resource Name (ARN) of the quick response.
|
1944
|
+
*/
|
1945
|
+
quickResponseArn: Arn;
|
1946
|
+
/**
|
1947
|
+
* The identifier of the quick response.
|
1948
|
+
*/
|
1949
|
+
quickResponseId: Uuid;
|
1950
|
+
/**
|
1951
|
+
* The shortcut key of the quick response. The value should be unique across the knowledge base.
|
1952
|
+
*/
|
1953
|
+
shortcutKey?: ShortCutKey;
|
1954
|
+
/**
|
1955
|
+
* The resource status of the quick response.
|
1956
|
+
*/
|
1957
|
+
status: QuickResponseStatus;
|
1958
|
+
/**
|
1959
|
+
* The tags used to organize, track, or control access for this resource.
|
1960
|
+
*/
|
1961
|
+
tags?: Tags;
|
1962
|
+
}
|
1963
|
+
export type QuickResponseSearchResultsList = QuickResponseSearchResultData[];
|
1964
|
+
export type QuickResponseStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|string;
|
1965
|
+
export interface QuickResponseSummary {
|
1966
|
+
/**
|
1967
|
+
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
|
1968
|
+
*/
|
1969
|
+
channels?: Channels;
|
1970
|
+
/**
|
1971
|
+
* The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext.
|
1972
|
+
*/
|
1973
|
+
contentType: QuickResponseType;
|
1974
|
+
/**
|
1975
|
+
* The timestamp when the quick response was created.
|
1976
|
+
*/
|
1977
|
+
createdTime: SyntheticTimestamp_epoch_seconds;
|
1978
|
+
/**
|
1979
|
+
* The description of the quick response.
|
1980
|
+
*/
|
1981
|
+
description?: QuickResponseDescription;
|
1982
|
+
/**
|
1983
|
+
* Whether the quick response is active.
|
1984
|
+
*/
|
1985
|
+
isActive?: Boolean;
|
1986
|
+
/**
|
1987
|
+
* The Amazon Resource Name (ARN) of the knowledge base.
|
1988
|
+
*/
|
1989
|
+
knowledgeBaseArn: Arn;
|
1990
|
+
/**
|
1991
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.
|
1992
|
+
*/
|
1993
|
+
knowledgeBaseId: Uuid;
|
1994
|
+
/**
|
1995
|
+
* The Amazon Resource Name (ARN) of the user who last updated the quick response data.
|
1996
|
+
*/
|
1997
|
+
lastModifiedBy?: GenericArn;
|
1998
|
+
/**
|
1999
|
+
* The timestamp when the quick response summary was last modified.
|
2000
|
+
*/
|
2001
|
+
lastModifiedTime: SyntheticTimestamp_epoch_seconds;
|
2002
|
+
/**
|
2003
|
+
* The name of the quick response.
|
2004
|
+
*/
|
2005
|
+
name: QuickResponseName;
|
2006
|
+
/**
|
2007
|
+
* The Amazon Resource Name (ARN) of the quick response.
|
2008
|
+
*/
|
2009
|
+
quickResponseArn: Arn;
|
2010
|
+
/**
|
2011
|
+
* The identifier of the quick response.
|
2012
|
+
*/
|
2013
|
+
quickResponseId: Uuid;
|
2014
|
+
/**
|
2015
|
+
* The resource status of the quick response.
|
2016
|
+
*/
|
2017
|
+
status: QuickResponseStatus;
|
2018
|
+
/**
|
2019
|
+
* The tags used to organize, track, or control access for this resource.
|
2020
|
+
*/
|
2021
|
+
tags?: Tags;
|
2022
|
+
}
|
2023
|
+
export type QuickResponseSummaryList = QuickResponseSummary[];
|
2024
|
+
export type QuickResponseType = string;
|
2025
|
+
export interface RankingData {
|
2026
|
+
/**
|
2027
|
+
* The relevance score of the content.
|
2028
|
+
*/
|
2029
|
+
relevanceLevel?: RelevanceLevel;
|
2030
|
+
/**
|
2031
|
+
* The relevance level of the recommendation.
|
2032
|
+
*/
|
2033
|
+
relevanceScore?: RelevanceScore;
|
2034
|
+
}
|
2035
|
+
export interface RecommendationData {
|
2036
|
+
/**
|
2037
|
+
* Summary of the recommended content.
|
2038
|
+
*/
|
2039
|
+
data?: DataSummary;
|
2040
|
+
/**
|
2041
|
+
* The recommended document.
|
2042
|
+
*/
|
2043
|
+
document?: Document;
|
2044
|
+
/**
|
2045
|
+
* The identifier of the recommendation.
|
2046
|
+
*/
|
2047
|
+
recommendationId: RecommendationId;
|
2048
|
+
/**
|
2049
|
+
* The relevance level of the recommendation.
|
2050
|
+
*/
|
2051
|
+
relevanceLevel?: RelevanceLevel;
|
2052
|
+
/**
|
2053
|
+
* The relevance score of the recommendation.
|
2054
|
+
*/
|
2055
|
+
relevanceScore?: RelevanceScore;
|
2056
|
+
/**
|
2057
|
+
* The type of recommendation.
|
2058
|
+
*/
|
2059
|
+
type?: RecommendationType;
|
2060
|
+
}
|
2061
|
+
export type RecommendationId = string;
|
2062
|
+
export type RecommendationIdList = RecommendationId[];
|
2063
|
+
export type RecommendationList = RecommendationData[];
|
2064
|
+
export type RecommendationSourceType = "ISSUE_DETECTION"|"RULE_EVALUATION"|"OTHER"|string;
|
2065
|
+
export interface RecommendationTrigger {
|
2066
|
+
/**
|
2067
|
+
* A union type containing information related to the trigger.
|
2068
|
+
*/
|
2069
|
+
data: RecommendationTriggerData;
|
2070
|
+
/**
|
2071
|
+
* The identifier of the recommendation trigger.
|
2072
|
+
*/
|
2073
|
+
id: Uuid;
|
2074
|
+
/**
|
2075
|
+
* The identifiers of the recommendations.
|
2076
|
+
*/
|
2077
|
+
recommendationIds: RecommendationIdList;
|
2078
|
+
/**
|
2079
|
+
* The source of the recommendation trigger. ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue. RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
|
2080
|
+
*/
|
2081
|
+
source: RecommendationSourceType;
|
2082
|
+
/**
|
2083
|
+
* The type of recommendation trigger.
|
2084
|
+
*/
|
2085
|
+
type: RecommendationTriggerType;
|
2086
|
+
}
|
2087
|
+
export interface RecommendationTriggerData {
|
2088
|
+
/**
|
2089
|
+
* Data associated with the QUERY RecommendationTriggerType.
|
2090
|
+
*/
|
2091
|
+
query?: QueryRecommendationTriggerData;
|
2092
|
+
}
|
2093
|
+
export type RecommendationTriggerList = RecommendationTrigger[];
|
2094
|
+
export type RecommendationTriggerType = "QUERY"|"GENERATIVE"|string;
|
2095
|
+
export type RecommendationType = "KNOWLEDGE_CONTENT"|"GENERATIVE_RESPONSE"|"GENERATIVE_ANSWER"|string;
|
2096
|
+
export type RelevanceLevel = "HIGH"|"MEDIUM"|"LOW"|string;
|
2097
|
+
export type RelevanceScore = number;
|
2098
|
+
export interface RemoveKnowledgeBaseTemplateUriRequest {
|
2099
|
+
/**
|
2100
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
2101
|
+
*/
|
2102
|
+
knowledgeBaseId: UuidOrArn;
|
2103
|
+
}
|
2104
|
+
export interface RemoveKnowledgeBaseTemplateUriResponse {
|
2105
|
+
}
|
2106
|
+
export interface RenderingConfiguration {
|
2107
|
+
/**
|
2108
|
+
* A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted ServiceNow: number, short_description, sys_mod_count, workflow_state, or active Zendesk: id, title, updated_at, or draft The variable is replaced with the actual value for a piece of content when calling GetContent.
|
2109
|
+
*/
|
2110
|
+
templateUri?: Uri;
|
2111
|
+
}
|
2112
|
+
export interface ResultData {
|
2113
|
+
/**
|
2114
|
+
* Summary of the recommended content.
|
2115
|
+
*/
|
2116
|
+
data?: DataSummary;
|
2117
|
+
/**
|
2118
|
+
* The document.
|
2119
|
+
*/
|
2120
|
+
document?: Document;
|
2121
|
+
/**
|
2122
|
+
* The relevance score of the results.
|
2123
|
+
*/
|
2124
|
+
relevanceScore?: RelevanceScore;
|
2125
|
+
/**
|
2126
|
+
* The identifier of the result data.
|
2127
|
+
*/
|
2128
|
+
resultId: Uuid;
|
2129
|
+
/**
|
2130
|
+
* The type of the query result.
|
2131
|
+
*/
|
2132
|
+
type?: QueryResultType;
|
2133
|
+
}
|
2134
|
+
export interface SearchContentRequest {
|
2135
|
+
/**
|
2136
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
2137
|
+
*/
|
2138
|
+
knowledgeBaseId: UuidOrArn;
|
2139
|
+
/**
|
2140
|
+
* The maximum number of results to return per page.
|
2141
|
+
*/
|
2142
|
+
maxResults?: MaxResults;
|
2143
|
+
/**
|
2144
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
2145
|
+
*/
|
2146
|
+
nextToken?: NextToken;
|
2147
|
+
/**
|
2148
|
+
* The search expression to filter results.
|
2149
|
+
*/
|
2150
|
+
searchExpression: SearchExpression;
|
2151
|
+
}
|
2152
|
+
export interface SearchContentResponse {
|
2153
|
+
/**
|
2154
|
+
* Summary information about the content.
|
2155
|
+
*/
|
2156
|
+
contentSummaries: ContentSummaryList;
|
2157
|
+
/**
|
2158
|
+
* If there are additional results, this is the token for the next set of results.
|
2159
|
+
*/
|
2160
|
+
nextToken?: NextToken;
|
2161
|
+
}
|
2162
|
+
export interface SearchExpression {
|
2163
|
+
/**
|
2164
|
+
* The search expression filters.
|
2165
|
+
*/
|
2166
|
+
filters: FilterList;
|
2167
|
+
}
|
2168
|
+
export interface SearchQuickResponsesRequest {
|
2169
|
+
/**
|
2170
|
+
* The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
|
2171
|
+
*/
|
2172
|
+
attributes?: ContactAttributes;
|
2173
|
+
/**
|
2174
|
+
* The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
2175
|
+
*/
|
2176
|
+
knowledgeBaseId: UuidOrArn;
|
2177
|
+
/**
|
2178
|
+
* The maximum number of results to return per page.
|
2179
|
+
*/
|
2180
|
+
maxResults?: MaxResults;
|
2181
|
+
/**
|
2182
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
2183
|
+
*/
|
2184
|
+
nextToken?: NonEmptyString;
|
2185
|
+
/**
|
2186
|
+
* The search expression for querying the quick response.
|
2187
|
+
*/
|
2188
|
+
searchExpression: QuickResponseSearchExpression;
|
2189
|
+
}
|
2190
|
+
export interface SearchQuickResponsesResponse {
|
2191
|
+
/**
|
2192
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
2193
|
+
*/
|
2194
|
+
nextToken?: NonEmptyString;
|
2195
|
+
/**
|
2196
|
+
* The results of the quick response search.
|
2197
|
+
*/
|
2198
|
+
results: QuickResponseSearchResultsList;
|
2199
|
+
}
|
2200
|
+
export interface SearchSessionsRequest {
|
2201
|
+
/**
|
2202
|
+
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
2203
|
+
*/
|
2204
|
+
assistantId: UuidOrArn;
|
2205
|
+
/**
|
2206
|
+
* The maximum number of results to return per page.
|
2207
|
+
*/
|
2208
|
+
maxResults?: MaxResults;
|
2209
|
+
/**
|
2210
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
2211
|
+
*/
|
2212
|
+
nextToken?: NextToken;
|
2213
|
+
/**
|
2214
|
+
* The search expression to filter results.
|
2215
|
+
*/
|
2216
|
+
searchExpression: SearchExpression;
|
2217
|
+
}
|
2218
|
+
export interface SearchSessionsResponse {
|
2219
|
+
/**
|
2220
|
+
* If there are additional results, this is the token for the next set of results.
|
2221
|
+
*/
|
2222
|
+
nextToken?: NextToken;
|
2223
|
+
/**
|
2224
|
+
* Summary information about the sessions.
|
2225
|
+
*/
|
2226
|
+
sessionSummaries: SessionSummaries;
|
2227
|
+
}
|
2228
|
+
export type SensitiveString = string;
|
2229
|
+
export interface ServerSideEncryptionConfiguration {
|
2230
|
+
/**
|
2231
|
+
* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
|
2232
|
+
*/
|
2233
|
+
kmsKeyId?: NonEmptyString;
|
2234
|
+
}
|
2235
|
+
export interface SessionData {
|
2236
|
+
/**
|
2237
|
+
* The description of the session.
|
2238
|
+
*/
|
2239
|
+
description?: Description;
|
2240
|
+
/**
|
2241
|
+
* The configuration information for the session integration.
|
2242
|
+
*/
|
2243
|
+
integrationConfiguration?: SessionIntegrationConfiguration;
|
2244
|
+
/**
|
2245
|
+
* The name of the session.
|
2246
|
+
*/
|
2247
|
+
name: Name;
|
2248
|
+
/**
|
2249
|
+
* The Amazon Resource Name (ARN) of the session.
|
2250
|
+
*/
|
2251
|
+
sessionArn: Arn;
|
2252
|
+
/**
|
2253
|
+
* The identifier of the session.
|
2254
|
+
*/
|
2255
|
+
sessionId: Uuid;
|
2256
|
+
/**
|
2257
|
+
* The tags used to organize, track, or control access for this resource.
|
2258
|
+
*/
|
2259
|
+
tags?: Tags;
|
2260
|
+
}
|
2261
|
+
export interface SessionIntegrationConfiguration {
|
2262
|
+
/**
|
2263
|
+
* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
|
2264
|
+
*/
|
2265
|
+
topicIntegrationArn?: GenericArn;
|
2266
|
+
}
|
2267
|
+
export type SessionSummaries = SessionSummary[];
|
2268
|
+
export interface SessionSummary {
|
2269
|
+
/**
|
2270
|
+
* The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
2271
|
+
*/
|
2272
|
+
assistantArn: Arn;
|
2273
|
+
/**
|
2274
|
+
* The identifier of the Amazon Q assistant.
|
2275
|
+
*/
|
2276
|
+
assistantId: Uuid;
|
2277
|
+
/**
|
2278
|
+
* The Amazon Resource Name (ARN) of the session.
|
2279
|
+
*/
|
2280
|
+
sessionArn: Arn;
|
2281
|
+
/**
|
2282
|
+
* The identifier of the session.
|
2283
|
+
*/
|
2284
|
+
sessionId: Uuid;
|
2285
|
+
}
|
2286
|
+
export type ShortCutKey = string;
|
2287
|
+
export interface SourceConfiguration {
|
2288
|
+
/**
|
2289
|
+
* Configuration information for Amazon AppIntegrations to automatically ingest content.
|
2290
|
+
*/
|
2291
|
+
appIntegrations?: AppIntegrationsConfiguration;
|
2292
|
+
}
|
2293
|
+
export interface SourceContentDataDetails {
|
2294
|
+
/**
|
2295
|
+
* The identifier of the source content.
|
2296
|
+
*/
|
2297
|
+
id: Uuid;
|
2298
|
+
/**
|
2299
|
+
* Details about the source content ranking data.
|
2300
|
+
*/
|
2301
|
+
rankingData: RankingData;
|
2302
|
+
/**
|
2303
|
+
* Details about the source content text data.
|
2304
|
+
*/
|
2305
|
+
textData: TextData;
|
2306
|
+
/**
|
2307
|
+
* The type of the source content.
|
2308
|
+
*/
|
2309
|
+
type: SourceContentType;
|
2310
|
+
}
|
2311
|
+
export type SourceContentType = "KNOWLEDGE_CONTENT"|string;
|
2312
|
+
export interface StartContentUploadRequest {
|
2313
|
+
/**
|
2314
|
+
* The type of content to upload.
|
2315
|
+
*/
|
2316
|
+
contentType: ContentType;
|
2317
|
+
/**
|
2318
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
2319
|
+
*/
|
2320
|
+
knowledgeBaseId: UuidOrArn;
|
2321
|
+
/**
|
2322
|
+
* The expected expiration time of the generated presigned URL, specified in minutes.
|
2323
|
+
*/
|
2324
|
+
presignedUrlTimeToLive?: TimeToLive;
|
2325
|
+
}
|
2326
|
+
export interface StartContentUploadResponse {
|
2327
|
+
/**
|
2328
|
+
* The headers to include in the upload.
|
2329
|
+
*/
|
2330
|
+
headersToInclude: Headers;
|
2331
|
+
/**
|
2332
|
+
* The identifier of the upload.
|
2333
|
+
*/
|
2334
|
+
uploadId: UploadId;
|
2335
|
+
/**
|
2336
|
+
* The URL of the upload.
|
2337
|
+
*/
|
2338
|
+
url: Url;
|
2339
|
+
/**
|
2340
|
+
* The expiration time of the URL as an epoch timestamp.
|
2341
|
+
*/
|
2342
|
+
urlExpiry: SyntheticTimestamp_epoch_seconds;
|
2343
|
+
}
|
2344
|
+
export interface StartImportJobRequest {
|
2345
|
+
/**
|
2346
|
+
* The tags used to organize, track, or control access for this resource.
|
2347
|
+
*/
|
2348
|
+
clientToken?: NonEmptyString;
|
2349
|
+
/**
|
2350
|
+
* The configuration information of the external source that the resource data are imported from.
|
2351
|
+
*/
|
2352
|
+
externalSourceConfiguration?: ExternalSourceConfiguration;
|
2353
|
+
/**
|
2354
|
+
* The type of the import job. For importing quick response resource, set the value to QUICK_RESPONSES.
|
2355
|
+
*/
|
2356
|
+
importJobType: ImportJobType;
|
2357
|
+
/**
|
2358
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. For importing Amazon Q quick responses, this should be a QUICK_RESPONSES type knowledge base.
|
2359
|
+
*/
|
2360
|
+
knowledgeBaseId: UuidOrArn;
|
2361
|
+
/**
|
2362
|
+
* The metadata fields of the imported Amazon Q resources.
|
2363
|
+
*/
|
2364
|
+
metadata?: ContentMetadata;
|
2365
|
+
/**
|
2366
|
+
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
|
2367
|
+
*/
|
2368
|
+
uploadId: UploadId;
|
2369
|
+
}
|
2370
|
+
export interface StartImportJobResponse {
|
2371
|
+
/**
|
2372
|
+
* The import job.
|
2373
|
+
*/
|
2374
|
+
importJob?: ImportJobData;
|
2375
|
+
}
|
2376
|
+
export type SyntheticTimestamp_epoch_seconds = Date;
|
2377
|
+
export type TagKey = string;
|
2378
|
+
export type TagKeyList = TagKey[];
|
2379
|
+
export interface TagResourceRequest {
|
2380
|
+
/**
|
2381
|
+
* The Amazon Resource Name (ARN) of the resource.
|
2382
|
+
*/
|
2383
|
+
resourceArn: Arn;
|
2384
|
+
/**
|
2385
|
+
* The tags used to organize, track, or control access for this resource.
|
2386
|
+
*/
|
2387
|
+
tags: Tags;
|
2388
|
+
}
|
2389
|
+
export interface TagResourceResponse {
|
2390
|
+
}
|
2391
|
+
export type TagValue = string;
|
2392
|
+
export type Tags = {[key: string]: TagValue};
|
2393
|
+
export interface TextData {
|
2394
|
+
excerpt?: DocumentText;
|
2395
|
+
title?: DocumentText;
|
2396
|
+
}
|
2397
|
+
export type TimeToLive = number;
|
2398
|
+
export interface UntagResourceRequest {
|
2399
|
+
/**
|
2400
|
+
* The Amazon Resource Name (ARN) of the resource.
|
2401
|
+
*/
|
2402
|
+
resourceArn: Arn;
|
2403
|
+
/**
|
2404
|
+
* The tag keys.
|
2405
|
+
*/
|
2406
|
+
tagKeys: TagKeyList;
|
2407
|
+
}
|
2408
|
+
export interface UntagResourceResponse {
|
2409
|
+
}
|
2410
|
+
export interface UpdateContentRequest {
|
2411
|
+
/**
|
2412
|
+
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
2413
|
+
*/
|
2414
|
+
contentId: UuidOrArn;
|
2415
|
+
/**
|
2416
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN
|
2417
|
+
*/
|
2418
|
+
knowledgeBaseId: UuidOrArn;
|
2419
|
+
/**
|
2420
|
+
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.
|
2421
|
+
*/
|
2422
|
+
metadata?: ContentMetadata;
|
2423
|
+
/**
|
2424
|
+
* The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.
|
2425
|
+
*/
|
2426
|
+
overrideLinkOutUri?: Uri;
|
2427
|
+
/**
|
2428
|
+
* Unset the existing overrideLinkOutUri if it exists.
|
2429
|
+
*/
|
2430
|
+
removeOverrideLinkOutUri?: Boolean;
|
2431
|
+
/**
|
2432
|
+
* The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.
|
2433
|
+
*/
|
2434
|
+
revisionId?: NonEmptyString;
|
2435
|
+
/**
|
2436
|
+
* The title of the content.
|
2437
|
+
*/
|
2438
|
+
title?: ContentTitle;
|
2439
|
+
/**
|
2440
|
+
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
|
2441
|
+
*/
|
2442
|
+
uploadId?: UploadId;
|
2443
|
+
}
|
2444
|
+
export interface UpdateContentResponse {
|
2445
|
+
/**
|
2446
|
+
* The content.
|
2447
|
+
*/
|
2448
|
+
content?: ContentData;
|
2449
|
+
}
|
2450
|
+
export interface UpdateKnowledgeBaseTemplateUriRequest {
|
2451
|
+
/**
|
2452
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
2453
|
+
*/
|
2454
|
+
knowledgeBaseId: UuidOrArn;
|
2455
|
+
/**
|
2456
|
+
* The template URI to update.
|
2457
|
+
*/
|
2458
|
+
templateUri: Uri;
|
2459
|
+
}
|
2460
|
+
export interface UpdateKnowledgeBaseTemplateUriResponse {
|
2461
|
+
/**
|
2462
|
+
* The knowledge base to update.
|
2463
|
+
*/
|
2464
|
+
knowledgeBase?: KnowledgeBaseData;
|
2465
|
+
}
|
2466
|
+
export interface UpdateQuickResponseRequest {
|
2467
|
+
/**
|
2468
|
+
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
|
2469
|
+
*/
|
2470
|
+
channels?: Channels;
|
2471
|
+
/**
|
2472
|
+
* The updated content of the quick response.
|
2473
|
+
*/
|
2474
|
+
content?: QuickResponseDataProvider;
|
2475
|
+
/**
|
2476
|
+
* The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext.
|
2477
|
+
*/
|
2478
|
+
contentType?: QuickResponseType;
|
2479
|
+
/**
|
2480
|
+
* The updated description of the quick response.
|
2481
|
+
*/
|
2482
|
+
description?: QuickResponseDescription;
|
2483
|
+
/**
|
2484
|
+
* The updated grouping configuration of the quick response.
|
2485
|
+
*/
|
2486
|
+
groupingConfiguration?: GroupingConfiguration;
|
2487
|
+
/**
|
2488
|
+
* Whether the quick response is active.
|
2489
|
+
*/
|
2490
|
+
isActive?: Boolean;
|
2491
|
+
/**
|
2492
|
+
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
|
2493
|
+
*/
|
2494
|
+
knowledgeBaseId: UuidOrArn;
|
2495
|
+
/**
|
2496
|
+
* The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
|
2497
|
+
*/
|
2498
|
+
language?: LanguageCode;
|
2499
|
+
/**
|
2500
|
+
* The name of the quick response.
|
2501
|
+
*/
|
2502
|
+
name?: QuickResponseName;
|
2503
|
+
/**
|
2504
|
+
* The identifier of the quick response.
|
2505
|
+
*/
|
2506
|
+
quickResponseId: UuidOrArn;
|
2507
|
+
/**
|
2508
|
+
* Whether to remove the description from the quick response.
|
2509
|
+
*/
|
2510
|
+
removeDescription?: Boolean;
|
2511
|
+
/**
|
2512
|
+
* Whether to remove the grouping configuration of the quick response.
|
2513
|
+
*/
|
2514
|
+
removeGroupingConfiguration?: Boolean;
|
2515
|
+
/**
|
2516
|
+
* Whether to remove the shortcut key of the quick response.
|
2517
|
+
*/
|
2518
|
+
removeShortcutKey?: Boolean;
|
2519
|
+
/**
|
2520
|
+
* The shortcut key of the quick response. The value should be unique across the knowledge base.
|
2521
|
+
*/
|
2522
|
+
shortcutKey?: ShortCutKey;
|
2523
|
+
}
|
2524
|
+
export interface UpdateQuickResponseResponse {
|
2525
|
+
/**
|
2526
|
+
* The quick response.
|
2527
|
+
*/
|
2528
|
+
quickResponse?: QuickResponseData;
|
2529
|
+
}
|
2530
|
+
export type UploadId = string;
|
2531
|
+
export type Uri = string;
|
2532
|
+
export type Url = string;
|
2533
|
+
export type Uuid = string;
|
2534
|
+
export type UuidOrArn = string;
|
2535
|
+
export type WaitTimeSeconds = number;
|
2536
|
+
/**
|
2537
|
+
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|
2538
|
+
*/
|
2539
|
+
export type apiVersion = "2020-10-19"|"latest"|string;
|
2540
|
+
export interface ClientApiVersions {
|
2541
|
+
/**
|
2542
|
+
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|
2543
|
+
*/
|
2544
|
+
apiVersion?: apiVersion;
|
2545
|
+
}
|
2546
|
+
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
2547
|
+
/**
|
2548
|
+
* Contains interfaces for use with the QConnect client.
|
2549
|
+
*/
|
2550
|
+
export import Types = QConnect;
|
2551
|
+
}
|
2552
|
+
export = QConnect;
|