@aws-sdk/client-qconnect 3.693.0 → 3.696.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.
Files changed (105) hide show
  1. package/README.md +112 -0
  2. package/dist-cjs/index.js +1279 -149
  3. package/dist-es/QConnect.js +28 -0
  4. package/dist-es/commands/ActivateMessageTemplateCommand.js +22 -0
  5. package/dist-es/commands/CreateMessageTemplateAttachmentCommand.js +23 -0
  6. package/dist-es/commands/CreateMessageTemplateCommand.js +23 -0
  7. package/dist-es/commands/CreateMessageTemplateVersionCommand.js +23 -0
  8. package/dist-es/commands/DeactivateMessageTemplateCommand.js +22 -0
  9. package/dist-es/commands/DeleteMessageTemplateAttachmentCommand.js +22 -0
  10. package/dist-es/commands/DeleteMessageTemplateCommand.js +22 -0
  11. package/dist-es/commands/GetMessageTemplateCommand.js +23 -0
  12. package/dist-es/commands/GetRecommendationsCommand.js +1 -1
  13. package/dist-es/commands/ListMessageTemplateVersionsCommand.js +22 -0
  14. package/dist-es/commands/ListMessageTemplatesCommand.js +22 -0
  15. package/dist-es/commands/QueryAssistantCommand.js +2 -1
  16. package/dist-es/commands/RenderMessageTemplateCommand.js +23 -0
  17. package/dist-es/commands/SearchMessageTemplatesCommand.js +23 -0
  18. package/dist-es/commands/SearchQuickResponsesCommand.js +1 -1
  19. package/dist-es/commands/StartContentUploadCommand.js +1 -1
  20. package/dist-es/commands/StartImportJobCommand.js +1 -1
  21. package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +1 -1
  22. package/dist-es/commands/UpdateMessageTemplateCommand.js +23 -0
  23. package/dist-es/commands/UpdateMessageTemplateMetadataCommand.js +23 -0
  24. package/dist-es/commands/index.js +14 -0
  25. package/dist-es/models/index.js +1 -0
  26. package/dist-es/models/models_0.js +280 -152
  27. package/dist-es/models/models_1.js +138 -0
  28. package/dist-es/pagination/ListMessageTemplateVersionsPaginator.js +4 -0
  29. package/dist-es/pagination/ListMessageTemplatesPaginator.js +4 -0
  30. package/dist-es/pagination/SearchMessageTemplatesPaginator.js +4 -0
  31. package/dist-es/pagination/index.js +3 -0
  32. package/dist-es/protocols/Aws_restJson1.js +527 -5
  33. package/dist-types/QConnect.d.ts +98 -0
  34. package/dist-types/QConnectClient.d.ts +16 -2
  35. package/dist-types/commands/ActivateMessageTemplateCommand.d.ts +96 -0
  36. package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +109 -0
  37. package/dist-types/commands/CreateMessageTemplateCommand.d.ts +347 -0
  38. package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +247 -0
  39. package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +95 -0
  40. package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +91 -0
  41. package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +92 -0
  42. package/dist-types/commands/GetMessageTemplateCommand.d.ts +231 -0
  43. package/dist-types/commands/GetRecommendationsCommand.d.ts +2 -1
  44. package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +99 -0
  45. package/dist-types/commands/ListMessageTemplatesCommand.d.ts +104 -0
  46. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  47. package/dist-types/commands/QueryAssistantCommand.d.ts +2 -1
  48. package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +2 -1
  49. package/dist-types/commands/RenderMessageTemplateCommand.d.ts +206 -0
  50. package/dist-types/commands/SearchContentCommand.d.ts +1 -1
  51. package/dist-types/commands/SearchMessageTemplatesCommand.d.ts +138 -0
  52. package/dist-types/commands/SearchQuickResponsesCommand.d.ts +1 -1
  53. package/dist-types/commands/StartContentUploadCommand.d.ts +1 -1
  54. package/dist-types/commands/StartImportJobCommand.d.ts +1 -1
  55. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  56. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  57. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -1
  58. package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +332 -0
  59. package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +233 -0
  60. package/dist-types/commands/index.d.ts +14 -0
  61. package/dist-types/models/index.d.ts +1 -0
  62. package/dist-types/models/models_0.d.ts +1639 -983
  63. package/dist-types/models/models_1.d.ts +1256 -0
  64. package/dist-types/pagination/ListMessageTemplateVersionsPaginator.d.ts +7 -0
  65. package/dist-types/pagination/ListMessageTemplatesPaginator.d.ts +7 -0
  66. package/dist-types/pagination/SearchMessageTemplatesPaginator.d.ts +7 -0
  67. package/dist-types/pagination/index.d.ts +3 -0
  68. package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
  69. package/dist-types/ts3.4/QConnect.d.ts +238 -0
  70. package/dist-types/ts3.4/QConnectClient.d.ts +84 -0
  71. package/dist-types/ts3.4/commands/ActivateMessageTemplateCommand.d.ts +51 -0
  72. package/dist-types/ts3.4/commands/CreateMessageTemplateAttachmentCommand.d.ts +51 -0
  73. package/dist-types/ts3.4/commands/CreateMessageTemplateCommand.d.ts +51 -0
  74. package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts +51 -0
  75. package/dist-types/ts3.4/commands/DeactivateMessageTemplateCommand.d.ts +51 -0
  76. package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +51 -0
  77. package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +51 -0
  78. package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +51 -0
  79. package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +2 -4
  80. package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +51 -0
  81. package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +51 -0
  82. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  83. package/dist-types/ts3.4/commands/QueryAssistantCommand.d.ts +2 -4
  84. package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +2 -4
  85. package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +51 -0
  86. package/dist-types/ts3.4/commands/SearchContentCommand.d.ts +1 -1
  87. package/dist-types/ts3.4/commands/SearchMessageTemplatesCommand.d.ts +51 -0
  88. package/dist-types/ts3.4/commands/SearchQuickResponsesCommand.d.ts +1 -1
  89. package/dist-types/ts3.4/commands/StartContentUploadCommand.d.ts +1 -1
  90. package/dist-types/ts3.4/commands/StartImportJobCommand.d.ts +1 -1
  91. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  92. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  93. package/dist-types/ts3.4/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -1
  94. package/dist-types/ts3.4/commands/UpdateMessageTemplateCommand.d.ts +51 -0
  95. package/dist-types/ts3.4/commands/UpdateMessageTemplateMetadataCommand.d.ts +51 -0
  96. package/dist-types/ts3.4/commands/index.d.ts +14 -0
  97. package/dist-types/ts3.4/models/index.d.ts +1 -0
  98. package/dist-types/ts3.4/models/models_0.d.ts +466 -284
  99. package/dist-types/ts3.4/models/models_1.d.ts +349 -0
  100. package/dist-types/ts3.4/pagination/ListMessageTemplateVersionsPaginator.d.ts +11 -0
  101. package/dist-types/ts3.4/pagination/ListMessageTemplatesPaginator.d.ts +11 -0
  102. package/dist-types/ts3.4/pagination/SearchMessageTemplatesPaginator.d.ts +11 -0
  103. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  104. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
  105. package/package.json +35 -35
@@ -12,6 +12,47 @@ export declare class AccessDeniedException extends __BaseException {
12
12
  */
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
+ /**
16
+ * @public
17
+ */
18
+ export interface ActivateMessageTemplateRequest {
19
+ /**
20
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
21
+ * the ARN.</p>
22
+ * @public
23
+ */
24
+ knowledgeBaseId: string | undefined;
25
+ /**
26
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
27
+ * @public
28
+ */
29
+ messageTemplateId: string | undefined;
30
+ /**
31
+ * <p>The version number of the message template version to activate.</p>
32
+ * @public
33
+ */
34
+ versionNumber: number | undefined;
35
+ }
36
+ /**
37
+ * @public
38
+ */
39
+ export interface ActivateMessageTemplateResponse {
40
+ /**
41
+ * <p>The Amazon Resource Name (ARN) of the message template.</p>
42
+ * @public
43
+ */
44
+ messageTemplateArn: string | undefined;
45
+ /**
46
+ * <p>The identifier of the message template.</p>
47
+ * @public
48
+ */
49
+ messageTemplateId: string | undefined;
50
+ /**
51
+ * <p>The version number of the message template version that is activated.</p>
52
+ * @public
53
+ */
54
+ versionNumber: number | undefined;
55
+ }
15
56
  /**
16
57
  * <p>The request could not be processed because of conflict in the current state of the
17
58
  * resource. For example, if you're using a <code>Create</code> API (such as
@@ -27,6 +68,64 @@ export declare class ConflictException extends __BaseException {
27
68
  */
28
69
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
29
70
  }
71
+ /**
72
+ * <p>The specified resource does not exist.</p>
73
+ * @public
74
+ */
75
+ export declare class ResourceNotFoundException extends __BaseException {
76
+ readonly name: "ResourceNotFoundException";
77
+ readonly $fault: "client";
78
+ /**
79
+ * <p>The specified resource name.</p>
80
+ * @public
81
+ */
82
+ resourceName?: string | undefined;
83
+ /**
84
+ * @internal
85
+ */
86
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
87
+ }
88
+ /**
89
+ * <p>The throttling limit has been exceeded.</p>
90
+ * @public
91
+ */
92
+ export declare class ThrottlingException extends __BaseException {
93
+ readonly name: "ThrottlingException";
94
+ readonly $fault: "client";
95
+ $retryable: {};
96
+ /**
97
+ * @internal
98
+ */
99
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
100
+ }
101
+ /**
102
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
103
+ * @public
104
+ */
105
+ export declare class ValidationException extends __BaseException {
106
+ readonly name: "ValidationException";
107
+ readonly $fault: "client";
108
+ /**
109
+ * @internal
110
+ */
111
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
112
+ }
113
+ /**
114
+ * <p>Information about an agent.</p>
115
+ * @public
116
+ */
117
+ export interface AgentAttributes {
118
+ /**
119
+ * <p>The agent’s first name as entered in their Amazon Connect user account.</p>
120
+ * @public
121
+ */
122
+ firstName?: string | undefined;
123
+ /**
124
+ * <p>The agent’s last name as entered in their Amazon Connect user account.</p>
125
+ * @public
126
+ */
127
+ lastName?: string | undefined;
128
+ }
30
129
  /**
31
130
  * <p>A leaf node condition which can be used to specify a tag condition. </p>
32
131
  * @public
@@ -192,8 +291,8 @@ export type AssociationConfigurationData = AssociationConfigurationData.Knowledg
192
291
  */
