@aws-sdk/client-qbusiness 3.565.0 → 3.567.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 +8 -3
- package/dist-cjs/index.js +434 -9
- package/dist-cjs/runtimeConfig.browser.js +4 -0
- package/dist-cjs/runtimeConfig.js +4 -0
- package/dist-cjs/runtimeConfig.native.js +3 -0
- package/dist-es/QBusiness.js +2 -0
- package/dist-es/QBusinessClient.js +8 -4
- package/dist-es/commands/ChatCommand.js +32 -0
- package/dist-es/commands/CreatePluginCommand.js +2 -1
- package/dist-es/commands/GetPluginCommand.js +2 -1
- package/dist-es/commands/UpdatePluginCommand.js +2 -1
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +134 -0
- package/dist-es/protocols/Aws_restJson1.js +225 -1
- package/dist-es/runtimeConfig.browser.js +5 -1
- package/dist-es/runtimeConfig.js +4 -0
- package/dist-es/runtimeConfig.native.js +3 -0
- package/dist-types/QBusiness.d.ts +8 -4
- package/dist-types/QBusinessClient.d.ts +19 -9
- package/dist-types/commands/ChatCommand.d.ts +281 -0
- package/dist-types/commands/ChatSyncCommand.d.ts +14 -1
- package/dist-types/commands/CreateApplicationCommand.d.ts +8 -1
- package/dist-types/commands/CreateIndexCommand.d.ts +1 -0
- package/dist-types/commands/CreatePluginCommand.d.ts +15 -2
- package/dist-types/commands/GetIndexCommand.d.ts +1 -0
- package/dist-types/commands/GetPluginCommand.d.ts +14 -1
- package/dist-types/commands/ListMessagesCommand.d.ts +6 -1
- package/dist-types/commands/ListPluginsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateApplicationCommand.d.ts +1 -0
- package/dist-types/commands/UpdatePluginCommand.d.ts +12 -0
- package/dist-types/commands/UpdateWebExperienceCommand.d.ts +1 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +1 -4
- package/dist-types/models/models_0.d.ts +867 -47
- package/dist-types/protocols/Aws_restJson1.d.ts +10 -1
- package/dist-types/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/runtimeConfig.d.ts +2 -0
- package/dist-types/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/QBusiness.d.ts +14 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +19 -0
- package/dist-types/ts3.4/commands/ChatCommand.d.ts +29 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +333 -11
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +13 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
- package/package.json +19 -15
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ChatInput, ChatOutput } from "../models/models_0";
|
|
4
|
+
import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link ChatCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface ChatCommandInput extends ChatInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link ChatCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface ChatCommandOutput extends ChatOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const ChatCommand_base: {
|
|
24
|
+
new (input: ChatCommandInput): import("@smithy/smithy-client").CommandImpl<ChatCommandInput, ChatCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ChatCommandInput): import("@smithy/smithy-client").CommandImpl<ChatCommandInput, ChatCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Starts or continues a streaming Amazon Q Business conversation.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { QBusinessClient, ChatCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
|
|
34
|
+
* // const { QBusinessClient, ChatCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
|
|
35
|
+
* const client = new QBusinessClient(config);
|
|
36
|
+
* const input = { // ChatInput
|
|
37
|
+
* applicationId: "STRING_VALUE", // required
|
|
38
|
+
* userId: "STRING_VALUE",
|
|
39
|
+
* userGroups: [ // UserGroups
|
|
40
|
+
* "STRING_VALUE",
|
|
41
|
+
* ],
|
|
42
|
+
* conversationId: "STRING_VALUE",
|
|
43
|
+
* parentMessageId: "STRING_VALUE",
|
|
44
|
+
* clientToken: "STRING_VALUE",
|
|
45
|
+
* inputStream: { // ChatInputStream Union: only one key present
|
|
46
|
+
* configurationEvent: { // ConfigurationEvent
|
|
47
|
+
* chatMode: "RETRIEVAL_MODE" || "CREATOR_MODE" || "PLUGIN_MODE",
|
|
48
|
+
* chatModeConfiguration: { // ChatModeConfiguration Union: only one key present
|
|
49
|
+
* pluginConfiguration: { // PluginConfiguration
|
|
50
|
+
* pluginId: "STRING_VALUE", // required
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
53
|
+
* attributeFilter: { // AttributeFilter
|
|
54
|
+
* andAllFilters: [ // AttributeFilters
|
|
55
|
+
* {
|
|
56
|
+
* andAllFilters: [
|
|
57
|
+
* "<AttributeFilter>",
|
|
58
|
+
* ],
|
|
59
|
+
* orAllFilters: [
|
|
60
|
+
* "<AttributeFilter>",
|
|
61
|
+
* ],
|
|
62
|
+
* notFilter: "<AttributeFilter>",
|
|
63
|
+
* equalsTo: { // DocumentAttribute
|
|
64
|
+
* name: "STRING_VALUE", // required
|
|
65
|
+
* value: { // DocumentAttributeValue Union: only one key present
|
|
66
|
+
* stringValue: "STRING_VALUE",
|
|
67
|
+
* stringListValue: [ // DocumentAttributeStringListValue
|
|
68
|
+
* "STRING_VALUE",
|
|
69
|
+
* ],
|
|
70
|
+
* longValue: Number("long"),
|
|
71
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
72
|
+
* },
|
|
73
|
+
* },
|
|
74
|
+
* containsAll: {
|
|
75
|
+
* name: "STRING_VALUE", // required
|
|
76
|
+
* value: {// Union: only one key present
|
|
77
|
+
* stringValue: "STRING_VALUE",
|
|
78
|
+
* stringListValue: [
|
|
79
|
+
* "STRING_VALUE",
|
|
80
|
+
* ],
|
|
81
|
+
* longValue: Number("long"),
|
|
82
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
83
|
+
* },
|
|
84
|
+
* },
|
|
85
|
+
* containsAny: {
|
|
86
|
+
* name: "STRING_VALUE", // required
|
|
87
|
+
* value: {// Union: only one key present
|
|
88
|
+
* stringValue: "STRING_VALUE",
|
|
89
|
+
* stringListValue: [
|
|
90
|
+
* "STRING_VALUE",
|
|
91
|
+
* ],
|
|
92
|
+
* longValue: Number("long"),
|
|
93
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
94
|
+
* },
|
|
95
|
+
* },
|
|
96
|
+
* greaterThan: {
|
|
97
|
+
* name: "STRING_VALUE", // required
|
|
98
|
+
* value: {// Union: only one key present
|
|
99
|
+
* stringValue: "STRING_VALUE",
|
|
100
|
+
* stringListValue: [
|
|
101
|
+
* "STRING_VALUE",
|
|
102
|
+
* ],
|
|
103
|
+
* longValue: Number("long"),
|
|
104
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
105
|
+
* },
|
|
106
|
+
* },
|
|
107
|
+
* greaterThanOrEquals: {
|
|
108
|
+
* name: "STRING_VALUE", // required
|
|
109
|
+
* value: {// Union: only one key present
|
|
110
|
+
* stringValue: "STRING_VALUE",
|
|
111
|
+
* stringListValue: [
|
|
112
|
+
* "STRING_VALUE",
|
|
113
|
+
* ],
|
|
114
|
+
* longValue: Number("long"),
|
|
115
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
116
|
+
* },
|
|
117
|
+
* },
|
|
118
|
+
* lessThan: "<DocumentAttribute>",
|
|
119
|
+
* lessThanOrEquals: "<DocumentAttribute>",
|
|
120
|
+
* },
|
|
121
|
+
* ],
|
|
122
|
+
* orAllFilters: [
|
|
123
|
+
* "<AttributeFilter>",
|
|
124
|
+
* ],
|
|
125
|
+
* notFilter: "<AttributeFilter>",
|
|
126
|
+
* equalsTo: "<DocumentAttribute>",
|
|
127
|
+
* containsAll: "<DocumentAttribute>",
|
|
128
|
+
* containsAny: "<DocumentAttribute>",
|
|
129
|
+
* greaterThan: "<DocumentAttribute>",
|
|
130
|
+
* greaterThanOrEquals: "<DocumentAttribute>",
|
|
131
|
+
* lessThan: "<DocumentAttribute>",
|
|
132
|
+
* lessThanOrEquals: "<DocumentAttribute>",
|
|
133
|
+
* },
|
|
134
|
+
* },
|
|
135
|
+
* textEvent: { // TextInputEvent
|
|
136
|
+
* userMessage: "STRING_VALUE", // required
|
|
137
|
+
* },
|
|
138
|
+
* attachmentEvent: { // AttachmentInputEvent
|
|
139
|
+
* attachment: { // AttachmentInput
|
|
140
|
+
* name: "STRING_VALUE", // required
|
|
141
|
+
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
142
|
+
* },
|
|
143
|
+
* },
|
|
144
|
+
* actionExecutionEvent: { // ActionExecutionEvent
|
|
145
|
+
* pluginId: "STRING_VALUE", // required
|
|
146
|
+
* payload: { // ActionExecutionPayload // required
|
|
147
|
+
* "<keys>": { // ActionExecutionPayloadField
|
|
148
|
+
* value: "DOCUMENT_VALUE", // required
|
|
149
|
+
* },
|
|
150
|
+
* },
|
|
151
|
+
* payloadFieldNameSeparator: "STRING_VALUE", // required
|
|
152
|
+
* },
|
|
153
|
+
* endOfInputEvent: {},
|
|
154
|
+
* authChallengeResponseEvent: { // AuthChallengeResponseEvent
|
|
155
|
+
* responseMap: { // AuthorizationResponseMap // required
|
|
156
|
+
* "<keys>": "STRING_VALUE",
|
|
157
|
+
* },
|
|
158
|
+
* },
|
|
159
|
+
* },
|
|
160
|
+
* };
|
|
161
|
+
* const command = new ChatCommand(input);
|
|
162
|
+
* const response = await client.send(command);
|
|
163
|
+
* // { // ChatOutput
|
|
164
|
+
* // outputStream: { // ChatOutputStream Union: only one key present
|
|
165
|
+
* // textEvent: { // TextOutputEvent
|
|
166
|
+
* // conversationId: "STRING_VALUE",
|
|
167
|
+
* // userMessageId: "STRING_VALUE",
|
|
168
|
+
* // systemMessageId: "STRING_VALUE",
|
|
169
|
+
* // systemMessage: "STRING_VALUE",
|
|
170
|
+
* // },
|
|
171
|
+
* // metadataEvent: { // MetadataEvent
|
|
172
|
+
* // conversationId: "STRING_VALUE",
|
|
173
|
+
* // userMessageId: "STRING_VALUE",
|
|
174
|
+
* // systemMessageId: "STRING_VALUE",
|
|
175
|
+
* // sourceAttributions: [ // SourceAttributions
|
|
176
|
+
* // { // SourceAttribution
|
|
177
|
+
* // title: "STRING_VALUE",
|
|
178
|
+
* // snippet: "STRING_VALUE",
|
|
179
|
+
* // url: "STRING_VALUE",
|
|
180
|
+
* // citationNumber: Number("int"),
|
|
181
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
182
|
+
* // textMessageSegments: [ // TextSegmentList
|
|
183
|
+
* // { // TextSegment
|
|
184
|
+
* // beginOffset: Number("int"),
|
|
185
|
+
* // endOffset: Number("int"),
|
|
186
|
+
* // snippetExcerpt: { // SnippetExcerpt
|
|
187
|
+
* // text: "STRING_VALUE",
|
|
188
|
+
* // },
|
|
189
|
+
* // },
|
|
190
|
+
* // ],
|
|
191
|
+
* // },
|
|
192
|
+
* // ],
|
|
193
|
+
* // finalTextMessage: "STRING_VALUE",
|
|
194
|
+
* // },
|
|
195
|
+
* // actionReviewEvent: { // ActionReviewEvent
|
|
196
|
+
* // conversationId: "STRING_VALUE",
|
|
197
|
+
* // userMessageId: "STRING_VALUE",
|
|
198
|
+
* // systemMessageId: "STRING_VALUE",
|
|
199
|
+
* // pluginId: "STRING_VALUE",
|
|
200
|
+
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM",
|
|
201
|
+
* // payload: { // ActionReviewPayload
|
|
202
|
+
* // "<keys>": { // ActionReviewPayloadField
|
|
203
|
+
* // displayName: "STRING_VALUE",
|
|
204
|
+
* // displayOrder: Number("int"),
|
|
205
|
+
* // displayDescription: "STRING_VALUE",
|
|
206
|
+
* // type: "STRING" || "NUMBER" || "ARRAY" || "BOOLEAN",
|
|
207
|
+
* // value: "DOCUMENT_VALUE",
|
|
208
|
+
* // allowedValues: [ // ActionReviewPayloadFieldAllowedValues
|
|
209
|
+
* // { // ActionReviewPayloadFieldAllowedValue
|
|
210
|
+
* // value: "DOCUMENT_VALUE",
|
|
211
|
+
* // displayValue: "DOCUMENT_VALUE",
|
|
212
|
+
* // },
|
|
213
|
+
* // ],
|
|
214
|
+
* // allowedFormat: "STRING_VALUE",
|
|
215
|
+
* // required: true || false,
|
|
216
|
+
* // },
|
|
217
|
+
* // },
|
|
218
|
+
* // payloadFieldNameSeparator: "STRING_VALUE",
|
|
219
|
+
* // },
|
|
220
|
+
* // failedAttachmentEvent: { // FailedAttachmentEvent
|
|
221
|
+
* // conversationId: "STRING_VALUE",
|
|
222
|
+
* // userMessageId: "STRING_VALUE",
|
|
223
|
+
* // systemMessageId: "STRING_VALUE",
|
|
224
|
+
* // attachment: { // AttachmentOutput
|
|
225
|
+
* // name: "STRING_VALUE",
|
|
226
|
+
* // status: "FAILED" || "SUCCEEDED",
|
|
227
|
+
* // error: { // ErrorDetail
|
|
228
|
+
* // errorMessage: "STRING_VALUE",
|
|
229
|
+
* // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
|
|
230
|
+
* // },
|
|
231
|
+
* // },
|
|
232
|
+
* // },
|
|
233
|
+
* // authChallengeRequestEvent: { // AuthChallengeRequestEvent
|
|
234
|
+
* // authorizationUrl: "STRING_VALUE", // required
|
|
235
|
+
* // },
|
|
236
|
+
* // },
|
|
237
|
+
* // };
|
|
238
|
+
*
|
|
239
|
+
* ```
|
|
240
|
+
*
|
|
241
|
+
* @param ChatCommandInput - {@link ChatCommandInput}
|
|
242
|
+
* @returns {@link ChatCommandOutput}
|
|
243
|
+
* @see {@link ChatCommandInput} for command's `input` shape.
|
|
244
|
+
* @see {@link ChatCommandOutput} for command's `response` shape.
|
|
245
|
+
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
246
|
+
*
|
|
247
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
248
|
+
* <p> You don't have access to perform this action. Make sure you have the required
|
|
249
|
+
* permission policies and user accounts and try again.</p>
|
|
250
|
+
*
|
|
251
|
+
* @throws {@link ConflictException} (client fault)
|
|
252
|
+
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
253
|
+
* resource. Fix any inconsistences with your resources and try again.</p>
|
|
254
|
+
*
|
|
255
|
+
* @throws {@link InternalServerException} (server fault)
|
|
256
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
257
|
+
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
258
|
+
*
|
|
259
|
+
* @throws {@link LicenseNotFoundException} (client fault)
|
|
260
|
+
* <p>You don't have permissions to perform the action because your license is inactive. Ask
|
|
261
|
+
* your admin to activate your license and try again after your licence is active.</p>
|
|
262
|
+
*
|
|
263
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
264
|
+
* <p>The resource you want to use doesn’t exist. Make sure you have provided the correct
|
|
265
|
+
* resource and try again.</p>
|
|
266
|
+
*
|
|
267
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
268
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
269
|
+
* again.</p>
|
|
270
|
+
*
|
|
271
|
+
* @throws {@link ValidationException} (client fault)
|
|
272
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
273
|
+
* correct input and try again.</p>
|
|
274
|
+
*
|
|
275
|
+
* @throws {@link QBusinessServiceException}
|
|
276
|
+
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
277
|
+
*
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
export declare class ChatCommand extends ChatCommand_base {
|
|
281
|
+
}
|
|
@@ -55,6 +55,11 @@ declare const ChatSyncCommand_base: {
|
|
|
55
55
|
* },
|
|
56
56
|
* payloadFieldNameSeparator: "STRING_VALUE", // required
|
|
57
57
|
* },
|
|
58
|
+
* authChallengeResponse: { // AuthChallengeResponse
|
|
59
|
+
* responseMap: { // AuthorizationResponseMap // required
|
|
60
|
+
* "<keys>": "STRING_VALUE",
|
|
61
|
+
* },
|
|
62
|
+
* },
|
|
58
63
|
* conversationId: "STRING_VALUE",
|
|
59
64
|
* parentMessageId: "STRING_VALUE",
|
|
60
65
|
* attributeFilter: { // AttributeFilter
|
|
@@ -155,11 +160,12 @@ declare const ChatSyncCommand_base: {
|
|
|
155
160
|
* // userMessageId: "STRING_VALUE",
|
|
156
161
|
* // actionReview: { // ActionReview
|
|
157
162
|
* // pluginId: "STRING_VALUE",
|
|
158
|
-
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK",
|
|
163
|
+
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM",
|
|
159
164
|
* // payload: { // ActionReviewPayload
|
|
160
165
|
* // "<keys>": { // ActionReviewPayloadField
|
|
161
166
|
* // displayName: "STRING_VALUE",
|
|
162
167
|
* // displayOrder: Number("int"),
|
|
168
|
+
* // displayDescription: "STRING_VALUE",
|
|
163
169
|
* // type: "STRING" || "NUMBER" || "ARRAY" || "BOOLEAN",
|
|
164
170
|
* // value: "DOCUMENT_VALUE",
|
|
165
171
|
* // allowedValues: [ // ActionReviewPayloadFieldAllowedValues
|
|
@@ -168,11 +174,15 @@ declare const ChatSyncCommand_base: {
|
|
|
168
174
|
* // displayValue: "DOCUMENT_VALUE",
|
|
169
175
|
* // },
|
|
170
176
|
* // ],
|
|
177
|
+
* // allowedFormat: "STRING_VALUE",
|
|
171
178
|
* // required: true || false,
|
|
172
179
|
* // },
|
|
173
180
|
* // },
|
|
174
181
|
* // payloadFieldNameSeparator: "STRING_VALUE",
|
|
175
182
|
* // },
|
|
183
|
+
* // authChallengeRequest: { // AuthChallengeRequest
|
|
184
|
+
* // authorizationUrl: "STRING_VALUE", // required
|
|
185
|
+
* // },
|
|
176
186
|
* // sourceAttributions: [ // SourceAttributions
|
|
177
187
|
* // { // SourceAttribution
|
|
178
188
|
* // title: "STRING_VALUE",
|
|
@@ -184,6 +194,9 @@ declare const ChatSyncCommand_base: {
|
|
|
184
194
|
* // { // TextSegment
|
|
185
195
|
* // beginOffset: Number("int"),
|
|
186
196
|
* // endOffset: Number("int"),
|
|
197
|
+
* // snippetExcerpt: { // SnippetExcerpt
|
|
198
|
+
* // text: "STRING_VALUE",
|
|
199
|
+
* // },
|
|
187
200
|
* // },
|
|
188
201
|
* // ],
|
|
189
202
|
* // },
|
|
@@ -27,6 +27,13 @@ declare const CreateApplicationCommand_base: {
|
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
29
|
* <p>Creates an Amazon Q Business application.</p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are
|
|
32
|
+
* also available in Amazon Q Business Lite. For information on what's included in
|
|
33
|
+
* Amazon Q Business Lite and what's included in
|
|
34
|
+
* Amazon Q Business Pro, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers">Amazon Q Business tiers</a>.
|
|
35
|
+
* You must use the Amazon Q Business console to assign subscription tiers to users.</p>
|
|
36
|
+
* </note>
|
|
30
37
|
* @example
|
|
31
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
39
|
* ```javascript
|
|
@@ -35,7 +42,7 @@ declare const CreateApplicationCommand_base: {
|
|
|
35
42
|
* const client = new QBusinessClient(config);
|
|
36
43
|
* const input = { // CreateApplicationRequest
|
|
37
44
|
* displayName: "STRING_VALUE", // required
|
|
38
|
-
* roleArn: "STRING_VALUE",
|
|
45
|
+
* roleArn: "STRING_VALUE",
|
|
39
46
|
* identityCenterInstanceArn: "STRING_VALUE",
|
|
40
47
|
* description: "STRING_VALUE",
|
|
41
48
|
* encryptionConfiguration: { // EncryptionConfiguration
|
|
@@ -44,6 +44,7 @@ declare const CreateIndexCommand_base: {
|
|
|
44
44
|
* const input = { // CreateIndexRequest
|
|
45
45
|
* applicationId: "STRING_VALUE", // required
|
|
46
46
|
* displayName: "STRING_VALUE", // required
|
|
47
|
+
* type: "ENTERPRISE" || "STARTER",
|
|
47
48
|
* description: "STRING_VALUE",
|
|
48
49
|
* tags: [ // Tags
|
|
49
50
|
* { // Tag
|
|
@@ -36,8 +36,7 @@ declare const CreatePluginCommand_base: {
|
|
|
36
36
|
* const input = { // CreatePluginRequest
|
|
37
37
|
* applicationId: "STRING_VALUE", // required
|
|
38
38
|
* displayName: "STRING_VALUE", // required
|
|
39
|
-
* type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK", // required
|
|
40
|
-
* serverUrl: "STRING_VALUE", // required
|
|
39
|
+
* type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM", // required
|
|
41
40
|
* authConfiguration: { // PluginAuthConfiguration Union: only one key present
|
|
42
41
|
* basicAuthConfiguration: { // BasicAuthConfiguration
|
|
43
42
|
* secretArn: "STRING_VALUE", // required
|
|
@@ -47,6 +46,19 @@ declare const CreatePluginCommand_base: {
|
|
|
47
46
|
* secretArn: "STRING_VALUE", // required
|
|
48
47
|
* roleArn: "STRING_VALUE", // required
|
|
49
48
|
* },
|
|
49
|
+
* noAuthConfiguration: {},
|
|
50
|
+
* },
|
|
51
|
+
* serverUrl: "STRING_VALUE",
|
|
52
|
+
* customPluginConfiguration: { // CustomPluginConfiguration
|
|
53
|
+
* description: "STRING_VALUE", // required
|
|
54
|
+
* apiSchemaType: "OPEN_API_V3", // required
|
|
55
|
+
* apiSchema: { // APISchema Union: only one key present
|
|
56
|
+
* payload: "STRING_VALUE",
|
|
57
|
+
* s3: { // S3
|
|
58
|
+
* bucket: "STRING_VALUE", // required
|
|
59
|
+
* key: "STRING_VALUE", // required
|
|
60
|
+
* },
|
|
61
|
+
* },
|
|
50
62
|
* },
|
|
51
63
|
* tags: [ // Tags
|
|
52
64
|
* { // Tag
|
|
@@ -61,6 +73,7 @@ declare const CreatePluginCommand_base: {
|
|
|
61
73
|
* // { // CreatePluginResponse
|
|
62
74
|
* // pluginId: "STRING_VALUE",
|
|
63
75
|
* // pluginArn: "STRING_VALUE",
|
|
76
|
+
* // buildStatus: "READY" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
|
|
64
77
|
* // };
|
|
65
78
|
*
|
|
66
79
|
* ```
|
|
@@ -43,6 +43,7 @@ declare const GetIndexCommand_base: {
|
|
|
43
43
|
* // applicationId: "STRING_VALUE",
|
|
44
44
|
* // indexId: "STRING_VALUE",
|
|
45
45
|
* // displayName: "STRING_VALUE",
|
|
46
|
+
* // type: "ENTERPRISE" || "STARTER",
|
|
46
47
|
* // indexArn: "STRING_VALUE",
|
|
47
48
|
* // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
|
|
48
49
|
* // description: "STRING_VALUE",
|
|
@@ -43,7 +43,7 @@ declare const GetPluginCommand_base: {
|
|
|
43
43
|
* // applicationId: "STRING_VALUE",
|
|
44
44
|
* // pluginId: "STRING_VALUE",
|
|
45
45
|
* // displayName: "STRING_VALUE",
|
|
46
|
-
* // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK",
|
|
46
|
+
* // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM",
|
|
47
47
|
* // serverUrl: "STRING_VALUE",
|
|
48
48
|
* // authConfiguration: { // PluginAuthConfiguration Union: only one key present
|
|
49
49
|
* // basicAuthConfiguration: { // BasicAuthConfiguration
|
|
@@ -54,7 +54,20 @@ declare const GetPluginCommand_base: {
|
|
|
54
54
|
* // secretArn: "STRING_VALUE", // required
|
|
55
55
|
* // roleArn: "STRING_VALUE", // required
|
|
56
56
|
* // },
|
|
57
|
+
* // noAuthConfiguration: {},
|
|
57
58
|
* // },
|
|
59
|
+
* // customPluginConfiguration: { // CustomPluginConfiguration
|
|
60
|
+
* // description: "STRING_VALUE", // required
|
|
61
|
+
* // apiSchemaType: "OPEN_API_V3", // required
|
|
62
|
+
* // apiSchema: { // APISchema Union: only one key present
|
|
63
|
+
* // payload: "STRING_VALUE",
|
|
64
|
+
* // s3: { // S3
|
|
65
|
+
* // bucket: "STRING_VALUE", // required
|
|
66
|
+
* // key: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // buildStatus: "READY" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
|
|
58
71
|
* // pluginArn: "STRING_VALUE",
|
|
59
72
|
* // state: "ENABLED" || "DISABLED",
|
|
60
73
|
* // createdAt: new Date("TIMESTAMP"),
|
|
@@ -70,17 +70,21 @@ declare const ListMessagesCommand_base: {
|
|
|
70
70
|
* // { // TextSegment
|
|
71
71
|
* // beginOffset: Number("int"),
|
|
72
72
|
* // endOffset: Number("int"),
|
|
73
|
+
* // snippetExcerpt: { // SnippetExcerpt
|
|
74
|
+
* // text: "STRING_VALUE",
|
|
75
|
+
* // },
|
|
73
76
|
* // },
|
|
74
77
|
* // ],
|
|
75
78
|
* // },
|
|
76
79
|
* // ],
|
|
77
80
|
* // actionReview: { // ActionReview
|
|
78
81
|
* // pluginId: "STRING_VALUE",
|
|
79
|
-
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK",
|
|
82
|
+
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM",
|
|
80
83
|
* // payload: { // ActionReviewPayload
|
|
81
84
|
* // "<keys>": { // ActionReviewPayloadField
|
|
82
85
|
* // displayName: "STRING_VALUE",
|
|
83
86
|
* // displayOrder: Number("int"),
|
|
87
|
+
* // displayDescription: "STRING_VALUE",
|
|
84
88
|
* // type: "STRING" || "NUMBER" || "ARRAY" || "BOOLEAN",
|
|
85
89
|
* // value: "DOCUMENT_VALUE",
|
|
86
90
|
* // allowedValues: [ // ActionReviewPayloadFieldAllowedValues
|
|
@@ -89,6 +93,7 @@ declare const ListMessagesCommand_base: {
|
|
|
89
93
|
* // displayValue: "DOCUMENT_VALUE",
|
|
90
94
|
* // },
|
|
91
95
|
* // ],
|
|
96
|
+
* // allowedFormat: "STRING_VALUE",
|
|
92
97
|
* // required: true || false,
|
|
93
98
|
* // },
|
|
94
99
|
* // },
|
|
@@ -46,9 +46,10 @@ declare const ListPluginsCommand_base: {
|
|
|
46
46
|
* // { // Plugin
|
|
47
47
|
* // pluginId: "STRING_VALUE",
|
|
48
48
|
* // displayName: "STRING_VALUE",
|
|
49
|
-
* // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK",
|
|
49
|
+
* // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM",
|
|
50
50
|
* // serverUrl: "STRING_VALUE",
|
|
51
51
|
* // state: "ENABLED" || "DISABLED",
|
|
52
|
+
* // buildStatus: "READY" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
|
|
52
53
|
* // createdAt: new Date("TIMESTAMP"),
|
|
53
54
|
* // updatedAt: new Date("TIMESTAMP"),
|
|
54
55
|
* // },
|
|
@@ -35,6 +35,7 @@ declare const UpdateApplicationCommand_base: {
|
|
|
35
35
|
* const client = new QBusinessClient(config);
|
|
36
36
|
* const input = { // UpdateApplicationRequest
|
|
37
37
|
* applicationId: "STRING_VALUE", // required
|
|
38
|
+
* identityCenterInstanceArn: "STRING_VALUE",
|
|
38
39
|
* displayName: "STRING_VALUE",
|
|
39
40
|
* description: "STRING_VALUE",
|
|
40
41
|
* roleArn: "STRING_VALUE",
|
|
@@ -39,6 +39,17 @@ declare const UpdatePluginCommand_base: {
|
|
|
39
39
|
* displayName: "STRING_VALUE",
|
|
40
40
|
* state: "ENABLED" || "DISABLED",
|
|
41
41
|
* serverUrl: "STRING_VALUE",
|
|
42
|
+
* customPluginConfiguration: { // CustomPluginConfiguration
|
|
43
|
+
* description: "STRING_VALUE", // required
|
|
44
|
+
* apiSchemaType: "OPEN_API_V3", // required
|
|
45
|
+
* apiSchema: { // APISchema Union: only one key present
|
|
46
|
+
* payload: "STRING_VALUE",
|
|
47
|
+
* s3: { // S3
|
|
48
|
+
* bucket: "STRING_VALUE", // required
|
|
49
|
+
* key: "STRING_VALUE", // required
|
|
50
|
+
* },
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
42
53
|
* authConfiguration: { // PluginAuthConfiguration Union: only one key present
|
|
43
54
|
* basicAuthConfiguration: { // BasicAuthConfiguration
|
|
44
55
|
* secretArn: "STRING_VALUE", // required
|
|
@@ -48,6 +59,7 @@ declare const UpdatePluginCommand_base: {
|
|
|
48
59
|
* secretArn: "STRING_VALUE", // required
|
|
49
60
|
* roleArn: "STRING_VALUE", // required
|
|
50
61
|
* },
|
|
62
|
+
* noAuthConfiguration: {},
|
|
51
63
|
* },
|
|
52
64
|
* };
|
|
53
65
|
* const command = new UpdatePluginCommand(input);
|
|
@@ -36,6 +36,7 @@ declare const UpdateWebExperienceCommand_base: {
|
|
|
36
36
|
* const input = { // UpdateWebExperienceRequest
|
|
37
37
|
* applicationId: "STRING_VALUE", // required
|
|
38
38
|
* webExperienceId: "STRING_VALUE", // required
|
|
39
|
+
* roleArn: "STRING_VALUE",
|
|
39
40
|
* authenticationConfiguration: { // WebExperienceAuthConfiguration Union: only one key present
|
|
40
41
|
* samlConfiguration: { // SamlConfiguration
|
|
41
42
|
* metadataXML: "STRING_VALUE", // required
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,8 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <
|
|
3
|
-
* <p>Amazon Q is in preview release and is subject to change.</p>
|
|
4
|
-
* </note>
|
|
5
|
-
* <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
|
|
2
|
+
* <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
|
|
6
3
|
* managed, generative-AI powered enterprise chat assistant that you can deploy within your
|
|
7
4
|
* organization. Amazon Q Business enhances employee productivity by supporting key tasks such
|
|
8
5
|
* as question-answering, knowledge discovery, writing email messages, summarizing text,
|