@aws-sdk/client-qconnect 3.552.0 → 3.554.0
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/README.md +19 -11
- package/dist-cjs/index.js +80 -1
- package/dist-es/QConnect.js +2 -0
- package/dist-es/commands/UpdateSessionCommand.js +24 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +22 -0
- package/dist-es/protocols/Aws_restJson1.js +31 -0
- package/dist-types/QConnect.d.ts +18 -11
- package/dist-types/QConnectClient.d.ts +14 -13
- package/dist-types/commands/CreateContentCommand.d.ts +1 -2
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/CreateSessionCommand.d.ts +45 -2
- package/dist-types/commands/GetRecommendationsCommand.d.ts +7 -1
- package/dist-types/commands/GetSessionCommand.d.ts +20 -0
- package/dist-types/commands/PutFeedbackCommand.d.ts +2 -1
- package/dist-types/commands/QueryAssistantCommand.d.ts +8 -3
- package/dist-types/commands/SearchQuickResponsesCommand.d.ts +1 -1
- package/dist-types/commands/StartContentUploadCommand.d.ts +4 -2
- package/dist-types/commands/StartImportJobCommand.d.ts +5 -2
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSessionCommand.d.ts +123 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +11 -11
- package/dist-types/models/models_0.d.ts +316 -158
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/QConnect.d.ts +17 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +80 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +4 -4
|
@@ -12,6 +12,23 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
|
+
/**
|
|
16
|
+
* <p>A leaf node condition which can be used to specify a tag condition.
|
|
17
|
+
* </p>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export interface TagCondition {
|
|
21
|
+
/**
|
|
22
|
+
* <p>The tag key in the tag condition.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
key: string | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* <p>The tag value in the tag condition.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
value?: string;
|
|
31
|
+
}
|
|
15
32
|
/**
|
|
16
33
|
* <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
|
|
17
34
|
* @public
|
|
@@ -61,7 +78,7 @@ export interface AppIntegrationsConfiguration {
|
|
|
61
78
|
*/
|
|
62
79
|
appIntegrationArn: string | undefined;
|
|
63
80
|
/**
|
|
64
|
-
* <p>The fields from the source that are made available to your agents in Amazon Q. Optional if
|
|
81
|
+
* <p>The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
|
|
65
82
|
* ObjectConfiguration is included in the provided DataIntegration. </p>
|
|
66
83
|
* <ul>
|
|
67
84
|
* <li>
|
|
@@ -102,7 +119,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
102
119
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
103
120
|
}
|
|
104
121
|
/**
|
|
105
|
-
* <p>The data that is input into Amazon Q as a result of the assistant association.</p>
|
|
122
|
+
* <p>The data that is input into Amazon Q in Connect as a result of the assistant association.</p>
|
|
106
123
|
* @public
|
|
107
124
|
*/
|
|
108
125
|
export type AssistantAssociationInputData = AssistantAssociationInputData.KnowledgeBaseIdMember | AssistantAssociationInputData.$UnknownMember;
|
|
@@ -111,8 +128,7 @@ export type AssistantAssociationInputData = AssistantAssociationInputData.Knowle
|
|
|
111
128
|
*/
|
|
112
129
|
export declare namespace AssistantAssociationInputData {
|
|
113
130
|
/**
|
|
114
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
115
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
131
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.</p>
|
|
116
132
|
* @public
|
|
117
133
|
*/
|
|
118
134
|
interface KnowledgeBaseIdMember {
|
|
@@ -148,7 +164,7 @@ export type AssociationType = (typeof AssociationType)[keyof typeof AssociationT
|
|
|
148
164
|
*/
|
|
149
165
|
export interface CreateAssistantAssociationRequest {
|
|
150
166
|
/**
|
|
151
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
167
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
152
168
|
* @public
|
|
153
169
|
*/
|
|
154
170
|
assistantId: string | undefined;
|
|
@@ -182,8 +198,7 @@ export interface CreateAssistantAssociationRequest {
|
|
|
182
198
|
*/
|
|
183
199
|
export interface KnowledgeBaseAssociationData {
|
|
184
200
|
/**
|
|
185
|
-
* <p>The identifier of the knowledge base
|
|
186
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
201
|
+
* <p>The identifier of the knowledge base.</p>
|
|
187
202
|
* @public
|
|
188
203
|
*/
|
|
189
204
|
knowledgeBaseId?: string;
|
|
@@ -239,12 +254,12 @@ export interface AssistantAssociationData {
|
|
|
239
254
|
*/
|
|
240
255
|
assistantAssociationArn: string | undefined;
|
|
241
256
|
/**
|
|
242
|
-
* <p>The identifier of the Amazon Q assistant.</p>
|
|
257
|
+
* <p>The identifier of the Amazon Q in Connect assistant.</p>
|
|
243
258
|
* @public
|
|
244
259
|
*/
|
|
245
260
|
assistantId: string | undefined;
|
|
246
261
|
/**
|
|
247
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
262
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
248
263
|
* @public
|
|
249
264
|
*/
|
|
250
265
|
assistantArn: string | undefined;
|
|
@@ -326,7 +341,7 @@ export interface DeleteAssistantAssociationRequest {
|
|
|
326
341
|
*/
|
|
327
342
|
assistantAssociationId: string | undefined;
|
|
328
343
|
/**
|
|
329
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
344
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
330
345
|
* @public
|
|
331
346
|
*/
|
|
332
347
|
assistantId: string | undefined;
|
|
@@ -346,7 +361,7 @@ export interface GetAssistantAssociationRequest {
|
|
|
346
361
|
*/
|
|
347
362
|
assistantAssociationId: string | undefined;
|
|
348
363
|
/**
|
|
349
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
364
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
350
365
|
* @public
|
|
351
366
|
*/
|
|
352
367
|
assistantId: string | undefined;
|
|
@@ -377,7 +392,7 @@ export interface ListAssistantAssociationsRequest {
|
|
|
377
392
|
*/
|
|
378
393
|
maxResults?: number;
|
|
379
394
|
/**
|
|
380
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
395
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
381
396
|
* @public
|
|
382
397
|
*/
|
|
383
398
|
assistantId: string | undefined;
|
|
@@ -398,12 +413,12 @@ export interface AssistantAssociationSummary {
|
|
|
398
413
|
*/
|
|
399
414
|
assistantAssociationArn: string | undefined;
|
|
400
415
|
/**
|
|
401
|
-
* <p>The identifier of the Amazon Q assistant.</p>
|
|
416
|
+
* <p>The identifier of the Amazon Q in Connect assistant.</p>
|
|
402
417
|
* @public
|
|
403
418
|
*/
|
|
404
419
|
assistantId: string | undefined;
|
|
405
420
|
/**
|
|
406
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
421
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
407
422
|
* @public
|
|
408
423
|
*/
|
|
409
424
|
assistantArn: string | undefined;
|
|
@@ -445,7 +460,7 @@ export interface ListAssistantAssociationsResponse {
|
|
|
445
460
|
export interface ServerSideEncryptionConfiguration {
|
|
446
461
|
/**
|
|
447
462
|
* <p>The customer managed key used for encryption. For more information about setting up a
|
|
448
|
-
* customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.
|
|
463
|
+
* customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.
|
|
449
464
|
* For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</p>
|
|
450
465
|
* @public
|
|
451
466
|
*/
|
|
@@ -499,11 +514,11 @@ export interface CreateAssistantRequest {
|
|
|
499
514
|
* <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
500
515
|
* <code> kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
501
516
|
* <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
|
|
502
|
-
* key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow
|
|
517
|
+
* key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow
|
|
503
518
|
* <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
|
|
504
519
|
* <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
|
|
505
520
|
* principal. </p>
|
|
506
|
-
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
521
|
+
* <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
507
522
|
* your instance</a>.</p>
|
|
508
523
|
* @public
|
|
509
524
|
*/
|
|
@@ -522,18 +537,18 @@ export declare const AssistantCapabilityType: {
|
|
|
522
537
|
*/
|
|
523
538
|
export type AssistantCapabilityType = (typeof AssistantCapabilityType)[keyof typeof AssistantCapabilityType];
|
|
524
539
|
/**
|
|
525
|
-
* <p>The capability configuration for an Amazon Q assistant. </p>
|
|
540
|
+
* <p>The capability configuration for an Amazon Q in Connect assistant. </p>
|
|
526
541
|
* @public
|
|
527
542
|
*/
|
|
528
543
|
export interface AssistantCapabilityConfiguration {
|
|
529
544
|
/**
|
|
530
|
-
* <p>The type of Amazon Q assistant capability. </p>
|
|
545
|
+
* <p>The type of Amazon Q in Connect assistant capability. </p>
|
|
531
546
|
* @public
|
|
532
547
|
*/
|
|
533
548
|
type?: AssistantCapabilityType;
|
|
534
549
|
}
|
|
535
550
|
/**
|
|
536
|
-
* <p>The configuration information for the Amazon Q assistant integration.</p>
|
|
551
|
+
* <p>The configuration information for the Amazon Q in Connect assistant integration.</p>
|
|
537
552
|
* @public
|
|
538
553
|
*/
|
|
539
554
|
export interface AssistantIntegrationConfiguration {
|
|
@@ -565,12 +580,12 @@ export type AssistantStatus = (typeof AssistantStatus)[keyof typeof AssistantSta
|
|
|
565
580
|
*/
|
|
566
581
|
export interface AssistantData {
|
|
567
582
|
/**
|
|
568
|
-
* <p>The identifier of the Amazon Q assistant.</p>
|
|
583
|
+
* <p>The identifier of the Amazon Q in Connect assistant.</p>
|
|
569
584
|
* @public
|
|
570
585
|
*/
|
|
571
586
|
assistantId: string | undefined;
|
|
572
587
|
/**
|
|
573
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
588
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
574
589
|
* @public
|
|
575
590
|
*/
|
|
576
591
|
assistantArn: string | undefined;
|
|
@@ -604,22 +619,22 @@ export interface AssistantData {
|
|
|
604
619
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
605
620
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
606
621
|
* <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
|
|
607
|
-
* key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow
|
|
622
|
+
* key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow
|
|
608
623
|
* <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
|
|
609
624
|
* <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
|
|
610
625
|
* principal. </p>
|
|
611
|
-
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
626
|
+
* <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
612
627
|
* your instance</a>.</p>
|
|
613
628
|
* @public
|
|
614
629
|
*/
|
|
615
630
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
616
631
|
/**
|
|
617
|
-
* <p>The configuration information for the Amazon Q assistant integration.</p>
|
|
632
|
+
* <p>The configuration information for the Amazon Q in Connect assistant integration.</p>
|
|
618
633
|
* @public
|
|
619
634
|
*/
|
|
620
635
|
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
621
636
|
/**
|
|
622
|
-
* <p>The configuration information for the Amazon Q assistant capability. </p>
|
|
637
|
+
* <p>The configuration information for the Amazon Q in Connect assistant capability. </p>
|
|
623
638
|
* @public
|
|
624
639
|
*/
|
|
625
640
|
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
@@ -639,7 +654,7 @@ export interface CreateAssistantResponse {
|
|
|
639
654
|
*/
|
|
640
655
|
export interface DeleteAssistantRequest {
|
|
641
656
|
/**
|
|
642
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
657
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
643
658
|
* @public
|
|
644
659
|
*/
|
|
645
660
|
assistantId: string | undefined;
|
|
@@ -654,7 +669,7 @@ export interface DeleteAssistantResponse {
|
|
|
654
669
|
*/
|
|
655
670
|
export interface GetAssistantRequest {
|
|
656
671
|
/**
|
|
657
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
672
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
658
673
|
* @public
|
|
659
674
|
*/
|
|
660
675
|
assistantId: string | undefined;
|
|
@@ -674,7 +689,7 @@ export interface GetAssistantResponse {
|
|
|
674
689
|
*/
|
|
675
690
|
export interface GetRecommendationsRequest {
|
|
676
691
|
/**
|
|
677
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
692
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
678
693
|
* @public
|
|
679
694
|
*/
|
|
680
695
|
assistantId: string | undefined;
|
|
@@ -839,8 +854,7 @@ export interface ContentReference {
|
|
|
839
854
|
*/
|
|
840
855
|
knowledgeBaseArn?: string;
|
|
841
856
|
/**
|
|
842
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
843
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
857
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.</p>
|
|
844
858
|
* @public
|
|
845
859
|
*/
|
|
846
860
|
knowledgeBaseId?: string;
|
|
@@ -1078,12 +1092,12 @@ export interface ListAssistantsRequest {
|
|
|
1078
1092
|
*/
|
|
1079
1093
|
export interface AssistantSummary {
|
|
1080
1094
|
/**
|
|
1081
|
-
* <p>The identifier of the Amazon Q assistant.</p>
|
|
1095
|
+
* <p>The identifier of the Amazon Q in Connect assistant.</p>
|
|
1082
1096
|
* @public
|
|
1083
1097
|
*/
|
|
1084
1098
|
assistantId: string | undefined;
|
|
1085
1099
|
/**
|
|
1086
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
1100
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
1087
1101
|
* @public
|
|
1088
1102
|
*/
|
|
1089
1103
|
assistantArn: string | undefined;
|
|
@@ -1117,22 +1131,22 @@ export interface AssistantSummary {
|
|
|
1117
1131
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
1118
1132
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
1119
1133
|
* <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
|
|
1120
|
-
* key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow
|
|
1134
|
+
* key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow
|
|
1121
1135
|
* <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
|
|
1122
1136
|
* <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
|
|
1123
1137
|
* principal. </p>
|
|
1124
|
-
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
1138
|
+
* <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
1125
1139
|
* your instance</a>.</p>
|
|
1126
1140
|
* @public
|
|
1127
1141
|
*/
|
|
1128
1142
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1129
1143
|
/**
|
|
1130
|
-
* <p>The configuration information for the Amazon Q assistant integration.</p>
|
|
1144
|
+
* <p>The configuration information for the Amazon Q in Connect assistant integration.</p>
|
|
1131
1145
|
* @public
|
|
1132
1146
|
*/
|
|
1133
1147
|
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
1134
1148
|
/**
|
|
1135
|
-
* <p>The configuration information for the Amazon Q assistant capability. </p>
|
|
1149
|
+
* <p>The configuration information for the Amazon Q in Connect assistant capability. </p>
|
|
1136
1150
|
* @public
|
|
1137
1151
|
*/
|
|
1138
1152
|
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
@@ -1157,7 +1171,7 @@ export interface ListAssistantsResponse {
|
|
|
1157
1171
|
*/
|
|
1158
1172
|
export interface NotifyRecommendationsReceivedRequest {
|
|
1159
1173
|
/**
|
|
1160
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1174
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1161
1175
|
* @public
|
|
1162
1176
|
*/
|
|
1163
1177
|
assistantId: string | undefined;
|
|
@@ -1273,7 +1287,7 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType];
|
|
|
1273
1287
|
*/
|
|
1274
1288
|
export interface PutFeedbackRequest {
|
|
1275
1289
|
/**
|
|
1276
|
-
* <p>The identifier of the Amazon Q assistant.</p>
|
|
1290
|
+
* <p>The identifier of the Amazon Q in Connect assistant.</p>
|
|
1277
1291
|
* @public
|
|
1278
1292
|
*/
|
|
1279
1293
|
assistantId: string | undefined;
|
|
@@ -1298,12 +1312,12 @@ export interface PutFeedbackRequest {
|
|
|
1298
1312
|
*/
|
|
1299
1313
|
export interface PutFeedbackResponse {
|
|
1300
1314
|
/**
|
|
1301
|
-
* <p>The identifier of the Amazon Q assistant.</p>
|
|
1315
|
+
* <p>The identifier of the Amazon Q in Connect assistant.</p>
|
|
1302
1316
|
* @public
|
|
1303
1317
|
*/
|
|
1304
1318
|
assistantId: string | undefined;
|
|
1305
1319
|
/**
|
|
1306
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
1320
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
1307
1321
|
* @public
|
|
1308
1322
|
*/
|
|
1309
1323
|
assistantArn: string | undefined;
|
|
@@ -1401,7 +1415,7 @@ export declare namespace QueryCondition {
|
|
|
1401
1415
|
*/
|
|
1402
1416
|
export interface QueryAssistantRequest {
|
|
1403
1417
|
/**
|
|
1404
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1418
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1405
1419
|
* @public
|
|
1406
1420
|
*/
|
|
1407
1421
|
assistantId: string | undefined;
|
|
@@ -1422,7 +1436,7 @@ export interface QueryAssistantRequest {
|
|
|
1422
1436
|
*/
|
|
1423
1437
|
maxResults?: number;
|
|
1424
1438
|
/**
|
|
1425
|
-
* <p>The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot
|
|
1439
|
+
* <p>The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot
|
|
1426
1440
|
* contain the ARN.</p>
|
|
1427
1441
|
* @public
|
|
1428
1442
|
*/
|
|
@@ -1530,7 +1544,7 @@ export interface SearchSessionsRequest {
|
|
|
1530
1544
|
*/
|
|
1531
1545
|
maxResults?: number;
|
|
1532
1546
|
/**
|
|
1533
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1547
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1534
1548
|
* @public
|
|
1535
1549
|
*/
|
|
1536
1550
|
assistantId: string | undefined;
|
|
@@ -1556,12 +1570,12 @@ export interface SessionSummary {
|
|
|
1556
1570
|
*/
|
|
1557
1571
|
sessionArn: string | undefined;
|
|
1558
1572
|
/**
|
|
1559
|
-
* <p>The identifier of the Amazon Q assistant.</p>
|
|
1573
|
+
* <p>The identifier of the Amazon Q in Connect assistant.</p>
|
|
1560
1574
|
* @public
|
|
1561
1575
|
*/
|
|
1562
1576
|
assistantId: string | undefined;
|
|
1563
1577
|
/**
|
|
1564
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
1578
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
1565
1579
|
* @public
|
|
1566
1580
|
*/
|
|
1567
1581
|
assistantArn: string | undefined;
|
|
@@ -1581,6 +1595,104 @@ export interface SearchSessionsResponse {
|
|
|
1581
1595
|
*/
|
|
1582
1596
|
nextToken?: string;
|
|
1583
1597
|
}
|
|
1598
|
+
/**
|
|
1599
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
export type OrCondition = OrCondition.AndConditionsMember | OrCondition.TagConditionMember | OrCondition.$UnknownMember;
|
|
1603
|
+
/**
|
|
1604
|
+
* @public
|
|
1605
|
+
*/
|
|
1606
|
+
export declare namespace OrCondition {
|
|
1607
|
+
/**
|
|
1608
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
1609
|
+
* @public
|
|
1610
|
+
*/
|
|
1611
|
+
interface AndConditionsMember {
|
|
1612
|
+
andConditions: TagCondition[];
|
|
1613
|
+
tagCondition?: never;
|
|
1614
|
+
$unknown?: never;
|
|
1615
|
+
}
|
|
1616
|
+
/**
|
|
1617
|
+
* <p>A leaf node condition which can be used to specify a tag condition.</p>
|
|
1618
|
+
* @public
|
|
1619
|
+
*/
|
|
1620
|
+
interface TagConditionMember {
|
|
1621
|
+
andConditions?: never;
|
|
1622
|
+
tagCondition: TagCondition;
|
|
1623
|
+
$unknown?: never;
|
|
1624
|
+
}
|
|
1625
|
+
/**
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
interface $UnknownMember {
|
|
1629
|
+
andConditions?: never;
|
|
1630
|
+
tagCondition?: never;
|
|
1631
|
+
$unknown: [string, any];
|
|
1632
|
+
}
|
|
1633
|
+
interface Visitor<T> {
|
|
1634
|
+
andConditions: (value: TagCondition[]) => T;
|
|
1635
|
+
tagCondition: (value: TagCondition) => T;
|
|
1636
|
+
_: (name: string, value: any) => T;
|
|
1637
|
+
}
|
|
1638
|
+
const visit: <T>(value: OrCondition, visitor: Visitor<T>) => T;
|
|
1639
|
+
}
|
|
1640
|
+
/**
|
|
1641
|
+
* <p>An object that can be used to specify Tag conditions.</p>
|
|
1642
|
+
* @public
|
|
1643
|
+
*/
|
|
1644
|
+
export type TagFilter = TagFilter.AndConditionsMember | TagFilter.OrConditionsMember | TagFilter.TagConditionMember | TagFilter.$UnknownMember;
|
|
1645
|
+
/**
|
|
1646
|
+
* @public
|
|
1647
|
+
*/
|
|
1648
|
+
export declare namespace TagFilter {
|
|
1649
|
+
/**
|
|
1650
|
+
* <p>A leaf node condition which can be used to specify a tag condition.</p>
|
|
1651
|
+
* @public
|
|
1652
|
+
*/
|
|
1653
|
+
interface TagConditionMember {
|
|
1654
|
+
tagCondition: TagCondition;
|
|
1655
|
+
andConditions?: never;
|
|
1656
|
+
orConditions?: never;
|
|
1657
|
+
$unknown?: never;
|
|
1658
|
+
}
|
|
1659
|
+
/**
|
|
1660
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
interface AndConditionsMember {
|
|
1664
|
+
tagCondition?: never;
|
|
1665
|
+
andConditions: TagCondition[];
|
|
1666
|
+
orConditions?: never;
|
|
1667
|
+
$unknown?: never;
|
|
1668
|
+
}
|
|
1669
|
+
/**
|
|
1670
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
1671
|
+
* @public
|
|
1672
|
+
*/
|
|
1673
|
+
interface OrConditionsMember {
|
|
1674
|
+
tagCondition?: never;
|
|
1675
|
+
andConditions?: never;
|
|
1676
|
+
orConditions: OrCondition[];
|
|
1677
|
+
$unknown?: never;
|
|
1678
|
+
}
|
|
1679
|
+
/**
|
|
1680
|
+
* @public
|
|
1681
|
+
*/
|
|
1682
|
+
interface $UnknownMember {
|
|
1683
|
+
tagCondition?: never;
|
|
1684
|
+
andConditions?: never;
|
|
1685
|
+
orConditions?: never;
|
|
1686
|
+
$unknown: [string, any];
|
|
1687
|
+
}
|
|
1688
|
+
interface Visitor<T> {
|
|
1689
|
+
tagCondition: (value: TagCondition) => T;
|
|
1690
|
+
andConditions: (value: TagCondition[]) => T;
|
|
1691
|
+
orConditions: (value: OrCondition[]) => T;
|
|
1692
|
+
_: (name: string, value: any) => T;
|
|
1693
|
+
}
|
|
1694
|
+
const visit: <T>(value: TagFilter, visitor: Visitor<T>) => T;
|
|
1695
|
+
}
|
|
1584
1696
|
/**
|
|
1585
1697
|
* @public
|
|
1586
1698
|
*/
|
|
@@ -1594,7 +1706,7 @@ export interface CreateSessionRequest {
|
|
|
1594
1706
|
*/
|
|
1595
1707
|
clientToken?: string;
|
|
1596
1708
|
/**
|
|
1597
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1709
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1598
1710
|
* @public
|
|
1599
1711
|
*/
|
|
1600
1712
|
assistantId: string | undefined;
|
|
@@ -1613,6 +1725,11 @@ export interface CreateSessionRequest {
|
|
|
1613
1725
|
* @public
|
|
1614
1726
|
*/
|
|
1615
1727
|
tags?: Record<string, string>;
|
|
1728
|
+
/**
|
|
1729
|
+
* <p>An object that can be used to specify Tag conditions. </p>
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1732
|
+
tagFilter?: TagFilter;
|
|
1616
1733
|
}
|
|
1617
1734
|
/**
|
|
1618
1735
|
* <p>The configuration information for the session integration.</p>
|
|
@@ -1660,6 +1777,11 @@ export interface SessionData {
|
|
|
1660
1777
|
* @public
|
|
1661
1778
|
*/
|
|
1662
1779
|
integrationConfiguration?: SessionIntegrationConfiguration;
|
|
1780
|
+
/**
|
|
1781
|
+
* <p>An object that can be used to specify Tag conditions.</p>
|
|
1782
|
+
* @public
|
|
1783
|
+
*/
|
|
1784
|
+
tagFilter?: TagFilter;
|
|
1663
1785
|
}
|
|
1664
1786
|
/**
|
|
1665
1787
|
* @public
|
|
@@ -1676,7 +1798,7 @@ export interface CreateSessionResponse {
|
|
|
1676
1798
|
*/
|
|
1677
1799
|
export interface GetSessionRequest {
|
|
1678
1800
|
/**
|
|
1679
|
-
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1801
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1680
1802
|
* @public
|
|
1681
1803
|
*/
|
|
1682
1804
|
assistantId: string | undefined;
|
|
@@ -1696,6 +1818,41 @@ export interface GetSessionResponse {
|
|
|
1696
1818
|
*/
|
|
1697
1819
|
session?: SessionData;
|
|
1698
1820
|
}
|
|
1821
|
+
/**
|
|
1822
|
+
* @public
|
|
1823
|
+
*/
|
|
1824
|
+
export interface UpdateSessionRequest {
|
|
1825
|
+
/**
|
|
1826
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1827
|
+
* @public
|
|
1828
|
+
*/
|
|
1829
|
+
assistantId: string | undefined;
|
|
1830
|
+
/**
|
|
1831
|
+
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1832
|
+
* @public
|
|
1833
|
+
*/
|
|
1834
|
+
sessionId: string | undefined;
|
|
1835
|
+
/**
|
|
1836
|
+
* <p>The description.</p>
|
|
1837
|
+
* @public
|
|
1838
|
+
*/
|
|
1839
|
+
description?: string;
|
|
1840
|
+
/**
|
|
1841
|
+
* <p>An object that can be used to specify Tag conditions.</p>
|
|
1842
|
+
* @public
|
|
1843
|
+
*/
|
|
1844
|
+
tagFilter?: TagFilter;
|
|
1845
|
+
}
|
|
1846
|
+
/**
|
|
1847
|
+
* @public
|
|
1848
|
+
*/
|
|
1849
|
+
export interface UpdateSessionResponse {
|
|
1850
|
+
/**
|
|
1851
|
+
* <p>Information about the session.</p>
|
|
1852
|
+
* @public
|
|
1853
|
+
*/
|
|
1854
|
+
session?: SessionData;
|
|
1855
|
+
}
|
|
1699
1856
|
/**
|
|
1700
1857
|
* <p>The configuration information of the Amazon Connect data source.</p>
|
|
1701
1858
|
* @public
|
|
@@ -1742,15 +1899,15 @@ export declare namespace Configuration {
|
|
|
1742
1899
|
*/
|
|
1743
1900
|
export interface CreateContentRequest {
|
|
1744
1901
|
/**
|
|
1745
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1746
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1902
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1747
1903
|
* @public
|
|
1748
1904
|
*/
|
|
1749
1905
|
knowledgeBaseId: string | undefined;
|
|
1750
1906
|
/**
|
|
1751
1907
|
* <p>The name of the content. Each piece of content in a knowledge base must have a unique
|
|
1752
1908
|
* name. You can retrieve a piece of content using only its knowledge base and its name with the
|
|
1753
|
-
* <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a>
|
|
1909
|
+
* <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a>
|
|
1910
|
+
* API.</p>
|
|
1754
1911
|
* @public
|
|
1755
1912
|
*/
|
|
1756
1913
|
name: string | undefined;
|
|
@@ -1767,7 +1924,7 @@ export interface CreateContentRequest {
|
|
|
1767
1924
|
overrideLinkOutUri?: string;
|
|
1768
1925
|
/**
|
|
1769
1926
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1770
|
-
* 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.</p>
|
|
1927
|
+
* For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
1771
1928
|
* @public
|
|
1772
1929
|
*/
|
|
1773
1930
|
metadata?: Record<string, string>;
|
|
@@ -1828,8 +1985,7 @@ export interface ContentData {
|
|
|
1828
1985
|
*/
|
|
1829
1986
|
knowledgeBaseArn: string | undefined;
|
|
1830
1987
|
/**
|
|
1831
|
-
* <p>The identifier of the knowledge base
|
|
1832
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
1988
|
+
* <p>The identifier of the knowledge base.</p>
|
|
1833
1989
|
* @public
|
|
1834
1990
|
*/
|
|
1835
1991
|
knowledgeBaseId: string | undefined;
|
|
@@ -1860,7 +2016,7 @@ export interface ContentData {
|
|
|
1860
2016
|
status: ContentStatus | undefined;
|
|
1861
2017
|
/**
|
|
1862
2018
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1863
|
-
* 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.</p>
|
|
2019
|
+
* For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
1864
2020
|
* @public
|
|
1865
2021
|
*/
|
|
1866
2022
|
metadata: Record<string, string> | undefined;
|
|
@@ -1900,8 +2056,7 @@ export interface CreateContentResponse {
|
|
|
1900
2056
|
*/
|
|
1901
2057
|
export interface DeleteContentRequest {
|
|
1902
2058
|
/**
|
|
1903
|
-
* <p>The identifier of the knowledge base.
|
|
1904
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2059
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1905
2060
|
* @public
|
|
1906
2061
|
*/
|
|
1907
2062
|
knowledgeBaseId: string | undefined;
|
|
@@ -1926,8 +2081,7 @@ export interface GetContentRequest {
|
|
|
1926
2081
|
*/
|
|
1927
2082
|
contentId: string | undefined;
|
|
1928
2083
|
/**
|
|
1929
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1930
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2084
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1931
2085
|
* @public
|
|
1932
2086
|
*/
|
|
1933
2087
|
knowledgeBaseId: string | undefined;
|
|
@@ -1952,8 +2106,7 @@ export interface GetContentSummaryRequest {
|
|
|
1952
2106
|
*/
|
|
1953
2107
|
contentId: string | undefined;
|
|
1954
2108
|
/**
|
|
1955
|
-
* <p>The identifier of the knowledge base.
|
|
1956
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2109
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1957
2110
|
* @public
|
|
1958
2111
|
*/
|
|
1959
2112
|
knowledgeBaseId: string | undefined;
|
|
@@ -1979,8 +2132,7 @@ export interface ContentSummary {
|
|
|
1979
2132
|
*/
|
|
1980
2133
|
knowledgeBaseArn: string | undefined;
|
|
1981
2134
|
/**
|
|
1982
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1983
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2135
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.</p>
|
|
1984
2136
|
* @public
|
|
1985
2137
|
*/
|
|
1986
2138
|
knowledgeBaseId: string | undefined;
|
|
@@ -2011,7 +2163,7 @@ export interface ContentSummary {
|
|
|
2011
2163
|
status: ContentStatus | undefined;
|
|
2012
2164
|
/**
|
|
2013
2165
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
2014
|
-
* 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.</p>
|
|
2166
|
+
* For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
2015
2167
|
* @public
|
|
2016
2168
|
*/
|
|
2017
2169
|
metadata: Record<string, string> | undefined;
|
|
@@ -2047,8 +2199,7 @@ export interface ListContentsRequest {
|
|
|
2047
2199
|
*/
|
|
2048
2200
|
maxResults?: number;
|
|
2049
2201
|
/**
|
|
2050
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2051
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2202
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2052
2203
|
* @public
|
|
2053
2204
|
*/
|
|
2054
2205
|
knowledgeBaseId: string | undefined;
|
|
@@ -2086,8 +2237,7 @@ export declare class PreconditionFailedException extends __BaseException {
|
|
|
2086
2237
|
*/
|
|
2087
2238
|
export interface UpdateContentRequest {
|
|
2088
2239
|
/**
|
|
2089
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2090
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN</p>
|
|
2240
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN</p>
|
|
2091
2241
|
* @public
|
|
2092
2242
|
*/
|
|
2093
2243
|
knowledgeBaseId: string | undefined;
|
|
@@ -2124,14 +2274,13 @@ export interface UpdateContentRequest {
|
|
|
2124
2274
|
removeOverrideLinkOutUri?: boolean;
|
|
2125
2275
|
/**
|
|
2126
2276
|
* <p>A key/value map to store attributes without affecting tagging or recommendations. For
|
|
2127
|
-
* example, when synchronizing data between an external system and Amazon Q, you can store an
|
|
2277
|
+
* example, when synchronizing data between an external system and Amazon Q in Connect, you can store an
|
|
2128
2278
|
* external version identifier as metadata to utilize for determining drift.</p>
|
|
2129
2279
|
* @public
|
|
2130
2280
|
*/
|
|
2131
2281
|
metadata?: Record<string, string>;
|
|
2132
2282
|
/**
|
|
2133
|
-
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.
|
|
2134
|
-
* </p>
|
|
2283
|
+
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>. </p>
|
|
2135
2284
|
* @public
|
|
2136
2285
|
*/
|
|
2137
2286
|
uploadId?: string;
|
|
@@ -2260,8 +2409,8 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
2260
2409
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
2261
2410
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
2262
2411
|
* <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
|
|
2263
|
-
* key to invoke Amazon Q.</p>
|
|
2264
|
-
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
2412
|
+
* key to invoke Amazon Q in Connect.</p>
|
|
2413
|
+
* <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
2265
2414
|
* your instance</a>.</p>
|
|
2266
2415
|
* @public
|
|
2267
2416
|
*/
|
|
@@ -2299,8 +2448,7 @@ export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof Know
|
|
|
2299
2448
|
*/
|
|
2300
2449
|
export interface KnowledgeBaseData {
|
|
2301
2450
|
/**
|
|
2302
|
-
* <p>The identifier of the knowledge base
|
|
2303
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2451
|
+
* <p>The identifier of the knowledge base.</p>
|
|
2304
2452
|
* @public
|
|
2305
2453
|
*/
|
|
2306
2454
|
knowledgeBaseId: string | undefined;
|
|
@@ -2345,8 +2493,8 @@ export interface KnowledgeBaseData {
|
|
|
2345
2493
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
2346
2494
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
2347
2495
|
* <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
|
|
2348
|
-
* key to invoke Amazon Q. </p>
|
|
2349
|
-
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
2496
|
+
* key to invoke Amazon Q in Connect. </p>
|
|
2497
|
+
* <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
2350
2498
|
* your instance</a>.</p>
|
|
2351
2499
|
* @public
|
|
2352
2500
|
*/
|
|
@@ -2403,29 +2551,30 @@ export declare namespace QuickResponseDataProvider {
|
|
|
2403
2551
|
const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
|
|
2404
2552
|
}
|
|
2405
2553
|
/**
|
|
2406
|
-
* <p>The configuration information of the grouping of Amazon Q users.</p>
|
|
2554
|
+
* <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
|
|
2407
2555
|
* @public
|
|
2408
2556
|
*/
|
|
2409
2557
|
export interface GroupingConfiguration {
|
|
2410
2558
|
/**
|
|
2411
|
-
* <p>The criteria used for grouping Amazon Q users.</p>
|
|
2559
|
+
* <p>The criteria used for grouping Amazon Q in Connect users.</p>
|
|
2412
2560
|
* <p>The following is the list of supported criteria values.</p>
|
|
2413
2561
|
* <ul>
|
|
2414
2562
|
* <li>
|
|
2415
2563
|
* <p>
|
|
2416
|
-
* <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon
|
|
2417
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p>
|
|
2564
|
+
* <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon
|
|
2565
|
+
* Connect routing profile ARN</a>. User should have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfile</a> and <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p>
|
|
2418
2566
|
* </li>
|
|
2419
2567
|
* </ul>
|
|
2420
2568
|
* @public
|
|
2421
2569
|
*/
|
|
2422
2570
|
criteria?: string;
|
|
2423
2571
|
/**
|
|
2424
|
-
* <p>The list of values that define different groups of Amazon Q users.</p>
|
|
2572
|
+
* <p>The list of values that define different groups of Amazon Q in Connect users.</p>
|
|
2425
2573
|
* <ul>
|
|
2426
2574
|
* <li>
|
|
2427
|
-
* <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to
|
|
2428
|
-
*
|
|
2575
|
+
* <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to
|
|
2576
|
+
* provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing
|
|
2577
|
+
* profiles</a> as values of this parameter.</p>
|
|
2429
2578
|
* </li>
|
|
2430
2579
|
* </ul>
|
|
2431
2580
|
* @public
|
|
@@ -2437,8 +2586,7 @@ export interface GroupingConfiguration {
|
|
|
2437
2586
|
*/
|
|
2438
2587
|
export interface CreateQuickResponseRequest {
|
|
2439
2588
|
/**
|
|
2440
|
-
* <p>The identifier of the knowledge base.
|
|
2441
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2589
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2442
2590
|
* @public
|
|
2443
2591
|
*/
|
|
2444
2592
|
knowledgeBaseId: string | undefined;
|
|
@@ -2456,17 +2604,20 @@ export interface CreateQuickResponseRequest {
|
|
|
2456
2604
|
* <p>The media type of the quick response content.</p>
|
|
2457
2605
|
* <ul>
|
|
2458
2606
|
* <li>
|
|
2459
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written
|
|
2607
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written
|
|
2608
|
+
* in plain text.</p>
|
|
2460
2609
|
* </li>
|
|
2461
2610
|
* <li>
|
|
2462
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response
|
|
2611
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response
|
|
2612
|
+
* written in richtext.</p>
|
|
2463
2613
|
* </li>
|
|
2464
2614
|
* </ul>
|
|
2465
2615
|
* @public
|
|
2466
2616
|
*/
|
|
2467
2617
|
contentType?: string;
|
|
2468
2618
|
/**
|
|
2469
|
-
* <p>The configuration information of the user groups that the quick response is accessible
|
|
2619
|
+
* <p>The configuration information of the user groups that the quick response is accessible
|
|
2620
|
+
* to.</p>
|
|
2470
2621
|
* @public
|
|
2471
2622
|
*/
|
|
2472
2623
|
groupingConfiguration?: GroupingConfiguration;
|
|
@@ -2477,8 +2628,7 @@ export interface CreateQuickResponseRequest {
|
|
|
2477
2628
|
description?: string;
|
|
2478
2629
|
/**
|
|
2479
2630
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
2480
|
-
* knowledge base.
|
|
2481
|
-
* </p>
|
|
2631
|
+
* knowledge base. </p>
|
|
2482
2632
|
* @public
|
|
2483
2633
|
*/
|
|
2484
2634
|
shortcutKey?: string;
|
|
@@ -2493,7 +2643,7 @@ export interface CreateQuickResponseRequest {
|
|
|
2493
2643
|
*/
|
|
2494
2644
|
channels?: string[];
|
|
2495
2645
|
/**
|
|
2496
|
-
* <p>The language code value for the language in which the quick response is written.
|
|
2646
|
+
* <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
|
|
2497
2647
|
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
2498
2648
|
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
2499
2649
|
* </p>
|
|
@@ -2599,8 +2749,7 @@ export interface QuickResponseData {
|
|
|
2599
2749
|
*/
|
|
2600
2750
|
knowledgeBaseArn: string | undefined;
|
|
2601
2751
|
/**
|
|
2602
|
-
* <p>The identifier of the knowledge base.
|
|
2603
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2752
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2604
2753
|
* @public
|
|
2605
2754
|
*/
|
|
2606
2755
|
knowledgeBaseId: string | undefined;
|
|
@@ -2613,10 +2762,12 @@ export interface QuickResponseData {
|
|
|
2613
2762
|
* <p>The media type of the quick response content.</p>
|
|
2614
2763
|
* <ul>
|
|
2615
2764
|
* <li>
|
|
2616
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
2765
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
2766
|
+
* in plain text.</p>
|
|
2617
2767
|
* </li>
|
|
2618
2768
|
* <li>
|
|
2619
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
2769
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
2770
|
+
* written in richtext.</p>
|
|
2620
2771
|
* </li>
|
|
2621
2772
|
* </ul>
|
|
2622
2773
|
* @public
|
|
@@ -2648,7 +2799,8 @@ export interface QuickResponseData {
|
|
|
2648
2799
|
*/
|
|
2649
2800
|
description?: string;
|
|
2650
2801
|
/**
|
|
2651
|
-
* <p>The configuration information of the user groups that the quick response is accessible
|
|
2802
|
+
* <p>The configuration information of the user groups that the quick response is accessible
|
|
2803
|
+
* to.</p>
|
|
2652
2804
|
* @public
|
|
2653
2805
|
*/
|
|
2654
2806
|
groupingConfiguration?: GroupingConfiguration;
|
|
@@ -2659,7 +2811,8 @@ export interface QuickResponseData {
|
|
|
2659
2811
|
*/
|
|
2660
2812
|
shortcutKey?: string;
|
|
2661
2813
|
/**
|
|
2662
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
2814
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
2815
|
+
* data.</p>
|
|
2663
2816
|
* @public
|
|
2664
2817
|
*/
|
|
2665
2818
|
lastModifiedBy?: string;
|
|
@@ -2669,7 +2822,8 @@ export interface QuickResponseData {
|
|
|
2669
2822
|
*/
|
|
2670
2823
|
isActive?: boolean;
|
|
2671
2824
|
/**
|
|
2672
|
-
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
2825
|
+
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
2826
|
+
* The supported contact channel types include <code>Chat</code>.</p>
|
|
2673
2827
|
* @public
|
|
2674
2828
|
*/
|
|
2675
2829
|
channels?: string[];
|
|
@@ -2699,8 +2853,7 @@ export interface CreateQuickResponseResponse {
|
|
|
2699
2853
|
*/
|
|
2700
2854
|
export interface DeleteImportJobRequest {
|
|
2701
2855
|
/**
|
|
2702
|
-
* <p>The identifier of the knowledge base
|
|
2703
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2856
|
+
* <p>The identifier of the knowledge base.</p>
|
|
2704
2857
|
* @public
|
|
2705
2858
|
*/
|
|
2706
2859
|
knowledgeBaseId: string | undefined;
|
|
@@ -2735,8 +2888,7 @@ export interface DeleteKnowledgeBaseResponse {
|
|
|
2735
2888
|
*/
|
|
2736
2889
|
export interface DeleteQuickResponseRequest {
|
|
2737
2890
|
/**
|
|
2738
|
-
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base
|
|
2739
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2891
|
+
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base.</p>
|
|
2740
2892
|
* @public
|
|
2741
2893
|
*/
|
|
2742
2894
|
knowledgeBaseId: string | undefined;
|
|
@@ -2831,8 +2983,7 @@ export interface ImportJobData {
|
|
|
2831
2983
|
*/
|
|
2832
2984
|
importJobId: string | undefined;
|
|
2833
2985
|
/**
|
|
2834
|
-
* <p>The identifier of the knowledge base
|
|
2835
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2986
|
+
* <p>The identifier of the knowledge base.</p>
|
|
2836
2987
|
* @public
|
|
2837
2988
|
*/
|
|
2838
2989
|
knowledgeBaseId: string | undefined;
|
|
@@ -2882,7 +3033,7 @@ export interface ImportJobData {
|
|
|
2882
3033
|
*/
|
|
2883
3034
|
lastModifiedTime: Date | undefined;
|
|
2884
3035
|
/**
|
|
2885
|
-
* <p>The metadata fields of the imported Amazon Q resources.</p>
|
|
3036
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
2886
3037
|
* @public
|
|
2887
3038
|
*/
|
|
2888
3039
|
metadata?: Record<string, string>;
|
|
@@ -2907,8 +3058,7 @@ export interface GetImportJobResponse {
|
|
|
2907
3058
|
*/
|
|
2908
3059
|
export interface GetKnowledgeBaseRequest {
|
|
2909
3060
|
/**
|
|
2910
|
-
* <p>The identifier of the knowledge base.
|
|
2911
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3061
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2912
3062
|
* @public
|
|
2913
3063
|
*/
|
|
2914
3064
|
knowledgeBaseId: string | undefined;
|
|
@@ -2959,8 +3109,7 @@ export interface ImportJobSummary {
|
|
|
2959
3109
|
*/
|
|
2960
3110
|
importJobId: string | undefined;
|
|
2961
3111
|
/**
|
|
2962
|
-
* <p>The identifier of the knowledge base
|
|
2963
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
3112
|
+
* <p>The identifier of the knowledge base.</p>
|
|
2964
3113
|
* @public
|
|
2965
3114
|
*/
|
|
2966
3115
|
knowledgeBaseId: string | undefined;
|
|
@@ -2995,12 +3144,13 @@ export interface ImportJobSummary {
|
|
|
2995
3144
|
*/
|
|
2996
3145
|
lastModifiedTime: Date | undefined;
|
|
2997
3146
|
/**
|
|
2998
|
-
* <p>The metadata fields of the imported Amazon Q resources.</p>
|
|
3147
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
2999
3148
|
* @public
|
|
3000
3149
|
*/
|
|
3001
3150
|
metadata?: Record<string, string>;
|
|
3002
3151
|
/**
|
|
3003
|
-
* <p>The configuration information of the external source that the resource data are imported
|
|
3152
|
+
* <p>The configuration information of the external source that the resource data are imported
|
|
3153
|
+
* from.</p>
|
|
3004
3154
|
* @public
|
|
3005
3155
|
*/
|
|
3006
3156
|
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
@@ -3021,8 +3171,7 @@ export interface ListImportJobsRequest {
|
|
|
3021
3171
|
*/
|
|
3022
3172
|
maxResults?: number;
|
|
3023
3173
|
/**
|
|
3024
|
-
* <p>The identifier of the knowledge base.
|
|
3025
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3174
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3026
3175
|
* @public
|
|
3027
3176
|
*/
|
|
3028
3177
|
knowledgeBaseId: string | undefined;
|
|
@@ -3065,8 +3214,7 @@ export interface ListKnowledgeBasesRequest {
|
|
|
3065
3214
|
*/
|
|
3066
3215
|
export interface KnowledgeBaseSummary {
|
|
3067
3216
|
/**
|
|
3068
|
-
* <p>The identifier of the knowledge base
|
|
3069
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
3217
|
+
* <p>The identifier of the knowledge base.</p>
|
|
3070
3218
|
* @public
|
|
3071
3219
|
*/
|
|
3072
3220
|
knowledgeBaseId: string | undefined;
|
|
@@ -3105,8 +3253,8 @@ export interface KnowledgeBaseSummary {
|
|
|
3105
3253
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
3106
3254
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
3107
3255
|
* <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
|
|
3108
|
-
* key to invoke Amazon Q. </p>
|
|
3109
|
-
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
3256
|
+
* key to invoke Amazon Q in Connect. </p>
|
|
3257
|
+
* <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
3110
3258
|
* your instance</a>.</p>
|
|
3111
3259
|
* @public
|
|
3112
3260
|
*/
|
|
@@ -3153,8 +3301,7 @@ export interface ListQuickResponsesRequest {
|
|
|
3153
3301
|
*/
|
|
3154
3302
|
maxResults?: number;
|
|
3155
3303
|
/**
|
|
3156
|
-
* <p>The identifier of the knowledge base.
|
|
3157
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3304
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3158
3305
|
* @public
|
|
3159
3306
|
*/
|
|
3160
3307
|
knowledgeBaseId: string | undefined;
|
|
@@ -3180,8 +3327,7 @@ export interface QuickResponseSummary {
|
|
|
3180
3327
|
*/
|
|
3181
3328
|
knowledgeBaseArn: string | undefined;
|
|
3182
3329
|
/**
|
|
3183
|
-
* <p>The identifier of the knowledge base
|
|
3184
|
-
* base if you're storing Amazon Q Content resource to it.</p>
|
|
3330
|
+
* <p>The identifier of the knowledge base.</p>
|
|
3185
3331
|
* @public
|
|
3186
3332
|
*/
|
|
3187
3333
|
knowledgeBaseId: string | undefined;
|
|
@@ -3194,10 +3340,12 @@ export interface QuickResponseSummary {
|
|
|
3194
3340
|
* <p>The media type of the quick response content.</p>
|
|
3195
3341
|
* <ul>
|
|
3196
3342
|
* <li>
|
|
3197
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
3343
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
3344
|
+
* in plain text.</p>
|
|
3198
3345
|
* </li>
|
|
3199
3346
|
* <li>
|
|
3200
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
3347
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
3348
|
+
* written in richtext.</p>
|
|
3201
3349
|
* </li>
|
|
3202
3350
|
* </ul>
|
|
3203
3351
|
* @public
|
|
@@ -3224,7 +3372,8 @@ export interface QuickResponseSummary {
|
|
|
3224
3372
|
*/
|
|
3225
3373
|
description?: string;
|
|
3226
3374
|
/**
|
|
3227
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
3375
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
3376
|
+
* data.</p>
|
|
3228
3377
|
* @public
|
|
3229
3378
|
*/
|
|
3230
3379
|
lastModifiedBy?: string;
|
|
@@ -3234,7 +3383,8 @@ export interface QuickResponseSummary {
|
|
|
3234
3383
|
*/
|
|
3235
3384
|
isActive?: boolean;
|
|
3236
3385
|
/**
|
|
3237
|
-
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
3386
|
+
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
3387
|
+
* The supported contact channel types include <code>Chat</code>.</p>
|
|
3238
3388
|
* @public
|
|
3239
3389
|
*/
|
|
3240
3390
|
channels?: string[];
|
|
@@ -3265,8 +3415,7 @@ export interface ListQuickResponsesResponse {
|
|
|
3265
3415
|
*/
|
|
3266
3416
|
export interface UpdateQuickResponseRequest {
|
|
3267
3417
|
/**
|
|
3268
|
-
* <p>The identifier of the knowledge base.
|
|
3269
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3418
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3270
3419
|
* @public
|
|
3271
3420
|
*/
|
|
3272
3421
|
knowledgeBaseId: string | undefined;
|
|
@@ -3289,10 +3438,12 @@ export interface UpdateQuickResponseRequest {
|
|
|
3289
3438
|
* <p>The media type of the quick response content.</p>
|
|
3290
3439
|
* <ul>
|
|
3291
3440
|
* <li>
|
|
3292
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
3441
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
3442
|
+
* in plain text.</p>
|
|
3293
3443
|
* </li>
|
|
3294
3444
|
* <li>
|
|
3295
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
3445
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
3446
|
+
* written in richtext.</p>
|
|
3296
3447
|
* </li>
|
|
3297
3448
|
* </ul>
|
|
3298
3449
|
* @public
|
|
@@ -3335,7 +3486,8 @@ export interface UpdateQuickResponseRequest {
|
|
|
3335
3486
|
*/
|
|
3336
3487
|
isActive?: boolean;
|
|
3337
3488
|
/**
|
|
3338
|
-
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
3489
|
+
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
3490
|
+
* The supported contact channel types include <code>Chat</code>.</p>
|
|
3339
3491
|
* @public
|
|
3340
3492
|
*/
|
|
3341
3493
|
channels?: string[];
|
|
@@ -3363,8 +3515,7 @@ export interface UpdateQuickResponseResponse {
|
|
|
3363
3515
|
*/
|
|
3364
3516
|
export interface RemoveKnowledgeBaseTemplateUriRequest {
|
|
3365
3517
|
/**
|
|
3366
|
-
* <p>The identifier of the knowledge base.
|
|
3367
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3518
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3368
3519
|
* @public
|
|
3369
3520
|
*/
|
|
3370
3521
|
knowledgeBaseId: string | undefined;
|
|
@@ -3390,8 +3541,7 @@ export interface SearchContentRequest {
|
|
|
3390
3541
|
*/
|
|
3391
3542
|
maxResults?: number;
|
|
3392
3543
|
/**
|
|
3393
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3394
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3544
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3395
3545
|
* @public
|
|
3396
3546
|
*/
|
|
3397
3547
|
knowledgeBaseId: string | undefined;
|
|
@@ -3621,13 +3771,14 @@ export interface QuickResponseQueryField {
|
|
|
3621
3771
|
*/
|
|
3622
3772
|
operator: QuickResponseQueryOperator | undefined;
|
|
3623
3773
|
/**
|
|
3624
|
-
* <p>Whether the query expects only exact matches on the attribute field values. The results of
|
|
3774
|
+
* <p>Whether the query expects only exact matches on the attribute field values. The results of
|
|
3775
|
+
* the query will only include exact matches if this parameter is set to false.</p>
|
|
3625
3776
|
* @public
|
|
3626
3777
|
*/
|
|
3627
3778
|
allowFuzziness?: boolean;
|
|
3628
3779
|
/**
|
|
3629
|
-
* <p>The importance of the attribute field when calculating query result relevancy scores.
|
|
3630
|
-
*
|
|
3780
|
+
* <p>The importance of the attribute field when calculating query result relevancy scores. The
|
|
3781
|
+
* value set for this parameter affects the ordering of search results.</p>
|
|
3631
3782
|
* @public
|
|
3632
3783
|
*/
|
|
3633
3784
|
priority?: Priority;
|
|
@@ -3679,7 +3830,8 @@ export interface SearchQuickResponsesRequest {
|
|
|
3679
3830
|
*/
|
|
3680
3831
|
maxResults?: number;
|
|
3681
3832
|
/**
|
|
3682
|
-
* <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search
|
|
3833
|
+
* <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search
|
|
3834
|
+
* results are returned.</p>
|
|
3683
3835
|
* @public
|
|
3684
3836
|
*/
|
|
3685
3837
|
attributes?: Record<string, string>;
|
|
@@ -3705,8 +3857,7 @@ export interface QuickResponseSearchResultData {
|
|
|
3705
3857
|
*/
|
|
3706
3858
|
knowledgeBaseArn: string | undefined;
|
|
3707
3859
|
/**
|
|
3708
|
-
* <p>The identifier of the knowledge base.
|
|
3709
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3860
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3710
3861
|
* @public
|
|
3711
3862
|
*/
|
|
3712
3863
|
knowledgeBaseId: string | undefined;
|
|
@@ -3719,10 +3870,12 @@ export interface QuickResponseSearchResultData {
|
|
|
3719
3870
|
* <p>The media type of the quick response content.</p>
|
|
3720
3871
|
* <ul>
|
|
3721
3872
|
* <li>
|
|
3722
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
3873
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
3874
|
+
* in plain text.</p>
|
|
3723
3875
|
* </li>
|
|
3724
3876
|
* <li>
|
|
3725
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
3877
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
3878
|
+
* written in richtext.</p>
|
|
3726
3879
|
* </li>
|
|
3727
3880
|
* </ul>
|
|
3728
3881
|
* @public
|
|
@@ -3759,7 +3912,8 @@ export interface QuickResponseSearchResultData {
|
|
|
3759
3912
|
*/
|
|
3760
3913
|
description?: string;
|
|
3761
3914
|
/**
|
|
3762
|
-
* <p>The configuration information of the user groups that the quick response is accessible
|
|
3915
|
+
* <p>The configuration information of the user groups that the quick response is accessible
|
|
3916
|
+
* to.</p>
|
|
3763
3917
|
* @public
|
|
3764
3918
|
*/
|
|
3765
3919
|
groupingConfiguration?: GroupingConfiguration;
|
|
@@ -3770,12 +3924,14 @@ export interface QuickResponseSearchResultData {
|
|
|
3770
3924
|
*/
|
|
3771
3925
|
shortcutKey?: string;
|
|
3772
3926
|
/**
|
|
3773
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search
|
|
3927
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search
|
|
3928
|
+
* result data.</p>
|
|
3774
3929
|
* @public
|
|
3775
3930
|
*/
|
|
3776
3931
|
lastModifiedBy?: string;
|
|
3777
3932
|
/**
|
|
3778
|
-
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
3933
|
+
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
3934
|
+
* The supported contact channel types include <code>Chat</code>.</p>
|
|
3779
3935
|
* @public
|
|
3780
3936
|
*/
|
|
3781
3937
|
channels?: string[];
|
|
@@ -3785,12 +3941,14 @@ export interface QuickResponseSearchResultData {
|
|
|
3785
3941
|
*/
|
|
3786
3942
|
language?: string;
|
|
3787
3943
|
/**
|
|
3788
|
-
* <p>The user defined contact attributes that are not resolved when the search result is
|
|
3944
|
+
* <p>The user defined contact attributes that are not resolved when the search result is
|
|
3945
|
+
* returned.</p>
|
|
3789
3946
|
* @public
|
|
3790
3947
|
*/
|
|
3791
3948
|
attributesNotInterpolated?: string[];
|
|
3792
3949
|
/**
|
|
3793
|
-
* <p>The user defined contact attributes that are resolved when the search result is
|
|
3950
|
+
* <p>The user defined contact attributes that are resolved when the search result is
|
|
3951
|
+
* returned.</p>
|
|
3794
3952
|
* @public
|
|
3795
3953
|
*/
|
|
3796
3954
|
attributesInterpolated?: string[];
|
|
@@ -3821,8 +3979,7 @@ export interface SearchQuickResponsesResponse {
|
|
|
3821
3979
|
*/
|
|
3822
3980
|
export interface StartContentUploadRequest {
|
|
3823
3981
|
/**
|
|
3824
|
-
* <p>The identifier of the knowledge base.
|
|
3825
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3982
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3826
3983
|
* @public
|
|
3827
3984
|
*/
|
|
3828
3985
|
knowledgeBaseId: string | undefined;
|
|
@@ -3867,11 +4024,11 @@ export interface StartContentUploadResponse {
|
|
|
3867
4024
|
*/
|
|
3868
4025
|
export interface StartImportJobRequest {
|
|
3869
4026
|
/**
|
|
3870
|
-
* <p>The identifier of the knowledge base.
|
|
3871
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
4027
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3872
4028
|
* <ul>
|
|
3873
4029
|
* <li>
|
|
3874
|
-
* <p>For importing Amazon Q quick responses, this should be a <code>QUICK_RESPONSES</code>
|
|
4030
|
+
* <p>For importing Amazon Q in Connect quick responses, this should be a <code>QUICK_RESPONSES</code>
|
|
4031
|
+
* type knowledge base.</p>
|
|
3875
4032
|
* </li>
|
|
3876
4033
|
* </ul>
|
|
3877
4034
|
* @public
|
|
@@ -3881,7 +4038,8 @@ export interface StartImportJobRequest {
|
|
|
3881
4038
|
* <p>The type of the import job.</p>
|
|
3882
4039
|
* <ul>
|
|
3883
4040
|
* <li>
|
|
3884
|
-
* <p>For importing quick response resource, set the value to
|
|
4041
|
+
* <p>For importing quick response resource, set the value to
|
|
4042
|
+
* <code>QUICK_RESPONSES</code>.</p>
|
|
3885
4043
|
* </li>
|
|
3886
4044
|
* </ul>
|
|
3887
4045
|
* @public
|
|
@@ -3898,12 +4056,13 @@ export interface StartImportJobRequest {
|
|
|
3898
4056
|
*/
|
|
3899
4057
|
clientToken?: string;
|
|
3900
4058
|
/**
|
|
3901
|
-
* <p>The metadata fields of the imported Amazon Q resources.</p>
|
|
4059
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
3902
4060
|
* @public
|
|
3903
4061
|
*/
|
|
3904
4062
|
metadata?: Record<string, string>;
|
|
3905
4063
|
/**
|
|
3906
|
-
* <p>The configuration information of the external source that the resource data are imported
|
|
4064
|
+
* <p>The configuration information of the external source that the resource data are imported
|
|
4065
|
+
* from.</p>
|
|
3907
4066
|
* @public
|
|
3908
4067
|
*/
|
|
3909
4068
|
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
@@ -3923,8 +4082,7 @@ export interface StartImportJobResponse {
|
|
|
3923
4082
|
*/
|
|
3924
4083
|
export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
3925
4084
|
/**
|
|
3926
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3927
|
-
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
4085
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3928
4086
|
* @public
|
|
3929
4087
|
*/
|
|
3930
4088
|
knowledgeBaseId: string | undefined;
|