193
292
  export declare namespace AssociationConfigurationData {
194
293
  /**
195
- * <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect Assistant
196
- * Association.</p>
294
+ * <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect
295
+ * Assistant Association.</p>
197
296
  * @public
198
297
  */
199
298
  interface KnowledgeBaseAssociationConfigurationDataMember {
@@ -363,8 +462,9 @@ export type VisibilityStatus = (typeof VisibilityStatus)[keyof typeof Visibility
363
462
  export interface CreateAIAgentRequest {
364
463
  /**
365
464
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
366
- * request. If not provided, the AWS SDK populates this field. For more information about
367
- * idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
465
+ * request. If not provided, the Amazon Web Services
466
+ * SDK populates this field. For more information about idempotency, see
467
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
368
468
  * @public
369
469
  */
370
470
  clientToken?: string | undefined;
@@ -517,23 +617,6 @@ export interface CreateAIAgentResponse {
517
617
  */
518
618
  aiAgent?: AIAgentData | undefined;
519
619
  }
520
- /**
521
- * <p>The specified resource does not exist.</p>
522
- * @public
523
- */
524
- export declare class ResourceNotFoundException extends __BaseException {
525
- readonly name: "ResourceNotFoundException";
526
- readonly $fault: "client";
527
- /**
528
- * <p>The specified resource name.</p>
529
- * @public
530
- */
531
- resourceName?: string | undefined;
532
- /**
533
- * @internal
534
- */
535
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
536
- }
537
620
  /**
538
621
  * <p>You've exceeded your service quota. To perform the requested action, remove some of the
539
622
  * relevant resources, or use service quotas to request a service quota increase.</p>
@@ -547,31 +630,6 @@ export declare class ServiceQuotaExceededException extends __BaseException {
547
630
  */
548
631
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
549
632
  }
550
- /**
551
- * <p>The throttling limit has been exceeded.</p>
552
- * @public
553
- */
554
- export declare class ThrottlingException extends __BaseException {
555
- readonly name: "ThrottlingException";
556
- readonly $fault: "client";
557
- $retryable: {};
558
- /**
559
- * @internal
560
- */
561
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
562
- }
563
- /**
564
- * <p>The input fails to satisfy the constraints specified by a service.</p>
565
- * @public
566
- */
567
- export declare class ValidationException extends __BaseException {
568
- readonly name: "ValidationException";
569
- readonly $fault: "client";
570
- /**
571
- * @internal
572
- */
573
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
574
- }
575
633
  /**
576
634
  * @public
577
635
  */
@@ -598,8 +656,9 @@ export interface CreateAIAgentVersionRequest {
598
656
  modifiedTime?: Date | undefined;
599
657
  /**
600
658
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
601
- * request. If not provided, the AWS SDK populates this field. For more information about
602
- * idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
659
+ * request. If not provided, the Amazon Web Services
660
+ * SDK populates this field. For more information about idempotency, see
661
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
603
662
  * @public
604
663
  */
605
664
  clientToken?: string | undefined;
@@ -893,8 +952,9 @@ export interface ListAIAgentVersionsResponse {
893
952
  export interface UpdateAIAgentRequest {
894
953
  /**
895
954
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
896
- * request. If not provided, the AWS SDK populates this field. For more information about
897
- * idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
955
+ * request. If not provided, the Amazon Web Services
956
+ * SDK populates this field. For more information about idempotency, see
957
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
898
958
  * @public
899
959
  */
900
960
  clientToken?: string | undefined;
@@ -1033,8 +1093,9 @@ export type AIPromptType = (typeof AIPromptType)[keyof typeof AIPromptType];
1033
1093
  export interface CreateAIPromptRequest {
1034
1094
  /**
1035
1095
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1036
- * request. If not provided, the AWS SDK populates this field. For more information about
1037
- * idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1096
+ * request. If not provided, the Amazon Web Services
1097
+ * SDK populates this field. For more information about idempotency, see
1098
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1038
1099
  * @public
1039
1100
  */
1040
1101
  clientToken?: string | undefined;
@@ -1214,8 +1275,9 @@ export interface CreateAIPromptVersionRequest {
1214
1275
  modifiedTime?: Date | undefined;
1215
1276
  /**
1216
1277
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1217
- * request. If not provided, the AWS SDK populates this field. For more information about
1218
- * idempotency, see <a href="http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1278
+ * request. If not provided, the Amazon Web Services
1279
+ * SDK populates this field. For more information about idempotency, see
1280
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1219
1281
  * @public
1220
1282
  */
1221
1283
  clientToken?: string | undefined;
@@ -1518,8 +1580,9 @@ export interface ListAIPromptVersionsResponse {
1518
1580
  export interface UpdateAIPromptRequest {
1519
1581
  /**
1520
1582
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1521
- * request. If not provided, the AWS SDK populates this field. For more information about
1522
- * idempotency, see <a href="http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1583
+ * request. If not provided, the Amazon Web Services
1584
+ * SDK populates this field. For more information about idempotency, see
1585
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1523
1586
  * @public
1524
1587
  */
1525
1588
  clientToken?: string | undefined;
@@ -1710,7 +1773,7 @@ export interface CreateAssistantAssociationRequest {
1710
1773
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1711
1774
  * request. If not provided, the Amazon Web Services
1712
1775
  * SDK populates this field. For more information about idempotency, see
1713
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1776
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1714
1777
  * @public
1715
1778
  */
1716
1779
  clientToken?: string | undefined;
@@ -1971,7 +2034,7 @@ export interface CreateAssistantRequest {
1971
2034
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1972
2035
  * request. If not provided, the Amazon Web Services
1973
2036
  * SDK populates this field. For more information about idempotency, see
1974
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
2037
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1975
2038
  * @public
1976
2039
  */
1977
2040
  clientToken?: string | undefined;
@@ -2368,7 +2431,8 @@ export interface SourceContentDataDetails {
2368
2431
  */
2369
2432
  rankingData: RankingData | undefined;
2370
2433
  /**
2371
- * <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
2434
+ * <p>Contains information about where the text with a citation begins and ends in the generated
2435
+ * output.</p>
2372
2436
  * @public
2373
2437
  */
2374
2438
  citationSpan?: CitationSpan | undefined;
@@ -3261,7 +3325,7 @@ export interface CreateSessionRequest {
3261
3325
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
3262
3326
  * request. If not provided, the Amazon Web Services
3263
3327
  * SDK populates this field. For more information about idempotency, see
3264
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3328
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3265
3329
  * @public
3266
3330
  */
3267
3331
  clientToken?: string | undefined;
@@ -3602,6 +3666,18 @@ export interface BedrockFoundationModelConfigurationForParsing {
3602
3666
  */
3603
3667
  parsingPrompt?: ParsingPrompt | undefined;
3604
3668
  }
3669
+ /**
3670
+ * @public
3671
+ * @enum
3672
+ */
3673
+ export declare const ChannelSubtype: {
3674
+ readonly EMAIL: "EMAIL";
3675
+ readonly SMS: "SMS";
3676
+ };
3677
+ /**
3678
+ * @public
3679
+ */
3680
+ export type ChannelSubtype = (typeof ChannelSubtype)[keyof typeof ChannelSubtype];
3605
3681
  /**
3606
3682
  * @public
3607
3683
  * @enum
@@ -3812,7 +3888,7 @@ export interface CreateContentAssociationRequest {
3812
3888
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
3813
3889
  * request. If not provided, the Amazon Web Services
3814
3890
  * SDK populates this field. For more information about idempotency, see
3815
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3891
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3816
3892
  * @public
3817
3893
  */
3818
3894
  clientToken?: string | undefined;
@@ -4093,7 +4169,7 @@ export interface CreateContentRequest {
4093
4169
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4094
4170
  * request. If not provided, the Amazon Web Services
4095
4171
  * SDK populates this field. For more information about idempotency, see
4096
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4172
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4097
4173
  * @public
4098
4174
  */
4099
4175
  clientToken?: string | undefined;
@@ -4451,6 +4527,17 @@ export interface UpdateContentResponse {
4451
4527
  */
4452
4528
  content?: ContentData | undefined;
4453
4529
  }
4530
+ /**
4531
+ * @public
4532
+ * @enum
4533
+ */
4534
+ export declare const ContentDisposition: {
4535
+ readonly ATTACHMENT: "ATTACHMENT";
4536
+ };
4537
+ /**
4538
+ * @public
4539
+ */
4540
+ export type ContentDisposition = (typeof ContentDisposition)[keyof typeof ContentDisposition];
4454
4541
  /**
4455
4542
  * @public
4456
4543
  * @enum
@@ -4712,7 +4799,7 @@ export interface CreateKnowledgeBaseRequest {
4712
4799
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4713
4800
  * request. If not provided, the Amazon Web Services
4714
4801
  * SDK populates this field. For more information about idempotency, see
4715
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4802
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4716
4803
  * @public
4717
4804
  */
4718
4805
  clientToken?: string | undefined;
@@ -4729,8 +4816,8 @@ export interface CreateKnowledgeBaseRequest {
4729
4816
  */
4730
4817
  knowledgeBaseType: KnowledgeBaseType | undefined;
4731
4818
  /**
4732
- * <p>The source of the knowledge base content. Only set this argument for EXTERNAL knowledge
4733
- * bases.</p>
4819
+ * <p>The source of the knowledge base content. Only set this argument for EXTERNAL or Managed
4820
+ * knowledge bases.</p>
4734
4821
  * @public
4735
4822
  */
4736
4823
  sourceConfiguration?: SourceConfiguration | undefined;
@@ -4890,16 +4977,16 @@ export interface CreateKnowledgeBaseResponse {
4890
4977
  knowledgeBase?: KnowledgeBaseData | undefined;
4891
4978
  }
4892
4979
  /**
4893
- * <p>The container of quick response data.</p>
4980
+ * <p>The container of the message template body.</p>
4894
4981
  * @public
4895
4982
  */
4896
- export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
4983
+ export type MessageTemplateBodyContentProvider = MessageTemplateBodyContentProvider.ContentMember | MessageTemplateBodyContentProvider.$UnknownMember;
4897
4984
  /**
4898
4985
  * @public
4899
4986
  */
4900
- export declare namespace QuickResponseDataProvider {
4987
+ export declare namespace MessageTemplateBodyContentProvider {
4901
4988
  /**
4902
- * <p>The content of the quick response.</p>
4989
+ * <p>The content of the message template.</p>
4903
4990
  * @public
4904
4991
  */
4905
4992
  interface ContentMember {
@@ -4917,144 +5004,1081 @@ export declare namespace QuickResponseDataProvider {
4917
5004
  content: (value: string) => T;
4918
5005
  _: (name: string, value: any) => T;
4919
5006
  }
4920
- const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
5007
+ const visit: <T>(value: MessageTemplateBodyContentProvider, visitor: Visitor<T>) => T;
4921
5008
  }
4922
5009
  /**
4923
- * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
5010
+ * <p>The body to use in email messages.</p>
4924
5011
  * @public
4925
5012
  */
4926
- export interface GroupingConfiguration {
5013
+ export interface EmailMessageTemplateContentBody {
4927
5014
  /**
4928
- * <p>The criteria used for grouping Amazon Q in Connect users.</p>
4929
- * <p>The following is the list of supported criteria values.</p>
4930
- * <ul>
4931
- * <li>
4932
- * <p>
4933
- * <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon
4934
- * 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>
4935
- * </li>
4936
- * </ul>
5015
+ * <p>The message body, in plain text format, to use in email messages that are based on the
5016
+ * message template. We recommend using plain text format for email clients that don't render
5017
+ * HTML content and clients that are connected to high-latency networks, such as mobile
5018
+ * devices.</p>
4937
5019
  * @public
4938
5020
  */
4939
- criteria?: string | undefined;
5021
+ plainText?: MessageTemplateBodyContentProvider | undefined;
4940
5022
  /**
4941
- * <p>The list of values that define different groups of Amazon Q in Connect users.</p>
4942
- * <ul>
4943
- * <li>
4944
- * <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to
4945
- * provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing
4946
- * profiles</a> as values of this parameter.</p>
4947
- * </li>
4948
- * </ul>
5023
+ * <p>The message body, in HTML format, to use in email messages that are based on the message
5024
+ * template. We recommend using HTML format for email clients that render HTML content. You can
5025
+ * include links, formatted text, and more in an HTML message.</p>
4949
5026
  * @public
4950
5027
  */
4951
- values?: string[] | undefined;
5028
+ html?: MessageTemplateBodyContentProvider | undefined;
4952
5029
  }
4953
5030
  /**
5031
+ * <p>The email header to include in email messages.</p>
4954
5032
  * @public
4955
5033
  */
4956
- export interface CreateQuickResponseRequest {
4957
- /**
4958
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
4959
- * @public
4960
- */
4961
- knowledgeBaseId: string | undefined;
4962
- /**
4963
- * <p>The name of the quick response.</p>
4964
- * @public
4965
- */
4966
- name: string | undefined;
4967
- /**
4968
- * <p>The content of the quick response.</p>
4969
- * @public
4970
- */
4971
- content: QuickResponseDataProvider | undefined;
4972
- /**
4973
- * <p>The media type of the quick response content.</p>
4974
- * <ul>
4975
- * <li>
4976
- * <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written
4977
- * in plain text.</p>
4978
- * </li>
4979
- * <li>
4980
- * <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response
4981
- * written in richtext.</p>
4982
- * </li>
4983
- * </ul>
4984
- * @public
4985
- */
4986
- contentType?: string | undefined;
5034
+ export interface EmailHeader {
4987
5035
  /**
4988
- * <p>The configuration information of the user groups that the quick response is accessible
4989
- * to.</p>
4990
- * @public
4991
- */
4992
- groupingConfiguration?: GroupingConfiguration | undefined;
4993
- /**
4994
- * <p>The description of the quick response.</p>
5036
+ * <p>The name of the email header.</p>
4995
5037
  * @public
4996
5038
  */
4997
- description?: string | undefined;
5039
+ name?: string | undefined;
4998
5040
  /**
4999
- * <p>The shortcut key of the quick response. The value should be unique across the
5000
- * knowledge base. </p>
5041
+ * <p>The value of the email header.</p>
5001
5042
  * @public
5002
5043
  */
5003
- shortcutKey?: string | undefined;
5044
+ value?: string | undefined;
5045
+ }
5046
+ /**
5047
+ * <p>The content of the message template that applies to the email channel subtype.</p>
5048
+ * @public
5049
+ */
5050
+ export interface EmailMessageTemplateContent {
5004
5051
  /**
5005
- * <p>Whether the quick response is active.</p>
5052
+ * <p>The subject line, or title, to use in email messages.</p>
5006
5053
  * @public
5007
5054
  */
5008
- isActive?: boolean | undefined;
5055
+ subject?: string | undefined;
5009
5056
  /**
5010
- * <p>The Amazon Connect channels this quick response applies to.</p>
5057
+ * <p>The body to use in email messages.</p>
5011
5058
  * @public
5012
5059
  */
5013
- channels?: string[] | undefined;
5060
+ body?: EmailMessageTemplateContentBody | undefined;
5014
5061
  /**
5015
- * <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>,
5016
- * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
5017
- * <code>zh_CN</code>, <code>zh_TW</code>
5018
- * </p>
5062
+ * <p>The email headers to include in email messages.</p>
5019
5063
  * @public
5020
5064
  */
5021
- language?: string | undefined;
5065
+ headers?: EmailHeader[] | undefined;
5066
+ }
5067
+ /**
5068
+ * <p>The body to use in SMS messages.</p>
5069
+ * @public
5070
+ */
5071
+ export interface SMSMessageTemplateContentBody {
5022
5072
  /**
5023
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
5024
- * request. If not provided, the Amazon Web Services
5025
- * SDK populates this field. For more information about idempotency, see
5026
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
5073
+ * <p>The message body to use in SMS messages.</p>
5027
5074
  * @public
5028
5075
  */
5029
- clientToken?: string | undefined;
5076
+ plainText?: MessageTemplateBodyContentProvider | undefined;
5077
+ }
5078
+ /**
5079
+ * <p>The content of the message template that applies to the SMS channel subtype.</p>
5080
+ * @public
5081
+ */
5082
+ export interface SMSMessageTemplateContent {
5030
5083
  /**
5031
- * <p>The tags used to organize, track, or control access for this resource.</p>
5084
+ * <p>The body to use in SMS messages.</p>
5032
5085
  * @public
5033
5086
  */
5034
- tags?: Record<string, string> | undefined;
5087
+ body?: SMSMessageTemplateContentBody | undefined;
5035
5088
  }
5036
5089
  /**
5037
- * <p>The container quick response content.</p>
5090
+ * <p>The container of message template content.</p>
5038
5091
  * @public
5039
5092
  */
5040
- export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
5093
+ export type MessageTemplateContentProvider = MessageTemplateContentProvider.EmailMember | MessageTemplateContentProvider.SmsMember | MessageTemplateContentProvider.$UnknownMember;
5041
5094
  /**
5042
5095
  * @public
5043
5096
  */
5044
- export declare namespace QuickResponseContentProvider {
5097
+ export declare namespace MessageTemplateContentProvider {
5045
5098
  /**
5046
- * <p>The content of the quick response.</p>
5099
+ * <p>The content of the message template that applies to the email channel subtype.</p>
5047
5100
  * @public
5048
5101
  */
5049
- interface ContentMember {
5050
- content: string;
5102
+ interface EmailMember {
5103
+ email: EmailMessageTemplateContent;
5104
+ sms?: never;
5051
5105
  $unknown?: never;
5052
5106
  }
5053
5107
  /**
5108
+ * <p>The content of the message template that applies to the SMS channel subtype.</p>
5054
5109
  * @public
5055
5110
  */
5056
- interface $UnknownMember {
5057
- content?: never;
5111
+ interface SmsMember {
5112
+ email?: never;
5113
+ sms: SMSMessageTemplateContent;
5114
+ $unknown?: never;
5115
+ }
5116
+ /**
5117
+ * @public
5118
+ */
5119
+ interface $UnknownMember {
5120
+ email?: never;
5121
+ sms?: never;
5122
+ $unknown: [string, any];
5123
+ }
5124
+ interface Visitor<T> {
5125
+ email: (value: EmailMessageTemplateContent) => T;
5126
+ sms: (value: SMSMessageTemplateContent) => T;
5127
+ _: (name: string, value: any) => T;
5128
+ }
5129
+ const visit: <T>(value: MessageTemplateContentProvider, visitor: Visitor<T>) => T;
5130
+ }
5131
+ /**
5132
+ * <p>The customer profile attributes that are used with the message template.</p>
5133
+ * @public
5134
+ */
5135
+ export interface CustomerProfileAttributes {
5136
+ /**
5137
+ * <p>The unique identifier of a customer profile.</p>
5138
+ * @public
5139
+ */
5140
+ profileId?: string | undefined;
5141
+ /**
5142
+ * <p>The ARN of a customer profile.</p>
5143
+ * @public
5144
+ */
5145
+ profileARN?: string | undefined;
5146
+ /**
5147
+ * <p>The customer's first name.</p>
5148
+ * @public
5149
+ */
5150
+ firstName?: string | undefined;
5151
+ /**
5152
+ * <p>The customer's middle name.</p>
5153
+ * @public
5154
+ */
5155
+ middleName?: string | undefined;
5156
+ /**
5157
+ * <p>The customer's last name.</p>
5158
+ * @public
5159
+ */
5160
+ lastName?: string | undefined;
5161
+ /**
5162
+ * <p>A unique account number that you have given to the customer.</p>
5163
+ * @public
5164
+ */
5165
+ accountNumber?: string | undefined;
5166
+ /**
5167
+ * <p>The customer's email address, which has not been specified as a personal or business
5168
+ * address.</p>
5169
+ * @public
5170
+ */
5171
+ emailAddress?: string | undefined;
5172
+ /**
5173
+ * <p>The customer's phone number, which has not been specified as a mobile, home, or business
5174
+ * number.</p>
5175
+ * @public
5176
+ */
5177
+ phoneNumber?: string | undefined;
5178
+ /**
5179
+ * <p>Any additional information relevant to the customer's profile.</p>
5180
+ * @public
5181
+ */
5182
+ additionalInformation?: string | undefined;
5183
+ /**
5184
+ * <p>The customer's party type.</p>
5185
+ * @public
5186
+ */
5187
+ partyType?: string | undefined;
5188
+ /**
5189
+ * <p>The name of the customer's business.</p>
5190
+ * @public
5191
+ */
5192
+ businessName?: string | undefined;
5193
+ /**
5194
+ * <p>The customer's birth date.</p>
5195
+ * @public
5196
+ */
5197
+ birthDate?: string | undefined;
5198
+ /**
5199
+ * <p>The customer's gender.</p>
5200
+ * @public
5201
+ */
5202
+ gender?: string | undefined;
5203
+ /**
5204
+ * <p>The customer's mobile phone number.</p>
5205
+ * @public
5206
+ */
5207
+ mobilePhoneNumber?: string | undefined;
5208
+ /**
5209
+ * <p>The customer's mobile phone number.</p>
5210
+ * @public
5211
+ */
5212
+ homePhoneNumber?: string | undefined;
5213
+ /**
5214
+ * <p>The customer's business phone number.</p>
5215
+ * @public
5216
+ */
5217
+ businessPhoneNumber?: string | undefined;
5218
+ /**
5219
+ * <p>The customer's business email address.</p>
5220
+ * @public
5221
+ */
5222
+ businessEmailAddress?: string | undefined;
5223
+ /**
5224
+ * <p>The first line of a customer address.</p>
5225
+ * @public
5226
+ */
5227
+ address1?: string | undefined;
5228
+ /**
5229
+ * <p>The second line of a customer address.</p>
5230
+ * @public
5231
+ */
5232
+ address2?: string | undefined;
5233
+ /**
5234
+ * <p>The third line of a customer address.</p>
5235
+ * @public
5236
+ */
5237
+ address3?: string | undefined;
5238
+ /**
5239
+ * <p>The fourth line of a customer address.</p>
5240
+ * @public
5241
+ */
5242
+ address4?: string | undefined;
5243
+ /**
5244
+ * <p>The city in which a customer lives.</p>
5245
+ * @public
5246
+ */
5247
+ city?: string | undefined;
5248
+ /**
5249
+ * <p>The county in which a customer lives.</p>
5250
+ * @public
5251
+ */
5252
+ county?: string | undefined;
5253
+ /**
5254
+ * <p>The country in which a customer lives.</p>
5255
+ * @public
5256
+ */
5257
+ country?: string | undefined;
5258
+ /**
5259
+ * <p>The postal code of a customer address.</p>
5260
+ * @public
5261
+ */
5262
+ postalCode?: string | undefined;
5263
+ /**
5264
+ * <p>The province in which a customer lives.</p>
5265
+ * @public
5266
+ */
5267
+ province?: string | undefined;
5268
+ /**
5269
+ * <p>The state in which a customer lives.</p>
5270
+ * @public
5271
+ */
5272
+ state?: string | undefined;
5273
+ /**
5274
+ * <p>The first line of a customer’s shipping address.</p>
5275
+ * @public
5276
+ */
5277
+ shippingAddress1?: string | undefined;
5278
+ /**
5279
+ * <p>The second line of a customer’s shipping address.</p>
5280
+ * @public
5281
+ */
5282
+ shippingAddress2?: string | undefined;
5283
+ /**
5284
+ * <p>The third line of a customer’s shipping address.</p>
5285
+ * @public
5286
+ */
5287
+ shippingAddress3?: string | undefined;
5288
+ /**
5289
+ * <p>The fourth line of a customer’s shipping address.</p>
5290
+ * @public
5291
+ */
5292
+ shippingAddress4?: string | undefined;
5293
+ /**
5294
+ * <p>The city of a customer’s shipping address.</p>
5295
+ * @public
5296
+ */
5297
+ shippingCity?: string | undefined;
5298
+ /**
5299
+ * <p>The county of a customer’s shipping address.</p>
5300
+ * @public
5301
+ */
5302
+ shippingCounty?: string | undefined;
5303
+ /**
5304
+ * <p>The country of a customer’s shipping address.</p>
5305
+ * @public
5306
+ */
5307
+ shippingCountry?: string | undefined;
5308
+ /**
5309
+ * <p>The postal code of a customer’s shipping address.</p>
5310
+ * @public
5311
+ */
5312
+ shippingPostalCode?: string | undefined;
5313
+ /**
5314
+ * <p>The province of a customer’s shipping address.</p>
5315
+ * @public
5316
+ */
5317
+ shippingProvince?: string | undefined;
5318
+ /**
5319
+ * <p>The state of a customer’s shipping address.</p>
5320
+ * @public
5321
+ */
5322
+ shippingState?: string | undefined;
5323
+ /**
5324
+ * <p>The first line of a customer’s mailing address.</p>
5325
+ * @public
5326
+ */
5327
+ mailingAddress1?: string | undefined;
5328
+ /**
5329
+ * <p>The second line of a customer’s mailing address.</p>
5330
+ * @public
5331
+ */
5332
+ mailingAddress2?: string | undefined;
5333
+ /**
5334
+ * <p>The third line of a customer’s mailing address.</p>
5335
+ * @public
5336
+ */
5337
+ mailingAddress3?: string | undefined;
5338
+ /**
5339
+ * <p>The fourth line of a customer’s mailing address.</p>
5340
+ * @public
5341
+ */
5342
+ mailingAddress4?: string | undefined;
5343
+ /**
5344
+ * <p>The city of a customer’s mailing address.</p>
5345
+ * @public
5346
+ */
5347
+ mailingCity?: string | undefined;
5348
+ /**
5349
+ * <p>The county of a customer’s mailing address.</p>
5350
+ * @public
5351
+ */
5352
+ mailingCounty?: string | undefined;
5353
+ /**
5354
+ * <p>The country of a customer’s mailing address.</p>
5355
+ * @public
5356
+ */
5357
+ mailingCountry?: string | undefined;
5358
+ /**
5359
+ * <p>The postal code of a customer’s mailing address.</p>
5360
+ * @public
5361
+ */
5362
+ mailingPostalCode?: string | undefined;
5363
+ /**
5364
+ * <p>The province of a customer’s mailing address.</p>
5365
+ * @public
5366
+ */
5367
+ mailingProvince?: string | undefined;
5368
+ /**
5369
+ * <p>The state of a customer’s mailing address.</p>
5370
+ * @public
5371
+ */
5372
+ mailingState?: string | undefined;
5373
+ /**
5374
+ * <p>The first line of a customer’s billing address.</p>
5375
+ * @public
5376
+ */
5377
+ billingAddress1?: string | undefined;
5378
+ /**
5379
+ * <p>The second line of a customer’s billing address.</p>
5380
+ * @public
5381
+ */
5382
+ billingAddress2?: string | undefined;
5383
+ /**
5384
+ * <p>The third line of a customer’s billing address.</p>
5385
+ * @public
5386
+ */
5387
+ billingAddress3?: string | undefined;
5388
+ /**
5389
+ * <p>The fourth line of a customer’s billing address.</p>
5390
+ * @public
5391
+ */
5392
+ billingAddress4?: string | undefined;
5393
+ /**
5394
+ * <p>The city of a customer’s billing address.</p>
5395
+ * @public
5396
+ */
5397
+ billingCity?: string | undefined;
5398
+ /**
5399
+ * <p>The county of a customer’s billing address.</p>
5400
+ * @public
5401
+ */
5402
+ billingCounty?: string | undefined;
5403
+ /**
5404
+ * <p>The country of a customer’s billing address.</p>
5405
+ * @public
5406
+ */
5407
+ billingCountry?: string | undefined;
5408
+ /**
5409
+ * <p>The postal code of a customer’s billing address.</p>
5410
+ * @public
5411
+ */
5412
+ billingPostalCode?: string | undefined;
5413
+ /**
5414
+ * <p>The province of a customer’s billing address.</p>
5415
+ * @public
5416
+ */
5417
+ billingProvince?: string | undefined;
5418
+ /**
5419
+ * <p>The state of a customer’s billing address.</p>
5420
+ * @public
5421
+ */
5422
+ billingState?: string | undefined;
5423
+ /**
5424
+ * <p>The custom attributes in customer profile attributes.</p>
5425
+ * @public
5426
+ */
5427
+ custom?: Record<string, string> | undefined;
5428
+ }
5429
+ /**
5430
+ * <p>The system endpoint attributes that are used with the message template.</p>
5431
+ * @public
5432
+ */
5433
+ export interface SystemEndpointAttributes {
5434
+ /**
5435
+ * <p>The customer's phone number if used with <code>customerEndpoint</code>, or the number the customer
5436
+ * dialed to call your contact center if used with <code>systemEndpoint</code>.</p>
5437
+ * @public
5438
+ */
5439
+ address?: string | undefined;
5440
+ }
5441
+ /**
5442
+ * <p>The system attributes that are used with the message template.</p>
5443
+ * @public
5444
+ */
5445
+ export interface SystemAttributes {
5446
+ /**
5447
+ * <p>The name of the task.</p>
5448
+ * @public
5449
+ */
5450
+ name?: string | undefined;
5451
+ /**
5452
+ * <p>The CustomerEndpoint attribute.</p>
5453
+ * @public
5454
+ */
5455
+ customerEndpoint?: SystemEndpointAttributes | undefined;
5456
+ /**
5457
+ * <p>The SystemEndpoint attribute.</p>
5458
+ * @public
5459
+ */
5460
+ systemEndpoint?: SystemEndpointAttributes | undefined;
5461
+ }
5462
+ /**
5463
+ * <p>The attributes that are used with the message template.</p>
5464
+ * @public
5465
+ */
5466
+ export interface MessageTemplateAttributes {
5467
+ /**
5468
+ * <p>The system attributes that are used with the message template.</p>
5469
+ * @public
5470
+ */
5471
+ systemAttributes?: SystemAttributes | undefined;
5472
+ /**
5473
+ * <p>The agent attributes that are used with the message template.</p>
5474
+ * @public
5475
+ */
5476
+ agentAttributes?: AgentAttributes | undefined;
5477
+ /**
5478
+ * <p>The customer profile attributes that are used with the message template.</p>
5479
+ * @public
5480
+ */
5481
+ customerProfileAttributes?: CustomerProfileAttributes | undefined;
5482
+ /**
5483
+ * <p>The custom attributes that are used with the message template.</p>
5484
+ * @public
5485
+ */
5486
+ customAttributes?: Record<string, string> | undefined;
5487
+ }
5488
+ /**
5489
+ * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
5490
+ * @public
5491
+ */
5492
+ export interface GroupingConfiguration {
5493
+ /**
5494
+ * <p>The criteria used for grouping Amazon Q in Connect users.</p>
5495
+ * <p>The following is the list of supported criteria values.</p>
5496
+ * <ul>
5497
+ * <li>
5498
+ * <p>
5499
+ * <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon
5500
+ * 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>
5501
+ * </li>
5502
+ * </ul>
5503
+ * @public
5504
+ */
5505
+ criteria?: string | undefined;
5506
+ /**
5507
+ * <p>The list of values that define different groups of Amazon Q in Connect users.</p>
5508
+ * <ul>
5509
+ * <li>
5510
+ * <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to
5511
+ * provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing
5512
+ * profiles</a> as values of this parameter.</p>
5513
+ * </li>
5514
+ * </ul>
5515
+ * @public
5516
+ */
5517
+ values?: string[] | undefined;
5518
+ }
5519
+ /**
5520
+ * @public
5521
+ */
5522
+ export interface CreateMessageTemplateRequest {
5523
+ /**
5524
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
5525
+ * the ARN.</p>
5526
+ * @public
5527
+ */
5528
+ knowledgeBaseId: string | undefined;
5529
+ /**
5530
+ * <p>The name of the message template.</p>
5531
+ * @public
5532
+ */
5533
+ name: string | undefined;
5534
+ /**
5535
+ * <p>The content of the message template.</p>
5536
+ * @public
5537
+ */
5538
+ content: MessageTemplateContentProvider | undefined;
5539
+ /**
5540
+ * <p>The description of the message template.</p>
5541
+ * @public
5542
+ */
5543
+ description?: string | undefined;
5544
+ /**
5545
+ * <p>The channel subtype this message template applies to.</p>
5546
+ * @public
5547
+ */
5548
+ channelSubtype: ChannelSubtype | undefined;
5549
+ /**
5550
+ * <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>,
5551
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
5552
+ * <code>zh_CN</code>, <code>zh_TW</code>
5553
+ * </p>
5554
+ * @public
5555
+ */
5556
+ language?: string | undefined;
5557
+ /**
5558
+ * <p>An object that specifies the default values to use for variables in the message template.
5559
+ * This object contains different categories of key-value pairs. Each key defines a variable or
5560
+ * placeholder in the message template. The corresponding value defines the default value for
5561
+ * that variable.</p>
5562
+ * @public
5563
+ */
5564
+ defaultAttributes?: MessageTemplateAttributes | undefined;
5565
+ /**
5566
+ * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
5567
+ * @public
5568
+ */
5569
+ groupingConfiguration?: GroupingConfiguration | undefined;
5570
+ /**
5571
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
5572
+ * request. If not provided, the Amazon Web Services
5573
+ * SDK populates this field. For more information about idempotency, see
5574
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
5575
+ * @public
5576
+ */
5577
+ clientToken?: string | undefined;
5578
+ /**
5579
+ * <p>The tags used to organize, track, or control access for this resource.</p>
5580
+ * @public
5581
+ */
5582
+ tags?: Record<string, string> | undefined;
5583
+ }
5584
+ /**
5585
+ * @public
5586
+ * @enum
5587
+ */
5588
+ export declare const MessageTemplateAttributeType: {
5589
+ readonly AGENT: "AGENT";
5590
+ readonly CUSTOM: "CUSTOM";
5591
+ readonly CUSTOMER_PROFILE: "CUSTOMER_PROFILE";
5592
+ readonly SYSTEM: "SYSTEM";
5593
+ };
5594
+ /**
5595
+ * @public
5596
+ */
5597
+ export type MessageTemplateAttributeType = (typeof MessageTemplateAttributeType)[keyof typeof MessageTemplateAttributeType];
5598
+ /**
5599
+ * <p>The data of a message template.</p>
5600
+ * @public
5601
+ */
5602
+ export interface MessageTemplateData {
5603
+ /**
5604
+ * <p>The Amazon Resource Name (ARN) of the message template.</p>
5605
+ * @public
5606
+ */
5607
+ messageTemplateArn: string | undefined;
5608
+ /**
5609
+ * <p>The identifier of the message template.</p>
5610
+ * @public
5611
+ */
5612
+ messageTemplateId: string | undefined;
5613
+ /**
5614
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
5615
+ * @public
5616
+ */
5617
+ knowledgeBaseArn: string | undefined;
5618
+ /**
5619
+ * <p>The identifier of the knowledge base.</p>
5620
+ * @public
5621
+ */
5622
+ knowledgeBaseId: string | undefined;
5623
+ /**
5624
+ * <p>The name of the message template.</p>
5625
+ * @public
5626
+ */
5627
+ name: string | undefined;
5628
+ /**
5629
+ * <p>The channel subtype this message template applies to.</p>
5630
+ * @public
5631
+ */
5632
+ channelSubtype: ChannelSubtype | undefined;
5633
+ /**
5634
+ * <p>The timestamp when the message template was created.</p>
5635
+ * @public
5636
+ */
5637
+ createdTime: Date | undefined;
5638
+ /**
5639
+ * <p>The timestamp when the message template data was last modified.</p>
5640
+ * @public
5641
+ */
5642
+ lastModifiedTime: Date | undefined;
5643
+ /**
5644
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the message template
5645
+ * data.</p>
5646
+ * @public
5647
+ */
5648
+ lastModifiedBy: string | undefined;
5649
+ /**
5650
+ * <p>The content of the message template.</p>
5651
+ * @public
5652
+ */
5653
+ content: MessageTemplateContentProvider | undefined;
5654
+ /**
5655
+ * <p>The description of the message template.</p>
5656
+ * @public
5657
+ */
5658
+ description?: string | undefined;
5659
+ /**
5660
+ * <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>,
5661
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
5662
+ * <code>zh_CN</code>, <code>zh_TW</code>
5663
+ * </p>
5664
+ * @public
5665
+ */
5666
+ language?: string | undefined;
5667
+ /**
5668
+ * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
5669
+ * @public
5670
+ */
5671
+ groupingConfiguration?: GroupingConfiguration | undefined;
5672
+ /**
5673
+ * <p>An object that specifies the default values to use for variables in the message template.
5674
+ * This object contains different categories of key-value pairs. Each key defines a variable or
5675
+ * placeholder in the message template. The corresponding value defines the default value for
5676
+ * that variable.</p>
5677
+ * @public
5678
+ */
5679
+ defaultAttributes?: MessageTemplateAttributes | undefined;
5680
+ /**
5681
+ * <p>The types of attributes that the message template contains.</p>
5682
+ * @public
5683
+ */
5684
+ attributeTypes?: MessageTemplateAttributeType[] | undefined;
5685
+ /**
5686
+ * <p>The checksum value of the message template content that is referenced by the
5687
+ * <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or
5688
+ * <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language,
5689
+ * <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
5690
+ * @public
5691
+ */
5692
+ messageTemplateContentSha256: string | undefined;
5693
+ /**
5694
+ * <p>The tags used to organize, track, or control access for this resource.</p>
5695
+ * @public
5696
+ */
5697
+ tags?: Record<string, string> | undefined;
5698
+ }
5699
+ /**
5700
+ * @public
5701
+ */
5702
+ export interface CreateMessageTemplateResponse {
5703
+ /**
5704
+ * <p>The message template.</p>
5705
+ * @public
5706
+ */
5707
+ messageTemplate?: MessageTemplateData | undefined;
5708
+ }
5709
+ /**
5710
+ * @public
5711
+ */
5712
+ export interface CreateMessageTemplateAttachmentRequest {
5713
+ /**
5714
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
5715
+ * the ARN.</p>
5716
+ * @public
5717
+ */
5718
+ knowledgeBaseId: string | undefined;
5719
+ /**
5720
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
5721
+ * @public
5722
+ */
5723
+ messageTemplateId: string | undefined;
5724
+ /**
5725
+ * <p>The presentation information for the attachment file.</p>
5726
+ * @public
5727
+ */
5728
+ contentDisposition: ContentDisposition | undefined;
5729
+ /**
5730
+ * <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
5731
+ * @public
5732
+ */
5733
+ name: string | undefined;
5734
+ /**
5735
+ * <p>The body of the attachment file being uploaded. It should be encoded using base64
5736
+ * encoding.</p>
5737
+ * @public
5738
+ */
5739
+ body: string | undefined;
5740
+ /**
5741
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
5742
+ * request. If not provided, the Amazon Web Services
5743
+ * SDK populates this field. For more information about idempotency, see
5744
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
5745
+ * @public
5746
+ */
5747
+ clientToken?: string | undefined;
5748
+ }
5749
+ /**
5750
+ * <p>Information about the message template attachment.</p>
5751
+ * @public
5752
+ */
5753
+ export interface MessageTemplateAttachment {
5754
+ /**
5755
+ * <p>The presentation information for the attachment file.</p>
5756
+ * @public
5757
+ */
5758
+ contentDisposition: ContentDisposition | undefined;
5759
+ /**
5760
+ * <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
5761
+ * @public
5762
+ */
5763
+ name: string | undefined;
5764
+ /**
5765
+ * <p>The timestamp when the attachment file was uploaded.</p>
5766
+ * @public
5767
+ */
5768
+ uploadedTime: Date | undefined;
5769
+ /**
5770
+ * <p>A pre-signed Amazon S3 URL that can be used to download the attachment file.</p>
5771
+ * @public
5772
+ */
5773
+ url: string | undefined;
5774
+ /**
5775
+ * <p>The expiration time of the pre-signed Amazon S3 URL.</p>
5776
+ * @public
5777
+ */
5778
+ urlExpiry: Date | undefined;
5779
+ /**
5780
+ * <p>The identifier of the attachment file.</p>
5781
+ * @public
5782
+ */
5783
+ attachmentId: string | undefined;
5784
+ }
5785
+ /**
5786
+ * @public
5787
+ */
5788
+ export interface CreateMessageTemplateAttachmentResponse {
5789
+ /**
5790
+ * <p>The message template attachment.</p>
5791
+ * @public
5792
+ */
5793
+ attachment?: MessageTemplateAttachment | undefined;
5794
+ }
5795
+ /**
5796
+ * @public
5797
+ */
5798
+ export interface CreateMessageTemplateVersionRequest {
5799
+ /**
5800
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
5801
+ * the ARN.</p>
5802
+ * @public
5803
+ */
5804
+ knowledgeBaseId: string | undefined;
5805
+ /**
5806
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
5807
+ * @public
5808
+ */
5809
+ messageTemplateId: string | undefined;
5810
+ /**
5811
+ * <p>The checksum value of the message template content that is referenced by the
5812
+ * <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or
5813
+ * <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language,
5814
+ * <code>defaultAttributes</code> and <code>Attachments</code> of the message template. If not
5815
+ * supplied, the message template version will be created based on the message template content
5816
+ * that is referenced by the <code>$LATEST</code> qualifier by default.</p>
5817
+ * @public
5818
+ */
5819
+ messageTemplateContentSha256?: string | undefined;
5820
+ }
5821
+ /**
5822
+ * <p>The extended data of a message template.</p>
5823
+ * @public
5824
+ */
5825
+ export interface ExtendedMessageTemplateData {
5826
+ /**
5827
+ * <p>The Amazon Resource Name (ARN) of the message template.</p>
5828
+ * @public
5829
+ */
5830
+ messageTemplateArn: string | undefined;
5831
+ /**
5832
+ * <p>The identifier of the message template.</p>
5833
+ * @public
5834
+ */
5835
+ messageTemplateId: string | undefined;
5836
+ /**
5837
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
5838
+ * @public
5839
+ */
5840
+ knowledgeBaseArn: string | undefined;
5841
+ /**
5842
+ * <p>The identifier of the knowledge base.</p>
5843
+ * @public
5844
+ */
5845
+ knowledgeBaseId: string | undefined;
5846
+ /**
5847
+ * <p>The name of the message template.</p>
5848
+ * @public
5849
+ */
5850
+ name: string | undefined;
5851
+ /**
5852
+ * <p>The channel subtype this message template applies to.</p>
5853
+ * @public
5854
+ */
5855
+ channelSubtype: ChannelSubtype | undefined;
5856
+ /**
5857
+ * <p>The timestamp when the message template was created.</p>
5858
+ * @public
5859
+ */
5860
+ createdTime: Date | undefined;
5861
+ /**
5862
+ * <p>The timestamp when the message template data was last modified.</p>
5863
+ * @public
5864
+ */
5865
+ lastModifiedTime: Date | undefined;
5866
+ /**
5867
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the message template
5868
+ * data.</p>
5869
+ * @public
5870
+ */
5871
+ lastModifiedBy: string | undefined;
5872
+ /**
5873
+ * <p>The content of the message template.</p>
5874
+ * @public
5875
+ */
5876
+ content: MessageTemplateContentProvider | undefined;
5877
+ /**
5878
+ * <p>The description of the message template.</p>
5879
+ * @public
5880
+ */
5881
+ description?: string | undefined;
5882
+ /**
5883
+ * <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>,
5884
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
5885
+ * <code>zh_CN</code>, <code>zh_TW</code>
5886
+ * </p>
5887
+ * @public
5888
+ */
5889
+ language?: string | undefined;
5890
+ /**
5891
+ * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
5892
+ * @public
5893
+ */
5894
+ groupingConfiguration?: GroupingConfiguration | undefined;
5895
+ /**
5896
+ * <p>An object that specifies the default values to use for variables in the message template.
5897
+ * This object contains different categories of key-value pairs. Each key defines a variable or
5898
+ * placeholder in the message template. The corresponding value defines the default value for
5899
+ * that variable.</p>
5900
+ * @public
5901
+ */
5902
+ defaultAttributes?: MessageTemplateAttributes | undefined;
5903
+ /**
5904
+ * <p>The types of attributes contain the message template.</p>
5905
+ * @public
5906
+ */
5907
+ attributeTypes?: MessageTemplateAttributeType[] | undefined;
5908
+ /**
5909
+ * <p>The message template attachments.</p>
5910
+ * @public
5911
+ */
5912
+ attachments?: MessageTemplateAttachment[] | undefined;
5913
+ /**
5914
+ * <p>Whether the version of the message template is activated.</p>
5915
+ * @public
5916
+ */
5917
+ isActive?: boolean | undefined;
5918
+ /**
5919
+ * <p>The version number of the message template version.</p>
5920
+ * @public
5921
+ */
5922
+ versionNumber?: number | undefined;
5923
+ /**
5924
+ * <p>The checksum value of the message template content that is referenced by the
5925
+ * <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or
5926
+ * <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language,
5927
+ * <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
5928
+ * @public
5929
+ */
5930
+ messageTemplateContentSha256: string | undefined;
5931
+ /**
5932
+ * <p>The tags used to organize, track, or control access for this resource.</p>
5933
+ * @public
5934
+ */
5935
+ tags?: Record<string, string> | undefined;
5936
+ }
5937
+ /**
5938
+ * @public
5939
+ */
5940
+ export interface CreateMessageTemplateVersionResponse {
5941
+ /**
5942
+ * <p>The message template.</p>
5943
+ * @public
5944
+ */
5945
+ messageTemplate?: ExtendedMessageTemplateData | undefined;
5946
+ }
5947
+ /**
5948
+ * <p>The container of quick response data.</p>
5949
+ * @public
5950
+ */
5951
+ export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
5952
+ /**
5953
+ * @public
5954
+ */
5955
+ export declare namespace QuickResponseDataProvider {
5956
+ /**
5957
+ * <p>The content of the quick response.</p>
5958
+ * @public
5959
+ */
5960
+ interface ContentMember {
5961
+ content: string;
5962
+ $unknown?: never;
5963
+ }
5964
+ /**
5965
+ * @public
5966
+ */
5967
+ interface $UnknownMember {
5968
+ content?: never;
5969
+ $unknown: [string, any];
5970
+ }
5971
+ interface Visitor<T> {
5972
+ content: (value: string) => T;
5973
+ _: (name: string, value: any) => T;
5974
+ }
5975
+ const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
5976
+ }
5977
+ /**
5978
+ * @public
5979
+ */
5980
+ export interface CreateQuickResponseRequest {
5981
+ /**
5982
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
5983
+ * @public
5984
+ */
5985
+ knowledgeBaseId: string | undefined;
5986
+ /**
5987
+ * <p>The name of the quick response.</p>
5988
+ * @public
5989
+ */
5990
+ name: string | undefined;
5991
+ /**
5992
+ * <p>The content of the quick response.</p>
5993
+ * @public
5994
+ */
5995
+ content: QuickResponseDataProvider | undefined;
5996
+ /**
5997
+ * <p>The media type of the quick response content.</p>
5998
+ * <ul>
5999
+ * <li>
6000
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written
6001
+ * in plain text.</p>
6002
+ * </li>
6003
+ * <li>
6004
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response
6005
+ * written in richtext.</p>
6006
+ * </li>
6007
+ * </ul>
6008
+ * @public
6009
+ */
6010
+ contentType?: string | undefined;
6011
+ /**
6012
+ * <p>The configuration information of the user groups that the quick response is accessible
6013
+ * to.</p>
6014
+ * @public
6015
+ */
6016
+ groupingConfiguration?: GroupingConfiguration | undefined;
6017
+ /**
6018
+ * <p>The description of the quick response.</p>
6019
+ * @public
6020
+ */
6021
+ description?: string | undefined;
6022
+ /**
6023
+ * <p>The shortcut key of the quick response. The value should be unique across the
6024
+ * knowledge base. </p>
6025
+ * @public
6026
+ */
6027
+ shortcutKey?: string | undefined;
6028
+ /**
6029
+ * <p>Whether the quick response is active.</p>
6030
+ * @public
6031
+ */
6032
+ isActive?: boolean | undefined;
6033
+ /**
6034
+ * <p>The Amazon Connect channels this quick response applies to.</p>
6035
+ * @public
6036
+ */
6037
+ channels?: string[] | undefined;
6038
+ /**
6039
+ * <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>,
6040
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
6041
+ * <code>zh_CN</code>, <code>zh_TW</code>
6042
+ * </p>
6043
+ * @public
6044
+ */
6045
+ language?: string | undefined;
6046
+ /**
6047
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6048
+ * request. If not provided, the Amazon Web Services
6049
+ * SDK populates this field. For more information about idempotency, see
6050
+ * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6051
+ * @public
6052
+ */
6053
+ clientToken?: string | undefined;
6054
+ /**
6055
+ * <p>The tags used to organize, track, or control access for this resource.</p>
6056
+ * @public
6057
+ */
6058
+ tags?: Record<string, string> | undefined;
6059
+ }
6060
+ /**
6061
+ * <p>The container quick response content.</p>
6062
+ * @public
6063
+ */
6064
+ export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
6065
+ /**
6066
+ * @public
6067
+ */
6068
+ export declare namespace QuickResponseContentProvider {
6069
+ /**
6070
+ * <p>The content of the quick response.</p>
6071
+ * @public
6072
+ */
6073
+ interface ContentMember {
6074
+ content: string;
6075
+ $unknown?: never;
6076
+ }
6077
+ /**
6078
+ * @public
6079
+ */
6080
+ interface $UnknownMember {
6081
+ content?: never;
5058
6082
  $unknown: [string, any];
5059
6083
  }
5060
6084
  interface Visitor<T> {
@@ -5197,7 +6221,10 @@ export interface QuickResponseData {
5197
6221
  */
5198
6222
  channels?: string[] | undefined;
5199
6223
  /**
5200
- * <p>The language code value for the language in which the quick response is written.</p>
6224
+ * <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>,
6225
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
6226
+ * <code>zh_CN</code>, <code>zh_TW</code>
6227
+ * </p>
5201
6228
  * @public
5202
6229
  */
5203
6230
  language?: string | undefined;
@@ -5217,6 +6244,47 @@ export interface CreateQuickResponseResponse {
5217
6244
  */
5218
6245
  quickResponse?: QuickResponseData | undefined;
5219
6246
  }
6247
+ /**
6248
+ * @public
6249
+ */
6250
+ export interface DeactivateMessageTemplateRequest {
6251
+ /**
6252
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
6253
+ * the ARN.</p>
6254
+ * @public
6255
+ */
6256
+ knowledgeBaseId: string | undefined;
6257
+ /**
6258
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
6259
+ * @public
6260
+ */
6261
+ messageTemplateId: string | undefined;
6262
+ /**
6263
+ * <p>The version number of the message template version to deactivate.</p>
6264
+ * @public
6265
+ */
6266
+ versionNumber: number | undefined;
6267
+ }
6268
+ /**
6269
+ * @public
6270
+ */
6271
+ export interface DeactivateMessageTemplateResponse {
6272
+ /**
6273
+ * <p>The Amazon Resource Name (ARN) of the message template.</p>
6274
+ * @public
6275
+ */
6276
+ messageTemplateArn: string | undefined;
6277
+ /**
6278
+ * <p>The identifier of the message template.</p>
6279
+ * @public
6280
+ */
6281
+ messageTemplateId: string | undefined;
6282
+ /**
6283
+ * <p>The version number of the message template version that has been deactivated.</p>
6284
+ * @public
6285
+ */
6286
+ versionNumber: number | undefined;
6287
+ }
5220
6288
  /**
5221
6289
  * @public
5222
6290
  */
@@ -5242,15 +6310,62 @@ export interface DeleteImportJobResponse {
5242
6310
  */
5243
6311
  export interface DeleteKnowledgeBaseRequest {
5244
6312
  /**
5245
- * <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
6313
+ * <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
6314
+ * @public
6315
+ */
6316
+ knowledgeBaseId: string | undefined;
6317
+ }
6318
+ /**
6319
+ * @public
6320
+ */
6321
+ export interface DeleteKnowledgeBaseResponse {
6322
+ }
6323
+ /**
6324
+ * @public
6325
+ */
6326
+ export interface DeleteMessageTemplateRequest {
6327
+ /**
6328
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
6329
+ * the ARN.</p>
6330
+ * @public
6331
+ */
6332
+ knowledgeBaseId: string | undefined;
6333
+ /**
6334
+ * <p>The identifier of the message template. Can be either the ID or the ARN.</p>
6335
+ * @public
6336
+ */
6337
+ messageTemplateId: string | undefined;
6338
+ }
6339
+ /**
6340
+ * @public
6341
+ */
6342
+ export interface DeleteMessageTemplateResponse {
6343
+ }
6344
+ /**
6345
+ * @public
6346
+ */
6347
+ export interface DeleteMessageTemplateAttachmentRequest {
6348
+ /**
6349
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
6350
+ * the ARN.</p>
6351
+ * @public
6352
+ */
6353
+ knowledgeBaseId: string | undefined;
6354
+ /**
6355
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
6356
+ * @public
6357
+ */
6358
+ messageTemplateId: string | undefined;
6359
+ /**
6360
+ * <p>The identifier of the attachment file.</p>
5246
6361
  * @public
5247
6362
  */
5248
- knowledgeBaseId: string | undefined;
6363
+ attachmentId: string | undefined;
5249
6364
  }
5250
6365
  /**
5251
6366
  * @public
5252
6367
  */
5253
- export interface DeleteKnowledgeBaseResponse {
6368
+ export interface DeleteMessageTemplateAttachmentResponse {
5254
6369
  }
5255
6370
  /**
5256
6371
  * @public
@@ -5442,6 +6557,32 @@ export interface GetKnowledgeBaseResponse {
5442
6557
  */
5443
6558
  knowledgeBase?: KnowledgeBaseData | undefined;
5444
6559
  }
6560
+ /**
6561
+ * @public
6562
+ */
6563
+ export interface GetMessageTemplateRequest {
6564
+ /**
6565
+ * <p>The identifier of the message template. Can be either the ID or the ARN.</p>
6566
+ * @public
6567
+ */
6568
+ messageTemplateId: string | undefined;
6569
+ /**
6570
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
6571
+ * the ARN.</p>
6572
+ * @public
6573
+ */
6574
+ knowledgeBaseId: string | undefined;
6575
+ }
6576
+ /**
6577
+ * @public
6578
+ */
6579
+ export interface GetMessageTemplateResponse {
6580
+ /**
6581
+ * <p>The message template.</p>
6582
+ * @public
6583
+ */
6584
+ messageTemplate?: ExtendedMessageTemplateData | undefined;
6585
+ }
5445
6586
  /**
5446
6587
  * @public
5447
6588
  */
@@ -5621,288 +6762,48 @@ export interface KnowledgeBaseSummary {
5621
6762
  * <p>Information about how to render the content.</p>
5622
6763
  * @public
5623
6764
  */
5624
- renderingConfiguration?: RenderingConfiguration | undefined;
5625
- /**
5626
- * <p>The configuration information for the customer managed key used for encryption. </p>
5627
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
5628
- * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
5629
- * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
5630
- * key to invoke Amazon Q in Connect. </p>
5631
- * <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
5632
- * your instance</a>.</p>
5633
- * @public
5634
- */
5635
- serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
5636
- /**
5637
- * <p>The description of the knowledge base.</p>
5638
- * @public
5639
- */
5640
- description?: string | undefined;
5641
- /**
5642
- * <p>The tags used to organize, track, or control access for this resource.</p>
5643
- * @public
5644
- */
5645
- tags?: Record<string, string> | undefined;
5646
- }
5647
- /**
5648
- * @public
5649
- */
5650
- export interface ListKnowledgeBasesResponse {
5651
- /**
5652
- * <p>Information about the knowledge bases.</p>
5653
- * @public
5654
- */
5655
- knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
5656
- /**
5657
- * <p>If there are additional results, this is the token for the next set of results.</p>
5658
- * @public
5659
- */
5660
- nextToken?: string | undefined;
5661
- }
5662
- /**
5663
- * @public
5664
- */
5665
- export interface ListQuickResponsesRequest {
5666
- /**
5667
- * <p>The token for the next set of results. Use the value returned in the previous
5668
- * response in the next request to retrieve the next set of results.</p>
5669
- * @public
5670
- */
5671
- nextToken?: string | undefined;
5672
- /**
5673
- * <p>The maximum number of results to return per page.</p>
5674
- * @public
5675
- */
5676
- maxResults?: number | undefined;
5677
- /**
5678
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
5679
- * @public
5680
- */
5681
- knowledgeBaseId: string | undefined;
5682
- }
5683
- /**
5684
- * <p>The summary information about the quick response.</p>
5685
- * @public
5686
- */
5687
- export interface QuickResponseSummary {
5688
- /**
5689
- * <p>The Amazon Resource Name (ARN) of the quick response.</p>
5690
- * @public
5691
- */
5692
- quickResponseArn: string | undefined;
5693
- /**
5694
- * <p>The identifier of the quick response.</p>
5695
- * @public
5696
- */
5697
- quickResponseId: string | undefined;
5698
- /**
5699
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
5700
- * @public
5701
- */
5702
- knowledgeBaseArn: string | undefined;
5703
- /**
5704
- * <p>The identifier of the knowledge base.</p>
5705
- * @public
5706
- */
5707
- knowledgeBaseId: string | undefined;
5708
- /**
5709
- * <p>The name of the quick response.</p>
5710
- * @public
5711
- */
5712
- name: string | undefined;
5713
- /**
5714
- * <p>The media type of the quick response content.</p>
5715
- * <ul>
5716
- * <li>
5717
- * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
5718
- * in plain text.</p>
5719
- * </li>
5720
- * <li>
5721
- * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
5722
- * written in richtext.</p>
5723
- * </li>
5724
- * </ul>
5725
- * @public
5726
- */
5727
- contentType: string | undefined;
5728
- /**
5729
- * <p>The resource status of the quick response.</p>
5730
- * @public
5731
- */
5732
- status: QuickResponseStatus | undefined;
5733
- /**
5734
- * <p>The timestamp when the quick response was created.</p>
5735
- * @public
5736
- */
5737
- createdTime: Date | undefined;
5738
- /**
5739
- * <p>The timestamp when the quick response summary was last modified.</p>
5740
- * @public
5741
- */
5742
- lastModifiedTime: Date | undefined;
5743
- /**
5744
- * <p>The description of the quick response.</p>
5745
- * @public
5746
- */
5747
- description?: string | undefined;
5748
- /**
5749
- * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
5750
- * data.</p>
5751
- * @public
5752
- */
5753
- lastModifiedBy?: string | undefined;
5754
- /**
5755
- * <p>Whether the quick response is active.</p>
5756
- * @public
5757
- */
5758
- isActive?: boolean | undefined;
5759
- /**
5760
- * <p>The Amazon Connect contact channels this quick response applies to.
5761
- * The supported contact channel types include <code>Chat</code>.</p>
5762
- * @public
5763
- */
5764
- channels?: string[] | undefined;
5765
- /**
5766
- * <p>The tags used to organize, track, or control access for this resource.</p>
5767
- * @public
5768
- */
5769
- tags?: Record<string, string> | undefined;
5770
- }
5771
- /**
5772
- * @public
5773
- */
5774
- export interface ListQuickResponsesResponse {
5775
- /**
5776
- * <p>Summary information about the quick responses.</p>
5777
- * @public
5778
- */
5779
- quickResponseSummaries: QuickResponseSummary[] | undefined;
5780
- /**
5781
- * <p>The token for the next set of results. Use the value returned in the previous
5782
- * response in the next request to retrieve the next set of results.</p>
5783
- * @public
5784
- */
5785
- nextToken?: string | undefined;
5786
- }
5787
- /**
5788
- * @public
5789
- */
5790
- export interface UpdateQuickResponseRequest {
5791
- /**
5792
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
5793
- * @public
5794
- */
5795
- knowledgeBaseId: string | undefined;
5796
- /**
5797
- * <p>The identifier of the quick response.</p>
5798
- * @public
5799
- */
5800
- quickResponseId: string | undefined;
5801
- /**
5802
- * <p>The name of the quick response.</p>
5803
- * @public
5804
- */
5805
- name?: string | undefined;
5806
- /**
5807
- * <p>The updated content of the quick response.</p>
5808
- * @public
5809
- */
5810
- content?: QuickResponseDataProvider | undefined;
5811
- /**
5812
- * <p>The media type of the quick response content.</p>
5813
- * <ul>
5814
- * <li>
5815
- * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
5816
- * in plain text.</p>
5817
- * </li>
5818
- * <li>
5819
- * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
5820
- * written in richtext.</p>
5821
- * </li>
5822
- * </ul>
5823
- * @public
5824
- */
5825
- contentType?: string | undefined;
5826
- /**
5827
- * <p>The updated grouping configuration of the quick response.</p>
5828
- * @public
5829
- */
5830
- groupingConfiguration?: GroupingConfiguration | undefined;
5831
- /**
5832
- * <p>Whether to remove the grouping configuration of the quick response.</p>
5833
- * @public
5834
- */
5835
- removeGroupingConfiguration?: boolean | undefined;
5836
- /**
5837
- * <p>The updated description of the quick response.</p>
5838
- * @public
5839
- */
5840
- description?: string | undefined;
5841
- /**
5842
- * <p>Whether to remove the description from the quick response.</p>
5843
- * @public
5844
- */
5845
- removeDescription?: boolean | undefined;
5846
- /**
5847
- * <p>The shortcut key of the quick response. The value should be unique across the
5848
- * knowledge base.</p>
5849
- * @public
5850
- */
5851
- shortcutKey?: string | undefined;
5852
- /**
5853
- * <p>Whether to remove the shortcut key of the quick response.</p>
5854
- * @public
5855
- */
5856
- removeShortcutKey?: boolean | undefined;
6765
+ renderingConfiguration?: RenderingConfiguration | undefined;
5857
6766
  /**
5858
- * <p>Whether the quick response is active. </p>
6767
+ * <p>The configuration information for the customer managed key used for encryption. </p>
6768
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
6769
+ * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
6770
+ * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
6771
+ * key to invoke Amazon Q in Connect. </p>
6772
+ * <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
6773
+ * your instance</a>.</p>
5859
6774
  * @public
5860
6775
  */
5861
- isActive?: boolean | undefined;
6776
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
5862
6777
  /**
5863
- * <p>The Amazon Connect contact channels this quick response applies to.
5864
- * The supported contact channel types include <code>Chat</code>.</p>
6778
+ * <p>The description of the knowledge base.</p>
5865
6779
  * @public
5866
6780
  */
5867
- channels?: string[] | undefined;
6781
+ description?: string | undefined;
5868
6782
  /**
5869
- * <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>,
5870
- * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
5871
- * <code>zh_CN</code>, <code>zh_TW</code>
5872
- * </p>
6783
+ * <p>The tags used to organize, track, or control access for this resource.</p>
5873
6784
  * @public
5874
6785
  */
5875
- language?: string | undefined;
6786
+ tags?: Record<string, string> | undefined;
5876
6787
  }
5877
6788
  /**
5878
6789
  * @public
5879
6790
  */
5880
- export interface UpdateQuickResponseResponse {
6791
+ export interface ListKnowledgeBasesResponse {
5881
6792
  /**
5882
- * <p>The quick response.</p>
6793
+ * <p>Information about the knowledge bases.</p>
5883
6794
  * @public
5884
6795
  */
5885
- quickResponse?: QuickResponseData | undefined;
5886
- }
5887
- /**
5888
- * @public
5889
- */
5890
- export interface RemoveKnowledgeBaseTemplateUriRequest {
6796
+ knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
5891
6797
  /**
5892
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
6798
+ * <p>If there are additional results, this is the token for the next set of results.</p>
5893
6799
  * @public
5894
6800
  */
5895
- knowledgeBaseId: string | undefined;
5896
- }
5897
- /**
5898
- * @public
5899
- */
5900
- export interface RemoveKnowledgeBaseTemplateUriResponse {
6801
+ nextToken?: string | undefined;
5901
6802
  }
5902
6803
  /**
5903
6804
  * @public
5904
6805
  */
5905
- export interface SearchContentRequest {
6806
+ export interface ListMessageTemplatesRequest {
5906
6807
  /**
5907
6808
  * <p>The token for the next set of results. Use the value returned in the previous
5908
6809
  * response in the next request to retrieve the next set of results.</p>
@@ -5915,283 +6816,109 @@ export interface SearchContentRequest {
5915
6816
  */
5916
6817
  maxResults?: number | undefined;
5917
6818
  /**
5918
- * <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>
6819
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
6820
+ * the ARN.</p>
5919
6821
  * @public
5920
6822
  */
5921
6823
  knowledgeBaseId: string | undefined;
5922
- /**
5923
- * <p>The search expression to filter results.</p>
5924
- * @public
5925
- */
5926
- searchExpression: SearchExpression | undefined;
5927
6824
  }
5928
6825
  /**
6826
+ * <p>The summary of the message template.</p>
5929
6827
  * @public
5930
6828
  */
5931
- export interface SearchContentResponse {
6829
+ export interface MessageTemplateSummary {
5932
6830
  /**
5933
- * <p>Summary information about the content.</p>
6831
+ * <p>The Amazon Resource Name (ARN) of the message template.</p>
5934
6832
  * @public
5935
6833
  */
5936
- contentSummaries: ContentSummary[] | undefined;
6834
+ messageTemplateArn: string | undefined;
5937
6835
  /**
5938
- * <p>If there are additional results, this is the token for the next set of results.</p>
5939
- * @public
5940
- */
5941
- nextToken?: string | undefined;
5942
- }
5943
- /**
5944
- * @public
5945
- * @enum
5946
- */
5947
- export declare const QuickResponseFilterOperator: {
5948
- readonly EQUALS: "EQUALS";
5949
- readonly PREFIX: "PREFIX";
5950
- };
5951
- /**
5952
- * @public
5953
- */
5954
- export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
5955
- /**
5956
- * <p>The quick response fields to filter the quick response query results by.</p>
5957
- * <p>The following is the list of supported field names.</p>
5958
- * <ul>
5959
- * <li>
5960
- * <p>name</p>
5961
- * </li>
5962
- * <li>
5963
- * <p>description</p>
5964
- * </li>
5965
- * <li>
5966
- * <p>shortcutKey</p>
5967
- * </li>
5968
- * <li>
5969
- * <p>isActive</p>
5970
- * </li>
5971
- * <li>
5972
- * <p>channels</p>
5973
- * </li>
5974
- * <li>
5975
- * <p>language</p>
5976
- * </li>
5977
- * <li>
5978
- * <p>contentType</p>
5979
- * </li>
5980
- * <li>
5981
- * <p>createdTime</p>
5982
- * </li>
5983
- * <li>
5984
- * <p>lastModifiedTime</p>
5985
- * </li>
5986
- * <li>
5987
- * <p>lastModifiedBy</p>
5988
- * </li>
5989
- * <li>
5990
- * <p>groupingConfiguration.criteria</p>
5991
- * </li>
5992
- * <li>
5993
- * <p>groupingConfiguration.values</p>
5994
- * </li>
5995
- * </ul>
5996
- * @public
5997
- */
5998
- export interface QuickResponseFilterField {
5999
- /**
6000
- * <p>The name of the attribute field to filter the quick responses by.</p>
6836
+ * <p>The identifier of the message template.</p>
6001
6837
  * @public
6002
6838
  */
6003
- name: string | undefined;
6839
+ messageTemplateId: string | undefined;
6004
6840
  /**
6005
- * <p>The values of attribute field to filter the quick response by.</p>
6841
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
6006
6842
  * @public
6007
6843
  */
6008
- values?: string[] | undefined;
6844
+ knowledgeBaseArn: string | undefined;
6009
6845
  /**
6010
- * <p>The operator to use for filtering.</p>
6846
+ * <p>The identifier of the knowledge base.</p>
6011
6847
  * @public
6012
6848
  */
6013
- operator: QuickResponseFilterOperator | undefined;
6849
+ knowledgeBaseId: string | undefined;
6014
6850
  /**
6015
- * <p>Whether to treat null value as a match for the attribute field.</p>
6851
+ * <p>The name of the message template.</p>
6016
6852
  * @public
6017
6853
  */
6018
- includeNoExistence?: boolean | undefined;
6019
- }
6020
- /**
6021
- * @public
6022
- * @enum
6023
- */
6024
- export declare const Order: {
6025
- readonly ASC: "ASC";
6026
- readonly DESC: "DESC";
6027
- };
6028
- /**
6029
- * @public
6030
- */
6031
- export type Order = (typeof Order)[keyof typeof Order];
6032
- /**
6033
- * <p>The quick response fields to order the quick response query results by.</p>
6034
- * <p>The following is the list of supported field names.</p>
6035
- * <ul>
6036
- * <li>
6037
- * <p>name</p>
6038
- * </li>
6039
- * <li>
6040
- * <p>description</p>
6041
- * </li>
6042
- * <li>
6043
- * <p>shortcutKey</p>
6044
- * </li>
6045
- * <li>
6046
- * <p>isActive</p>
6047
- * </li>
6048
- * <li>
6049
- * <p>channels</p>
6050
- * </li>
6051
- * <li>
6052
- * <p>language</p>
6053
- * </li>
6054
- * <li>
6055
- * <p>contentType</p>
6056
- * </li>
6057
- * <li>
6058
- * <p>createdTime</p>
6059
- * </li>
6060
- * <li>
6061
- * <p>lastModifiedTime</p>
6062
- * </li>
6063
- * <li>
6064
- * <p>lastModifiedBy</p>
6065
- * </li>
6066
- * <li>
6067
- * <p>groupingConfiguration.criteria</p>
6068
- * </li>
6069
- * <li>
6070
- * <p>groupingConfiguration.values</p>
6071
- * </li>
6072
- * </ul>
6073
- * @public
6074
- */
6075
- export interface QuickResponseOrderField {
6076
- /**
6077
- * <p>The name of the attribute to order the quick response query results by.</p>
6854
+ name: string | undefined;
6855
+ /**
6856
+ * <p>The channel subtype this message template applies to.</p>
6078
6857
  * @public
6079
6858
  */
6080
- name: string | undefined;
6859
+ channelSubtype: ChannelSubtype | undefined;
6081
6860
  /**
6082
- * <p>The order at which the quick responses are sorted by.</p>
6861
+ * <p>The timestamp when the message template was created.</p>
6083
6862
  * @public
6084
6863
  */
6085
- order?: Order | undefined;
6086
- }
6087
- /**
6088
- * @public
6089
- * @enum
6090
- */
6091
- export declare const QuickResponseQueryOperator: {
6092
- readonly CONTAINS: "CONTAINS";
6093
- readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
6094
- };
6095
- /**
6096
- * @public
6097
- */
6098
- export type QuickResponseQueryOperator = (typeof QuickResponseQueryOperator)[keyof typeof QuickResponseQueryOperator];
6099
- /**
6100
- * @public
6101
- * @enum
6102
- */
6103
- export declare const Priority: {
6104
- readonly HIGH: "HIGH";
6105
- readonly LOW: "LOW";
6106
- readonly MEDIUM: "MEDIUM";
6107
- };
6108
- /**
6109
- * @public
6110
- */
6111
- export type Priority = (typeof Priority)[keyof typeof Priority];
6112
- /**
6113
- * <p>The quick response fields to query quick responses by.</p>
6114
- * <p>The following is the list of supported field names.</p>
6115
- * <ul>
6116
- * <li>
6117
- * <p>content</p>
6118
- * </li>
6119
- * <li>
6120
- * <p>name</p>
6121
- * </li>
6122
- * <li>
6123
- * <p>description</p>
6124
- * </li>
6125
- * <li>
6126
- * <p>shortcutKey</p>
6127
- * </li>
6128
- * </ul>
6129
- * @public
6130
- */
6131
- export interface QuickResponseQueryField {
6864
+ createdTime: Date | undefined;
6132
6865
  /**
6133
- * <p>The name of the attribute to query the quick responses by.</p>
6866
+ * <p>The timestamp when the message template data was last modified.</p>
6134
6867
  * @public
6135
6868
  */
6136
- name: string | undefined;
6869
+ lastModifiedTime: Date | undefined;
6137
6870
  /**
6138
- * <p>The values of the attribute to query the quick responses by.</p>
6871
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the message template
6872
+ * data.</p>
6139
6873
  * @public
6140
6874
  */
6141
- values: string[] | undefined;
6875
+ lastModifiedBy: string | undefined;
6142
6876
  /**
6143
- * <p>The operator to use for matching attribute field values in the query.</p>
6877
+ * <p>The version number of the message template version that is activated.</p>
6144
6878
  * @public
6145
6879
  */
6146
- operator: QuickResponseQueryOperator | undefined;
6880
+ activeVersionNumber?: number | undefined;
6147
6881
  /**
6148
- * <p>Whether the query expects only exact matches on the attribute field values. The results of
6149
- * the query will only include exact matches if this parameter is set to false.</p>
6882
+ * <p>The description of the message template.</p>
6150
6883
  * @public
6151
6884
  */
6152
- allowFuzziness?: boolean | undefined;
6885
+ description?: string | undefined;
6153
6886
  /**
6154
- * <p>The importance of the attribute field when calculating query result relevancy scores. The
6155
- * value set for this parameter affects the ordering of search results.</p>
6887
+ * <p>The tags used to organize, track, or control access for this resource.</p>
6156
6888
  * @public
6157
6889
  */
6158
- priority?: Priority | undefined;
6890
+ tags?: Record<string, string> | undefined;
6159
6891
  }
6160
6892
  /**
6161
- * <p>Information about the import job.</p>
6162
6893
  * @public
6163
6894
  */
6164
- export interface QuickResponseSearchExpression {
6165
- /**
6166
- * <p>The quick response query expressions.</p>
6167
- * @public
6168
- */
6169
- queries?: QuickResponseQueryField[] | undefined;
6895
+ export interface ListMessageTemplatesResponse {
6170
6896
  /**
6171
- * <p>The configuration of filtering rules applied to quick response query results.</p>
6897
+ * <p>Summary information about the message template.</p>
6172
6898
  * @public
6173
6899
  */
6174
- filters?: QuickResponseFilterField[] | undefined;
6900
+ messageTemplateSummaries: MessageTemplateSummary[] | undefined;
6175
6901
  /**
6176
- * <p>The quick response attribute fields on which the query results are ordered.</p>
6902
+ * <p>If there are additional results, this is the token for the next set of results.</p>
6177
6903
  * @public
6178
6904
  */
6179
- orderOnField?: QuickResponseOrderField | undefined;
6905
+ nextToken?: string | undefined;
6180
6906
  }
6181
6907
  /**
6182
6908
  * @public
6183
6909
  */
6184
- export interface SearchQuickResponsesRequest {
6910
+ export interface ListMessageTemplateVersionsRequest {
6185
6911
  /**
6186
- * <p>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.</p>
6912
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
6913
+ * the ARN.</p>
6187
6914
  * @public
6188
6915
  */
6189
6916
  knowledgeBaseId: string | undefined;
6190
6917
  /**
6191
- * <p>The search expression for querying the quick response.</p>
6918
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
6192
6919
  * @public
6193
6920
  */
6194
- searchExpression: QuickResponseSearchExpression | undefined;
6921
+ messageTemplateId: string | undefined;
6195
6922
  /**
6196
6923
  * <p>The token for the next set of results. Use the value returned in the previous
6197
6924
  * response in the next request to retrieve the next set of results.</p>
@@ -6203,562 +6930,439 @@ export interface SearchQuickResponsesRequest {
6203
6930
  * @public
6204
6931
  */
6205
6932
  maxResults?: number | undefined;
6206
- /**
6207
- * <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
6208
- * results are returned.</p>
6209
- * @public
6210
- */
6211
- attributes?: Record<string, string> | undefined;
6212
6933
  }
6213
6934
  /**
6214
- * <p>The result of quick response search.</p>
6935
+ * <p>The summary of the message template version.</p>
6215
6936
  * @public
6216
6937
  */
6217
- export interface QuickResponseSearchResultData {
6938
+ export interface MessageTemplateVersionSummary {
6218
6939
  /**
6219
- * <p>The Amazon Resource Name (ARN) of the quick response.</p>
6940
+ * <p>The Amazon Resource Name (ARN) of the message template.</p>
6220
6941
  * @public
6221
6942
  */
6222
- quickResponseArn: string | undefined;
6943
+ messageTemplateArn: string | undefined;
6223
6944
  /**
6224
- * <p>The identifier of the quick response.</p>
6945
+ * <p>The identifier of the message template.</p>
6225
6946
  * @public
6226
6947
  */
6227
- quickResponseId: string | undefined;
6948
+ messageTemplateId: string | undefined;
6228
6949
  /**
6229
6950
  * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
6230
6951
  * @public
6231
6952
  */
6232
6953
  knowledgeBaseArn: string | undefined;
6233
6954
  /**
6234
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
6955
+ * <p>The identifier of the knowledge base.</p>
6235
6956
  * @public
6236
6957
  */
6237
6958
  knowledgeBaseId: string | undefined;
6238
6959
  /**
6239
- * <p>The name of the quick response.</p>
6960
+ * <p>The name of the message template.</p>
6240
6961
  * @public
6241
6962
  */
6242
6963
  name: string | undefined;
6243
6964
  /**
6244
- * <p>The media type of the quick response content.</p>
6245
- * <ul>
6246
- * <li>
6247
- * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
6248
- * in plain text.</p>
6249
- * </li>
6250
- * <li>
6251
- * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
6252
- * written in richtext.</p>
6253
- * </li>
6254
- * </ul>
6255
- * @public
6256
- */
6257
- contentType: string | undefined;
6258
- /**
6259
- * <p>The resource status of the quick response.</p>
6260
- * @public
6261
- */
6262
- status: QuickResponseStatus | undefined;
6263
- /**
6264
- * <p>The contents of the quick response.</p>
6265
- * @public
6266
- */
6267
- contents: QuickResponseContents | undefined;
6268
- /**
6269
- * <p>The timestamp when the quick response was created.</p>
6270
- * @public
6271
- */
6272
- createdTime: Date | undefined;
6273
- /**
6274
- * <p>The timestamp when the quick response search result data was last modified.</p>
6965
+ * <p>The channel subtype this message template applies to.</p>
6275
6966
  * @public
6276
6967
  */
6277
- lastModifiedTime: Date | undefined;
6968
+ channelSubtype: ChannelSubtype | undefined;
6278
6969
  /**
6279
- * <p>Whether the quick response is active.</p>
6970
+ * <p>Whether the version of the message template is activated.</p>
6280
6971
  * @public
6281
6972
  */
6282
6973
  isActive: boolean | undefined;
6283
6974
  /**
6284
- * <p>The description of the quick response.</p>
6975
+ * <p>The version number of the message template version.</p>
6285
6976
  * @public
6286
6977
  */
6287
- description?: string | undefined;
6978
+ versionNumber: number | undefined;
6979
+ }
6980
+ /**
6981
+ * @public
6982
+ */
6983
+ export interface ListMessageTemplateVersionsResponse {
6288
6984
  /**
6289
- * <p>The configuration information of the user groups that the quick response is accessible
6290
- * to.</p>
6985
+ * <p>Summary information about the versions of a message template.</p>
6291
6986
  * @public
6292
6987
  */
6293
- groupingConfiguration?: GroupingConfiguration | undefined;
6988
+ messageTemplateVersionSummaries: MessageTemplateVersionSummary[] | undefined;
6294
6989
  /**
6295
- * <p>The shortcut key of the quick response. The value should be unique across the
6296
- * knowledge base.</p>
6990
+ * <p>If there are additional results, this is the token for the next set of results.</p>
6297
6991
  * @public
6298
6992
  */
6299
- shortcutKey?: string | undefined;
6993
+ nextToken?: string | undefined;
6994
+ }
6995
+ /**
6996
+ * @public
6997
+ */
6998
+ export interface RenderMessageTemplateRequest {
6300
6999
  /**
6301
- * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search
6302
- * result data.</p>
7000
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
7001
+ * the ARN.</p>
6303
7002
  * @public
6304
7003
  */
6305
- lastModifiedBy?: string | undefined;
7004
+ knowledgeBaseId: string | undefined;
6306
7005
  /**
6307
- * <p>The Amazon Connect contact channels this quick response applies to.
6308
- * The supported contact channel types include <code>Chat</code>.</p>
7006
+ * <p>The identifier of the message template. Can be either the ID or the ARN.</p>
6309
7007
  * @public
6310
7008
  */
6311
- channels?: string[] | undefined;
7009
+ messageTemplateId: string | undefined;
6312
7010
  /**
6313
- * <p>The language code value for the language in which the quick response is written.</p>
7011
+ * <p>An object that specifies the values to use for variables in the message template. This
7012
+ * object contains different categories of key-value pairs. Each key defines a variable or
7013
+ * placeholder in the message template. The corresponding value defines the value for that
7014
+ * variable.</p>
6314
7015
  * @public
6315
7016
  */
6316
- language?: string | undefined;
7017
+ attributes: MessageTemplateAttributes | undefined;
7018
+ }
7019
+ /**
7020
+ * @public
7021
+ */
7022
+ export interface RenderMessageTemplateResponse {
6317
7023
  /**
6318
- * <p>The user defined contact attributes that are not resolved when the search result is
6319
- * returned.</p>
7024
+ * <p>The content of the message template.</p>
6320
7025
  * @public
6321
7026
  */
6322
- attributesNotInterpolated?: string[] | undefined;
7027
+ content: MessageTemplateContentProvider | undefined;
6323
7028
  /**
6324
- * <p>The user defined contact attributes that are resolved when the search result is
6325
- * returned.</p>
7029
+ * <p>The attribute keys that are not resolved.</p>
6326
7030
  * @public
6327
7031
  */
6328
- attributesInterpolated?: string[] | undefined;
7032
+ attributesNotInterpolated?: string[] | undefined;
6329
7033
  /**
6330
- * <p>The tags used to organize, track, or control access for this resource.</p>
7034
+ * <p>The message template attachments.</p>
6331
7035
  * @public
6332
7036
  */
6333
- tags?: Record<string, string> | undefined;
7037
+ attachments?: MessageTemplateAttachment[] | undefined;
6334
7038
  }
6335
7039
  /**
6336
7040
  * @public
6337
7041
  */
6338
- export interface SearchQuickResponsesResponse {
7042
+ export interface UpdateMessageTemplateRequest {
6339
7043
  /**
6340
- * <p>The results of the quick response search.</p>
7044
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
7045
+ * the ARN.</p>
6341
7046
  * @public
6342
7047
  */
6343
- results: QuickResponseSearchResultData[] | undefined;
7048
+ knowledgeBaseId: string | undefined;
6344
7049
  /**
6345
- * <p>The token for the next set of results. Use the value returned in the previous
6346
- * response in the next request to retrieve the next set of results.</p>
7050
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
6347
7051
  * @public
6348
7052
  */
6349
- nextToken?: string | undefined;
6350
- }
6351
- /**
6352
- * @public
6353
- */
6354
- export interface StartContentUploadRequest {
7053
+ messageTemplateId: string | undefined;
6355
7054
  /**
6356
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
7055
+ * <p>The content of the message template.</p>
6357
7056
  * @public
6358
7057
  */
6359
- knowledgeBaseId: string | undefined;
7058
+ content?: MessageTemplateContentProvider | undefined;
6360
7059
  /**
6361
- * <p>The type of content to upload.</p>
7060
+ * <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>,
7061
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
7062
+ * <code>zh_CN</code>, <code>zh_TW</code>
7063
+ * </p>
6362
7064
  * @public
6363
7065
  */
6364
- contentType: string | undefined;
7066
+ language?: string | undefined;
6365
7067
  /**
6366
- * <p>The expected expiration time of the generated presigned URL, specified in minutes.</p>
7068
+ * <p>An object that specifies the default values to use for variables in the message template.
7069
+ * This object contains different categories of key-value pairs. Each key defines a variable or
7070
+ * placeholder in the message template. The corresponding value defines the default value for
7071
+ * that variable.</p>
6367
7072
  * @public
6368
7073
  */
6369
- presignedUrlTimeToLive?: number | undefined;
7074
+ defaultAttributes?: MessageTemplateAttributes | undefined;
6370
7075
  }
6371
7076
  /**
6372
7077
  * @public
6373
7078
  */
6374
- export interface StartContentUploadResponse {
6375
- /**
6376
- * <p>The identifier of the upload.</p>
6377
- * @public
6378
- */
6379
- uploadId: string | undefined;
6380
- /**
6381
- * <p>The URL of the upload.</p>
6382
- * @public
6383
- */
6384
- url: string | undefined;
6385
- /**
6386
- * <p>The expiration time of the URL as an epoch timestamp.</p>
6387
- * @public
6388
- */
6389
- urlExpiry: Date | undefined;
7079
+ export interface UpdateMessageTemplateResponse {
6390
7080
  /**
6391
- * <p>The headers to include in the upload.</p>
7081
+ * <p>The message template.</p>
6392
7082
  * @public
6393
7083
  */
6394
- headersToInclude: Record<string, string> | undefined;
7084
+ messageTemplate?: MessageTemplateData | undefined;
6395
7085
  }
6396
7086
  /**
6397
7087
  * @public
6398
7088
  */
6399
- export interface StartImportJobRequest {
7089
+ export interface UpdateMessageTemplateMetadataRequest {
6400
7090
  /**
6401
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
6402
- * <ul>
6403
- * <li>
6404
- * <p>For importing Amazon Q in Connect quick responses, this should be a <code>QUICK_RESPONSES</code>
6405
- * type knowledge base.</p>
6406
- * </li>
6407
- * </ul>
7091
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
7092
+ * the ARN.</p>
6408
7093
  * @public
6409
7094
  */
6410
7095
  knowledgeBaseId: string | undefined;
6411
7096
  /**
6412
- * <p>The type of the import job.</p>
6413
- * <ul>
6414
- * <li>
6415
- * <p>For importing quick response resource, set the value to
6416
- * <code>QUICK_RESPONSES</code>.</p>
6417
- * </li>
6418
- * </ul>
6419
- * @public
6420
- */
6421
- importJobType: ImportJobType | undefined;
6422
- /**
6423
- * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
7097
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
6424
7098
  * @public
6425
7099
  */
6426
- uploadId: string | undefined;
7100
+ messageTemplateId: string | undefined;
6427
7101
  /**
6428
- * <p>The tags used to organize, track, or control access for this resource.</p>
7102
+ * <p>The name of the message template.</p>
6429
7103
  * @public
6430
7104
  */
6431
- clientToken?: string | undefined;
7105
+ name?: string | undefined;
6432
7106
  /**
6433
- * <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
7107
+ * <p>The description of the message template.</p>
6434
7108
  * @public
6435
7109
  */
6436
- metadata?: Record<string, string> | undefined;
7110
+ description?: string | undefined;
6437
7111
  /**
6438
- * <p>The configuration information of the external source that the resource data are imported
6439
- * from.</p>
7112
+ * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
6440
7113
  * @public
6441
7114
  */
6442
- externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
7115
+ groupingConfiguration?: GroupingConfiguration | undefined;
6443
7116
  }
6444
7117
  /**
6445
7118
  * @public
6446
7119
  */
6447
- export interface StartImportJobResponse {
7120
+ export interface UpdateMessageTemplateMetadataResponse {
6448
7121
  /**
6449
- * <p>The import job.</p>
7122
+ * <p>The message template.</p>
6450
7123
  * @public
6451
7124
  */
6452
- importJob?: ImportJobData | undefined;
7125
+ messageTemplate?: MessageTemplateData | undefined;
6453
7126
  }
6454
7127
  /**
6455
7128
  * @public
6456
7129
  */
6457
- export interface UpdateKnowledgeBaseTemplateUriRequest {
7130
+ export interface ListQuickResponsesRequest {
6458
7131
  /**
6459
- * <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>
7132
+ * <p>The token for the next set of results. Use the value returned in the previous
7133
+ * response in the next request to retrieve the next set of results.</p>
7134
+ * @public
7135
+ */
7136
+ nextToken?: string | undefined;
7137
+ /**
7138
+ * <p>The maximum number of results to return per page.</p>
6460
7139
  * @public
6461
7140
  */
6462
- knowledgeBaseId: string | undefined;
7141
+ maxResults?: number | undefined;
6463
7142
  /**
6464
- * <p>The template URI to update.</p>
7143
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
6465
7144
  * @public
6466
7145
  */
6467
- templateUri: string | undefined;
7146
+ knowledgeBaseId: string | undefined;
6468
7147
  }
6469
7148
  /**
7149
+ * <p>The summary information about the quick response.</p>
6470
7150
  * @public
6471
7151
  */
6472
- export interface UpdateKnowledgeBaseTemplateUriResponse {
7152
+ export interface QuickResponseSummary {
6473
7153
  /**
6474
- * <p>The knowledge base to update.</p>
7154
+ * <p>The Amazon Resource Name (ARN) of the quick response.</p>
6475
7155
  * @public
6476
7156
  */
6477
- knowledgeBase?: KnowledgeBaseData | undefined;
6478
- }
6479
- /**
6480
- * @public
6481
- */
6482
- export interface ListTagsForResourceRequest {
7157
+ quickResponseArn: string | undefined;
6483
7158
  /**
6484
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
7159
+ * <p>The identifier of the quick response.</p>
6485
7160
  * @public
6486
7161
  */
6487
- resourceArn: string | undefined;
6488
- }
6489
- /**
6490
- * @public
6491
- */
6492
- export interface ListTagsForResourceResponse {
7162
+ quickResponseId: string | undefined;
6493
7163
  /**
6494
- * <p>The tags used to organize, track, or control access for this resource.</p>
7164
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
6495
7165
  * @public
6496
7166
  */
6497
- tags?: Record<string, string> | undefined;
6498
- }
6499
- /**
6500
- * @public
6501
- */
6502
- export interface TagResourceRequest {
7167
+ knowledgeBaseArn: string | undefined;
6503
7168
  /**
6504
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
7169
+ * <p>The identifier of the knowledge base.</p>
6505
7170
  * @public
6506
7171
  */
6507
- resourceArn: string | undefined;
7172
+ knowledgeBaseId: string | undefined;
6508
7173
  /**
6509
- * <p>The tags used to organize, track, or control access for this resource.</p>
7174
+ * <p>The name of the quick response.</p>
6510
7175
  * @public
6511
7176
  */
6512
- tags: Record<string, string> | undefined;
6513
- }
6514
- /**
6515
- * @public
6516
- */
6517
- export interface TagResourceResponse {
6518
- }
6519
- /**
6520
- * <p>Amazon Q in Connect throws this exception if you have too many tags in your tag set.</p>
6521
- * @public
6522
- */
6523
- export declare class TooManyTagsException extends __BaseException {
6524
- readonly name: "TooManyTagsException";
6525
- readonly $fault: "client";
7177
+ name: string | undefined;
6526
7178
  /**
6527
- * <p>The specified resource name.</p>
7179
+ * <p>The media type of the quick response content.</p>
7180
+ * <ul>
7181
+ * <li>
7182
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
7183
+ * in plain text.</p>
7184
+ * </li>
7185
+ * <li>
7186
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
7187
+ * written in richtext.</p>
7188
+ * </li>
7189
+ * </ul>
6528
7190
  * @public
6529
7191
  */
6530
- resourceName?: string | undefined;
7192
+ contentType: string | undefined;
6531
7193
  /**
6532
- * @internal
7194
+ * <p>The resource status of the quick response.</p>
7195
+ * @public
6533
7196
  */
6534
- constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
6535
- }
6536
- /**
6537
- * @public
6538
- */
6539
- export interface UntagResourceRequest {
7197
+ status: QuickResponseStatus | undefined;
6540
7198
  /**
6541
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
7199
+ * <p>The timestamp when the quick response was created.</p>
6542
7200
  * @public
6543
7201
  */
6544
- resourceArn: string | undefined;
7202
+ createdTime: Date | undefined;
6545
7203
  /**
6546
- * <p>The tag keys.</p>
7204
+ * <p>The timestamp when the quick response summary was last modified.</p>
6547
7205
  * @public
6548
7206
  */
6549
- tagKeys: string[] | undefined;
6550
- }
6551
- /**
6552
- * @public
6553
- */
6554
- export interface UntagResourceResponse {
6555
- }
6556
- /**
6557
- * <p>Details about the data.</p>
6558
- * @public
6559
- */
6560
- export type DataDetails = DataDetails.ContentDataMember | DataDetails.GenerativeDataMember | DataDetails.IntentDetectedDataMember | DataDetails.SourceContentDataMember | DataDetails.$UnknownMember;
6561
- /**
6562
- * @public
6563
- */
6564
- export declare namespace DataDetails {
7207
+ lastModifiedTime: Date | undefined;
6565
7208
  /**
6566
- * <p>Details about the content data.</p>
7209
+ * <p>The description of the quick response.</p>
6567
7210
  * @public
6568
7211
  */
6569
- interface ContentDataMember {
6570
- contentData: ContentDataDetails;
6571
- generativeData?: never;
6572
- intentDetectedData?: never;
6573
- sourceContentData?: never;
6574
- $unknown?: never;
6575
- }
7212
+ description?: string | undefined;
6576
7213
  /**
6577
- * <p> Details about the generative data.</p>
7214
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
7215
+ * data.</p>
6578
7216
  * @public
6579
7217
  */
6580
- interface GenerativeDataMember {
6581
- contentData?: never;
6582
- generativeData: GenerativeDataDetails;
6583
- intentDetectedData?: never;
6584
- sourceContentData?: never;
6585
- $unknown?: never;
6586
- }
7218
+ lastModifiedBy?: string | undefined;
6587
7219
  /**
6588
- * <p>Details about the intent data.</p>
7220
+ * <p>Whether the quick response is active.</p>
6589
7221
  * @public
6590
7222
  */
6591
- interface IntentDetectedDataMember {
6592
- contentData?: never;
6593
- generativeData?: never;
6594
- intentDetectedData: IntentDetectedDataDetails;
6595
- sourceContentData?: never;
6596
- $unknown?: never;
6597
- }
7223
+ isActive?: boolean | undefined;
6598
7224
  /**
6599
- * <p>Details about the content data.</p>
7225
+ * <p>The Amazon Connect contact channels this quick response applies to.
7226
+ * The supported contact channel types include <code>Chat</code>.</p>
6600
7227
  * @public
6601
7228
  */
6602
- interface SourceContentDataMember {
6603
- contentData?: never;
6604
- generativeData?: never;
6605
- intentDetectedData?: never;
6606
- sourceContentData: SourceContentDataDetails;
6607
- $unknown?: never;
6608
- }
7229
+ channels?: string[] | undefined;
6609
7230
  /**
7231
+ * <p>The tags used to organize, track, or control access for this resource.</p>
6610
7232
  * @public
6611
7233
  */
6612
- interface $UnknownMember {
6613
- contentData?: never;
6614
- generativeData?: never;
6615
- intentDetectedData?: never;
6616
- sourceContentData?: never;
6617
- $unknown: [string, any];
6618
- }
6619
- interface Visitor<T> {
6620
- contentData: (value: ContentDataDetails) => T;
6621
- generativeData: (value: GenerativeDataDetails) => T;
6622
- intentDetectedData: (value: IntentDetectedDataDetails) => T;
6623
- sourceContentData: (value: SourceContentDataDetails) => T;
6624
- _: (name: string, value: any) => T;
6625
- }
6626
- const visit: <T>(value: DataDetails, visitor: Visitor<T>) => T;
7234
+ tags?: Record<string, string> | undefined;
6627
7235
  }
6628
7236
  /**
6629
- * <p>Summary of the data.</p>
6630
7237
  * @public
6631
7238
  */
6632
- export interface DataSummary {
7239
+ export interface ListQuickResponsesResponse {
6633
7240
  /**
6634
- * <p>Reference information about the content.</p>
7241
+ * <p>Summary information about the quick responses.</p>
6635
7242
  * @public
6636
7243
  */
6637
- reference: DataReference | undefined;
7244
+ quickResponseSummaries: QuickResponseSummary[] | undefined;
6638
7245
  /**
6639
- * <p>Details about the data.</p>
7246
+ * <p>The token for the next set of results. Use the value returned in the previous
7247
+ * response in the next request to retrieve the next set of results.</p>
6640
7248
  * @public
6641
7249
  */
6642
- details: DataDetails | undefined;
7250
+ nextToken?: string | undefined;
6643
7251
  }
6644
7252
  /**
6645
- * <p>Details about generative data.</p>
6646
7253
  * @public
6647
7254
  */
6648
- export interface GenerativeDataDetails {
7255
+ export interface UpdateQuickResponseRequest {
6649
7256
  /**
6650
- * <p>The LLM response.</p>
7257
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
6651
7258
  * @public
6652
7259
  */
6653
- completion: string | undefined;
7260
+ knowledgeBaseId: string | undefined;
6654
7261
  /**
6655
- * <p>The references used to generative the LLM response.</p>
7262
+ * <p>The identifier of the quick response.</p>
6656
7263
  * @public
6657
7264
  */
6658
- references: DataSummary[] | undefined;
7265
+ quickResponseId: string | undefined;
6659
7266
  /**
6660
- * <p>Details about the generative content ranking data.</p>
7267
+ * <p>The name of the quick response.</p>
6661
7268
  * @public
6662
7269
  */
6663
- rankingData: RankingData | undefined;
6664
- }
6665
- /**
6666
- * <p>Information about the recommendation.</p>
6667
- * @public
6668
- */
6669
- export interface RecommendationData {
7270
+ name?: string | undefined;
6670
7271
  /**
6671
- * <p>The identifier of the recommendation.</p>
7272
+ * <p>The updated content of the quick response.</p>
6672
7273
  * @public
6673
7274
  */
6674
- recommendationId: string | undefined;
7275
+ content?: QuickResponseDataProvider | undefined;
6675
7276
  /**
6676
- * <p>The recommended document.</p>
7277
+ * <p>The media type of the quick response content.</p>
7278
+ * <ul>
7279
+ * <li>
7280
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
7281
+ * in plain text.</p>
7282
+ * </li>
7283
+ * <li>
7284
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
7285
+ * written in richtext.</p>
7286
+ * </li>
7287
+ * </ul>
6677
7288
  * @public
6678
7289
  */
6679
- document?: Document | undefined;
7290
+ contentType?: string | undefined;
6680
7291
  /**
6681
- * <p>The relevance score of the recommendation.</p>
7292
+ * <p>The updated grouping configuration of the quick response.</p>
6682
7293
  * @public
6683
7294
  */
6684
- relevanceScore?: number | undefined;
7295
+ groupingConfiguration?: GroupingConfiguration | undefined;
6685
7296
  /**
6686
- * <p>The relevance level of the recommendation.</p>
7297
+ * <p>Whether to remove the grouping configuration of the quick response.</p>
6687
7298
  * @public
6688
7299
  */
6689
- relevanceLevel?: RelevanceLevel | undefined;
7300
+ removeGroupingConfiguration?: boolean | undefined;
6690
7301
  /**
6691
- * <p>The type of recommendation.</p>
7302
+ * <p>The updated description of the quick response.</p>
6692
7303
  * @public
6693
7304
  */
6694
- type?: RecommendationType | undefined;
7305
+ description?: string | undefined;
6695
7306
  /**
6696
- * <p> Summary of the recommended content.</p>
7307
+ * <p>Whether to remove the description from the quick response.</p>
6697
7308
  * @public
6698
7309
  */
6699
- data?: DataSummary | undefined;
6700
- }
6701
- /**
6702
- * <p>Information about the result.</p>
6703
- * @public
6704
- */
6705
- export interface ResultData {
7310
+ removeDescription?: boolean | undefined;
6706
7311
  /**
6707
- * <p>The identifier of the result data.</p>
7312
+ * <p>The shortcut key of the quick response. The value should be unique across the
7313
+ * knowledge base.</p>
6708
7314
  * @public
6709
7315
  */
6710
- resultId: string | undefined;
7316
+ shortcutKey?: string | undefined;
6711
7317
  /**
6712
- * <p>The document.</p>
7318
+ * <p>Whether to remove the shortcut key of the quick response.</p>
6713
7319
  * @public
6714
7320
  */
6715
- document?: Document | undefined;
7321
+ removeShortcutKey?: boolean | undefined;
6716
7322
  /**
6717
- * <p>The relevance score of the results.</p>
7323
+ * <p>Whether the quick response is active. </p>
6718
7324
  * @public
6719
7325
  */
6720
- relevanceScore?: number | undefined;
7326
+ isActive?: boolean | undefined;
6721
7327
  /**
6722
- * <p> Summary of the recommended content.</p>
7328
+ * <p>The Amazon Connect contact channels this quick response applies to.
7329
+ * The supported contact channel types include <code>Chat</code>.</p>
6723
7330
  * @public
6724
7331
  */
6725
- data?: DataSummary | undefined;
7332
+ channels?: string[] | undefined;
6726
7333
  /**
6727
- * <p>The type of the query result.</p>
7334
+ * <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>,
7335
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
7336
+ * <code>zh_CN</code>, <code>zh_TW</code>
7337
+ * </p>
6728
7338
  * @public
6729
7339
  */
6730
- type?: QueryResultType | undefined;
7340
+ language?: string | undefined;
6731
7341
  }
6732
7342
  /**
6733
7343
  * @public
6734
7344
  */
6735
- export interface GetRecommendationsResponse {
6736
- /**
6737
- * <p>The recommendations.</p>
6738
- * @public
6739
- */
6740
- recommendations: RecommendationData[] | undefined;
7345
+ export interface UpdateQuickResponseResponse {
6741
7346
  /**
6742
- * <p>The triggers corresponding to recommendations.</p>
7347
+ * <p>The quick response.</p>
6743
7348
  * @public
6744
7349
  */
6745
- triggers?: RecommendationTrigger[] | undefined;
7350
+ quickResponse?: QuickResponseData | undefined;
6746
7351
  }
6747
7352
  /**
6748
7353
  * @public
6749
7354
  */
6750
- export interface QueryAssistantResponse {
6751
- /**
6752
- * <p>The results of the query.</p>
6753
- * @public
6754
- */
6755
- results: ResultData[] | undefined;
7355
+ export interface RemoveKnowledgeBaseTemplateUriRequest {
6756
7356
  /**
6757
- * <p>If there are additional results, this is the token for the next set of results.</p>
7357
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
6758
7358
  * @public
6759
7359
  */
6760
- nextToken?: string | undefined;
7360
+ knowledgeBaseId: string | undefined;
6761
7361
  }
7362
+ /**
7363
+ * @internal
7364
+ */
7365
+ export declare const AgentAttributesFilterSensitiveLog: (obj: AgentAttributes) => any;
6762
7366
  /**
6763
7367
  * @internal
6764
7368
  */
@@ -6902,7 +7506,47 @@ export declare const CreateKnowledgeBaseResponseFilterSensitiveLog: (obj: Create
6902
7506
  /**
6903
7507
  * @internal
6904
7508
  */
6905
- export declare const QuickResponseDataProviderFilterSensitiveLog: (obj: QuickResponseDataProvider) => any;
7509
+ export declare const MessageTemplateBodyContentProviderFilterSensitiveLog: (obj: MessageTemplateBodyContentProvider) => any;
7510
+ /**
7511
+ * @internal
7512
+ */
7513
+ export declare const EmailMessageTemplateContentBodyFilterSensitiveLog: (obj: EmailMessageTemplateContentBody) => any;
7514
+ /**
7515
+ * @internal
7516
+ */
7517
+ export declare const EmailHeaderFilterSensitiveLog: (obj: EmailHeader) => any;
7518
+ /**
7519
+ * @internal
7520
+ */
7521
+ export declare const EmailMessageTemplateContentFilterSensitiveLog: (obj: EmailMessageTemplateContent) => any;
7522
+ /**
7523
+ * @internal
7524
+ */
7525
+ export declare const SMSMessageTemplateContentBodyFilterSensitiveLog: (obj: SMSMessageTemplateContentBody) => any;
7526
+ /**
7527
+ * @internal
7528
+ */
7529
+ export declare const SMSMessageTemplateContentFilterSensitiveLog: (obj: SMSMessageTemplateContent) => any;
7530
+ /**
7531
+ * @internal
7532
+ */
7533
+ export declare const MessageTemplateContentProviderFilterSensitiveLog: (obj: MessageTemplateContentProvider) => any;
7534
+ /**
7535
+ * @internal
7536
+ */
7537
+ export declare const CustomerProfileAttributesFilterSensitiveLog: (obj: CustomerProfileAttributes) => any;
7538
+ /**
7539
+ * @internal
7540
+ */
7541
+ export declare const SystemEndpointAttributesFilterSensitiveLog: (obj: SystemEndpointAttributes) => any;
7542
+ /**
7543
+ * @internal
7544
+ */
7545
+ export declare const SystemAttributesFilterSensitiveLog: (obj: SystemAttributes) => any;
7546
+ /**
7547
+ * @internal
7548
+ */
7549
+ export declare const MessageTemplateAttributesFilterSensitiveLog: (obj: MessageTemplateAttributes) => any;
6906
7550
  /**
6907
7551
  * @internal
6908
7552
  */
@@ -6910,112 +7554,124 @@ export declare const GroupingConfigurationFilterSensitiveLog: (obj: GroupingConf
6910
7554
  /**
6911
7555
  * @internal
6912
7556
  */
6913
- export declare const CreateQuickResponseRequestFilterSensitiveLog: (obj: CreateQuickResponseRequest) => any;
7557
+ export declare const CreateMessageTemplateRequestFilterSensitiveLog: (obj: CreateMessageTemplateRequest) => any;
6914
7558
  /**
6915
7559
  * @internal
6916
7560
  */
6917
- export declare const QuickResponseContentProviderFilterSensitiveLog: (obj: QuickResponseContentProvider) => any;
7561
+ export declare const MessageTemplateDataFilterSensitiveLog: (obj: MessageTemplateData) => any;
6918
7562
  /**
6919
7563
  * @internal
6920
7564
  */
6921
- export declare const QuickResponseContentsFilterSensitiveLog: (obj: QuickResponseContents) => any;
7565
+ export declare const CreateMessageTemplateResponseFilterSensitiveLog: (obj: CreateMessageTemplateResponse) => any;
6922
7566
  /**
6923
7567
  * @internal
6924
7568
  */
6925
- export declare const QuickResponseDataFilterSensitiveLog: (obj: QuickResponseData) => any;
7569
+ export declare const CreateMessageTemplateAttachmentRequestFilterSensitiveLog: (obj: CreateMessageTemplateAttachmentRequest) => any;
6926
7570
  /**
6927
7571
  * @internal
6928
7572
  */
6929
- export declare const CreateQuickResponseResponseFilterSensitiveLog: (obj: CreateQuickResponseResponse) => any;
7573
+ export declare const MessageTemplateAttachmentFilterSensitiveLog: (obj: MessageTemplateAttachment) => any;
6930
7574
  /**
6931
7575
  * @internal
6932
7576
  */
6933
- export declare const ImportJobDataFilterSensitiveLog: (obj: ImportJobData) => any;
7577
+ export declare const CreateMessageTemplateAttachmentResponseFilterSensitiveLog: (obj: CreateMessageTemplateAttachmentResponse) => any;
6934
7578
  /**
6935
7579
  * @internal
6936
7580
  */
6937
- export declare const GetImportJobResponseFilterSensitiveLog: (obj: GetImportJobResponse) => any;
7581
+ export declare const ExtendedMessageTemplateDataFilterSensitiveLog: (obj: ExtendedMessageTemplateData) => any;
6938
7582
  /**
6939
7583
  * @internal
6940
7584
  */
6941
- export declare const GetKnowledgeBaseResponseFilterSensitiveLog: (obj: GetKnowledgeBaseResponse) => any;
7585
+ export declare const CreateMessageTemplateVersionResponseFilterSensitiveLog: (obj: CreateMessageTemplateVersionResponse) => any;
6942
7586
  /**
6943
7587
  * @internal
6944
7588
  */
6945
- export declare const GetQuickResponseResponseFilterSensitiveLog: (obj: GetQuickResponseResponse) => any;
7589
+ export declare const QuickResponseDataProviderFilterSensitiveLog: (obj: QuickResponseDataProvider) => any;
6946
7590
  /**
6947
7591
  * @internal
6948
7592
  */
6949
- export declare const KnowledgeBaseSummaryFilterSensitiveLog: (obj: KnowledgeBaseSummary) => any;
7593
+ export declare const CreateQuickResponseRequestFilterSensitiveLog: (obj: CreateQuickResponseRequest) => any;
6950
7594
  /**
6951
7595
  * @internal
6952
7596
  */
6953
- export declare const ListKnowledgeBasesResponseFilterSensitiveLog: (obj: ListKnowledgeBasesResponse) => any;
7597
+ export declare const QuickResponseContentProviderFilterSensitiveLog: (obj: QuickResponseContentProvider) => any;
6954
7598
  /**
6955
7599
  * @internal
6956
7600
  */
6957
- export declare const QuickResponseSummaryFilterSensitiveLog: (obj: QuickResponseSummary) => any;
7601
+ export declare const QuickResponseContentsFilterSensitiveLog: (obj: QuickResponseContents) => any;
6958
7602
  /**
6959
7603
  * @internal
6960
7604
  */
6961
- export declare const ListQuickResponsesResponseFilterSensitiveLog: (obj: ListQuickResponsesResponse) => any;
7605
+ export declare const QuickResponseDataFilterSensitiveLog: (obj: QuickResponseData) => any;
6962
7606
  /**
6963
7607
  * @internal
6964
7608
  */
6965
- export declare const UpdateQuickResponseRequestFilterSensitiveLog: (obj: UpdateQuickResponseRequest) => any;
7609
+ export declare const CreateQuickResponseResponseFilterSensitiveLog: (obj: CreateQuickResponseResponse) => any;
6966
7610
  /**
6967
7611
  * @internal
6968
7612
  */
6969
- export declare const UpdateQuickResponseResponseFilterSensitiveLog: (obj: UpdateQuickResponseResponse) => any;
7613
+ export declare const ImportJobDataFilterSensitiveLog: (obj: ImportJobData) => any;
7614
+ /**
7615
+ * @internal
7616
+ */
7617
+ export declare const GetImportJobResponseFilterSensitiveLog: (obj: GetImportJobResponse) => any;
7618
+ /**
7619
+ * @internal
7620
+ */
7621
+ export declare const GetKnowledgeBaseResponseFilterSensitiveLog: (obj: GetKnowledgeBaseResponse) => any;
7622
+ /**
7623
+ * @internal
7624
+ */
7625
+ export declare const GetMessageTemplateResponseFilterSensitiveLog: (obj: GetMessageTemplateResponse) => any;
6970
7626
  /**
6971
7627
  * @internal
6972
7628
  */
6973
- export declare const SearchQuickResponsesRequestFilterSensitiveLog: (obj: SearchQuickResponsesRequest) => any;
7629
+ export declare const GetQuickResponseResponseFilterSensitiveLog: (obj: GetQuickResponseResponse) => any;
6974
7630
  /**
6975
7631
  * @internal
6976
7632
  */
6977
- export declare const QuickResponseSearchResultDataFilterSensitiveLog: (obj: QuickResponseSearchResultData) => any;
7633
+ export declare const KnowledgeBaseSummaryFilterSensitiveLog: (obj: KnowledgeBaseSummary) => any;
6978
7634
  /**
6979
7635
  * @internal
6980
7636
  */
6981
- export declare const SearchQuickResponsesResponseFilterSensitiveLog: (obj: SearchQuickResponsesResponse) => any;
7637
+ export declare const ListKnowledgeBasesResponseFilterSensitiveLog: (obj: ListKnowledgeBasesResponse) => any;
6982
7638
  /**
6983
7639
  * @internal
6984
7640
  */
6985
- export declare const StartContentUploadResponseFilterSensitiveLog: (obj: StartContentUploadResponse) => any;
7641
+ export declare const RenderMessageTemplateRequestFilterSensitiveLog: (obj: RenderMessageTemplateRequest) => any;
6986
7642
  /**
6987
7643
  * @internal
6988
7644
  */
6989
- export declare const StartImportJobResponseFilterSensitiveLog: (obj: StartImportJobResponse) => any;
7645
+ export declare const RenderMessageTemplateResponseFilterSensitiveLog: (obj: RenderMessageTemplateResponse) => any;
6990
7646
  /**
6991
7647
  * @internal
6992
7648
  */
6993
- export declare const UpdateKnowledgeBaseTemplateUriResponseFilterSensitiveLog: (obj: UpdateKnowledgeBaseTemplateUriResponse) => any;
7649
+ export declare const UpdateMessageTemplateRequestFilterSensitiveLog: (obj: UpdateMessageTemplateRequest) => any;
6994
7650
  /**
6995
7651
  * @internal
6996
7652
  */
6997
- export declare const DataDetailsFilterSensitiveLog: (obj: DataDetails) => any;
7653
+ export declare const UpdateMessageTemplateResponseFilterSensitiveLog: (obj: UpdateMessageTemplateResponse) => any;
6998
7654
  /**
6999
7655
  * @internal
7000
7656
  */
7001
- export declare const DataSummaryFilterSensitiveLog: (obj: DataSummary) => any;
7657
+ export declare const UpdateMessageTemplateMetadataRequestFilterSensitiveLog: (obj: UpdateMessageTemplateMetadataRequest) => any;
7002
7658
  /**
7003
7659
  * @internal
7004
7660
  */
7005
- export declare const GenerativeDataDetailsFilterSensitiveLog: (obj: GenerativeDataDetails) => any;
7661
+ export declare const UpdateMessageTemplateMetadataResponseFilterSensitiveLog: (obj: UpdateMessageTemplateMetadataResponse) => any;
7006
7662
  /**
7007
7663
  * @internal
7008
7664
  */
7009
- export declare const RecommendationDataFilterSensitiveLog: (obj: RecommendationData) => any;
7665
+ export declare const QuickResponseSummaryFilterSensitiveLog: (obj: QuickResponseSummary) => any;
7010
7666
  /**
7011
7667
  * @internal
7012
7668
  */
7013
- export declare const ResultDataFilterSensitiveLog: (obj: ResultData) => any;
7669
+ export declare const ListQuickResponsesResponseFilterSensitiveLog: (obj: ListQuickResponsesResponse) => any;
7014
7670
  /**
7015
7671
  * @internal
7016
7672
  */
7017
- export declare const GetRecommendationsResponseFilterSensitiveLog: (obj: GetRecommendationsResponse) => any;
7673
+ export declare const UpdateQuickResponseRequestFilterSensitiveLog: (obj: UpdateQuickResponseRequest) => any;
7018
7674
  /**
7019
7675
  * @internal
7020
7676
  */
7021
- export declare const QueryAssistantResponseFilterSensitiveLog: (obj: QueryAssistantResponse) => any;
7677
+ export declare const UpdateQuickResponseResponseFilterSensitiveLog: (obj: UpdateQuickResponseResponse) => any;