@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
@@ -0,0 +1,332 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { UpdateMessageTemplateRequest, UpdateMessageTemplateResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateMessageTemplateCommand}.
14
+ */
15
+ export interface UpdateMessageTemplateCommandInput extends UpdateMessageTemplateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateMessageTemplateCommand}.
21
+ */
22
+ export interface UpdateMessageTemplateCommandOutput extends UpdateMessageTemplateResponse, __MetadataBearer {
23
+ }
24
+ declare const UpdateMessageTemplateCommand_base: {
25
+ new (input: UpdateMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateMessageTemplateCommandInput, UpdateMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateMessageTemplateCommandInput, UpdateMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Updates the Amazon Q in Connect message template. Partial update is supported. If any
31
+ * field is not supplied, it will remain unchanged for the message template that is referenced by
32
+ * the <code>$LATEST</code> qualifier. Any modification will only apply to the message template
33
+ * that is referenced by the <code>$LATEST</code> qualifier. The fields for all available
34
+ * versions will remain unchanged.</p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { QConnectClient, UpdateMessageTemplateCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
39
+ * // const { QConnectClient, UpdateMessageTemplateCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
40
+ * const client = new QConnectClient(config);
41
+ * const input = { // UpdateMessageTemplateRequest
42
+ * knowledgeBaseId: "STRING_VALUE", // required
43
+ * messageTemplateId: "STRING_VALUE", // required
44
+ * content: { // MessageTemplateContentProvider Union: only one key present
45
+ * email: { // EmailMessageTemplateContent
46
+ * subject: "STRING_VALUE",
47
+ * body: { // EmailMessageTemplateContentBody
48
+ * plainText: { // MessageTemplateBodyContentProvider Union: only one key present
49
+ * content: "STRING_VALUE",
50
+ * },
51
+ * html: {// Union: only one key present
52
+ * content: "STRING_VALUE",
53
+ * },
54
+ * },
55
+ * headers: [ // EmailHeaders
56
+ * { // EmailHeader
57
+ * name: "STRING_VALUE",
58
+ * value: "STRING_VALUE",
59
+ * },
60
+ * ],
61
+ * },
62
+ * sms: { // SMSMessageTemplateContent
63
+ * body: { // SMSMessageTemplateContentBody
64
+ * plainText: {// Union: only one key present
65
+ * content: "STRING_VALUE",
66
+ * },
67
+ * },
68
+ * },
69
+ * },
70
+ * language: "STRING_VALUE",
71
+ * defaultAttributes: { // MessageTemplateAttributes
72
+ * systemAttributes: { // SystemAttributes
73
+ * name: "STRING_VALUE",
74
+ * customerEndpoint: { // SystemEndpointAttributes
75
+ * address: "STRING_VALUE",
76
+ * },
77
+ * systemEndpoint: {
78
+ * address: "STRING_VALUE",
79
+ * },
80
+ * },
81
+ * agentAttributes: { // AgentAttributes
82
+ * firstName: "STRING_VALUE",
83
+ * lastName: "STRING_VALUE",
84
+ * },
85
+ * customerProfileAttributes: { // CustomerProfileAttributes
86
+ * profileId: "STRING_VALUE",
87
+ * profileARN: "STRING_VALUE",
88
+ * firstName: "STRING_VALUE",
89
+ * middleName: "STRING_VALUE",
90
+ * lastName: "STRING_VALUE",
91
+ * accountNumber: "STRING_VALUE",
92
+ * emailAddress: "STRING_VALUE",
93
+ * phoneNumber: "STRING_VALUE",
94
+ * additionalInformation: "STRING_VALUE",
95
+ * partyType: "STRING_VALUE",
96
+ * businessName: "STRING_VALUE",
97
+ * birthDate: "STRING_VALUE",
98
+ * gender: "STRING_VALUE",
99
+ * mobilePhoneNumber: "STRING_VALUE",
100
+ * homePhoneNumber: "STRING_VALUE",
101
+ * businessPhoneNumber: "STRING_VALUE",
102
+ * businessEmailAddress: "STRING_VALUE",
103
+ * address1: "STRING_VALUE",
104
+ * address2: "STRING_VALUE",
105
+ * address3: "STRING_VALUE",
106
+ * address4: "STRING_VALUE",
107
+ * city: "STRING_VALUE",
108
+ * county: "STRING_VALUE",
109
+ * country: "STRING_VALUE",
110
+ * postalCode: "STRING_VALUE",
111
+ * province: "STRING_VALUE",
112
+ * state: "STRING_VALUE",
113
+ * shippingAddress1: "STRING_VALUE",
114
+ * shippingAddress2: "STRING_VALUE",
115
+ * shippingAddress3: "STRING_VALUE",
116
+ * shippingAddress4: "STRING_VALUE",
117
+ * shippingCity: "STRING_VALUE",
118
+ * shippingCounty: "STRING_VALUE",
119
+ * shippingCountry: "STRING_VALUE",
120
+ * shippingPostalCode: "STRING_VALUE",
121
+ * shippingProvince: "STRING_VALUE",
122
+ * shippingState: "STRING_VALUE",
123
+ * mailingAddress1: "STRING_VALUE",
124
+ * mailingAddress2: "STRING_VALUE",
125
+ * mailingAddress3: "STRING_VALUE",
126
+ * mailingAddress4: "STRING_VALUE",
127
+ * mailingCity: "STRING_VALUE",
128
+ * mailingCounty: "STRING_VALUE",
129
+ * mailingCountry: "STRING_VALUE",
130
+ * mailingPostalCode: "STRING_VALUE",
131
+ * mailingProvince: "STRING_VALUE",
132
+ * mailingState: "STRING_VALUE",
133
+ * billingAddress1: "STRING_VALUE",
134
+ * billingAddress2: "STRING_VALUE",
135
+ * billingAddress3: "STRING_VALUE",
136
+ * billingAddress4: "STRING_VALUE",
137
+ * billingCity: "STRING_VALUE",
138
+ * billingCounty: "STRING_VALUE",
139
+ * billingCountry: "STRING_VALUE",
140
+ * billingPostalCode: "STRING_VALUE",
141
+ * billingProvince: "STRING_VALUE",
142
+ * billingState: "STRING_VALUE",
143
+ * custom: { // CustomAttributes
144
+ * "<keys>": "STRING_VALUE",
145
+ * },
146
+ * },
147
+ * customAttributes: {
148
+ * "<keys>": "STRING_VALUE",
149
+ * },
150
+ * },
151
+ * };
152
+ * const command = new UpdateMessageTemplateCommand(input);
153
+ * const response = await client.send(command);
154
+ * // { // UpdateMessageTemplateResponse
155
+ * // messageTemplate: { // MessageTemplateData
156
+ * // messageTemplateArn: "STRING_VALUE", // required
157
+ * // messageTemplateId: "STRING_VALUE", // required
158
+ * // knowledgeBaseArn: "STRING_VALUE", // required
159
+ * // knowledgeBaseId: "STRING_VALUE", // required
160
+ * // name: "STRING_VALUE", // required
161
+ * // channelSubtype: "STRING_VALUE", // required
162
+ * // createdTime: new Date("TIMESTAMP"), // required
163
+ * // lastModifiedTime: new Date("TIMESTAMP"), // required
164
+ * // lastModifiedBy: "STRING_VALUE", // required
165
+ * // content: { // MessageTemplateContentProvider Union: only one key present
166
+ * // email: { // EmailMessageTemplateContent
167
+ * // subject: "STRING_VALUE",
168
+ * // body: { // EmailMessageTemplateContentBody
169
+ * // plainText: { // MessageTemplateBodyContentProvider Union: only one key present
170
+ * // content: "STRING_VALUE",
171
+ * // },
172
+ * // html: {// Union: only one key present
173
+ * // content: "STRING_VALUE",
174
+ * // },
175
+ * // },
176
+ * // headers: [ // EmailHeaders
177
+ * // { // EmailHeader
178
+ * // name: "STRING_VALUE",
179
+ * // value: "STRING_VALUE",
180
+ * // },
181
+ * // ],
182
+ * // },
183
+ * // sms: { // SMSMessageTemplateContent
184
+ * // body: { // SMSMessageTemplateContentBody
185
+ * // plainText: {// Union: only one key present
186
+ * // content: "STRING_VALUE",
187
+ * // },
188
+ * // },
189
+ * // },
190
+ * // },
191
+ * // description: "STRING_VALUE",
192
+ * // language: "STRING_VALUE",
193
+ * // groupingConfiguration: { // GroupingConfiguration
194
+ * // criteria: "STRING_VALUE",
195
+ * // values: [ // GroupingValues
196
+ * // "STRING_VALUE",
197
+ * // ],
198
+ * // },
199
+ * // defaultAttributes: { // MessageTemplateAttributes
200
+ * // systemAttributes: { // SystemAttributes
201
+ * // name: "STRING_VALUE",
202
+ * // customerEndpoint: { // SystemEndpointAttributes
203
+ * // address: "STRING_VALUE",
204
+ * // },
205
+ * // systemEndpoint: {
206
+ * // address: "STRING_VALUE",
207
+ * // },
208
+ * // },
209
+ * // agentAttributes: { // AgentAttributes
210
+ * // firstName: "STRING_VALUE",
211
+ * // lastName: "STRING_VALUE",
212
+ * // },
213
+ * // customerProfileAttributes: { // CustomerProfileAttributes
214
+ * // profileId: "STRING_VALUE",
215
+ * // profileARN: "STRING_VALUE",
216
+ * // firstName: "STRING_VALUE",
217
+ * // middleName: "STRING_VALUE",
218
+ * // lastName: "STRING_VALUE",
219
+ * // accountNumber: "STRING_VALUE",
220
+ * // emailAddress: "STRING_VALUE",
221
+ * // phoneNumber: "STRING_VALUE",
222
+ * // additionalInformation: "STRING_VALUE",
223
+ * // partyType: "STRING_VALUE",
224
+ * // businessName: "STRING_VALUE",
225
+ * // birthDate: "STRING_VALUE",
226
+ * // gender: "STRING_VALUE",
227
+ * // mobilePhoneNumber: "STRING_VALUE",
228
+ * // homePhoneNumber: "STRING_VALUE",
229
+ * // businessPhoneNumber: "STRING_VALUE",
230
+ * // businessEmailAddress: "STRING_VALUE",
231
+ * // address1: "STRING_VALUE",
232
+ * // address2: "STRING_VALUE",
233
+ * // address3: "STRING_VALUE",
234
+ * // address4: "STRING_VALUE",
235
+ * // city: "STRING_VALUE",
236
+ * // county: "STRING_VALUE",
237
+ * // country: "STRING_VALUE",
238
+ * // postalCode: "STRING_VALUE",
239
+ * // province: "STRING_VALUE",
240
+ * // state: "STRING_VALUE",
241
+ * // shippingAddress1: "STRING_VALUE",
242
+ * // shippingAddress2: "STRING_VALUE",
243
+ * // shippingAddress3: "STRING_VALUE",
244
+ * // shippingAddress4: "STRING_VALUE",
245
+ * // shippingCity: "STRING_VALUE",
246
+ * // shippingCounty: "STRING_VALUE",
247
+ * // shippingCountry: "STRING_VALUE",
248
+ * // shippingPostalCode: "STRING_VALUE",
249
+ * // shippingProvince: "STRING_VALUE",
250
+ * // shippingState: "STRING_VALUE",
251
+ * // mailingAddress1: "STRING_VALUE",
252
+ * // mailingAddress2: "STRING_VALUE",
253
+ * // mailingAddress3: "STRING_VALUE",
254
+ * // mailingAddress4: "STRING_VALUE",
255
+ * // mailingCity: "STRING_VALUE",
256
+ * // mailingCounty: "STRING_VALUE",
257
+ * // mailingCountry: "STRING_VALUE",
258
+ * // mailingPostalCode: "STRING_VALUE",
259
+ * // mailingProvince: "STRING_VALUE",
260
+ * // mailingState: "STRING_VALUE",
261
+ * // billingAddress1: "STRING_VALUE",
262
+ * // billingAddress2: "STRING_VALUE",
263
+ * // billingAddress3: "STRING_VALUE",
264
+ * // billingAddress4: "STRING_VALUE",
265
+ * // billingCity: "STRING_VALUE",
266
+ * // billingCounty: "STRING_VALUE",
267
+ * // billingCountry: "STRING_VALUE",
268
+ * // billingPostalCode: "STRING_VALUE",
269
+ * // billingProvince: "STRING_VALUE",
270
+ * // billingState: "STRING_VALUE",
271
+ * // custom: { // CustomAttributes
272
+ * // "<keys>": "STRING_VALUE",
273
+ * // },
274
+ * // },
275
+ * // customAttributes: {
276
+ * // "<keys>": "STRING_VALUE",
277
+ * // },
278
+ * // },
279
+ * // attributeTypes: [ // MessageTemplateAttributeTypeList
280
+ * // "STRING_VALUE",
281
+ * // ],
282
+ * // messageTemplateContentSha256: "STRING_VALUE", // required
283
+ * // tags: { // Tags
284
+ * // "<keys>": "STRING_VALUE",
285
+ * // },
286
+ * // },
287
+ * // };
288
+ *
289
+ * ```
290
+ *
291
+ * @param UpdateMessageTemplateCommandInput - {@link UpdateMessageTemplateCommandInput}
292
+ * @returns {@link UpdateMessageTemplateCommandOutput}
293
+ * @see {@link UpdateMessageTemplateCommandInput} for command's `input` shape.
294
+ * @see {@link UpdateMessageTemplateCommandOutput} for command's `response` shape.
295
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
296
+ *
297
+ * @throws {@link AccessDeniedException} (client fault)
298
+ * <p>You do not have sufficient access to perform this action.</p>
299
+ *
300
+ * @throws {@link ConflictException} (client fault)
301
+ * <p>The request could not be processed because of conflict in the current state of the
302
+ * resource. For example, if you're using a <code>Create</code> API (such as
303
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
304
+ * same name) is being created or mutated.</p>
305
+ *
306
+ * @throws {@link ResourceNotFoundException} (client fault)
307
+ * <p>The specified resource does not exist.</p>
308
+ *
309
+ * @throws {@link ThrottlingException} (client fault)
310
+ * <p>The throttling limit has been exceeded.</p>
311
+ *
312
+ * @throws {@link ValidationException} (client fault)
313
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
314
+ *
315
+ * @throws {@link QConnectServiceException}
316
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
317
+ *
318
+ * @public
319
+ */
320
+ export declare class UpdateMessageTemplateCommand extends UpdateMessageTemplateCommand_base {
321
+ /** @internal type navigation helper, not in runtime. */
322
+ protected static __types: {
323
+ api: {
324
+ input: UpdateMessageTemplateRequest;
325
+ output: UpdateMessageTemplateResponse;
326
+ };
327
+ sdk: {
328
+ input: UpdateMessageTemplateCommandInput;
329
+ output: UpdateMessageTemplateCommandOutput;
330
+ };
331
+ };
332
+ }
@@ -0,0 +1,233 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { UpdateMessageTemplateMetadataRequest, UpdateMessageTemplateMetadataResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateMessageTemplateMetadataCommand}.
14
+ */
15
+ export interface UpdateMessageTemplateMetadataCommandInput extends UpdateMessageTemplateMetadataRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateMessageTemplateMetadataCommand}.
21
+ */
22
+ export interface UpdateMessageTemplateMetadataCommandOutput extends UpdateMessageTemplateMetadataResponse, __MetadataBearer {
23
+ }
24
+ declare const UpdateMessageTemplateMetadataCommand_base: {
25
+ new (input: UpdateMessageTemplateMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateMessageTemplateMetadataCommandInput, UpdateMessageTemplateMetadataCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateMessageTemplateMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateMessageTemplateMetadataCommandInput, UpdateMessageTemplateMetadataCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Updates the Amazon Q in Connect message template metadata. Note that any modification to
31
+ * the message template’s name, description and grouping configuration will applied to the
32
+ * message template pointed by the <code>$LATEST</code> qualifier and all available versions.
33
+ * Partial update is supported. If any field is not supplied, it will remain unchanged for the
34
+ * message template.</p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { QConnectClient, UpdateMessageTemplateMetadataCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
39
+ * // const { QConnectClient, UpdateMessageTemplateMetadataCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
40
+ * const client = new QConnectClient(config);
41
+ * const input = { // UpdateMessageTemplateMetadataRequest
42
+ * knowledgeBaseId: "STRING_VALUE", // required
43
+ * messageTemplateId: "STRING_VALUE", // required
44
+ * name: "STRING_VALUE",
45
+ * description: "STRING_VALUE",
46
+ * groupingConfiguration: { // GroupingConfiguration
47
+ * criteria: "STRING_VALUE",
48
+ * values: [ // GroupingValues
49
+ * "STRING_VALUE",
50
+ * ],
51
+ * },
52
+ * };
53
+ * const command = new UpdateMessageTemplateMetadataCommand(input);
54
+ * const response = await client.send(command);
55
+ * // { // UpdateMessageTemplateMetadataResponse
56
+ * // messageTemplate: { // MessageTemplateData
57
+ * // messageTemplateArn: "STRING_VALUE", // required
58
+ * // messageTemplateId: "STRING_VALUE", // required
59
+ * // knowledgeBaseArn: "STRING_VALUE", // required
60
+ * // knowledgeBaseId: "STRING_VALUE", // required
61
+ * // name: "STRING_VALUE", // required
62
+ * // channelSubtype: "STRING_VALUE", // required
63
+ * // createdTime: new Date("TIMESTAMP"), // required
64
+ * // lastModifiedTime: new Date("TIMESTAMP"), // required
65
+ * // lastModifiedBy: "STRING_VALUE", // required
66
+ * // content: { // MessageTemplateContentProvider Union: only one key present
67
+ * // email: { // EmailMessageTemplateContent
68
+ * // subject: "STRING_VALUE",
69
+ * // body: { // EmailMessageTemplateContentBody
70
+ * // plainText: { // MessageTemplateBodyContentProvider Union: only one key present
71
+ * // content: "STRING_VALUE",
72
+ * // },
73
+ * // html: {// Union: only one key present
74
+ * // content: "STRING_VALUE",
75
+ * // },
76
+ * // },
77
+ * // headers: [ // EmailHeaders
78
+ * // { // EmailHeader
79
+ * // name: "STRING_VALUE",
80
+ * // value: "STRING_VALUE",
81
+ * // },
82
+ * // ],
83
+ * // },
84
+ * // sms: { // SMSMessageTemplateContent
85
+ * // body: { // SMSMessageTemplateContentBody
86
+ * // plainText: {// Union: only one key present
87
+ * // content: "STRING_VALUE",
88
+ * // },
89
+ * // },
90
+ * // },
91
+ * // },
92
+ * // description: "STRING_VALUE",
93
+ * // language: "STRING_VALUE",
94
+ * // groupingConfiguration: { // GroupingConfiguration
95
+ * // criteria: "STRING_VALUE",
96
+ * // values: [ // GroupingValues
97
+ * // "STRING_VALUE",
98
+ * // ],
99
+ * // },
100
+ * // defaultAttributes: { // MessageTemplateAttributes
101
+ * // systemAttributes: { // SystemAttributes
102
+ * // name: "STRING_VALUE",
103
+ * // customerEndpoint: { // SystemEndpointAttributes
104
+ * // address: "STRING_VALUE",
105
+ * // },
106
+ * // systemEndpoint: {
107
+ * // address: "STRING_VALUE",
108
+ * // },
109
+ * // },
110
+ * // agentAttributes: { // AgentAttributes
111
+ * // firstName: "STRING_VALUE",
112
+ * // lastName: "STRING_VALUE",
113
+ * // },
114
+ * // customerProfileAttributes: { // CustomerProfileAttributes
115
+ * // profileId: "STRING_VALUE",
116
+ * // profileARN: "STRING_VALUE",
117
+ * // firstName: "STRING_VALUE",
118
+ * // middleName: "STRING_VALUE",
119
+ * // lastName: "STRING_VALUE",
120
+ * // accountNumber: "STRING_VALUE",
121
+ * // emailAddress: "STRING_VALUE",
122
+ * // phoneNumber: "STRING_VALUE",
123
+ * // additionalInformation: "STRING_VALUE",
124
+ * // partyType: "STRING_VALUE",
125
+ * // businessName: "STRING_VALUE",
126
+ * // birthDate: "STRING_VALUE",
127
+ * // gender: "STRING_VALUE",
128
+ * // mobilePhoneNumber: "STRING_VALUE",
129
+ * // homePhoneNumber: "STRING_VALUE",
130
+ * // businessPhoneNumber: "STRING_VALUE",
131
+ * // businessEmailAddress: "STRING_VALUE",
132
+ * // address1: "STRING_VALUE",
133
+ * // address2: "STRING_VALUE",
134
+ * // address3: "STRING_VALUE",
135
+ * // address4: "STRING_VALUE",
136
+ * // city: "STRING_VALUE",
137
+ * // county: "STRING_VALUE",
138
+ * // country: "STRING_VALUE",
139
+ * // postalCode: "STRING_VALUE",
140
+ * // province: "STRING_VALUE",
141
+ * // state: "STRING_VALUE",
142
+ * // shippingAddress1: "STRING_VALUE",
143
+ * // shippingAddress2: "STRING_VALUE",
144
+ * // shippingAddress3: "STRING_VALUE",
145
+ * // shippingAddress4: "STRING_VALUE",
146
+ * // shippingCity: "STRING_VALUE",
147
+ * // shippingCounty: "STRING_VALUE",
148
+ * // shippingCountry: "STRING_VALUE",
149
+ * // shippingPostalCode: "STRING_VALUE",
150
+ * // shippingProvince: "STRING_VALUE",
151
+ * // shippingState: "STRING_VALUE",
152
+ * // mailingAddress1: "STRING_VALUE",
153
+ * // mailingAddress2: "STRING_VALUE",
154
+ * // mailingAddress3: "STRING_VALUE",
155
+ * // mailingAddress4: "STRING_VALUE",
156
+ * // mailingCity: "STRING_VALUE",
157
+ * // mailingCounty: "STRING_VALUE",
158
+ * // mailingCountry: "STRING_VALUE",
159
+ * // mailingPostalCode: "STRING_VALUE",
160
+ * // mailingProvince: "STRING_VALUE",
161
+ * // mailingState: "STRING_VALUE",
162
+ * // billingAddress1: "STRING_VALUE",
163
+ * // billingAddress2: "STRING_VALUE",
164
+ * // billingAddress3: "STRING_VALUE",
165
+ * // billingAddress4: "STRING_VALUE",
166
+ * // billingCity: "STRING_VALUE",
167
+ * // billingCounty: "STRING_VALUE",
168
+ * // billingCountry: "STRING_VALUE",
169
+ * // billingPostalCode: "STRING_VALUE",
170
+ * // billingProvince: "STRING_VALUE",
171
+ * // billingState: "STRING_VALUE",
172
+ * // custom: { // CustomAttributes
173
+ * // "<keys>": "STRING_VALUE",
174
+ * // },
175
+ * // },
176
+ * // customAttributes: {
177
+ * // "<keys>": "STRING_VALUE",
178
+ * // },
179
+ * // },
180
+ * // attributeTypes: [ // MessageTemplateAttributeTypeList
181
+ * // "STRING_VALUE",
182
+ * // ],
183
+ * // messageTemplateContentSha256: "STRING_VALUE", // required
184
+ * // tags: { // Tags
185
+ * // "<keys>": "STRING_VALUE",
186
+ * // },
187
+ * // },
188
+ * // };
189
+ *
190
+ * ```
191
+ *
192
+ * @param UpdateMessageTemplateMetadataCommandInput - {@link UpdateMessageTemplateMetadataCommandInput}
193
+ * @returns {@link UpdateMessageTemplateMetadataCommandOutput}
194
+ * @see {@link UpdateMessageTemplateMetadataCommandInput} for command's `input` shape.
195
+ * @see {@link UpdateMessageTemplateMetadataCommandOutput} for command's `response` shape.
196
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
197
+ *
198
+ * @throws {@link AccessDeniedException} (client fault)
199
+ * <p>You do not have sufficient access to perform this action.</p>
200
+ *
201
+ * @throws {@link ConflictException} (client fault)
202
+ * <p>The request could not be processed because of conflict in the current state of the
203
+ * resource. For example, if you're using a <code>Create</code> API (such as
204
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
205
+ * same name) is being created or mutated.</p>
206
+ *
207
+ * @throws {@link ResourceNotFoundException} (client fault)
208
+ * <p>The specified resource does not exist.</p>
209
+ *
210
+ * @throws {@link ThrottlingException} (client fault)
211
+ * <p>The throttling limit has been exceeded.</p>
212
+ *
213
+ * @throws {@link ValidationException} (client fault)
214
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
215
+ *
216
+ * @throws {@link QConnectServiceException}
217
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
218
+ *
219
+ * @public
220
+ */
221
+ export declare class UpdateMessageTemplateMetadataCommand extends UpdateMessageTemplateMetadataCommand_base {
222
+ /** @internal type navigation helper, not in runtime. */
223
+ protected static __types: {
224
+ api: {
225
+ input: UpdateMessageTemplateMetadataRequest;
226
+ output: UpdateMessageTemplateMetadataResponse;
227
+ };
228
+ sdk: {
229
+ input: UpdateMessageTemplateMetadataCommandInput;
230
+ output: UpdateMessageTemplateMetadataCommandOutput;
231
+ };
232
+ };
233
+ }
@@ -1,3 +1,4 @@
1
+ export * from "./ActivateMessageTemplateCommand";
1
2
  export * from "./CreateAIAgentCommand";
2
3
  export * from "./CreateAIAgentVersionCommand";
3
4
  export * from "./CreateAIPromptCommand";
@@ -7,8 +8,12 @@ export * from "./CreateAssistantCommand";
7
8
  export * from "./CreateContentAssociationCommand";
8
9
  export * from "./CreateContentCommand";
9
10
  export * from "./CreateKnowledgeBaseCommand";
11
+ export * from "./CreateMessageTemplateAttachmentCommand";
12
+ export * from "./CreateMessageTemplateCommand";
13
+ export * from "./CreateMessageTemplateVersionCommand";
10
14
  export * from "./CreateQuickResponseCommand";
11
15
  export * from "./CreateSessionCommand";
16
+ export * from "./DeactivateMessageTemplateCommand";
12
17
  export * from "./DeleteAIAgentCommand";
13
18
  export * from "./DeleteAIAgentVersionCommand";
14
19
  export * from "./DeleteAIPromptCommand";
@@ -19,6 +24,8 @@ export * from "./DeleteContentAssociationCommand";
19
24
  export * from "./DeleteContentCommand";
20
25
  export * from "./DeleteImportJobCommand";
21
26
  export * from "./DeleteKnowledgeBaseCommand";
27
+ export * from "./DeleteMessageTemplateAttachmentCommand";
28
+ export * from "./DeleteMessageTemplateCommand";
22
29
  export * from "./DeleteQuickResponseCommand";
23
30
  export * from "./GetAIAgentCommand";
24
31
  export * from "./GetAIPromptCommand";
@@ -29,6 +36,7 @@ export * from "./GetContentCommand";
29
36
  export * from "./GetContentSummaryCommand";
30
37
  export * from "./GetImportJobCommand";
31
38
  export * from "./GetKnowledgeBaseCommand";
39
+ export * from "./GetMessageTemplateCommand";
32
40
  export * from "./GetQuickResponseCommand";
33
41
  export * from "./GetRecommendationsCommand";
34
42
  export * from "./GetSessionCommand";
@@ -42,6 +50,8 @@ export * from "./ListContentAssociationsCommand";
42
50
  export * from "./ListContentsCommand";
43
51
  export * from "./ListImportJobsCommand";
44
52
  export * from "./ListKnowledgeBasesCommand";
53
+ export * from "./ListMessageTemplateVersionsCommand";
54
+ export * from "./ListMessageTemplatesCommand";
45
55
  export * from "./ListQuickResponsesCommand";
46
56
  export * from "./ListTagsForResourceCommand";
47
57
  export * from "./NotifyRecommendationsReceivedCommand";
@@ -49,7 +59,9 @@ export * from "./PutFeedbackCommand";
49
59
  export * from "./QueryAssistantCommand";
50
60
  export * from "./RemoveAssistantAIAgentCommand";
51
61
  export * from "./RemoveKnowledgeBaseTemplateUriCommand";
62
+ export * from "./RenderMessageTemplateCommand";
52
63
  export * from "./SearchContentCommand";
64
+ export * from "./SearchMessageTemplatesCommand";
53
65
  export * from "./SearchQuickResponsesCommand";
54
66
  export * from "./SearchSessionsCommand";
55
67
  export * from "./StartContentUploadCommand";
@@ -61,6 +73,8 @@ export * from "./UpdateAIPromptCommand";
61
73
  export * from "./UpdateAssistantAIAgentCommand";
62
74
  export * from "./UpdateContentCommand";
63
75
  export * from "./UpdateKnowledgeBaseTemplateUriCommand";
76
+ export * from "./UpdateMessageTemplateCommand";
77
+ export * from "./UpdateMessageTemplateMetadataCommand";
64
78
  export * from "./UpdateQuickResponseCommand";
65
79
  export * from "./UpdateSessionCommand";
66
80
  export * from "./UpdateSessionDataCommand";
@@ -1 +1,2 @@
1
1
  export * from "./models_0";
2
+ export * from "./models_1";