@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.
- package/README.md +112 -0
- package/dist-cjs/index.js +1279 -149
- package/dist-es/QConnect.js +28 -0
- package/dist-es/commands/ActivateMessageTemplateCommand.js +22 -0
- package/dist-es/commands/CreateMessageTemplateAttachmentCommand.js +23 -0
- package/dist-es/commands/CreateMessageTemplateCommand.js +23 -0
- package/dist-es/commands/CreateMessageTemplateVersionCommand.js +23 -0
- package/dist-es/commands/DeactivateMessageTemplateCommand.js +22 -0
- package/dist-es/commands/DeleteMessageTemplateAttachmentCommand.js +22 -0
- package/dist-es/commands/DeleteMessageTemplateCommand.js +22 -0
- package/dist-es/commands/GetMessageTemplateCommand.js +23 -0
- package/dist-es/commands/GetRecommendationsCommand.js +1 -1
- package/dist-es/commands/ListMessageTemplateVersionsCommand.js +22 -0
- package/dist-es/commands/ListMessageTemplatesCommand.js +22 -0
- package/dist-es/commands/QueryAssistantCommand.js +2 -1
- package/dist-es/commands/RenderMessageTemplateCommand.js +23 -0
- package/dist-es/commands/SearchMessageTemplatesCommand.js +23 -0
- package/dist-es/commands/SearchQuickResponsesCommand.js +1 -1
- package/dist-es/commands/StartContentUploadCommand.js +1 -1
- package/dist-es/commands/StartImportJobCommand.js +1 -1
- package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +1 -1
- package/dist-es/commands/UpdateMessageTemplateCommand.js +23 -0
- package/dist-es/commands/UpdateMessageTemplateMetadataCommand.js +23 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +280 -152
- package/dist-es/models/models_1.js +138 -0
- package/dist-es/pagination/ListMessageTemplateVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListMessageTemplatesPaginator.js +4 -0
- package/dist-es/pagination/SearchMessageTemplatesPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +527 -5
- package/dist-types/QConnect.d.ts +98 -0
- package/dist-types/QConnectClient.d.ts +16 -2
- package/dist-types/commands/ActivateMessageTemplateCommand.d.ts +96 -0
- package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +109 -0
- package/dist-types/commands/CreateMessageTemplateCommand.d.ts +347 -0
- package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +247 -0
- package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +95 -0
- package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +91 -0
- package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +92 -0
- package/dist-types/commands/GetMessageTemplateCommand.d.ts +231 -0
- package/dist-types/commands/GetRecommendationsCommand.d.ts +2 -1
- package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +99 -0
- package/dist-types/commands/ListMessageTemplatesCommand.d.ts +104 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/QueryAssistantCommand.d.ts +2 -1
- package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +2 -1
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +206 -0
- package/dist-types/commands/SearchContentCommand.d.ts +1 -1
- package/dist-types/commands/SearchMessageTemplatesCommand.d.ts +138 -0
- package/dist-types/commands/SearchQuickResponsesCommand.d.ts +1 -1
- package/dist-types/commands/StartContentUploadCommand.d.ts +1 -1
- package/dist-types/commands/StartImportJobCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +332 -0
- package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +233 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1639 -983
- package/dist-types/models/models_1.d.ts +1256 -0
- package/dist-types/pagination/ListMessageTemplateVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListMessageTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchMessageTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/QConnect.d.ts +238 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +84 -0
- package/dist-types/ts3.4/commands/ActivateMessageTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateMessageTemplateAttachmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateMessageTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeactivateMessageTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/QueryAssistantCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchContentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchMessageTemplatesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchQuickResponsesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartContentUploadCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateMessageTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateMessageTemplateMetadataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +466 -284
- package/dist-types/ts3.4/models/models_1.d.ts +349 -0
- package/dist-types/ts3.4/pagination/ListMessageTemplateVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListMessageTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchMessageTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +35 -35
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListMessageTemplatesRequest, ListMessageTemplatesResponse } 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 ListMessageTemplatesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListMessageTemplatesCommandInput extends ListMessageTemplatesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListMessageTemplatesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListMessageTemplatesCommandOutput extends ListMessageTemplatesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListMessageTemplatesCommand_base: {
|
|
25
|
+
new (input: ListMessageTemplatesCommandInput): import("@smithy/smithy-client").CommandImpl<ListMessageTemplatesCommandInput, ListMessageTemplatesCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListMessageTemplatesCommandInput): import("@smithy/smithy-client").CommandImpl<ListMessageTemplatesCommandInput, ListMessageTemplatesCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists all the available Amazon Q in Connect message templates for the specified knowledge
|
|
31
|
+
* base.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { QConnectClient, ListMessageTemplatesCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
36
|
+
* // const { QConnectClient, ListMessageTemplatesCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
37
|
+
* const client = new QConnectClient(config);
|
|
38
|
+
* const input = { // ListMessageTemplatesRequest
|
|
39
|
+
* nextToken: "STRING_VALUE",
|
|
40
|
+
* maxResults: Number("int"),
|
|
41
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListMessageTemplatesCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListMessageTemplatesResponse
|
|
46
|
+
* // messageTemplateSummaries: [ // MessageTemplateSummaryList // required
|
|
47
|
+
* // { // MessageTemplateSummary
|
|
48
|
+
* // messageTemplateArn: "STRING_VALUE", // required
|
|
49
|
+
* // messageTemplateId: "STRING_VALUE", // required
|
|
50
|
+
* // knowledgeBaseArn: "STRING_VALUE", // required
|
|
51
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
52
|
+
* // name: "STRING_VALUE", // required
|
|
53
|
+
* // channelSubtype: "STRING_VALUE", // required
|
|
54
|
+
* // createdTime: new Date("TIMESTAMP"), // required
|
|
55
|
+
* // lastModifiedTime: new Date("TIMESTAMP"), // required
|
|
56
|
+
* // lastModifiedBy: "STRING_VALUE", // required
|
|
57
|
+
* // activeVersionNumber: Number("long"),
|
|
58
|
+
* // description: "STRING_VALUE",
|
|
59
|
+
* // tags: { // Tags
|
|
60
|
+
* // "<keys>": "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // nextToken: "STRING_VALUE",
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param ListMessageTemplatesCommandInput - {@link ListMessageTemplatesCommandInput}
|
|
70
|
+
* @returns {@link ListMessageTemplatesCommandOutput}
|
|
71
|
+
* @see {@link ListMessageTemplatesCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link ListMessageTemplatesCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
+
* <p>The specified resource does not exist.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link QConnectServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class ListMessageTemplatesCommand extends ListMessageTemplatesCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: ListMessageTemplatesRequest;
|
|
97
|
+
output: ListMessageTemplatesResponse;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: ListMessageTemplatesCommandInput;
|
|
101
|
+
output: ListMessageTemplatesCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/
|
|
3
|
+
import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { QueryAssistantRequest
|
|
3
|
+
import { QueryAssistantRequest } from "../models/models_0";
|
|
4
|
+
import { QueryAssistantResponse } from "../models/models_1";
|
|
4
5
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { RemoveKnowledgeBaseTemplateUriRequest
|
|
3
|
+
import { RemoveKnowledgeBaseTemplateUriRequest } from "../models/models_0";
|
|
4
|
+
import { RemoveKnowledgeBaseTemplateUriResponse } from "../models/models_1";
|
|
4
5
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { RenderMessageTemplateRequest, RenderMessageTemplateResponse } 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 RenderMessageTemplateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RenderMessageTemplateCommandInput extends RenderMessageTemplateRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RenderMessageTemplateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RenderMessageTemplateCommandOutput extends RenderMessageTemplateResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RenderMessageTemplateCommand_base: {
|
|
25
|
+
new (input: RenderMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<RenderMessageTemplateCommandInput, RenderMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: RenderMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<RenderMessageTemplateCommandInput, RenderMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Renders the Amazon Q in Connect message template based on the attribute values provided
|
|
31
|
+
* and generates the message content. For any variable present in the message template, if the
|
|
32
|
+
* attribute value is neither provided in the attribute request parameter nor the default
|
|
33
|
+
* attribute of the message template, the rendered message content will keep the variable
|
|
34
|
+
* placeholder as it is and return the attribute keys that are missing.</p>
|
|
35
|
+
* @example
|
|
36
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { QConnectClient, RenderMessageTemplateCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
39
|
+
* // const { QConnectClient, RenderMessageTemplateCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
40
|
+
* const client = new QConnectClient(config);
|
|
41
|
+
* const input = { // RenderMessageTemplateRequest
|
|
42
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
43
|
+
* messageTemplateId: "STRING_VALUE", // required
|
|
44
|
+
* attributes: { // MessageTemplateAttributes
|
|
45
|
+
* systemAttributes: { // SystemAttributes
|
|
46
|
+
* name: "STRING_VALUE",
|
|
47
|
+
* customerEndpoint: { // SystemEndpointAttributes
|
|
48
|
+
* address: "STRING_VALUE",
|
|
49
|
+
* },
|
|
50
|
+
* systemEndpoint: {
|
|
51
|
+
* address: "STRING_VALUE",
|
|
52
|
+
* },
|
|
53
|
+
* },
|
|
54
|
+
* agentAttributes: { // AgentAttributes
|
|
55
|
+
* firstName: "STRING_VALUE",
|
|
56
|
+
* lastName: "STRING_VALUE",
|
|
57
|
+
* },
|
|
58
|
+
* customerProfileAttributes: { // CustomerProfileAttributes
|
|
59
|
+
* profileId: "STRING_VALUE",
|
|
60
|
+
* profileARN: "STRING_VALUE",
|
|
61
|
+
* firstName: "STRING_VALUE",
|
|
62
|
+
* middleName: "STRING_VALUE",
|
|
63
|
+
* lastName: "STRING_VALUE",
|
|
64
|
+
* accountNumber: "STRING_VALUE",
|
|
65
|
+
* emailAddress: "STRING_VALUE",
|
|
66
|
+
* phoneNumber: "STRING_VALUE",
|
|
67
|
+
* additionalInformation: "STRING_VALUE",
|
|
68
|
+
* partyType: "STRING_VALUE",
|
|
69
|
+
* businessName: "STRING_VALUE",
|
|
70
|
+
* birthDate: "STRING_VALUE",
|
|
71
|
+
* gender: "STRING_VALUE",
|
|
72
|
+
* mobilePhoneNumber: "STRING_VALUE",
|
|
73
|
+
* homePhoneNumber: "STRING_VALUE",
|
|
74
|
+
* businessPhoneNumber: "STRING_VALUE",
|
|
75
|
+
* businessEmailAddress: "STRING_VALUE",
|
|
76
|
+
* address1: "STRING_VALUE",
|
|
77
|
+
* address2: "STRING_VALUE",
|
|
78
|
+
* address3: "STRING_VALUE",
|
|
79
|
+
* address4: "STRING_VALUE",
|
|
80
|
+
* city: "STRING_VALUE",
|
|
81
|
+
* county: "STRING_VALUE",
|
|
82
|
+
* country: "STRING_VALUE",
|
|
83
|
+
* postalCode: "STRING_VALUE",
|
|
84
|
+
* province: "STRING_VALUE",
|
|
85
|
+
* state: "STRING_VALUE",
|
|
86
|
+
* shippingAddress1: "STRING_VALUE",
|
|
87
|
+
* shippingAddress2: "STRING_VALUE",
|
|
88
|
+
* shippingAddress3: "STRING_VALUE",
|
|
89
|
+
* shippingAddress4: "STRING_VALUE",
|
|
90
|
+
* shippingCity: "STRING_VALUE",
|
|
91
|
+
* shippingCounty: "STRING_VALUE",
|
|
92
|
+
* shippingCountry: "STRING_VALUE",
|
|
93
|
+
* shippingPostalCode: "STRING_VALUE",
|
|
94
|
+
* shippingProvince: "STRING_VALUE",
|
|
95
|
+
* shippingState: "STRING_VALUE",
|
|
96
|
+
* mailingAddress1: "STRING_VALUE",
|
|
97
|
+
* mailingAddress2: "STRING_VALUE",
|
|
98
|
+
* mailingAddress3: "STRING_VALUE",
|
|
99
|
+
* mailingAddress4: "STRING_VALUE",
|
|
100
|
+
* mailingCity: "STRING_VALUE",
|
|
101
|
+
* mailingCounty: "STRING_VALUE",
|
|
102
|
+
* mailingCountry: "STRING_VALUE",
|
|
103
|
+
* mailingPostalCode: "STRING_VALUE",
|
|
104
|
+
* mailingProvince: "STRING_VALUE",
|
|
105
|
+
* mailingState: "STRING_VALUE",
|
|
106
|
+
* billingAddress1: "STRING_VALUE",
|
|
107
|
+
* billingAddress2: "STRING_VALUE",
|
|
108
|
+
* billingAddress3: "STRING_VALUE",
|
|
109
|
+
* billingAddress4: "STRING_VALUE",
|
|
110
|
+
* billingCity: "STRING_VALUE",
|
|
111
|
+
* billingCounty: "STRING_VALUE",
|
|
112
|
+
* billingCountry: "STRING_VALUE",
|
|
113
|
+
* billingPostalCode: "STRING_VALUE",
|
|
114
|
+
* billingProvince: "STRING_VALUE",
|
|
115
|
+
* billingState: "STRING_VALUE",
|
|
116
|
+
* custom: { // CustomAttributes
|
|
117
|
+
* "<keys>": "STRING_VALUE",
|
|
118
|
+
* },
|
|
119
|
+
* },
|
|
120
|
+
* customAttributes: {
|
|
121
|
+
* "<keys>": "STRING_VALUE",
|
|
122
|
+
* },
|
|
123
|
+
* },
|
|
124
|
+
* };
|
|
125
|
+
* const command = new RenderMessageTemplateCommand(input);
|
|
126
|
+
* const response = await client.send(command);
|
|
127
|
+
* // { // RenderMessageTemplateResponse
|
|
128
|
+
* // content: { // MessageTemplateContentProvider Union: only one key present
|
|
129
|
+
* // email: { // EmailMessageTemplateContent
|
|
130
|
+
* // subject: "STRING_VALUE",
|
|
131
|
+
* // body: { // EmailMessageTemplateContentBody
|
|
132
|
+
* // plainText: { // MessageTemplateBodyContentProvider Union: only one key present
|
|
133
|
+
* // content: "STRING_VALUE",
|
|
134
|
+
* // },
|
|
135
|
+
* // html: {// Union: only one key present
|
|
136
|
+
* // content: "STRING_VALUE",
|
|
137
|
+
* // },
|
|
138
|
+
* // },
|
|
139
|
+
* // headers: [ // EmailHeaders
|
|
140
|
+
* // { // EmailHeader
|
|
141
|
+
* // name: "STRING_VALUE",
|
|
142
|
+
* // value: "STRING_VALUE",
|
|
143
|
+
* // },
|
|
144
|
+
* // ],
|
|
145
|
+
* // },
|
|
146
|
+
* // sms: { // SMSMessageTemplateContent
|
|
147
|
+
* // body: { // SMSMessageTemplateContentBody
|
|
148
|
+
* // plainText: {// Union: only one key present
|
|
149
|
+
* // content: "STRING_VALUE",
|
|
150
|
+
* // },
|
|
151
|
+
* // },
|
|
152
|
+
* // },
|
|
153
|
+
* // },
|
|
154
|
+
* // attributesNotInterpolated: [ // MessageTemplateAttributeKeyList
|
|
155
|
+
* // "STRING_VALUE",
|
|
156
|
+
* // ],
|
|
157
|
+
* // attachments: [ // MessageTemplateAttachmentList
|
|
158
|
+
* // { // MessageTemplateAttachment
|
|
159
|
+
* // contentDisposition: "STRING_VALUE", // required
|
|
160
|
+
* // name: "STRING_VALUE", // required
|
|
161
|
+
* // uploadedTime: new Date("TIMESTAMP"), // required
|
|
162
|
+
* // url: "STRING_VALUE", // required
|
|
163
|
+
* // urlExpiry: new Date("TIMESTAMP"), // required
|
|
164
|
+
* // attachmentId: "STRING_VALUE", // required
|
|
165
|
+
* // },
|
|
166
|
+
* // ],
|
|
167
|
+
* // };
|
|
168
|
+
*
|
|
169
|
+
* ```
|
|
170
|
+
*
|
|
171
|
+
* @param RenderMessageTemplateCommandInput - {@link RenderMessageTemplateCommandInput}
|
|
172
|
+
* @returns {@link RenderMessageTemplateCommandOutput}
|
|
173
|
+
* @see {@link RenderMessageTemplateCommandInput} for command's `input` shape.
|
|
174
|
+
* @see {@link RenderMessageTemplateCommandOutput} for command's `response` shape.
|
|
175
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
176
|
+
*
|
|
177
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
178
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
179
|
+
*
|
|
180
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
181
|
+
* <p>The specified resource does not exist.</p>
|
|
182
|
+
*
|
|
183
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
184
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
185
|
+
*
|
|
186
|
+
* @throws {@link ValidationException} (client fault)
|
|
187
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
188
|
+
*
|
|
189
|
+
* @throws {@link QConnectServiceException}
|
|
190
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
191
|
+
*
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
export declare class RenderMessageTemplateCommand extends RenderMessageTemplateCommand_base {
|
|
195
|
+
/** @internal type navigation helper, not in runtime. */
|
|
196
|
+
protected static __types: {
|
|
197
|
+
api: {
|
|
198
|
+
input: RenderMessageTemplateRequest;
|
|
199
|
+
output: RenderMessageTemplateResponse;
|
|
200
|
+
};
|
|
201
|
+
sdk: {
|
|
202
|
+
input: RenderMessageTemplateCommandInput;
|
|
203
|
+
output: RenderMessageTemplateCommandOutput;
|
|
204
|
+
};
|
|
205
|
+
};
|
|
206
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { SearchContentRequest, SearchContentResponse } from "../models/
|
|
3
|
+
import { SearchContentRequest, SearchContentResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { SearchMessageTemplatesRequest, SearchMessageTemplatesResponse } from "../models/models_1";
|
|
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 SearchMessageTemplatesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SearchMessageTemplatesCommandInput extends SearchMessageTemplatesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SearchMessageTemplatesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SearchMessageTemplatesCommandOutput extends SearchMessageTemplatesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SearchMessageTemplatesCommand_base: {
|
|
25
|
+
new (input: SearchMessageTemplatesCommandInput): import("@smithy/smithy-client").CommandImpl<SearchMessageTemplatesCommandInput, SearchMessageTemplatesCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SearchMessageTemplatesCommandInput): import("@smithy/smithy-client").CommandImpl<SearchMessageTemplatesCommandInput, SearchMessageTemplatesCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Searches for Amazon Q in Connect message templates in the specified knowledge base.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QConnectClient, SearchMessageTemplatesCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
35
|
+
* // const { QConnectClient, SearchMessageTemplatesCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
36
|
+
* const client = new QConnectClient(config);
|
|
37
|
+
* const input = { // SearchMessageTemplatesRequest
|
|
38
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
39
|
+
* searchExpression: { // MessageTemplateSearchExpression
|
|
40
|
+
* queries: [ // MessageTemplateQueryFieldList
|
|
41
|
+
* { // MessageTemplateQueryField
|
|
42
|
+
* name: "STRING_VALUE", // required
|
|
43
|
+
* values: [ // MessageTemplateQueryValueList // required
|
|
44
|
+
* "STRING_VALUE",
|
|
45
|
+
* ],
|
|
46
|
+
* operator: "STRING_VALUE", // required
|
|
47
|
+
* allowFuzziness: true || false,
|
|
48
|
+
* priority: "STRING_VALUE",
|
|
49
|
+
* },
|
|
50
|
+
* ],
|
|
51
|
+
* filters: [ // MessageTemplateFilterFieldList
|
|
52
|
+
* { // MessageTemplateFilterField
|
|
53
|
+
* name: "STRING_VALUE", // required
|
|
54
|
+
* values: [ // MessageTemplateFilterValueList
|
|
55
|
+
* "STRING_VALUE",
|
|
56
|
+
* ],
|
|
57
|
+
* operator: "STRING_VALUE", // required
|
|
58
|
+
* includeNoExistence: true || false,
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* orderOnField: { // MessageTemplateOrderField
|
|
62
|
+
* name: "STRING_VALUE", // required
|
|
63
|
+
* order: "STRING_VALUE",
|
|
64
|
+
* },
|
|
65
|
+
* },
|
|
66
|
+
* nextToken: "STRING_VALUE",
|
|
67
|
+
* maxResults: Number("int"),
|
|
68
|
+
* };
|
|
69
|
+
* const command = new SearchMessageTemplatesCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* // { // SearchMessageTemplatesResponse
|
|
72
|
+
* // results: [ // MessageTemplateSearchResultsList // required
|
|
73
|
+
* // { // MessageTemplateSearchResultData
|
|
74
|
+
* // messageTemplateArn: "STRING_VALUE", // required
|
|
75
|
+
* // messageTemplateId: "STRING_VALUE", // required
|
|
76
|
+
* // knowledgeBaseArn: "STRING_VALUE", // required
|
|
77
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
78
|
+
* // name: "STRING_VALUE", // required
|
|
79
|
+
* // channelSubtype: "STRING_VALUE", // required
|
|
80
|
+
* // createdTime: new Date("TIMESTAMP"), // required
|
|
81
|
+
* // lastModifiedTime: new Date("TIMESTAMP"), // required
|
|
82
|
+
* // lastModifiedBy: "STRING_VALUE", // required
|
|
83
|
+
* // isActive: true || false,
|
|
84
|
+
* // versionNumber: Number("long"),
|
|
85
|
+
* // description: "STRING_VALUE",
|
|
86
|
+
* // groupingConfiguration: { // GroupingConfiguration
|
|
87
|
+
* // criteria: "STRING_VALUE",
|
|
88
|
+
* // values: [ // GroupingValues
|
|
89
|
+
* // "STRING_VALUE",
|
|
90
|
+
* // ],
|
|
91
|
+
* // },
|
|
92
|
+
* // language: "STRING_VALUE",
|
|
93
|
+
* // tags: { // Tags
|
|
94
|
+
* // "<keys>": "STRING_VALUE",
|
|
95
|
+
* // },
|
|
96
|
+
* // },
|
|
97
|
+
* // ],
|
|
98
|
+
* // nextToken: "STRING_VALUE",
|
|
99
|
+
* // };
|
|
100
|
+
*
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
103
|
+
* @param SearchMessageTemplatesCommandInput - {@link SearchMessageTemplatesCommandInput}
|
|
104
|
+
* @returns {@link SearchMessageTemplatesCommandOutput}
|
|
105
|
+
* @see {@link SearchMessageTemplatesCommandInput} for command's `input` shape.
|
|
106
|
+
* @see {@link SearchMessageTemplatesCommandOutput} for command's `response` shape.
|
|
107
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
110
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
113
|
+
* <p>The specified resource does not exist.</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
116
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link ValidationException} (client fault)
|
|
119
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link QConnectServiceException}
|
|
122
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
123
|
+
*
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
export declare class SearchMessageTemplatesCommand extends SearchMessageTemplatesCommand_base {
|
|
127
|
+
/** @internal type navigation helper, not in runtime. */
|
|
128
|
+
protected static __types: {
|
|
129
|
+
api: {
|
|
130
|
+
input: SearchMessageTemplatesRequest;
|
|
131
|
+
output: SearchMessageTemplatesResponse;
|
|
132
|
+
};
|
|
133
|
+
sdk: {
|
|
134
|
+
input: SearchMessageTemplatesCommandInput;
|
|
135
|
+
output: SearchMessageTemplatesCommandOutput;
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { SearchQuickResponsesRequest, SearchQuickResponsesResponse } from "../models/
|
|
3
|
+
import { SearchQuickResponsesRequest, SearchQuickResponsesResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { StartContentUploadRequest, StartContentUploadResponse } from "../models/
|
|
3
|
+
import { StartContentUploadRequest, StartContentUploadResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { StartImportJobRequest, StartImportJobResponse } from "../models/
|
|
3
|
+
import { StartImportJobRequest, StartImportJobResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { TagResourceRequest, TagResourceResponse } from "../models/
|
|
3
|
+
import { TagResourceRequest, TagResourceResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { UntagResourceRequest, UntagResourceResponse } from "../models/
|
|
3
|
+
import { UntagResourceRequest, UntagResourceResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { UpdateKnowledgeBaseTemplateUriRequest, UpdateKnowledgeBaseTemplateUriResponse } from "../models/
|
|
3
|
+
import { UpdateKnowledgeBaseTemplateUriRequest, UpdateKnowledgeBaseTemplateUriResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|