@aws-sdk/client-qbusiness 3.782.0 → 3.793.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 +9 -39
- package/dist-cjs/index.js +69 -5
- package/dist-es/QBusiness.js +2 -0
- package/dist-es/commands/CheckDocumentAccessCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +8 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +34 -0
- package/dist-types/QBusiness.d.ts +8 -39
- package/dist-types/QBusinessClient.d.ts +4 -41
- package/dist-types/commands/AssociatePermissionCommand.d.ts +7 -15
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +7 -16
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +7 -29
- package/dist-types/commands/CancelSubscriptionCommand.d.ts +6 -13
- package/dist-types/commands/ChatCommand.d.ts +9 -17
- package/dist-types/commands/ChatSyncCommand.d.ts +8 -17
- package/dist-types/commands/CheckDocumentAccessCommand.d.ts +145 -0
- package/dist-types/commands/CreateApplicationCommand.d.ts +7 -27
- package/dist-types/commands/CreateDataAccessorCommand.d.ts +7 -18
- package/dist-types/commands/CreateDataSourceCommand.d.ts +7 -16
- package/dist-types/commands/CreateIndexCommand.d.ts +7 -21
- package/dist-types/commands/CreatePluginCommand.d.ts +6 -12
- package/dist-types/commands/CreateRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/CreateSubscriptionCommand.d.ts +7 -18
- package/dist-types/commands/CreateUserCommand.d.ts +7 -14
- package/dist-types/commands/CreateWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/DeleteApplicationCommand.d.ts +6 -12
- package/dist-types/commands/DeleteAttachmentCommand.d.ts +6 -12
- package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +5 -10
- package/dist-types/commands/DeleteConversationCommand.d.ts +6 -12
- package/dist-types/commands/DeleteDataAccessorCommand.d.ts +7 -14
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +7 -15
- package/dist-types/commands/DeleteGroupCommand.d.ts +7 -21
- package/dist-types/commands/DeleteIndexCommand.d.ts +6 -12
- package/dist-types/commands/DeletePluginCommand.d.ts +6 -12
- package/dist-types/commands/DeleteRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/DeleteUserCommand.d.ts +6 -12
- package/dist-types/commands/DeleteWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/DisassociatePermissionCommand.d.ts +7 -14
- package/dist-types/commands/GetApplicationCommand.d.ts +5 -10
- package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/GetDataAccessorCommand.d.ts +6 -14
- package/dist-types/commands/GetDataSourceCommand.d.ts +5 -10
- package/dist-types/commands/GetGroupCommand.d.ts +6 -12
- package/dist-types/commands/GetIndexCommand.d.ts +5 -10
- package/dist-types/commands/GetMediaCommand.d.ts +7 -16
- package/dist-types/commands/GetPluginCommand.d.ts +5 -10
- package/dist-types/commands/GetPolicyCommand.d.ts +6 -12
- package/dist-types/commands/GetRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/GetUserCommand.d.ts +7 -14
- package/dist-types/commands/GetWebExperienceCommand.d.ts +5 -10
- package/dist-types/commands/ListApplicationsCommand.d.ts +5 -15
- package/dist-types/commands/ListAttachmentsCommand.d.ts +6 -12
- package/dist-types/commands/ListConversationsCommand.d.ts +6 -12
- package/dist-types/commands/ListDataAccessorsCommand.d.ts +6 -13
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +6 -12
- package/dist-types/commands/ListDataSourcesCommand.d.ts +5 -10
- package/dist-types/commands/ListDocumentsCommand.d.ts +7 -11
- package/dist-types/commands/ListGroupsCommand.d.ts +7 -13
- package/dist-types/commands/ListIndicesCommand.d.ts +5 -10
- package/dist-types/commands/ListMessagesCommand.d.ts +7 -13
- package/dist-types/commands/ListPluginActionsCommand.d.ts +6 -11
- package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +6 -11
- package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +4 -8
- package/dist-types/commands/ListPluginsCommand.d.ts +5 -10
- package/dist-types/commands/ListRetrieversCommand.d.ts +5 -10
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +6 -12
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -12
- package/dist-types/commands/ListWebExperiencesCommand.d.ts +5 -10
- package/dist-types/commands/PutFeedbackCommand.d.ts +6 -12
- package/dist-types/commands/PutGroupCommand.d.ts +7 -23
- package/dist-types/commands/SearchRelevantContentCommand.d.ts +7 -18
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +7 -14
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +7 -14
- package/dist-types/commands/TagResourceCommand.d.ts +7 -15
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -10
- package/dist-types/commands/UpdateApplicationCommand.d.ts +7 -25
- package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +10 -14
- package/dist-types/commands/UpdateDataAccessorCommand.d.ts +7 -15
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +6 -12
- package/dist-types/commands/UpdateIndexCommand.d.ts +6 -12
- package/dist-types/commands/UpdatePluginCommand.d.ts +6 -12
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/UpdateSubscriptionCommand.d.ts +7 -16
- package/dist-types/commands/UpdateUserCommand.d.ts +8 -10
- package/dist-types/commands/UpdateWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +1 -39
- package/dist-types/models/models_0.d.ts +542 -1258
- package/dist-types/models/models_1.d.ts +309 -175
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/QBusiness.d.ts +17 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CheckDocumentAccessCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDocumentsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessagesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginTypeActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +61 -64
- package/dist-types/ts3.4/models/models_1.d.ts +73 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +5 -5
|
@@ -80,8 +80,7 @@ export interface PrincipalUser {
|
|
|
80
80
|
membershipType?: MembershipType | undefined;
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
|
-
* <p>Provides user and group information used for filtering documents to use for generating
|
|
84
|
-
* Amazon Q Business conversation responses.</p>
|
|
83
|
+
* <p>Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.</p>
|
|
85
84
|
* @public
|
|
86
85
|
*/
|
|
87
86
|
export type Principal = Principal.GroupMember | Principal.UserMember | Principal.$UnknownMember;
|
|
@@ -123,16 +122,12 @@ export declare namespace Principal {
|
|
|
123
122
|
const visit: <T>(value: Principal, visitor: Visitor<T>) => T;
|
|
124
123
|
}
|
|
125
124
|
/**
|
|
126
|
-
* <p>A list of principals. Each principal can be either a <code>USER</code> or a
|
|
127
|
-
* <code>GROUP</code> and can be designated document access permissions of either
|
|
128
|
-
* <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
125
|
+
* <p>A list of principals. Each principal can be either a <code>USER</code> or a <code>GROUP</code> and can be designated document access permissions of either <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
129
126
|
* @public
|
|
130
127
|
*/
|
|
131
128
|
export interface AccessControl {
|
|
132
129
|
/**
|
|
133
|
-
* <p>Contains a list of principals, where a principal can be either a <code>USER</code> or
|
|
134
|
-
* a <code>GROUP</code>. Each principal can be have the following type of document access:
|
|
135
|
-
* <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
130
|
+
* <p>Contains a list of principals, where a principal can be either a <code>USER</code> or a <code>GROUP</code>. Each principal can be have the following type of document access: <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
136
131
|
* @public
|
|
137
132
|
*/
|
|
138
133
|
principals: Principal[] | undefined;
|
|
@@ -159,8 +154,7 @@ export interface AccessConfiguration {
|
|
|
159
154
|
memberRelation?: MemberRelation | undefined;
|
|
160
155
|
}
|
|
161
156
|
/**
|
|
162
|
-
* <p> You don't have access to perform this action. Make sure you have the required
|
|
163
|
-
* permission policies and user accounts and try again.</p>
|
|
157
|
+
* <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
|
|
164
158
|
* @public
|
|
165
159
|
*/
|
|
166
160
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -172,8 +166,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
172
166
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
173
167
|
}
|
|
174
168
|
/**
|
|
175
|
-
* <p>The value of a document attribute. You can only provide one value for a document
|
|
176
|
-
* attribute.</p>
|
|
169
|
+
* <p>The value of a document attribute. You can only provide one value for a document attribute.</p>
|
|
177
170
|
* @public
|
|
178
171
|
*/
|
|
179
172
|
export type DocumentAttributeValue = DocumentAttributeValue.DateValueMember | DocumentAttributeValue.LongValueMember | DocumentAttributeValue.StringListValueMember | DocumentAttributeValue.StringValueMember | DocumentAttributeValue.$UnknownMember;
|
|
@@ -215,10 +208,7 @@ export declare namespace DocumentAttributeValue {
|
|
|
215
208
|
$unknown?: never;
|
|
216
209
|
}
|
|
217
210
|
/**
|
|
218
|
-
* <p>A date expressed as an ISO 8601 string.</p>
|
|
219
|
-
* <p>It's important for the time zone to be included in the ISO 8601 date-time format. For
|
|
220
|
-
* example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012
|
|
221
|
-
* at 12:30PM (plus 10 seconds) in Central European Time. </p>
|
|
211
|
+
* <p>A date expressed as an ISO 8601 string.</p> <p>It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. </p>
|
|
222
212
|
* @public
|
|
223
213
|
*/
|
|
224
214
|
interface DateValueMember {
|
|
@@ -275,8 +265,7 @@ export interface ActionExecutionPayloadField {
|
|
|
275
265
|
value: __DocumentType | undefined;
|
|
276
266
|
}
|
|
277
267
|
/**
|
|
278
|
-
* <p>Performs an Amazon Q Business plugin action during a non-streaming chat
|
|
279
|
-
* conversation.</p>
|
|
268
|
+
* <p>Performs an Amazon Q Business plugin action during a non-streaming chat conversation.</p>
|
|
280
269
|
* @public
|
|
281
270
|
*/
|
|
282
271
|
export interface ActionExecution {
|
|
@@ -286,21 +275,18 @@ export interface ActionExecution {
|
|
|
286
275
|
*/
|
|
287
276
|
pluginId: string | undefined;
|
|
288
277
|
/**
|
|
289
|
-
* <p>A mapping of field names to the field values in input that an end user provides to
|
|
290
|
-
* Amazon Q Business requests to perform their plugin action. </p>
|
|
278
|
+
* <p>A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action. </p>
|
|
291
279
|
* @public
|
|
292
280
|
*/
|
|
293
281
|
payload: Record<string, ActionExecutionPayloadField> | undefined;
|
|
294
282
|
/**
|
|
295
|
-
* <p>A string used to retain information about the hierarchical contexts within an action
|
|
296
|
-
* execution event payload.</p>
|
|
283
|
+
* <p>A string used to retain information about the hierarchical contexts within an action execution event payload.</p>
|
|
297
284
|
* @public
|
|
298
285
|
*/
|
|
299
286
|
payloadFieldNameSeparator: string | undefined;
|
|
300
287
|
}
|
|
301
288
|
/**
|
|
302
|
-
* <p>A request from an end user signalling an intent to perform an Amazon Q Business plugin
|
|
303
|
-
* action during a streaming chat.</p>
|
|
289
|
+
* <p>A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.</p>
|
|
304
290
|
* @public
|
|
305
291
|
*/
|
|
306
292
|
export interface ActionExecutionEvent {
|
|
@@ -310,14 +296,12 @@ export interface ActionExecutionEvent {
|
|
|
310
296
|
*/
|
|
311
297
|
pluginId: string | undefined;
|
|
312
298
|
/**
|
|
313
|
-
* <p>A mapping of field names to the field values in input that an end user provides to
|
|
314
|
-
* Amazon Q Business requests to perform their plugin action. </p>
|
|
299
|
+
* <p>A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action. </p>
|
|
315
300
|
* @public
|
|
316
301
|
*/
|
|
317
302
|
payload: Record<string, ActionExecutionPayloadField> | undefined;
|
|
318
303
|
/**
|
|
319
|
-
* <p>A string used to retain information about the hierarchical contexts within a action
|
|
320
|
-
* execution event payload.</p>
|
|
304
|
+
* <p>A string used to retain information about the hierarchical contexts within a action execution event payload.</p>
|
|
321
305
|
* @public
|
|
322
306
|
*/
|
|
323
307
|
payloadFieldNameSeparator: string | undefined;
|
|
@@ -337,8 +321,7 @@ export declare const ActionPayloadFieldType: {
|
|
|
337
321
|
*/
|
|
338
322
|
export type ActionPayloadFieldType = (typeof ActionPayloadFieldType)[keyof typeof ActionPayloadFieldType];
|
|
339
323
|
/**
|
|
340
|
-
* <p>Information about the field values that an end user can use to provide to
|
|
341
|
-
* Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
324
|
+
* <p>Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
342
325
|
* @public
|
|
343
326
|
*/
|
|
344
327
|
export interface ActionReviewPayloadFieldAllowedValue {
|
|
@@ -369,9 +352,7 @@ export interface ActionReviewPayloadField {
|
|
|
369
352
|
*/
|
|
370
353
|
displayOrder?: number | undefined;
|
|
371
354
|
/**
|
|
372
|
-
* <p>The field level description of each action review input field. This could be an
|
|
373
|
-
* explanation of the field. In the Amazon Q Business web experience, these descriptions could
|
|
374
|
-
* be used to display as tool tips to help users understand the field. </p>
|
|
355
|
+
* <p>The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field. </p>
|
|
375
356
|
* @public
|
|
376
357
|
*/
|
|
377
358
|
displayDescription?: string | undefined;
|
|
@@ -386,21 +367,17 @@ export interface ActionReviewPayloadField {
|
|
|
386
367
|
*/
|
|
387
368
|
value?: __DocumentType | undefined;
|
|
388
369
|
/**
|
|
389
|
-
* <p>Information about the field values that an end user can use to provide to
|
|
390
|
-
* Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
370
|
+
* <p>Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
391
371
|
* @public
|
|
392
372
|
*/
|
|
393
373
|
allowedValues?: ActionReviewPayloadFieldAllowedValue[] | undefined;
|
|
394
374
|
/**
|
|
395
|
-
* <p>The expected data format for the action review input field value. For example, in PTO
|
|
396
|
-
* request, <code>from</code> and <code>to</code> would be of <code>datetime</code> allowed
|
|
397
|
-
* format. </p>
|
|
375
|
+
* <p>The expected data format for the action review input field value. For example, in PTO request, <code>from</code> and <code>to</code> would be of <code>datetime</code> allowed format. </p>
|
|
398
376
|
* @public
|
|
399
377
|
*/
|
|
400
378
|
allowedFormat?: string | undefined;
|
|
401
379
|
/**
|
|
402
|
-
* <p>Use to create a custom form with array fields (fields with nested objects inside an
|
|
403
|
-
* array).</p>
|
|
380
|
+
* <p>Use to create a custom form with array fields (fields with nested objects inside an array).</p>
|
|
404
381
|
* @public
|
|
405
382
|
*/
|
|
406
383
|
arrayItemJsonSchema?: __DocumentType | undefined;
|
|
@@ -438,10 +415,7 @@ export declare const PluginType: {
|
|
|
438
415
|
*/
|
|
439
416
|
export type PluginType = (typeof PluginType)[keyof typeof PluginType];
|
|
440
417
|
/**
|
|
441
|
-
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin
|
|
442
|
-
* action during a non-streaming chat conversation. It contains information about the
|
|
443
|
-
* selected action with a list of possible user input fields, some pre-populated by
|
|
444
|
-
* Amazon Q Business.</p>
|
|
418
|
+
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.</p>
|
|
445
419
|
* @public
|
|
446
420
|
*/
|
|
447
421
|
export interface ActionReview {
|
|
@@ -456,29 +430,23 @@ export interface ActionReview {
|
|
|
456
430
|
*/
|
|
457
431
|
pluginType?: PluginType | undefined;
|
|
458
432
|
/**
|
|
459
|
-
* <p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to
|
|
460
|
-
* perform the requested plugin action.</p>
|
|
433
|
+
* <p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
461
434
|
* @public
|
|
462
435
|
*/
|
|
463
436
|
payload?: Record<string, ActionReviewPayloadField> | undefined;
|
|
464
437
|
/**
|
|
465
|
-
* <p>A string used to retain information about the hierarchical contexts within an action
|
|
466
|
-
* review payload.</p>
|
|
438
|
+
* <p>A string used to retain information about the hierarchical contexts within an action review payload.</p>
|
|
467
439
|
* @public
|
|
468
440
|
*/
|
|
469
441
|
payloadFieldNameSeparator?: string | undefined;
|
|
470
442
|
}
|
|
471
443
|
/**
|
|
472
|
-
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin
|
|
473
|
-
* action during a streaming chat conversation. It contains information about the selected
|
|
474
|
-
* action with a list of possible user input fields, some pre-populated by Amazon Q Business.
|
|
475
|
-
* </p>
|
|
444
|
+
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business. </p>
|
|
476
445
|
* @public
|
|
477
446
|
*/
|
|
478
447
|
export interface ActionReviewEvent {
|
|
479
448
|
/**
|
|
480
|
-
* <p>The identifier of the conversation with which the action review event is
|
|
481
|
-
* associated.</p>
|
|
449
|
+
* <p>The identifier of the conversation with which the action review event is associated.</p>
|
|
482
450
|
* @public
|
|
483
451
|
*/
|
|
484
452
|
conversationId?: string | undefined;
|
|
@@ -488,8 +456,7 @@ export interface ActionReviewEvent {
|
|
|
488
456
|
*/
|
|
489
457
|
userMessageId?: string | undefined;
|
|
490
458
|
/**
|
|
491
|
-
* <p>The identifier of an Amazon Q Business AI generated associated with the action review
|
|
492
|
-
* event.</p>
|
|
459
|
+
* <p>The identifier of an Amazon Q Business AI generated associated with the action review event.</p>
|
|
493
460
|
* @public
|
|
494
461
|
*/
|
|
495
462
|
systemMessageId?: string | undefined;
|
|
@@ -504,14 +471,12 @@ export interface ActionReviewEvent {
|
|
|
504
471
|
*/
|
|
505
472
|
pluginType?: PluginType | undefined;
|
|
506
473
|
/**
|
|
507
|
-
* <p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to
|
|
508
|
-
* perform the requested plugin action.</p>
|
|
474
|
+
* <p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
509
475
|
* @public
|
|
510
476
|
*/
|
|
511
477
|
payload?: Record<string, ActionReviewPayloadField> | undefined;
|
|
512
478
|
/**
|
|
513
|
-
* <p>A string used to retain information about the hierarchical contexts within an action
|
|
514
|
-
* review event payload.</p>
|
|
479
|
+
* <p>A string used to retain information about the hierarchical contexts within an action review event payload.</p>
|
|
515
480
|
* @public
|
|
516
481
|
*/
|
|
517
482
|
payloadFieldNameSeparator?: string | undefined;
|
|
@@ -527,24 +492,12 @@ export interface ActionSummary {
|
|
|
527
492
|
*/
|
|
528
493
|
actionIdentifier?: string | undefined;
|
|
529
494
|
/**
|
|
530
|
-
* <p>The display name assigned by Amazon Q Business to a plugin action. You can't
|
|
531
|
-
* modify this value.</p>
|
|
495
|
+
* <p>The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.</p>
|
|
532
496
|
* @public
|
|
533
497
|
*/
|
|
534
498
|
displayName?: string | undefined;
|
|
535
499
|
/**
|
|
536
|
-
* <p>An Amazon Q Business suggested prompt and end user can use to invoke a plugin
|
|
537
|
-
* action. This value can be modified and sent as input to initiate an action. For
|
|
538
|
-
* example:</p>
|
|
539
|
-
* <ul>
|
|
540
|
-
* <li>
|
|
541
|
-
* <p>Create a Jira task</p>
|
|
542
|
-
* </li>
|
|
543
|
-
* <li>
|
|
544
|
-
* <p>Create a chat assistant task to find the root cause of a specific
|
|
545
|
-
* incident</p>
|
|
546
|
-
* </li>
|
|
547
|
-
* </ul>
|
|
500
|
+
* <p>An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:</p> <ul> <li> <p>Create a Jira task</p> </li> <li> <p>Create a chat assistant task to find the root cause of a specific incident</p> </li> </ul>
|
|
548
501
|
* @public
|
|
549
502
|
*/
|
|
550
503
|
instructionExample?: string | undefined;
|
|
@@ -555,8 +508,7 @@ export interface ActionSummary {
|
|
|
555
508
|
description?: string | undefined;
|
|
556
509
|
}
|
|
557
510
|
/**
|
|
558
|
-
* <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
|
|
559
|
-
* bucket.</p>
|
|
511
|
+
* <p>Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.</p>
|
|
560
512
|
* @public
|
|
561
513
|
*/
|
|
562
514
|
export interface S3 {
|
|
@@ -572,10 +524,7 @@ export interface S3 {
|
|
|
572
524
|
key: string | undefined;
|
|
573
525
|
}
|
|
574
526
|
/**
|
|
575
|
-
* <p>Contains details about the OpenAPI schema for a custom plugin. For more information,
|
|
576
|
-
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema">custom plugin OpenAPI schemas</a>. You can either include
|
|
577
|
-
* the schema directly in the payload field or you can upload it to an S3 bucket and
|
|
578
|
-
* specify the S3 bucket location in the <code>s3</code> field. </p>
|
|
527
|
+
* <p>Contains details about the OpenAPI schema for a custom plugin. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema">custom plugin OpenAPI schemas</a>. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the <code>s3</code> field. </p>
|
|
579
528
|
* @public
|
|
580
529
|
*/
|
|
581
530
|
export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema.$UnknownMember;
|
|
@@ -584,8 +533,7 @@ export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema
|
|
|
584
533
|
*/
|
|
585
534
|
export declare namespace APISchema {
|
|
586
535
|
/**
|
|
587
|
-
* <p>The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
|
|
588
|
-
* </p>
|
|
536
|
+
* <p>The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin. </p>
|
|
589
537
|
* @public
|
|
590
538
|
*/
|
|
591
539
|
interface PayloadMember {
|
|
@@ -594,8 +542,7 @@ export declare namespace APISchema {
|
|
|
594
542
|
$unknown?: never;
|
|
595
543
|
}
|
|
596
544
|
/**
|
|
597
|
-
* <p>Contains details about the S3 object containing the OpenAPI schema for a custom
|
|
598
|
-
* plugin. The schema could be in either JSON or YAML format.</p>
|
|
545
|
+
* <p>Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.</p>
|
|
599
546
|
* @public
|
|
600
547
|
*/
|
|
601
548
|
interface S3Member {
|
|
@@ -644,16 +591,12 @@ export declare const IdentityType: {
|
|
|
644
591
|
*/
|
|
645
592
|
export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
|
|
646
593
|
/**
|
|
647
|
-
* <p>The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
|
|
648
|
-
* For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html">Creating an
|
|
649
|
-
* Amazon QuickSight integrated application</a>.</p>
|
|
594
|
+
* <p>The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html">Creating an Amazon QuickSight integrated application</a>.</p>
|
|
650
595
|
* @public
|
|
651
596
|
*/
|
|
652
597
|
export interface QuickSightConfiguration {
|
|
653
598
|
/**
|
|
654
|
-
* <p>The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see
|
|
655
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html">Namespace operations</a>.
|
|
656
|
-
* </p>
|
|
599
|
+
* <p>The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see <a href="https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html">Namespace operations</a>. </p>
|
|
657
600
|
* @public
|
|
658
601
|
*/
|
|
659
602
|
clientNamespace: string | undefined;
|
|
@@ -699,8 +642,7 @@ export interface Application {
|
|
|
699
642
|
*/
|
|
700
643
|
updatedAt?: Date | undefined;
|
|
701
644
|
/**
|
|
702
|
-
* <p>The status of the Amazon Q Business application. The application is ready to use when the
|
|
703
|
-
* status is <code>ACTIVE</code>.</p>
|
|
645
|
+
* <p>The status of the Amazon Q Business application. The application is ready to use when the status is <code>ACTIVE</code>.</p>
|
|
704
646
|
* @public
|
|
705
647
|
*/
|
|
706
648
|
status?: ApplicationStatus | undefined;
|
|
@@ -716,8 +658,7 @@ export interface Application {
|
|
|
716
658
|
quickSightConfiguration?: QuickSightConfiguration | undefined;
|
|
717
659
|
}
|
|
718
660
|
/**
|
|
719
|
-
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
720
|
-
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
661
|
+
* <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
|
|
721
662
|
* @public
|
|
722
663
|
*/
|
|
723
664
|
export declare class ConflictException extends __BaseException {
|
|
@@ -756,21 +697,18 @@ export type AttachmentsControlMode = (typeof AttachmentsControlMode)[keyof typeo
|
|
|
756
697
|
*/
|
|
757
698
|
export interface AttachmentsConfiguration {
|
|
758
699
|
/**
|
|
759
|
-
* <p>Status information about whether file upload functionality is activated or deactivated
|
|
760
|
-
* for your end user.</p>
|
|
700
|
+
* <p>Status information about whether file upload functionality is activated or deactivated for your end user.</p>
|
|
761
701
|
* @public
|
|
762
702
|
*/
|
|
763
703
|
attachmentsControlMode: AttachmentsControlMode | undefined;
|
|
764
704
|
}
|
|
765
705
|
/**
|
|
766
|
-
* <p>Provides the identifier of the KMS key used to encrypt data indexed by
|
|
767
|
-
* Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.</p>
|
|
706
|
+
* <p>Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.</p>
|
|
768
707
|
* @public
|
|
769
708
|
*/
|
|
770
709
|
export interface EncryptionConfiguration {
|
|
771
710
|
/**
|
|
772
|
-
* <p>The identifier of the KMS key. Amazon Q Business doesn't support asymmetric
|
|
773
|
-
* keys.</p>
|
|
711
|
+
* <p>The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.</p>
|
|
774
712
|
* @public
|
|
775
713
|
*/
|
|
776
714
|
kmsKeyId?: string | undefined;
|
|
@@ -788,15 +726,12 @@ export declare const PersonalizationControlMode: {
|
|
|
788
726
|
*/
|
|
789
727
|
export type PersonalizationControlMode = (typeof PersonalizationControlMode)[keyof typeof PersonalizationControlMode];
|
|
790
728
|
/**
|
|
791
|
-
* <p>Configuration information about chat response personalization. For more information,
|
|
792
|
-
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
729
|
+
* <p>Configuration information about chat response personalization. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
793
730
|
* @public
|
|
794
731
|
*/
|
|
795
732
|
export interface PersonalizationConfiguration {
|
|
796
733
|
/**
|
|
797
|
-
* <p>An option to allow Amazon Q Business to customize chat responses using user
|
|
798
|
-
* specific metadata—specifically, location and job information—in your
|
|
799
|
-
* IAM Identity Center instance.</p>
|
|
734
|
+
* <p>An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.</p>
|
|
800
735
|
* @public
|
|
801
736
|
*/
|
|
802
737
|
personalizationControlMode: PersonalizationControlMode | undefined;
|
|
@@ -819,28 +754,23 @@ export type QAppsControlMode = (typeof QAppsControlMode)[keyof typeof QAppsContr
|
|
|
819
754
|
*/
|
|
820
755
|
export interface QAppsConfiguration {
|
|
821
756
|
/**
|
|
822
|
-
* <p>Status information about whether end users can create and use Amazon Q Apps in the web
|
|
823
|
-
* experience.</p>
|
|
757
|
+
* <p>Status information about whether end users can create and use Amazon Q Apps in the web experience.</p>
|
|
824
758
|
* @public
|
|
825
759
|
*/
|
|
826
760
|
qAppsControlMode: QAppsControlMode | undefined;
|
|
827
761
|
}
|
|
828
762
|
/**
|
|
829
|
-
* <p>A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and
|
|
830
|
-
* values can consist of Unicode letters, digits, white space, and any of the following
|
|
831
|
-
* symbols: _ . : / = + - @.</p>
|
|
763
|
+
* <p>A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
832
764
|
* @public
|
|
833
765
|
*/
|
|
834
766
|
export interface Tag {
|
|
835
767
|
/**
|
|
836
|
-
* <p> The key for the tag. Keys are not case sensitive and must be unique for the
|
|
837
|
-
* Amazon Q Business application or data source.</p>
|
|
768
|
+
* <p> The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.</p>
|
|
838
769
|
* @public
|
|
839
770
|
*/
|
|
840
771
|
key: string | undefined;
|
|
841
772
|
/**
|
|
842
|
-
* <p>The value associated with the tag. The value may be an empty string but it can't be
|
|
843
|
-
* null.</p>
|
|
773
|
+
* <p>The value associated with the tag. The value may be an empty string but it can't be null.</p>
|
|
844
774
|
* @public
|
|
845
775
|
*/
|
|
846
776
|
value: string | undefined;
|
|
@@ -855,9 +785,7 @@ export interface CreateApplicationRequest {
|
|
|
855
785
|
*/
|
|
856
786
|
displayName: string | undefined;
|
|
857
787
|
/**
|
|
858
|
-
* <p> The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon
|
|
859
|
-
* CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions">service linked role (SLR)</a> and use it as the
|
|
860
|
-
* application's role.</p>
|
|
788
|
+
* <p> The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions">service linked role (SLR)</a> and use it as the application's role.</p>
|
|
861
789
|
* @public
|
|
862
790
|
*/
|
|
863
791
|
roleArn?: string | undefined;
|
|
@@ -872,8 +800,7 @@ export interface CreateApplicationRequest {
|
|
|
872
800
|
*/
|
|
873
801
|
iamIdentityProviderArn?: string | undefined;
|
|
874
802
|
/**
|
|
875
|
-
* <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either
|
|
876
|
-
* creating for—or connecting to—your Amazon Q Business application.</p>
|
|
803
|
+
* <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.</p>
|
|
877
804
|
* @public
|
|
878
805
|
*/
|
|
879
806
|
identityCenterInstanceArn?: string | undefined;
|
|
@@ -888,22 +815,17 @@ export interface CreateApplicationRequest {
|
|
|
888
815
|
*/
|
|
889
816
|
description?: string | undefined;
|
|
890
817
|
/**
|
|
891
|
-
* <p>The identifier of the KMS key that is used to encrypt your data.
|
|
892
|
-
* Amazon Q Business doesn't support asymmetric keys.</p>
|
|
818
|
+
* <p>The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.</p>
|
|
893
819
|
* @public
|
|
894
820
|
*/
|
|
895
821
|
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
896
822
|
/**
|
|
897
|
-
* <p>A list of key-value pairs that identify or categorize your Amazon Q Business application.
|
|
898
|
-
* You can also use tags to help control access to the application. Tag keys and values can
|
|
899
|
-
* consist of Unicode letters, digits, white space, and any of the following symbols: _ . :
|
|
900
|
-
* / = + - @.</p>
|
|
823
|
+
* <p>A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
901
824
|
* @public
|
|
902
825
|
*/
|
|
903
826
|
tags?: Tag[] | undefined;
|
|
904
827
|
/**
|
|
905
|
-
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
906
|
-
* application.</p>
|
|
828
|
+
* <p>A token that you provide to identify the request to create your Amazon Q Business application.</p>
|
|
907
829
|
* @public
|
|
908
830
|
*/
|
|
909
831
|
clientToken?: string | undefined;
|
|
@@ -913,22 +835,17 @@ export interface CreateApplicationRequest {
|
|
|
913
835
|
*/
|
|
914
836
|
attachmentsConfiguration?: AttachmentsConfiguration | undefined;
|
|
915
837
|
/**
|
|
916
|
-
* <p>An option to allow end users to create and use Amazon Q Apps in the web
|
|
917
|
-
* experience.</p>
|
|
838
|
+
* <p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>
|
|
918
839
|
* @public
|
|
919
840
|
*/
|
|
920
841
|
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
921
842
|
/**
|
|
922
|
-
* <p>Configuration information about chat response personalization. For more information,
|
|
923
|
-
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>
|
|
924
|
-
* </p>
|
|
843
|
+
* <p>Configuration information about chat response personalization. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a> </p>
|
|
925
844
|
* @public
|
|
926
845
|
*/
|
|
927
846
|
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
928
847
|
/**
|
|
929
|
-
* <p>The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is
|
|
930
|
-
* required if your application uses QuickSight as the identity provider. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html">Creating an
|
|
931
|
-
* Amazon QuickSight integrated application</a>.</p>
|
|
848
|
+
* <p>The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html">Creating an Amazon QuickSight integrated application</a>.</p>
|
|
932
849
|
* @public
|
|
933
850
|
*/
|
|
934
851
|
quickSightConfiguration?: QuickSightConfiguration | undefined;
|
|
@@ -949,8 +866,7 @@ export interface CreateApplicationResponse {
|
|
|
949
866
|
applicationArn?: string | undefined;
|
|
950
867
|
}
|
|
951
868
|
/**
|
|
952
|
-
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
953
|
-
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
869
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
954
870
|
* @public
|
|
955
871
|
*/
|
|
956
872
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -962,8 +878,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
962
878
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
963
879
|
}
|
|
964
880
|
/**
|
|
965
|
-
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
966
|
-
* provided the correct resource and try again.</p>
|
|
881
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
|
|
967
882
|
* @public
|
|
968
883
|
*/
|
|
969
884
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -1007,8 +922,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
1007
922
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
1008
923
|
}
|
|
1009
924
|
/**
|
|
1010
|
-
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
1011
|
-
* again.</p>
|
|
925
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
|
|
1012
926
|
* @public
|
|
1013
927
|
*/
|
|
1014
928
|
export declare class ThrottlingException extends __BaseException {
|
|
@@ -1020,8 +934,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
1020
934
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
1021
935
|
}
|
|
1022
936
|
/**
|
|
1023
|
-
* <p>The input failed to meet the constraints specified by Amazon Q Business in a specified
|
|
1024
|
-
* field.</p>
|
|
937
|
+
* <p>The input failed to meet the constraints specified by Amazon Q Business in a specified field.</p>
|
|
1025
938
|
* @public
|
|
1026
939
|
*/
|
|
1027
940
|
export interface ValidationExceptionField {
|
|
@@ -1050,8 +963,7 @@ export declare const ValidationExceptionReason: {
|
|
|
1050
963
|
*/
|
|
1051
964
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
1052
965
|
/**
|
|
1053
|
-
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
1054
|
-
* correct input and try again.</p>
|
|
966
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
|
|
1055
967
|
* @public
|
|
1056
968
|
*/
|
|
1057
969
|
export declare class ValidationException extends __BaseException {
|
|
@@ -1234,14 +1146,12 @@ export interface GetApplicationRequest {
|
|
|
1234
1146
|
applicationId: string | undefined;
|
|
1235
1147
|
}
|
|
1236
1148
|
/**
|
|
1237
|
-
* <p>Configuration information about the file upload during chat feature for your
|
|
1238
|
-
* application.</p>
|
|
1149
|
+
* <p>Configuration information about the file upload during chat feature for your application.</p>
|
|
1239
1150
|
* @public
|
|
1240
1151
|
*/
|
|
1241
1152
|
export interface AppliedAttachmentsConfiguration {
|
|
1242
1153
|
/**
|
|
1243
|
-
* <p>Information about whether file upload during chat functionality is activated for your
|
|
1244
|
-
* application.</p>
|
|
1154
|
+
* <p>Information about whether file upload during chat functionality is activated for your application.</p>
|
|
1245
1155
|
* @public
|
|
1246
1156
|
*/
|
|
1247
1157
|
attachmentsControlMode?: AttachmentsControlMode | undefined;
|
|
@@ -1271,22 +1181,17 @@ export declare const SubscriptionType: {
|
|
|
1271
1181
|
*/
|
|
1272
1182
|
export type SubscriptionType = (typeof SubscriptionType)[keyof typeof SubscriptionType];
|
|
1273
1183
|
/**
|
|
1274
|
-
* <p>Subscription configuration information for an Amazon Q Business application
|
|
1275
|
-
* using IAM identity federation for user management. </p>
|
|
1184
|
+
* <p>Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. </p>
|
|
1276
1185
|
* @public
|
|
1277
1186
|
*/
|
|
1278
1187
|
export interface AutoSubscriptionConfiguration {
|
|
1279
1188
|
/**
|
|
1280
|
-
* <p>Describes whether automatic subscriptions are enabled for an Amazon Q Business
|
|
1281
|
-
* application using IAM identity federation for user management.</p>
|
|
1189
|
+
* <p>Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.</p>
|
|
1282
1190
|
* @public
|
|
1283
1191
|
*/
|
|
1284
1192
|
autoSubscribe: AutoSubscriptionStatus | undefined;
|
|
1285
1193
|
/**
|
|
1286
|
-
* <p>Describes the default subscription type assigned to an Amazon Q Business
|
|
1287
|
-
* application using IAM identity federation for user management. If the
|
|
1288
|
-
* value for <code>autoSubscribe</code> is set to <code>ENABLED</code> you must select a
|
|
1289
|
-
* value for this field.</p>
|
|
1194
|
+
* <p>Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for <code>autoSubscribe</code> is set to <code>ENABLED</code> you must select a value for this field.</p>
|
|
1290
1195
|
* @public
|
|
1291
1196
|
*/
|
|
1292
1197
|
defaultSubscriptionType?: SubscriptionType | undefined;
|
|
@@ -1351,14 +1256,12 @@ export interface GetApplicationResponse {
|
|
|
1351
1256
|
*/
|
|
1352
1257
|
iamIdentityProviderArn?: string | undefined;
|
|
1353
1258
|
/**
|
|
1354
|
-
* <p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to
|
|
1355
|
-
* your Amazon Q Business application.</p>
|
|
1259
|
+
* <p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.</p>
|
|
1356
1260
|
* @public
|
|
1357
1261
|
*/
|
|
1358
1262
|
identityCenterApplicationArn?: string | undefined;
|
|
1359
1263
|
/**
|
|
1360
|
-
* <p>The Amazon Resource Name (ARN) of the IAM with permissions to access
|
|
1361
|
-
* your CloudWatch logs and metrics.</p>
|
|
1264
|
+
* <p>The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.</p>
|
|
1362
1265
|
* @public
|
|
1363
1266
|
*/
|
|
1364
1267
|
roleArn?: string | undefined;
|
|
@@ -1373,9 +1276,7 @@ export interface GetApplicationResponse {
|
|
|
1373
1276
|
*/
|
|
1374
1277
|
description?: string | undefined;
|
|
1375
1278
|
/**
|
|
1376
|
-
* <p>The identifier of the Amazon Web Services
|
|
1377
|
-
* KMS key that is used to encrypt your data. Amazon Q Business doesn't support
|
|
1378
|
-
* asymmetric keys.</p>
|
|
1279
|
+
* <p>The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.</p>
|
|
1379
1280
|
* @public
|
|
1380
1281
|
*/
|
|
1381
1282
|
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
@@ -1390,9 +1291,7 @@ export interface GetApplicationResponse {
|
|
|
1390
1291
|
*/
|
|
1391
1292
|
updatedAt?: Date | undefined;
|
|
1392
1293
|
/**
|
|
1393
|
-
* <p>If the <code>Status</code> field is set to <code>ERROR</code>, the
|
|
1394
|
-
* <code>ErrorMessage</code> field contains a description of the error that caused the
|
|
1395
|
-
* synchronization to fail.</p>
|
|
1294
|
+
* <p>If the <code>Status</code> field is set to <code>ERROR</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the synchronization to fail.</p>
|
|
1396
1295
|
* @public
|
|
1397
1296
|
*/
|
|
1398
1297
|
error?: ErrorDetail | undefined;
|
|
@@ -1402,20 +1301,17 @@ export interface GetApplicationResponse {
|
|
|
1402
1301
|
*/
|
|
1403
1302
|
attachmentsConfiguration?: AppliedAttachmentsConfiguration | undefined;
|
|
1404
1303
|
/**
|
|
1405
|
-
* <p>Settings for whether end users can create and use Amazon Q Apps in the web
|
|
1406
|
-
* experience.</p>
|
|
1304
|
+
* <p>Settings for whether end users can create and use Amazon Q Apps in the web experience.</p>
|
|
1407
1305
|
* @public
|
|
1408
1306
|
*/
|
|
1409
1307
|
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
1410
1308
|
/**
|
|
1411
|
-
* <p>Configuration information about chat response personalization. For more information,
|
|
1412
|
-
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
1309
|
+
* <p>Configuration information about chat response personalization. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
1413
1310
|
* @public
|
|
1414
1311
|
*/
|
|
1415
1312
|
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
1416
1313
|
/**
|
|
1417
|
-
* <p>Settings for auto-subscription behavior for this application. This is only applicable
|
|
1418
|
-
* to SAML and OIDC applications.</p>
|
|
1314
|
+
* <p>Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.</p>
|
|
1419
1315
|
* @public
|
|
1420
1316
|
*/
|
|
1421
1317
|
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration | undefined;
|
|
@@ -1473,29 +1369,22 @@ export interface CreateIndexRequest {
|
|
|
1473
1369
|
*/
|
|
1474
1370
|
description?: string | undefined;
|
|
1475
1371
|
/**
|
|
1476
|
-
* <p>The index type that's suitable for your needs. For more information on what's included
|
|
1477
|
-
* in each type of index, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers">Amazon Q Business
|
|
1478
|
-
* tiers</a>.</p>
|
|
1372
|
+
* <p>The index type that's suitable for your needs. For more information on what's included in each type of index, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers">Amazon Q Business tiers</a>.</p>
|
|
1479
1373
|
* @public
|
|
1480
1374
|
*/
|
|
1481
1375
|
type?: IndexType | undefined;
|
|
1482
1376
|
/**
|
|
1483
|
-
* <p>A list of key-value pairs that identify or categorize the index. You can also use tags
|
|
1484
|
-
* to help control access to the index. Tag keys and values can consist of Unicode letters,
|
|
1485
|
-
* digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
1377
|
+
* <p>A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
1486
1378
|
* @public
|
|
1487
1379
|
*/
|
|
1488
1380
|
tags?: Tag[] | undefined;
|
|
1489
1381
|
/**
|
|
1490
|
-
* <p>The capacity units you want to provision for your index. You can add and remove
|
|
1491
|
-
* capacity to fit your usage needs.</p>
|
|
1382
|
+
* <p>The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.</p>
|
|
1492
1383
|
* @public
|
|
1493
1384
|
*/
|
|
1494
1385
|
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
1495
1386
|
/**
|
|
1496
|
-
* <p>A token that you provide to identify the request to create an index. Multiple calls to
|
|
1497
|
-
* the <code>CreateIndex</code> API with the same client token will create only one
|
|
1498
|
-
* index.</p>
|
|
1387
|
+
* <p>A token that you provide to identify the request to create an index. Multiple calls to the <code>CreateIndex</code> API with the same client token will create only one index.</p>
|
|
1499
1388
|
* @public
|
|
1500
1389
|
*/
|
|
1501
1390
|
clientToken?: string | undefined;
|
|
@@ -1537,43 +1426,22 @@ export declare const DocumentEnrichmentConditionOperator: {
|
|
|
1537
1426
|
*/
|
|
1538
1427
|
export type DocumentEnrichmentConditionOperator = (typeof DocumentEnrichmentConditionOperator)[keyof typeof DocumentEnrichmentConditionOperator];
|
|
1539
1428
|
/**
|
|
1540
|
-
* <p>The condition used for the target document attribute or metadata field when ingesting
|
|
1541
|
-
* documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
1542
|
-
* <code>DocumentAttributeTarget</code>
|
|
1543
|
-
* </a> to apply the condition.</p>
|
|
1544
|
-
* <p>For example, you can create the 'Department' target field and have it prefill
|
|
1545
|
-
* department names associated with the documents based on information in the 'Source_URI'
|
|
1546
|
-
* field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI
|
|
1547
|
-
* value, then prefill the target field 'Department' with the target value 'Finance' for
|
|
1548
|
-
* the document.</p>
|
|
1549
|
-
* <p>Amazon Q Business can't create a target field if it has not already been created as an
|
|
1550
|
-
* index field. After you create your index field, you can create a document metadata field
|
|
1551
|
-
* using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly
|
|
1552
|
-
* created metadata field to your index field.</p>
|
|
1429
|
+
* <p>The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html"> <code>DocumentAttributeTarget</code> </a> to apply the condition.</p> <p>For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.</p> <p>Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly created metadata field to your index field.</p>
|
|
1553
1430
|
* @public
|
|
1554
1431
|
*/
|
|
1555
1432
|
export interface DocumentAttributeCondition {
|
|
1556
1433
|
/**
|
|
1557
|
-
* <p>The identifier of the document attribute used for the condition.</p>
|
|
1558
|
-
* <p>For example, 'Source_URI' could be an identifier for the attribute or metadata field
|
|
1559
|
-
* that contains source URIs associated with the documents.</p>
|
|
1560
|
-
* <p>Amazon Q Business currently doesn't support <code>_document_body</code> as an attribute
|
|
1561
|
-
* key used for the condition.</p>
|
|
1434
|
+
* <p>The identifier of the document attribute used for the condition.</p> <p>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</p> <p>Amazon Q Business currently doesn't support <code>_document_body</code> as an attribute key used for the condition.</p>
|
|
1562
1435
|
* @public
|
|
1563
1436
|
*/
|
|
1564
1437
|
key: string | undefined;
|
|
1565
1438
|
/**
|
|
1566
|
-
* <p>The identifier of the document attribute used for the condition.</p>
|
|
1567
|
-
* <p>For example, 'Source_URI' could be an identifier for the attribute or metadata field
|
|
1568
|
-
* that contains source URIs associated with the documents.</p>
|
|
1569
|
-
* <p>Amazon Q Business currently does not support <code>_document_body</code> as an attribute
|
|
1570
|
-
* key used for the condition.</p>
|
|
1439
|
+
* <p>The identifier of the document attribute used for the condition.</p> <p>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</p> <p>Amazon Q Business currently does not support <code>_document_body</code> as an attribute key used for the condition.</p>
|
|
1571
1440
|
* @public
|
|
1572
1441
|
*/
|
|
1573
1442
|
operator: DocumentEnrichmentConditionOperator | undefined;
|
|
1574
1443
|
/**
|
|
1575
|
-
* <p>The value of a document attribute. You can only provide one value for a document
|
|
1576
|
-
* attribute.</p>
|
|
1444
|
+
* <p>The value of a document attribute. You can only provide one value for a document attribute.</p>
|
|
1577
1445
|
* @public
|
|
1578
1446
|
*/
|
|
1579
1447
|
value?: DocumentAttributeValue | undefined;
|
|
@@ -1601,190 +1469,90 @@ export declare const AttributeValueOperator: {
|
|
|
1601
1469
|
*/
|
|
1602
1470
|
export type AttributeValueOperator = (typeof AttributeValueOperator)[keyof typeof AttributeValueOperator];
|
|
1603
1471
|
/**
|
|
1604
|
-
* <p>The target document attribute or metadata field you want to alter when ingesting
|
|
1605
|
-
* documents into Amazon Q Business.</p>
|
|
1606
|
-
* <p>For example, you can delete all customer identification numbers associated with the
|
|
1607
|
-
* documents, stored in the document metadata field called 'Customer_ID' by setting the
|
|
1608
|
-
* target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This removes all
|
|
1609
|
-
* customer ID values in the field 'Customer_ID'. This would scrub personally identifiable
|
|
1610
|
-
* information from each document's metadata.</p>
|
|
1611
|
-
* <p>Amazon Q Business can't create a target field if it has not already been created as an
|
|
1612
|
-
* index field. After you create your index field, you can create a document metadata field
|
|
1613
|
-
* using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
1614
|
-
* <code>DocumentAttributeTarget</code>
|
|
1615
|
-
* </a>. Amazon Q Business
|
|
1616
|
-
* will then map your newly created document attribute to your index field.</p>
|
|
1617
|
-
* <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html">
|
|
1618
|
-
* <code>DocumentAttributeCondition</code>
|
|
1619
|
-
* </a>.</p>
|
|
1472
|
+
* <p>The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.</p> <p>For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.</p> <p>Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html"> <code>DocumentAttributeTarget</code> </a>. Amazon Q Business will then map your newly created document attribute to your index field.</p> <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html"> <code>DocumentAttributeCondition</code> </a>.</p>
|
|
1620
1473
|
* @public
|
|
1621
1474
|
*/
|
|
1622
1475
|
export interface DocumentAttributeTarget {
|
|
1623
1476
|
/**
|
|
1624
|
-
* <p>The identifier of the target document attribute or metadata field. For example,
|
|
1625
|
-
* 'Department' could be an identifier for the target attribute or metadata field that
|
|
1626
|
-
* includes the department names associated with the documents.</p>
|
|
1477
|
+
* <p>The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.</p>
|
|
1627
1478
|
* @public
|
|
1628
1479
|
*/
|
|
1629
1480
|
key: string | undefined;
|
|
1630
1481
|
/**
|
|
1631
|
-
* <p>The value of a document attribute. You can only provide one value for a document
|
|
1632
|
-
* attribute.</p>
|
|
1482
|
+
* <p>The value of a document attribute. You can only provide one value for a document attribute.</p>
|
|
1633
1483
|
* @public
|
|
1634
1484
|
*/
|
|
1635
1485
|
value?: DocumentAttributeValue | undefined;
|
|
1636
1486
|
/**
|
|
1637
|
-
* <p>
|
|
1638
|
-
* <code>TRUE</code> to delete the existing target value for your specified target
|
|
1639
|
-
* attribute key. You cannot create a target value and set this to
|
|
1640
|
-
* <code>TRUE</code>.</p>
|
|
1487
|
+
* <p> <code>TRUE</code> to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to <code>TRUE</code>.</p>
|
|
1641
1488
|
* @public
|
|
1642
1489
|
*/
|
|
1643
1490
|
attributeValueOperator?: AttributeValueOperator | undefined;
|
|
1644
1491
|
}
|
|
1645
1492
|
/**
|
|
1646
|
-
* <p>Provides the configuration information for applying basic logic to alter document
|
|
1647
|
-
* metadata and content when ingesting documents into Amazon Q Business.</p>
|
|
1648
|
-
* <p>To apply advanced logic, to go beyond what you can do with basic logic, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html">
|
|
1649
|
-
* <code>HookConfiguration</code>
|
|
1650
|
-
* </a>.</p>
|
|
1651
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
|
|
1493
|
+
* <p>Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.</p> <p>To apply advanced logic, to go beyond what you can do with basic logic, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html"> <code>HookConfiguration</code> </a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
|
|
1652
1494
|
* @public
|
|
1653
1495
|
*/
|
|
1654
1496
|
export interface InlineDocumentEnrichmentConfiguration {
|
|
1655
1497
|
/**
|
|
1656
|
-
* <p>The condition used for the target document attribute or metadata field when ingesting
|
|
1657
|
-
* documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
1658
|
-
* <code>DocumentAttributeTarget</code>
|
|
1659
|
-
* </a> to apply the condition.</p>
|
|
1660
|
-
* <p>For example, you can create the 'Department' target field and have it prefill
|
|
1661
|
-
* department names associated with the documents based on information in the 'Source_URI'
|
|
1662
|
-
* field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI
|
|
1663
|
-
* value, then prefill the target field 'Department' with the target value 'Finance' for
|
|
1664
|
-
* the document.</p>
|
|
1665
|
-
* <p>Amazon Q Business can't create a target field if it has not already been created as an
|
|
1666
|
-
* index field. After you create your index field, you can create a document metadata field
|
|
1667
|
-
* using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly
|
|
1668
|
-
* created metadata field to your index field.</p>
|
|
1498
|
+
* <p>The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html"> <code>DocumentAttributeTarget</code> </a> to apply the condition.</p> <p>For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.</p> <p>Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly created metadata field to your index field.</p>
|
|
1669
1499
|
* @public
|
|
1670
1500
|
*/
|
|
1671
1501
|
condition?: DocumentAttributeCondition | undefined;
|
|
1672
1502
|
/**
|
|
1673
|
-
* <p>The target document attribute or metadata field you want to alter when ingesting
|
|
1674
|
-
* documents into Amazon Q Business.</p>
|
|
1675
|
-
* <p>For example, you can delete all customer identification numbers associated with the
|
|
1676
|
-
* documents, stored in the document metadata field called 'Customer_ID' by setting the
|
|
1677
|
-
* target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This removes all
|
|
1678
|
-
* customer ID values in the field 'Customer_ID'. This would scrub personally identifiable
|
|
1679
|
-
* information from each document's metadata.</p>
|
|
1680
|
-
* <p>Amazon Q Business can't create a target field if it has not already been created as an
|
|
1681
|
-
* index field. After you create your index field, you can create a document metadata field
|
|
1682
|
-
* using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
1683
|
-
* <code>DocumentAttributeTarget</code>
|
|
1684
|
-
* </a>. Amazon Q Business
|
|
1685
|
-
* will then map your newly created document attribute to your index field.</p>
|
|
1686
|
-
* <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html">
|
|
1687
|
-
* <code>DocumentAttributeCondition</code>
|
|
1688
|
-
* </a>.</p>
|
|
1503
|
+
* <p>The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.</p> <p>For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.</p> <p>Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html"> <code>DocumentAttributeTarget</code> </a>. Amazon Q Business will then map your newly created document attribute to your index field.</p> <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html"> <code>DocumentAttributeCondition</code> </a>.</p>
|
|
1689
1504
|
* @public
|
|
1690
1505
|
*/
|
|
1691
1506
|
target?: DocumentAttributeTarget | undefined;
|
|
1692
1507
|
/**
|
|
1693
|
-
* <p>
|
|
1694
|
-
* <code>TRUE</code> to delete content if the condition used for the target attribute is
|
|
1695
|
-
* met.</p>
|
|
1508
|
+
* <p> <code>TRUE</code> to delete content if the condition used for the target attribute is met.</p>
|
|
1696
1509
|
* @public
|
|
1697
1510
|
*/
|
|
1698
1511
|
documentContentOperator?: DocumentContentOperator | undefined;
|
|
1699
1512
|
}
|
|
1700
1513
|
/**
|
|
1701
|
-
* <p>Provides the configuration information for invoking a Lambda function in
|
|
1702
|
-
* Lambda to alter document metadata and content when ingesting
|
|
1703
|
-
* documents into Amazon Q Business.</p>
|
|
1704
|
-
* <p>You can configure your Lambda function using the
|
|
1705
|
-
* <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced
|
|
1706
|
-
* alterations on the original or raw documents.</p>
|
|
1707
|
-
* <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
|
|
1708
|
-
* you must configure your Lambda function using
|
|
1709
|
-
* <code>PostExtractionHookConfiguration</code>.</p>
|
|
1710
|
-
* <p>You can only invoke one Lambda function. However, this function can invoke
|
|
1711
|
-
* other functions it requires.</p>
|
|
1712
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
|
|
1514
|
+
* <p>Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.</p> <p>You can configure your Lambda function using the <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced alterations on the original or raw documents.</p> <p>If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using <code>PostExtractionHookConfiguration</code>.</p> <p>You can only invoke one Lambda function. However, this function can invoke other functions it requires.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
|
|
1713
1515
|
* @public
|
|
1714
1516
|
*/
|
|
1715
1517
|
export interface HookConfiguration {
|
|
1716
1518
|
/**
|
|
1717
|
-
* <p>The condition used for when a Lambda function should be invoked.</p>
|
|
1718
|
-
* <p>For example, you can specify a condition that if there are empty date-time values,
|
|
1719
|
-
* then Amazon Q Business should invoke a function that inserts the current date-time.</p>
|
|
1519
|
+
* <p>The condition used for when a Lambda function should be invoked.</p> <p>For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.</p>
|
|
1720
1520
|
* @public
|
|
1721
1521
|
*/
|
|
1722
1522
|
invocationCondition?: DocumentAttributeCondition | undefined;
|
|
1723
1523
|
/**
|
|
1724
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
1725
|
-
* function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role">IAM roles for
|
|
1726
|
-
* Custom Document Enrichment (CDE)</a>.</p>
|
|
1524
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function sduring ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cde-lambda-operations.html">Using Lambda functions for Amazon Q Business document enrichment</a>.</p>
|
|
1727
1525
|
* @public
|
|
1728
1526
|
*/
|
|
1729
1527
|
lambdaArn?: string | undefined;
|
|
1730
1528
|
/**
|
|
1731
|
-
* <p>Stores the original, raw documents or the structured, parsed documents before and
|
|
1732
|
-
* after altering them. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts">Data contracts for Lambda functions</a>.</p>
|
|
1529
|
+
* <p>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts">Data contracts for Lambda functions</a>.</p>
|
|
1733
1530
|
* @public
|
|
1734
1531
|
*/
|
|
1735
1532
|
s3BucketName?: string | undefined;
|
|
1736
1533
|
/**
|
|
1737
|
-
* <p>The Amazon Resource Name (ARN) of a role with permission to run
|
|
1738
|
-
* <code>PreExtractionHookConfiguration</code> and
|
|
1739
|
-
* <code>PostExtractionHookConfiguration</code> for altering document metadata and
|
|
1740
|
-
* content during the document ingestion process.</p>
|
|
1534
|
+
* <p>The Amazon Resource Name (ARN) of a role with permission to run <code>PreExtractionHookConfiguration</code> and <code>PostExtractionHookConfiguration</code> for altering document metadata and content during the document ingestion process.</p>
|
|
1741
1535
|
* @public
|
|
1742
1536
|
*/
|
|
1743
1537
|
roleArn?: string | undefined;
|
|
1744
1538
|
}
|
|
1745
1539
|
/**
|
|
1746
|
-
* <p>Provides the configuration information for altering document metadata and content
|
|
1747
|
-
* during the document ingestion process.</p>
|
|
1748
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document
|
|
1749
|
-
* enrichment</a>.</p>
|
|
1540
|
+
* <p>Provides the configuration information for altering document metadata and content during the document ingestion process.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>.</p>
|
|
1750
1541
|
* @public
|
|
1751
1542
|
*/
|
|
1752
1543
|
export interface DocumentEnrichmentConfiguration {
|
|
1753
1544
|
/**
|
|
1754
|
-
* <p>Configuration information to alter document attributes or metadata fields and content
|
|
1755
|
-
* when ingesting documents into Amazon Q Business.</p>
|
|
1545
|
+
* <p>Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.</p>
|
|
1756
1546
|
* @public
|
|
1757
1547
|
*/
|
|
1758
1548
|
inlineConfigurations?: InlineDocumentEnrichmentConfiguration[] | undefined;
|
|
1759
1549
|
/**
|
|
1760
|
-
* <p>Provides the configuration information for invoking a Lambda function in
|
|
1761
|
-
* Lambda to alter document metadata and content when ingesting
|
|
1762
|
-
* documents into Amazon Q Business.</p>
|
|
1763
|
-
* <p>You can configure your Lambda function using the
|
|
1764
|
-
* <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced
|
|
1765
|
-
* alterations on the original or raw documents.</p>
|
|
1766
|
-
* <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
|
|
1767
|
-
* you must configure your Lambda function using
|
|
1768
|
-
* <code>PostExtractionHookConfiguration</code>.</p>
|
|
1769
|
-
* <p>You can only invoke one Lambda function. However, this function can invoke
|
|
1770
|
-
* other functions it requires.</p>
|
|
1771
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
|
|
1550
|
+
* <p>Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.</p> <p>You can configure your Lambda function using the <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced alterations on the original or raw documents.</p> <p>If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using <code>PostExtractionHookConfiguration</code>.</p> <p>You can only invoke one Lambda function. However, this function can invoke other functions it requires.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
|
|
1772
1551
|
* @public
|
|
1773
1552
|
*/
|
|
1774
1553
|
preExtractionHookConfiguration?: HookConfiguration | undefined;
|
|
1775
1554
|
/**
|
|
1776
|
-
* <p>Provides the configuration information for invoking a Lambda function in
|
|
1777
|
-
* Lambda to alter document metadata and content when ingesting
|
|
1778
|
-
* documents into Amazon Q Business.</p>
|
|
1779
|
-
* <p>You can configure your Lambda function using the
|
|
1780
|
-
* <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced
|
|
1781
|
-
* alterations on the original or raw documents.</p>
|
|
1782
|
-
* <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
|
|
1783
|
-
* you must configure your Lambda function using
|
|
1784
|
-
* <code>PostExtractionHookConfiguration</code>.</p>
|
|
1785
|
-
* <p>You can only invoke one Lambda function. However, this function can invoke
|
|
1786
|
-
* other functions it requires.</p>
|
|
1787
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
|
|
1555
|
+
* <p>Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.</p> <p>You can configure your Lambda function using the <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced alterations on the original or raw documents.</p> <p>If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using <code>PostExtractionHookConfiguration</code>.</p> <p>You can only invoke one Lambda function. However, this function can invoke other functions it requires.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
|
|
1788
1556
|
* @public
|
|
1789
1557
|
*/
|
|
1790
1558
|
postExtractionHookConfiguration?: HookConfiguration | undefined;
|
|
@@ -1864,8 +1632,7 @@ export interface VideoExtractionConfiguration {
|
|
|
1864
1632
|
*/
|
|
1865
1633
|
export interface MediaExtractionConfiguration {
|
|
1866
1634
|
/**
|
|
1867
|
-
* <p>The configuration for extracting semantic meaning from images in documents.
|
|
1868
|
-
* For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html">Extracting semantic meaning from images and visuals</a>. </p>
|
|
1635
|
+
* <p>The configuration for extracting semantic meaning from images in documents. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html">Extracting semantic meaning from images and visuals</a>. </p>
|
|
1869
1636
|
* @public
|
|
1870
1637
|
*/
|
|
1871
1638
|
imageExtractionConfiguration?: ImageExtractionConfiguration | undefined;
|
|
@@ -1881,21 +1648,17 @@ export interface MediaExtractionConfiguration {
|
|
|
1881
1648
|
videoExtractionConfiguration?: VideoExtractionConfiguration | undefined;
|
|
1882
1649
|
}
|
|
1883
1650
|
/**
|
|
1884
|
-
* <p>Provides configuration information needed to connect to an Amazon VPC (Virtual
|
|
1885
|
-
* Private Cloud).</p>
|
|
1651
|
+
* <p>Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).</p>
|
|
1886
1652
|
* @public
|
|
1887
1653
|
*/
|
|
1888
1654
|
export interface DataSourceVpcConfiguration {
|
|
1889
1655
|
/**
|
|
1890
|
-
* <p>A list of identifiers for subnets within your Amazon VPC. The subnets should
|
|
1891
|
-
* be able to connect to each other in the VPC, and they should have outgoing access to the
|
|
1892
|
-
* Internet through a NAT device.</p>
|
|
1656
|
+
* <p>A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.</p>
|
|
1893
1657
|
* @public
|
|
1894
1658
|
*/
|
|
1895
1659
|
subnetIds: string[] | undefined;
|
|
1896
1660
|
/**
|
|
1897
|
-
* <p>A list of identifiers of security groups within your Amazon VPC. The security
|
|
1898
|
-
* groups should enable Amazon Q Business to connect to the data source.</p>
|
|
1661
|
+
* <p>A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.</p>
|
|
1899
1662
|
* @public
|
|
1900
1663
|
*/
|
|
1901
1664
|
securityGroupIds: string[] | undefined;
|
|
@@ -1905,14 +1668,12 @@ export interface DataSourceVpcConfiguration {
|
|
|
1905
1668
|
*/
|
|
1906
1669
|
export interface CreateDataSourceRequest {
|
|
1907
1670
|
/**
|
|
1908
|
-
* <p> The identifier of the Amazon Q Business application the data source will be attached
|
|
1909
|
-
* to.</p>
|
|
1671
|
+
* <p> The identifier of the Amazon Q Business application the data source will be attached to.</p>
|
|
1910
1672
|
* @public
|
|
1911
1673
|
*/
|
|
1912
1674
|
applicationId: string | undefined;
|
|
1913
1675
|
/**
|
|
1914
|
-
* <p>The identifier of the index that you want to use with the data source
|
|
1915
|
-
* connector.</p>
|
|
1676
|
+
* <p>The identifier of the index that you want to use with the data source connector.</p>
|
|
1916
1677
|
* @public
|
|
1917
1678
|
*/
|
|
1918
1679
|
indexId: string | undefined;
|
|
@@ -1922,43 +1683,12 @@ export interface CreateDataSourceRequest {
|
|
|
1922
1683
|
*/
|
|
1923
1684
|
displayName: string | undefined;
|
|
1924
1685
|
/**
|
|
1925
|
-
* <p>Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration
|
|
1926
|
-
* information specific to your data source connector.</p>
|
|
1927
|
-
* <p>Each data source has a JSON schema provided by Amazon Q Business that you must
|
|
1928
|
-
* use. For example, the Amazon S3 and Web Crawler connectors require the following
|
|
1929
|
-
* JSON schemas:</p>
|
|
1930
|
-
* <ul>
|
|
1931
|
-
* <li>
|
|
1932
|
-
* <p>
|
|
1933
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-api.html">Amazon S3 JSON schema</a>
|
|
1934
|
-
* </p>
|
|
1935
|
-
* </li>
|
|
1936
|
-
* <li>
|
|
1937
|
-
* <p>
|
|
1938
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html">Web Crawler JSON schema</a>
|
|
1939
|
-
* </p>
|
|
1940
|
-
* </li>
|
|
1941
|
-
* </ul>
|
|
1942
|
-
* <p>You can find configuration templates for your specific data source using the following
|
|
1943
|
-
* steps:</p>
|
|
1944
|
-
* <ol>
|
|
1945
|
-
* <li>
|
|
1946
|
-
* <p>Navigate to the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html">Supported
|
|
1947
|
-
* connectors</a> page in the Amazon Q Business User Guide, and
|
|
1948
|
-
* select the data source of your choice.</p>
|
|
1949
|
-
* </li>
|
|
1950
|
-
* <li>
|
|
1951
|
-
* <p>Then, from your specific data source connector page, select <b>Using the API</b>. You will find the JSON schema for your
|
|
1952
|
-
* data source, including parameter descriptions, in this section.</p>
|
|
1953
|
-
* </li>
|
|
1954
|
-
* </ol>
|
|
1686
|
+
* <p>Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.</p> <p>Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-api.html">Amazon S3 JSON schema</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html">Web Crawler JSON schema</a> </p> </li> </ul> <p>You can find configuration templates for your specific data source using the following steps:</p> <ol> <li> <p>Navigate to the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html">Supported connectors</a> page in the Amazon Q Business User Guide, and select the data source of your choice.</p> </li> <li> <p>Then, from your specific data source connector page, select <b>Using the API</b>. You will find the JSON schema for your data source, including parameter descriptions, in this section.</p> </li> </ol>
|
|
1955
1687
|
* @public
|
|
1956
1688
|
*/
|
|
1957
1689
|
configuration: __DocumentType | undefined;
|
|
1958
1690
|
/**
|
|
1959
|
-
* <p>Configuration information for an Amazon VPC (Virtual Private Cloud) to connect
|
|
1960
|
-
* to your data source. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html">Using
|
|
1961
|
-
* Amazon VPC with Amazon Q Business connectors</a>.</p>
|
|
1691
|
+
* <p>Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html">Using Amazon VPC with Amazon Q Business connectors</a>.</p>
|
|
1962
1692
|
* @public
|
|
1963
1693
|
*/
|
|
1964
1694
|
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
@@ -1968,42 +1698,27 @@ export interface CreateDataSourceRequest {
|
|
|
1968
1698
|
*/
|
|
1969
1699
|
description?: string | undefined;
|
|
1970
1700
|
/**
|
|
1971
|
-
* <p>A list of key-value pairs that identify or categorize the data source connector. You
|
|
1972
|
-
* can also use tags to help control access to the data source connector. Tag keys and
|
|
1973
|
-
* values can consist of Unicode letters, digits, white space, and any of the following
|
|
1974
|
-
* symbols: _ . : / = + - @.</p>
|
|
1701
|
+
* <p>A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
1975
1702
|
* @public
|
|
1976
1703
|
*/
|
|
1977
1704
|
tags?: Tag[] | undefined;
|
|
1978
1705
|
/**
|
|
1979
|
-
* <p>Sets the frequency for Amazon Q Business to check the documents in your data source
|
|
1980
|
-
* repository and update your index. If you don't set a schedule, Amazon Q Business won't
|
|
1981
|
-
* periodically update the index.</p>
|
|
1982
|
-
* <p>Specify a <code>cron-</code> format schedule string or an empty string to indicate
|
|
1983
|
-
* that the index is updated on demand. You can't specify the <code>Schedule</code>
|
|
1984
|
-
* parameter when the <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
1985
|
-
* you receive a <code>ValidationException</code> exception. </p>
|
|
1706
|
+
* <p>Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.</p> <p>Specify a <code>cron-</code> format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the <code>Schedule</code> parameter when the <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code> exception. </p>
|
|
1986
1707
|
* @public
|
|
1987
1708
|
*/
|
|
1988
1709
|
syncSchedule?: string | undefined;
|
|
1989
1710
|
/**
|
|
1990
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
1991
|
-
* the data source and required resources.</p>
|
|
1711
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.</p>
|
|
1992
1712
|
* @public
|
|
1993
1713
|
*/
|
|
1994
1714
|
roleArn?: string | undefined;
|
|
1995
1715
|
/**
|
|
1996
|
-
* <p>A token you provide to identify a request to create a data source connector. Multiple
|
|
1997
|
-
* calls to the <code>CreateDataSource</code> API with the same client token will create
|
|
1998
|
-
* only one data source connector. </p>
|
|
1716
|
+
* <p>A token you provide to identify a request to create a data source connector. Multiple calls to the <code>CreateDataSource</code> API with the same client token will create only one data source connector. </p>
|
|
1999
1717
|
* @public
|
|
2000
1718
|
*/
|
|
2001
1719
|
clientToken?: string | undefined;
|
|
2002
1720
|
/**
|
|
2003
|
-
* <p>Provides the configuration information for altering document metadata and content
|
|
2004
|
-
* during the document ingestion process.</p>
|
|
2005
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document
|
|
2006
|
-
* enrichment</a>.</p>
|
|
1721
|
+
* <p>Provides the configuration information for altering document metadata and content during the document ingestion process.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>.</p>
|
|
2007
1722
|
* @public
|
|
2008
1723
|
*/
|
|
2009
1724
|
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
@@ -2023,8 +1738,7 @@ export interface CreateDataSourceResponse {
|
|
|
2023
1738
|
*/
|
|
2024
1739
|
dataSourceId?: string | undefined;
|
|
2025
1740
|
/**
|
|
2026
|
-
* <p> The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
|
|
2027
|
-
* </p>
|
|
1741
|
+
* <p> The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application. </p>
|
|
2028
1742
|
* @public
|
|
2029
1743
|
*/
|
|
2030
1744
|
dataSourceArn?: string | undefined;
|
|
@@ -2034,8 +1748,7 @@ export interface CreateDataSourceResponse {
|
|
|
2034
1748
|
*/
|
|
2035
1749
|
export interface DeleteDataSourceRequest {
|
|
2036
1750
|
/**
|
|
2037
|
-
* <p>The identifier of the Amazon Q Business application used with the data source
|
|
2038
|
-
* connector.</p>
|
|
1751
|
+
* <p>The identifier of the Amazon Q Business application used with the data source connector.</p>
|
|
2039
1752
|
* @public
|
|
2040
1753
|
*/
|
|
2041
1754
|
applicationId: string | undefined;
|
|
@@ -2131,8 +1844,7 @@ export interface GetDataSourceResponse {
|
|
|
2131
1844
|
*/
|
|
2132
1845
|
configuration?: __DocumentType | undefined;
|
|
2133
1846
|
/**
|
|
2134
|
-
* <p>Configuration information for an Amazon VPC (Virtual Private Cloud) to connect
|
|
2135
|
-
* to your data source.</p>
|
|
1847
|
+
* <p>Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.</p>
|
|
2136
1848
|
* @public
|
|
2137
1849
|
*/
|
|
2138
1850
|
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
@@ -2152,9 +1864,7 @@ export interface GetDataSourceResponse {
|
|
|
2152
1864
|
*/
|
|
2153
1865
|
description?: string | undefined;
|
|
2154
1866
|
/**
|
|
2155
|
-
* <p>The current status of the data source connector. When the <code>Status</code> field
|
|
2156
|
-
* value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description
|
|
2157
|
-
* of the error that caused the data source connector to fail.</p>
|
|
1867
|
+
* <p>The current status of the data source connector. When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>
|
|
2158
1868
|
* @public
|
|
2159
1869
|
*/
|
|
2160
1870
|
status?: DataSourceStatus | undefined;
|
|
@@ -2164,29 +1874,22 @@ export interface GetDataSourceResponse {
|
|
|
2164
1874
|
*/
|
|
2165
1875
|
syncSchedule?: string | undefined;
|
|
2166
1876
|
/**
|
|
2167
|
-
* <p>The Amazon Resource Name (ARN) of the role with permission to access the data source
|
|
2168
|
-
* and required resources.</p>
|
|
1877
|
+
* <p>The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.</p>
|
|
2169
1878
|
* @public
|
|
2170
1879
|
*/
|
|
2171
1880
|
roleArn?: string | undefined;
|
|
2172
1881
|
/**
|
|
2173
|
-
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
2174
|
-
* <code>ErrorMessage</code> field contains a description of the error that caused the
|
|
2175
|
-
* data source connector to fail.</p>
|
|
1882
|
+
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>
|
|
2176
1883
|
* @public
|
|
2177
1884
|
*/
|
|
2178
1885
|
error?: ErrorDetail | undefined;
|
|
2179
1886
|
/**
|
|
2180
|
-
* <p>Provides the configuration information for altering document metadata and content
|
|
2181
|
-
* during the document ingestion process.</p>
|
|
2182
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document
|
|
2183
|
-
* enrichment</a>.</p>
|
|
1887
|
+
* <p>Provides the configuration information for altering document metadata and content during the document ingestion process.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>.</p>
|
|
2184
1888
|
* @public
|
|
2185
1889
|
*/
|
|
2186
1890
|
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
2187
1891
|
/**
|
|
2188
|
-
* <p>The configuration for extracting information from media in documents for the data source.
|
|
2189
|
-
* </p>
|
|
1892
|
+
* <p>The configuration for extracting information from media in documents for the data source. </p>
|
|
2190
1893
|
* @public
|
|
2191
1894
|
*/
|
|
2192
1895
|
mediaExtractionConfiguration?: MediaExtractionConfiguration | undefined;
|
|
@@ -2196,8 +1899,7 @@ export interface GetDataSourceResponse {
|
|
|
2196
1899
|
*/
|
|
2197
1900
|
export interface ListDataSourcesRequest {
|
|
2198
1901
|
/**
|
|
2199
|
-
* <p>The identifier of the Amazon Q Business application linked to the data source
|
|
2200
|
-
* connectors.</p>
|
|
1902
|
+
* <p>The identifier of the Amazon Q Business application linked to the data source connectors.</p>
|
|
2201
1903
|
* @public
|
|
2202
1904
|
*/
|
|
2203
1905
|
applicationId: string | undefined;
|
|
@@ -2207,10 +1909,7 @@ export interface ListDataSourcesRequest {
|
|
|
2207
1909
|
*/
|
|
2208
1910
|
indexId: string | undefined;
|
|
2209
1911
|
/**
|
|
2210
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
2211
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
2212
|
-
* pagination token to retrieve the next set of Amazon Q Business data source
|
|
2213
|
-
* connectors.</p>
|
|
1912
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.</p>
|
|
2214
1913
|
* @public
|
|
2215
1914
|
*/
|
|
2216
1915
|
nextToken?: string | undefined;
|
|
@@ -2266,8 +1965,7 @@ export interface ListDataSourcesResponse {
|
|
|
2266
1965
|
*/
|
|
2267
1966
|
dataSources?: DataSource[] | undefined;
|
|
2268
1967
|
/**
|
|
2269
|
-
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
2270
|
-
* in a subsequent request to retrieve the next set of data source connectors.</p>
|
|
1968
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.</p>
|
|
2271
1969
|
* @public
|
|
2272
1970
|
*/
|
|
2273
1971
|
nextToken?: string | undefined;
|
|
@@ -2277,8 +1975,7 @@ export interface ListDataSourcesResponse {
|
|
|
2277
1975
|
*/
|
|
2278
1976
|
export interface UpdateDataSourceRequest {
|
|
2279
1977
|
/**
|
|
2280
|
-
* <p> The identifier of the Amazon Q Business application the data source is attached
|
|
2281
|
-
* to.</p>
|
|
1978
|
+
* <p> The identifier of the Amazon Q Business application the data source is attached to.</p>
|
|
2282
1979
|
* @public
|
|
2283
1980
|
*/
|
|
2284
1981
|
applicationId: string | undefined;
|
|
@@ -2303,8 +2000,7 @@ export interface UpdateDataSourceRequest {
|
|
|
2303
2000
|
*/
|
|
2304
2001
|
configuration?: __DocumentType | undefined;
|
|
2305
2002
|
/**
|
|
2306
|
-
* <p>Provides configuration information needed to connect to an Amazon VPC (Virtual
|
|
2307
|
-
* Private Cloud).</p>
|
|
2003
|
+
* <p>Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).</p>
|
|
2308
2004
|
* @public
|
|
2309
2005
|
*/
|
|
2310
2006
|
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
@@ -2319,16 +2015,12 @@ export interface UpdateDataSourceRequest {
|
|
|
2319
2015
|
*/
|
|
2320
2016
|
syncSchedule?: string | undefined;
|
|
2321
2017
|
/**
|
|
2322
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
2323
|
-
* the data source and required resources.</p>
|
|
2018
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.</p>
|
|
2324
2019
|
* @public
|
|
2325
2020
|
*/
|
|
2326
2021
|
roleArn?: string | undefined;
|
|
2327
2022
|
/**
|
|
2328
|
-
* <p>Provides the configuration information for altering document metadata and content
|
|
2329
|
-
* during the document ingestion process.</p>
|
|
2330
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document
|
|
2331
|
-
* enrichment</a>.</p>
|
|
2023
|
+
* <p>Provides the configuration information for altering document metadata and content during the document ingestion process.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>.</p>
|
|
2332
2024
|
* @public
|
|
2333
2025
|
*/
|
|
2334
2026
|
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
@@ -2348,8 +2040,7 @@ export interface UpdateDataSourceResponse {
|
|
|
2348
2040
|
*/
|
|
2349
2041
|
export interface DeleteIndexRequest {
|
|
2350
2042
|
/**
|
|
2351
|
-
* <p>The identifier of the Amazon Q Business application the Amazon Q Business index is linked
|
|
2352
|
-
* to.</p>
|
|
2043
|
+
* <p>The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.</p>
|
|
2353
2044
|
* @public
|
|
2354
2045
|
*/
|
|
2355
2046
|
applicationId: string | undefined;
|
|
@@ -2406,10 +2097,7 @@ export declare const AttributeType: {
|
|
|
2406
2097
|
*/
|
|
2407
2098
|
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
2408
2099
|
/**
|
|
2409
|
-
* <p>Configuration information for document attributes. Document attributes are metadata or
|
|
2410
|
-
* fields associated with your documents. For example, the company department name
|
|
2411
|
-
* associated with each document.</p>
|
|
2412
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html">Understanding document attributes</a>.</p>
|
|
2100
|
+
* <p>Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html">Understanding document attributes</a>.</p>
|
|
2413
2101
|
* @public
|
|
2414
2102
|
*/
|
|
2415
2103
|
export interface DocumentAttributeConfiguration {
|
|
@@ -2424,8 +2112,7 @@ export interface DocumentAttributeConfiguration {
|
|
|
2424
2112
|
*/
|
|
2425
2113
|
type?: AttributeType | undefined;
|
|
2426
2114
|
/**
|
|
2427
|
-
* <p>Information about whether the document attribute can be used by an end user to search
|
|
2428
|
-
* for information on their web experience.</p>
|
|
2115
|
+
* <p>Information about whether the document attribute can be used by an end user to search for information on their web experience.</p>
|
|
2429
2116
|
* @public
|
|
2430
2117
|
*/
|
|
2431
2118
|
search?: Status | undefined;
|
|
@@ -2497,9 +2184,7 @@ export interface GetIndexResponse {
|
|
|
2497
2184
|
*/
|
|
2498
2185
|
indexArn?: string | undefined;
|
|
2499
2186
|
/**
|
|
2500
|
-
* <p>The current status of the index. When the value is <code>ACTIVE</code>, the index is
|
|
2501
|
-
* ready for use. If the <code>Status</code> field value is <code>FAILED</code>, the
|
|
2502
|
-
* <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
2187
|
+
* <p>The current status of the index. When the value is <code>ACTIVE</code>, the index is ready for use. If the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
2503
2188
|
* @public
|
|
2504
2189
|
*/
|
|
2505
2190
|
status?: IndexStatus | undefined;
|
|
@@ -2529,15 +2214,12 @@ export interface GetIndexResponse {
|
|
|
2529
2214
|
*/
|
|
2530
2215
|
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
2531
2216
|
/**
|
|
2532
|
-
* <p>Configuration information for document attributes or metadata. Document metadata are
|
|
2533
|
-
* fields associated with your documents. For example, the company department name
|
|
2534
|
-
* associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>
|
|
2217
|
+
* <p>Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>
|
|
2535
2218
|
* @public
|
|
2536
2219
|
*/
|
|
2537
2220
|
documentAttributeConfigurations?: DocumentAttributeConfiguration[] | undefined;
|
|
2538
2221
|
/**
|
|
2539
|
-
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
2540
|
-
* <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
2222
|
+
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
2541
2223
|
* @public
|
|
2542
2224
|
*/
|
|
2543
2225
|
error?: ErrorDetail | undefined;
|
|
@@ -2557,9 +2239,7 @@ export interface ListIndicesRequest {
|
|
|
2557
2239
|
*/
|
|
2558
2240
|
applicationId: string | undefined;
|
|
2559
2241
|
/**
|
|
2560
|
-
* <p>If the maxResults response was incomplete because there is more data to retrieve,
|
|
2561
|
-
* Amazon Q Business returns a pagination token in the response. You can use this pagination
|
|
2562
|
-
* token to retrieve the next set of Amazon Q Business indices.</p>
|
|
2242
|
+
* <p>If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.</p>
|
|
2563
2243
|
* @public
|
|
2564
2244
|
*/
|
|
2565
2245
|
nextToken?: string | undefined;
|
|
@@ -2595,8 +2275,7 @@ export interface Index {
|
|
|
2595
2275
|
*/
|
|
2596
2276
|
updatedAt?: Date | undefined;
|
|
2597
2277
|
/**
|
|
2598
|
-
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the index is
|
|
2599
|
-
* ready.</p>
|
|
2278
|
+
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the index is ready.</p>
|
|
2600
2279
|
* @public
|
|
2601
2280
|
*/
|
|
2602
2281
|
status?: IndexStatus | undefined;
|
|
@@ -2606,8 +2285,7 @@ export interface Index {
|
|
|
2606
2285
|
*/
|
|
2607
2286
|
export interface ListIndicesResponse {
|
|
2608
2287
|
/**
|
|
2609
|
-
* <p>If the response is truncated, Amazon Q Business returns this token that you can use in the
|
|
2610
|
-
* subsequent request to retrieve the next set of indexes.</p>
|
|
2288
|
+
* <p>If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.</p>
|
|
2611
2289
|
* @public
|
|
2612
2290
|
*/
|
|
2613
2291
|
nextToken?: string | undefined;
|
|
@@ -2642,15 +2320,12 @@ export interface UpdateIndexRequest {
|
|
|
2642
2320
|
*/
|
|
2643
2321
|
description?: string | undefined;
|
|
2644
2322
|
/**
|
|
2645
|
-
* <p>The storage capacity units you want to provision for your Amazon Q Business index. You can
|
|
2646
|
-
* add and remove capacity to fit your usage needs.</p>
|
|
2323
|
+
* <p>The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.</p>
|
|
2647
2324
|
* @public
|
|
2648
2325
|
*/
|
|
2649
2326
|
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
2650
2327
|
/**
|
|
2651
|
-
* <p>Configuration information for document metadata or fields. Document metadata are
|
|
2652
|
-
* fields or attributes associated with your documents. For example, the company department
|
|
2653
|
-
* name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>
|
|
2328
|
+
* <p>Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>
|
|
2654
2329
|
* @public
|
|
2655
2330
|
*/
|
|
2656
2331
|
documentAttributeConfigurations?: DocumentAttributeConfiguration[] | undefined;
|
|
@@ -2665,9 +2340,7 @@ export interface UpdateIndexResponse {
|
|
|
2665
2340
|
*/
|
|
2666
2341
|
export interface ListApplicationsRequest {
|
|
2667
2342
|
/**
|
|
2668
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
2669
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
2670
|
-
* pagination token to retrieve the next set of Amazon Q Business applications.</p>
|
|
2343
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.</p>
|
|
2671
2344
|
* @public
|
|
2672
2345
|
*/
|
|
2673
2346
|
nextToken?: string | undefined;
|
|
@@ -2682,33 +2355,28 @@ export interface ListApplicationsRequest {
|
|
|
2682
2355
|
*/
|
|
2683
2356
|
export interface ListApplicationsResponse {
|
|
2684
2357
|
/**
|
|
2685
|
-
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
2686
|
-
* in a subsequent request to retrieve the next set of applications.</p>
|
|
2358
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.</p>
|
|
2687
2359
|
* @public
|
|
2688
2360
|
*/
|
|
2689
2361
|
nextToken?: string | undefined;
|
|
2690
2362
|
/**
|
|
2691
|
-
* <p>An array of summary information on the configuration of one or more Amazon Q Business
|
|
2692
|
-
* applications.</p>
|
|
2363
|
+
* <p>An array of summary information on the configuration of one or more Amazon Q Business applications.</p>
|
|
2693
2364
|
* @public
|
|
2694
2365
|
*/
|
|
2695
2366
|
applications?: Application[] | undefined;
|
|
2696
2367
|
}
|
|
2697
2368
|
/**
|
|
2698
|
-
* <p>Information about the basic authentication credentials used to configure a
|
|
2699
|
-
* plugin.</p>
|
|
2369
|
+
* <p>Information about the basic authentication credentials used to configure a plugin.</p>
|
|
2700
2370
|
* @public
|
|
2701
2371
|
*/
|
|
2702
2372
|
export interface BasicAuthConfiguration {
|
|
2703
2373
|
/**
|
|
2704
|
-
* <p>The ARN of the Secrets Manager secret that stores the basic authentication
|
|
2705
|
-
* credentials used for plugin configuration..</p>
|
|
2374
|
+
* <p>The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..</p>
|
|
2706
2375
|
* @public
|
|
2707
2376
|
*/
|
|
2708
2377
|
secretArn: string | undefined;
|
|
2709
2378
|
/**
|
|
2710
|
-
* <p>The ARN of an IAM role used by Amazon Q Business to access the basic
|
|
2711
|
-
* authentication credentials stored in a Secrets Manager secret.</p>
|
|
2379
|
+
* <p>The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.</p>
|
|
2712
2380
|
* @public
|
|
2713
2381
|
*/
|
|
2714
2382
|
roleArn: string | undefined;
|
|
@@ -2724,46 +2392,39 @@ export interface IdcAuthConfiguration {
|
|
|
2724
2392
|
*/
|
|
2725
2393
|
idcApplicationArn: string | undefined;
|
|
2726
2394
|
/**
|
|
2727
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services
|
|
2728
|
-
* on your behalf.</p>
|
|
2395
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.</p>
|
|
2729
2396
|
* @public
|
|
2730
2397
|
*/
|
|
2731
2398
|
roleArn: string | undefined;
|
|
2732
2399
|
}
|
|
2733
2400
|
/**
|
|
2734
|
-
* <p>Information about invoking a custom plugin without any authentication or authorization
|
|
2735
|
-
* requirement.</p>
|
|
2401
|
+
* <p>Information about invoking a custom plugin without any authentication or authorization requirement.</p>
|
|
2736
2402
|
* @public
|
|
2737
2403
|
*/
|
|
2738
2404
|
export interface NoAuthConfiguration {
|
|
2739
2405
|
}
|
|
2740
2406
|
/**
|
|
2741
|
-
* <p>Information about the OAuth 2.0 authentication credential/token used to configure a
|
|
2742
|
-
* plugin.</p>
|
|
2407
|
+
* <p>Information about the OAuth 2.0 authentication credential/token used to configure a plugin.</p>
|
|
2743
2408
|
* @public
|
|
2744
2409
|
*/
|
|
2745
2410
|
export interface OAuth2ClientCredentialConfiguration {
|
|
2746
2411
|
/**
|
|
2747
|
-
* <p>The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token
|
|
2748
|
-
* used for plugin configuration.</p>
|
|
2412
|
+
* <p>The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.</p>
|
|
2749
2413
|
* @public
|
|
2750
2414
|
*/
|
|
2751
2415
|
secretArn: string | undefined;
|
|
2752
2416
|
/**
|
|
2753
|
-
* <p>The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0
|
|
2754
|
-
* authentication credentials stored in a Secrets Manager secret.</p>
|
|
2417
|
+
* <p>The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.</p>
|
|
2755
2418
|
* @public
|
|
2756
2419
|
*/
|
|
2757
2420
|
roleArn: string | undefined;
|
|
2758
2421
|
/**
|
|
2759
|
-
* <p>The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to
|
|
2760
|
-
* authenticate a plugin user through a third party authentication server.</p>
|
|
2422
|
+
* <p>The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.</p>
|
|
2761
2423
|
* @public
|
|
2762
2424
|
*/
|
|
2763
2425
|
authorizationUrl?: string | undefined;
|
|
2764
2426
|
/**
|
|
2765
|
-
* <p>The URL required by the OAuth 2.0 protocol to exchange an end user authorization code
|
|
2766
|
-
* for an access token.</p>
|
|
2427
|
+
* <p>The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.</p>
|
|
2767
2428
|
* @public
|
|
2768
2429
|
*/
|
|
2769
2430
|
tokenUrl?: string | undefined;
|
|
@@ -2778,8 +2439,7 @@ export type PluginAuthConfiguration = PluginAuthConfiguration.BasicAuthConfigura
|
|
|
2778
2439
|
*/
|
|
2779
2440
|
export declare namespace PluginAuthConfiguration {
|
|
2780
2441
|
/**
|
|
2781
|
-
* <p>Information about the basic authentication credentials used to configure a
|
|
2782
|
-
* plugin.</p>
|
|
2442
|
+
* <p>Information about the basic authentication credentials used to configure a plugin.</p>
|
|
2783
2443
|
* @public
|
|
2784
2444
|
*/
|
|
2785
2445
|
interface BasicAuthConfigurationMember {
|
|
@@ -2790,8 +2450,7 @@ export declare namespace PluginAuthConfiguration {
|
|
|
2790
2450
|
$unknown?: never;
|
|
2791
2451
|
}
|
|
2792
2452
|
/**
|
|
2793
|
-
* <p>Information about the OAuth 2.0 authentication credential/token used to configure a
|
|
2794
|
-
* plugin.</p>
|
|
2453
|
+
* <p>Information about the OAuth 2.0 authentication credential/token used to configure a plugin.</p>
|
|
2795
2454
|
* @public
|
|
2796
2455
|
*/
|
|
2797
2456
|
interface OAuth2ClientCredentialConfigurationMember {
|
|
@@ -2858,8 +2517,7 @@ export interface CustomPluginConfiguration {
|
|
|
2858
2517
|
*/
|
|
2859
2518
|
apiSchemaType: APISchemaType | undefined;
|
|
2860
2519
|
/**
|
|
2861
|
-
* <p>Contains either details about the S3 object containing the OpenAPI schema for the
|
|
2862
|
-
* action group or the JSON or YAML-formatted payload defining the schema.</p>
|
|
2520
|
+
* <p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>
|
|
2863
2521
|
* @public
|
|
2864
2522
|
*/
|
|
2865
2523
|
apiSchema: APISchema | undefined;
|
|
@@ -2899,16 +2557,12 @@ export interface CreatePluginRequest {
|
|
|
2899
2557
|
*/
|
|
2900
2558
|
customPluginConfiguration?: CustomPluginConfiguration | undefined;
|
|
2901
2559
|
/**
|
|
2902
|
-
* <p>A list of key-value pairs that identify or categorize the data source connector. You
|
|
2903
|
-
* can also use tags to help control access to the data source connector. Tag keys and
|
|
2904
|
-
* values can consist of Unicode letters, digits, white space, and any of the following
|
|
2905
|
-
* symbols: _ . : / = + - @.</p>
|
|
2560
|
+
* <p>A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
2906
2561
|
* @public
|
|
2907
2562
|
*/
|
|
2908
2563
|
tags?: Tag[] | undefined;
|
|
2909
2564
|
/**
|
|
2910
|
-
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
2911
|
-
* plugin.</p>
|
|
2565
|
+
* <p>A token that you provide to identify the request to create your Amazon Q Business plugin.</p>
|
|
2912
2566
|
* @public
|
|
2913
2567
|
*/
|
|
2914
2568
|
clientToken?: string | undefined;
|
|
@@ -3042,8 +2696,7 @@ export interface GetPluginResponse {
|
|
|
3042
2696
|
*/
|
|
3043
2697
|
buildStatus?: PluginBuildStatus | undefined;
|
|
3044
2698
|
/**
|
|
3045
|
-
* <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed
|
|
3046
|
-
* to create the plugin.</p>
|
|
2699
|
+
* <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.</p>
|
|
3047
2700
|
* @public
|
|
3048
2701
|
*/
|
|
3049
2702
|
pluginArn?: string | undefined;
|
|
@@ -3073,9 +2726,7 @@ export interface ListPluginsRequest {
|
|
|
3073
2726
|
*/
|
|
3074
2727
|
applicationId: string | undefined;
|
|
3075
2728
|
/**
|
|
3076
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
3077
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
3078
|
-
* pagination token to retrieve the next set of plugins.</p>
|
|
2729
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.</p>
|
|
3079
2730
|
* @public
|
|
3080
2731
|
*/
|
|
3081
2732
|
nextToken?: string | undefined;
|
|
@@ -3136,9 +2787,7 @@ export interface Plugin {
|
|
|
3136
2787
|
*/
|
|
3137
2788
|
export interface ListPluginsResponse {
|
|
3138
2789
|
/**
|
|
3139
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
3140
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
3141
|
-
* pagination token to retrieve the next set of plugins.</p>
|
|
2790
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.</p>
|
|
3142
2791
|
* @public
|
|
3143
2792
|
*/
|
|
3144
2793
|
nextToken?: string | undefined;
|
|
@@ -3220,9 +2869,7 @@ export declare const DocumentAttributeBoostingLevel: {
|
|
|
3220
2869
|
*/
|
|
3221
2870
|
export type DocumentAttributeBoostingLevel = (typeof DocumentAttributeBoostingLevel)[keyof typeof DocumentAttributeBoostingLevel];
|
|
3222
2871
|
/**
|
|
3223
|
-
* <p>Provides information on boosting <code>DATE</code> type document attributes.</p>
|
|
3224
|
-
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
3225
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2872
|
+
* <p>Provides information on boosting <code>DATE</code> type document attributes.</p> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3226
2873
|
* @public
|
|
3227
2874
|
*/
|
|
3228
2875
|
export interface DateAttributeBoostingConfiguration {
|
|
@@ -3232,8 +2879,7 @@ export interface DateAttributeBoostingConfiguration {
|
|
|
3232
2879
|
*/
|
|
3233
2880
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
3234
2881
|
/**
|
|
3235
|
-
* <p>Specifies the duration, in seconds, of a boost applies to a <code>DATE</code> type
|
|
3236
|
-
* document attribute.</p>
|
|
2882
|
+
* <p>Specifies the duration, in seconds, of a boost applies to a <code>DATE</code> type document attribute.</p>
|
|
3237
2883
|
* @public
|
|
3238
2884
|
*/
|
|
3239
2885
|
boostingDurationInSeconds?: number | undefined;
|
|
@@ -3251,15 +2897,12 @@ export declare const NumberAttributeBoostingType: {
|
|
|
3251
2897
|
*/
|
|
3252
2898
|
export type NumberAttributeBoostingType = (typeof NumberAttributeBoostingType)[keyof typeof NumberAttributeBoostingType];
|
|
3253
2899
|
/**
|
|
3254
|
-
* <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p>
|
|
3255
|
-
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
3256
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2900
|
+
* <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3257
2901
|
* @public
|
|
3258
2902
|
*/
|
|
3259
2903
|
export interface NumberAttributeBoostingConfiguration {
|
|
3260
2904
|
/**
|
|
3261
|
-
* <p>Specifies the duration, in seconds, of a boost applies to a <code>NUMBER</code> type
|
|
3262
|
-
* document attribute.</p>
|
|
2905
|
+
* <p>Specifies the duration, in seconds, of a boost applies to a <code>NUMBER</code> type document attribute.</p>
|
|
3263
2906
|
* @public
|
|
3264
2907
|
*/
|
|
3265
2908
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
@@ -3284,16 +2927,7 @@ export declare const StringAttributeValueBoostingLevel: {
|
|
|
3284
2927
|
*/
|
|
3285
2928
|
export type StringAttributeValueBoostingLevel = (typeof StringAttributeValueBoostingLevel)[keyof typeof StringAttributeValueBoostingLevel];
|
|
3286
2929
|
/**
|
|
3287
|
-
* <p>Provides information on boosting <code>STRING</code> type document attributes.</p>
|
|
3288
|
-
* <note>
|
|
3289
|
-
* <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
|
|
3290
|
-
* be used for boosting on the console and the API, they must be enabled for search
|
|
3291
|
-
* using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes,
|
|
3292
|
-
* you can't boost attributes of these data types on either the console or the
|
|
3293
|
-
* API.</p>
|
|
3294
|
-
* </note>
|
|
3295
|
-
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
3296
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2930
|
+
* <p>Provides information on boosting <code>STRING</code> type document attributes.</p> <note> <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to be used for boosting on the console and the API, they must be enabled for search using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.</p> </note> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3297
2931
|
* @public
|
|
3298
2932
|
*/
|
|
3299
2933
|
export interface StringAttributeBoostingConfiguration {
|
|
@@ -3303,24 +2937,13 @@ export interface StringAttributeBoostingConfiguration {
|
|
|
3303
2937
|
*/
|
|
3304
2938
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
3305
2939
|
/**
|
|
3306
|
-
* <p>Specifies specific values of a <code>STRING</code> type document attribute being
|
|
3307
|
-
* boosted.</p>
|
|
2940
|
+
* <p>Specifies specific values of a <code>STRING</code> type document attribute being boosted.</p>
|
|
3308
2941
|
* @public
|
|
3309
2942
|
*/
|
|
3310
2943
|
attributeValueBoosting?: Record<string, StringAttributeValueBoostingLevel> | undefined;
|
|
3311
2944
|
}
|
|
3312
2945
|
/**
|
|
3313
|
-
* <p>Provides information on boosting <code>STRING_LIST</code> type document
|
|
3314
|
-
* attributes.</p>
|
|
3315
|
-
* <note>
|
|
3316
|
-
* <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
|
|
3317
|
-
* be used for boosting on the console and the API, they must be enabled for search
|
|
3318
|
-
* using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes,
|
|
3319
|
-
* you can't boost attributes of these data types on either the console or the
|
|
3320
|
-
* API.</p>
|
|
3321
|
-
* </note>
|
|
3322
|
-
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
3323
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2946
|
+
* <p>Provides information on boosting <code>STRING_LIST</code> type document attributes.</p> <note> <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to be used for boosting on the console and the API, they must be enabled for search using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.</p> </note> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3324
2947
|
* @public
|
|
3325
2948
|
*/
|
|
3326
2949
|
export interface StringListAttributeBoostingConfiguration {
|
|
@@ -3331,19 +2954,7 @@ export interface StringListAttributeBoostingConfiguration {
|
|
|
3331
2954
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
3332
2955
|
}
|
|
3333
2956
|
/**
|
|
3334
|
-
* <p>Provides information on boosting supported Amazon Q Business document attribute types.
|
|
3335
|
-
* When an end user chat query matches document attributes that have been boosted,
|
|
3336
|
-
* Amazon Q Business prioritizes generating responses from content that matches the boosted
|
|
3337
|
-
* document attributes.</p>
|
|
3338
|
-
* <note>
|
|
3339
|
-
* <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
|
|
3340
|
-
* be used for boosting on the console and the API, they must be enabled for search
|
|
3341
|
-
* using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes,
|
|
3342
|
-
* you can't boost attributes of these data types on either the console or the
|
|
3343
|
-
* API.</p>
|
|
3344
|
-
* </note>
|
|
3345
|
-
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
3346
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2957
|
+
* <p>Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.</p> <note> <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to be used for boosting on the console and the API, they must be enabled for search using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.</p> </note> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3347
2958
|
* @public
|
|
3348
2959
|
*/
|
|
3349
2960
|
export type DocumentAttributeBoostingConfiguration = DocumentAttributeBoostingConfiguration.DateConfigurationMember | DocumentAttributeBoostingConfiguration.NumberConfigurationMember | DocumentAttributeBoostingConfiguration.StringConfigurationMember | DocumentAttributeBoostingConfiguration.StringListConfigurationMember | DocumentAttributeBoostingConfiguration.$UnknownMember;
|
|
@@ -3385,8 +2996,7 @@ export declare namespace DocumentAttributeBoostingConfiguration {
|
|
|
3385
2996
|
$unknown?: never;
|
|
3386
2997
|
}
|
|
3387
2998
|
/**
|
|
3388
|
-
* <p>Provides information on boosting <code>STRING_LIST</code> type document
|
|
3389
|
-
* attributes.</p>
|
|
2999
|
+
* <p>Provides information on boosting <code>STRING_LIST</code> type document attributes.</p>
|
|
3390
3000
|
* @public
|
|
3391
3001
|
*/
|
|
3392
3002
|
interface StringListConfigurationMember {
|
|
@@ -3426,15 +3036,13 @@ export interface NativeIndexConfiguration {
|
|
|
3426
3036
|
*/
|
|
3427
3037
|
indexId: string | undefined;
|
|
3428
3038
|
/**
|
|
3429
|
-
* <p>Overrides the default boosts applied by Amazon Q Business to supported document attribute
|
|
3430
|
-
* data types.</p>
|
|
3039
|
+
* <p>Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.</p>
|
|
3431
3040
|
* @public
|
|
3432
3041
|
*/
|
|
3433
3042
|
boostingOverride?: Record<string, DocumentAttributeBoostingConfiguration> | undefined;
|
|
3434
3043
|
}
|
|
3435
3044
|
/**
|
|
3436
|
-
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
3437
|
-
* configured.</p>
|
|
3045
|
+
* <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
|
|
3438
3046
|
* @public
|
|
3439
3047
|
*/
|
|
3440
3048
|
export type RetrieverConfiguration = RetrieverConfiguration.KendraIndexConfigurationMember | RetrieverConfiguration.NativeIndexConfigurationMember | RetrieverConfiguration.$UnknownMember;
|
|
@@ -3443,8 +3051,7 @@ export type RetrieverConfiguration = RetrieverConfiguration.KendraIndexConfigura
|
|
|
3443
3051
|
*/
|
|
3444
3052
|
export declare namespace RetrieverConfiguration {
|
|
3445
3053
|
/**
|
|
3446
|
-
* <p>Provides information on how a Amazon Q Business index used as a retriever for your
|
|
3447
|
-
* Amazon Q Business application is configured.</p>
|
|
3054
|
+
* <p>Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.</p>
|
|
3448
3055
|
* @public
|
|
3449
3056
|
*/
|
|
3450
3057
|
interface NativeIndexConfigurationMember {
|
|
@@ -3453,8 +3060,7 @@ export declare namespace RetrieverConfiguration {
|
|
|
3453
3060
|
$unknown?: never;
|
|
3454
3061
|
}
|
|
3455
3062
|
/**
|
|
3456
|
-
* <p>Provides information on how the Amazon Kendra index used as a retriever for your
|
|
3457
|
-
* Amazon Q Business application is configured.</p>
|
|
3063
|
+
* <p>Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.</p>
|
|
3458
3064
|
* @public
|
|
3459
3065
|
*/
|
|
3460
3066
|
interface KendraIndexConfigurationMember {
|
|
@@ -3509,27 +3115,22 @@ export interface CreateRetrieverRequest {
|
|
|
3509
3115
|
*/
|
|
3510
3116
|
displayName: string | undefined;
|
|
3511
3117
|
/**
|
|
3512
|
-
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
3513
|
-
* configured.</p>
|
|
3118
|
+
* <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
|
|
3514
3119
|
* @public
|
|
3515
3120
|
*/
|
|
3516
3121
|
configuration: RetrieverConfiguration | undefined;
|
|
3517
3122
|
/**
|
|
3518
|
-
* <p>The ARN of an IAM role used by Amazon Q Business to access the basic
|
|
3519
|
-
* authentication credentials stored in a Secrets Manager secret.</p>
|
|
3123
|
+
* <p>The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.</p>
|
|
3520
3124
|
* @public
|
|
3521
3125
|
*/
|
|
3522
3126
|
roleArn?: string | undefined;
|
|
3523
3127
|
/**
|
|
3524
|
-
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
3525
|
-
* application retriever.</p>
|
|
3128
|
+
* <p>A token that you provide to identify the request to create your Amazon Q Business application retriever.</p>
|
|
3526
3129
|
* @public
|
|
3527
3130
|
*/
|
|
3528
3131
|
clientToken?: string | undefined;
|
|
3529
3132
|
/**
|
|
3530
|
-
* <p>A list of key-value pairs that identify or categorize the retriever. You can also use
|
|
3531
|
-
* tags to help control access to the retriever. Tag keys and values can consist of Unicode
|
|
3532
|
-
* letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
3133
|
+
* <p>A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
3533
3134
|
* @public
|
|
3534
3135
|
*/
|
|
3535
3136
|
tags?: Tag[] | undefined;
|
|
@@ -3632,14 +3233,12 @@ export interface GetRetrieverResponse {
|
|
|
3632
3233
|
*/
|
|
3633
3234
|
displayName?: string | undefined;
|
|
3634
3235
|
/**
|
|
3635
|
-
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
3636
|
-
* configured.</p>
|
|
3236
|
+
* <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
|
|
3637
3237
|
* @public
|
|
3638
3238
|
*/
|
|
3639
3239
|
configuration?: RetrieverConfiguration | undefined;
|
|
3640
3240
|
/**
|
|
3641
|
-
* <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever
|
|
3642
|
-
* and required resources.</p>
|
|
3241
|
+
* <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.</p>
|
|
3643
3242
|
* @public
|
|
3644
3243
|
*/
|
|
3645
3244
|
roleArn?: string | undefined;
|
|
@@ -3664,9 +3263,7 @@ export interface ListRetrieversRequest {
|
|
|
3664
3263
|
*/
|
|
3665
3264
|
applicationId: string | undefined;
|
|
3666
3265
|
/**
|
|
3667
|
-
* <p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q Business
|
|
3668
|
-
* returns a next token as a pagination token to retrieve the next set of
|
|
3669
|
-
* retrievers.</p>
|
|
3266
|
+
* <p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.</p>
|
|
3670
3267
|
* @public
|
|
3671
3268
|
*/
|
|
3672
3269
|
nextToken?: string | undefined;
|
|
@@ -3717,8 +3314,7 @@ export interface ListRetrieversResponse {
|
|
|
3717
3314
|
*/
|
|
3718
3315
|
retrievers?: Retriever[] | undefined;
|
|
3719
3316
|
/**
|
|
3720
|
-
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
3721
|
-
* later request to list the next set of retrievers.</p>
|
|
3317
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.</p>
|
|
3722
3318
|
* @public
|
|
3723
3319
|
*/
|
|
3724
3320
|
nextToken?: string | undefined;
|
|
@@ -3738,8 +3334,7 @@ export interface UpdateRetrieverRequest {
|
|
|
3738
3334
|
*/
|
|
3739
3335
|
retrieverId: string | undefined;
|
|
3740
3336
|
/**
|
|
3741
|
-
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
3742
|
-
* configured.</p>
|
|
3337
|
+
* <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
|
|
3743
3338
|
* @public
|
|
3744
3339
|
*/
|
|
3745
3340
|
configuration?: RetrieverConfiguration | undefined;
|
|
@@ -3749,8 +3344,7 @@ export interface UpdateRetrieverRequest {
|
|
|
3749
3344
|
*/
|
|
3750
3345
|
displayName?: string | undefined;
|
|
3751
3346
|
/**
|
|
3752
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever
|
|
3753
|
-
* and required resources. </p>
|
|
3347
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources. </p>
|
|
3754
3348
|
* @public
|
|
3755
3349
|
*/
|
|
3756
3350
|
roleArn?: string | undefined;
|
|
@@ -3770,8 +3364,7 @@ export interface UpdateApplicationRequest {
|
|
|
3770
3364
|
*/
|
|
3771
3365
|
applicationId: string | undefined;
|
|
3772
3366
|
/**
|
|
3773
|
-
* <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either
|
|
3774
|
-
* creating for—or connecting to—your Amazon Q Business application.</p>
|
|
3367
|
+
* <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.</p>
|
|
3775
3368
|
* @public
|
|
3776
3369
|
*/
|
|
3777
3370
|
identityCenterInstanceArn?: string | undefined;
|
|
@@ -3786,9 +3379,7 @@ export interface UpdateApplicationRequest {
|
|
|
3786
3379
|
*/
|
|
3787
3380
|
description?: string | undefined;
|
|
3788
3381
|
/**
|
|
3789
|
-
* <p>An Amazon Web Services Identity and Access Management (IAM) role that
|
|
3790
|
-
* gives Amazon Q Business permission to access Amazon CloudWatch logs and
|
|
3791
|
-
* metrics.</p>
|
|
3382
|
+
* <p>An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.</p>
|
|
3792
3383
|
* @public
|
|
3793
3384
|
*/
|
|
3794
3385
|
roleArn?: string | undefined;
|
|
@@ -3798,20 +3389,17 @@ export interface UpdateApplicationRequest {
|
|
|
3798
3389
|
*/
|
|
3799
3390
|
attachmentsConfiguration?: AttachmentsConfiguration | undefined;
|
|
3800
3391
|
/**
|
|
3801
|
-
* <p>An option to allow end users to create and use Amazon Q Apps in the web
|
|
3802
|
-
* experience.</p>
|
|
3392
|
+
* <p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>
|
|
3803
3393
|
* @public
|
|
3804
3394
|
*/
|
|
3805
3395
|
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
3806
3396
|
/**
|
|
3807
|
-
* <p>Configuration information about chat response personalization. For more information,
|
|
3808
|
-
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
3397
|
+
* <p>Configuration information about chat response personalization. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
3809
3398
|
* @public
|
|
3810
3399
|
*/
|
|
3811
3400
|
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
3812
3401
|
/**
|
|
3813
|
-
* <p>An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user
|
|
3814
|
-
* management.</p>
|
|
3402
|
+
* <p>An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.</p>
|
|
3815
3403
|
* @public
|
|
3816
3404
|
*/
|
|
3817
3405
|
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration | undefined;
|
|
@@ -3839,23 +3427,7 @@ export type BrowserExtension = (typeof BrowserExtension)[keyof typeof BrowserExt
|
|
|
3839
3427
|
*/
|
|
3840
3428
|
export interface BrowserExtensionConfiguration {
|
|
3841
3429
|
/**
|
|
3842
|
-
* <p>Specify the browser extensions allowed for your Amazon Q web experience.</p>
|
|
3843
|
-
* <ul>
|
|
3844
|
-
* <li>
|
|
3845
|
-
* <p>
|
|
3846
|
-
* <code>CHROME</code> — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft
|
|
3847
|
-
* Edge, Opera, etc.).</p>
|
|
3848
|
-
* </li>
|
|
3849
|
-
* <li>
|
|
3850
|
-
* <p>
|
|
3851
|
-
* <code>FIREFOX</code> — Enables the extension for Mozilla Firefox.</p>
|
|
3852
|
-
* </li>
|
|
3853
|
-
* <li>
|
|
3854
|
-
* <p>
|
|
3855
|
-
* <code>CHROME</code> and <code>FIREFOX</code> — Enable the extension for Chromium-based browsers
|
|
3856
|
-
* and Mozilla Firefox.</p>
|
|
3857
|
-
* </li>
|
|
3858
|
-
* </ul>
|
|
3430
|
+
* <p>Specify the browser extensions allowed for your Amazon Q web experience.</p> <ul> <li> <p> <code>CHROME</code> — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).</p> </li> <li> <p> <code>FIREFOX</code> — Enables the extension for Mozilla Firefox.</p> </li> <li> <p> <code>CHROME</code> and <code>FIREFOX</code> — Enable the extension for Chromium-based browsers and Mozilla Firefox.</p> </li> </ul>
|
|
3859
3431
|
* @public
|
|
3860
3432
|
*/
|
|
3861
3433
|
enabledBrowserExtensions: BrowserExtension[] | undefined;
|
|
@@ -3887,40 +3459,34 @@ export interface CustomizationConfiguration {
|
|
|
3887
3459
|
faviconUrl?: string | undefined;
|
|
3888
3460
|
}
|
|
3889
3461
|
/**
|
|
3890
|
-
* <p>Information about the OIDC-compliant identity provider (IdP) used to authenticate end
|
|
3891
|
-
* users of an Amazon Q Business web experience.</p>
|
|
3462
|
+
* <p>Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
|
|
3892
3463
|
* @public
|
|
3893
3464
|
*/
|
|
3894
3465
|
export interface OpenIDConnectProviderConfiguration {
|
|
3895
3466
|
/**
|
|
3896
|
-
* <p>The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC
|
|
3897
|
-
* client secret.</p>
|
|
3467
|
+
* <p>The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.</p>
|
|
3898
3468
|
* @public
|
|
3899
3469
|
*/
|
|
3900
3470
|
secretsArn: string | undefined;
|
|
3901
3471
|
/**
|
|
3902
|
-
* <p>An IAM role with permissions to access KMS to decrypt
|
|
3903
|
-
* the Secrets Manager secret containing your OIDC client secret.</p>
|
|
3472
|
+
* <p>An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.</p>
|
|
3904
3473
|
* @public
|
|
3905
3474
|
*/
|
|
3906
3475
|
secretsRole: string | undefined;
|
|
3907
3476
|
}
|
|
3908
3477
|
/**
|
|
3909
|
-
* <p>Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate
|
|
3910
|
-
* end users of an Amazon Q Business web experience.</p>
|
|
3478
|
+
* <p>Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
|
|
3911
3479
|
* @public
|
|
3912
3480
|
*/
|
|
3913
3481
|
export interface SamlProviderConfiguration {
|
|
3914
3482
|
/**
|
|
3915
|
-
* <p>The URL where Amazon Q Business end users will be redirected for authentication.
|
|
3916
|
-
* </p>
|
|
3483
|
+
* <p>The URL where Amazon Q Business end users will be redirected for authentication. </p>
|
|
3917
3484
|
* @public
|
|
3918
3485
|
*/
|
|
3919
3486
|
authenticationUrl: string | undefined;
|
|
3920
3487
|
}
|
|
3921
3488
|
/**
|
|
3922
|
-
* <p>Provides information about the identity provider (IdP) used to authenticate end users
|
|
3923
|
-
* of an Amazon Q Business web experience.</p>
|
|
3489
|
+
* <p>Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
|
|
3924
3490
|
* @public
|
|
3925
3491
|
*/
|
|
3926
3492
|
export type IdentityProviderConfiguration = IdentityProviderConfiguration.OpenIDConnectConfigurationMember | IdentityProviderConfiguration.SamlConfigurationMember | IdentityProviderConfiguration.$UnknownMember;
|
|
@@ -3929,8 +3495,7 @@ export type IdentityProviderConfiguration = IdentityProviderConfiguration.OpenID
|
|
|
3929
3495
|
*/
|
|
3930
3496
|
export declare namespace IdentityProviderConfiguration {
|
|
3931
3497
|
/**
|
|
3932
|
-
* <p>Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate
|
|
3933
|
-
* end users of an Amazon Q Business web experience.</p>
|
|
3498
|
+
* <p>Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
|
|
3934
3499
|
* @public
|
|
3935
3500
|
*/
|
|
3936
3501
|
interface SamlConfigurationMember {
|
|
@@ -3939,8 +3504,7 @@ export declare namespace IdentityProviderConfiguration {
|
|
|
3939
3504
|
$unknown?: never;
|
|
3940
3505
|
}
|
|
3941
3506
|
/**
|
|
3942
|
-
* <p>Information about the OIDC-compliant identity provider (IdP) used to authenticate end
|
|
3943
|
-
* users of an Amazon Q Business web experience.</p>
|
|
3507
|
+
* <p>Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
|
|
3944
3508
|
* @public
|
|
3945
3509
|
*/
|
|
3946
3510
|
interface OpenIDConnectConfigurationMember {
|
|
@@ -3995,72 +3559,42 @@ export interface CreateWebExperienceRequest {
|
|
|
3995
3559
|
*/
|
|
3996
3560
|
subtitle?: string | undefined;
|
|
3997
3561
|
/**
|
|
3998
|
-
* <p>The customized welcome message for end users of an Amazon Q Business web
|
|
3999
|
-
* experience.</p>
|
|
3562
|
+
* <p>The customized welcome message for end users of an Amazon Q Business web experience.</p>
|
|
4000
3563
|
* @public
|
|
4001
3564
|
*/
|
|
4002
3565
|
welcomeMessage?: string | undefined;
|
|
4003
3566
|
/**
|
|
4004
|
-
* <p>Determines whether sample prompts are enabled in the web experience for an end
|
|
4005
|
-
* user.</p>
|
|
3567
|
+
* <p>Determines whether sample prompts are enabled in the web experience for an end user.</p>
|
|
4006
3568
|
* @public
|
|
4007
3569
|
*/
|
|
4008
3570
|
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
4009
3571
|
/**
|
|
4010
|
-
* <p>Sets the website domain origins that
|
|
4011
|
-
* are allowed to embed the Amazon Q Business web experience.
|
|
4012
|
-
*
|
|
4013
|
-
* The <i>domain origin</i> refers to the
|
|
4014
|
-
* base URL for accessing a website including the protocol
|
|
4015
|
-
* (<code>http/https</code>), the domain name, and the port number (if specified).
|
|
4016
|
-
* </p>
|
|
4017
|
-
* <note>
|
|
4018
|
-
* <p>You must only submit a <i>base URL</i> and
|
|
4019
|
-
* not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p>
|
|
4020
|
-
* </note>
|
|
3572
|
+
* <p>Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p> <note> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </note>
|
|
4021
3573
|
* @public
|
|
4022
3574
|
*/
|
|
4023
3575
|
origins?: string[] | undefined;
|
|
4024
3576
|
/**
|
|
4025
|
-
* <p>The Amazon Resource Name (ARN) of the service role attached to your web
|
|
4026
|
-
* experience.</p>
|
|
4027
|
-
* <note>
|
|
4028
|
-
* <p>You must provide this value if you're using IAM Identity Center to manage end user
|
|
4029
|
-
* access to your application. If you're using legacy identity management to manage
|
|
4030
|
-
* user access, you don't need to provide this value.</p>
|
|
4031
|
-
* </note>
|
|
3577
|
+
* <p>The Amazon Resource Name (ARN) of the service role attached to your web experience.</p> <note> <p>You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.</p> </note>
|
|
4032
3578
|
* @public
|
|
4033
3579
|
*/
|
|
4034
3580
|
roleArn?: string | undefined;
|
|
4035
3581
|
/**
|
|
4036
|
-
* <p>A list of key-value pairs that identify or categorize your Amazon Q Business web
|
|
4037
|
-
* experience. You can also use tags to help control access to the web experience. Tag keys
|
|
4038
|
-
* and values can consist of Unicode letters, digits, white space, and any of the following
|
|
4039
|
-
* symbols: _ . : / = + - @.</p>
|
|
3582
|
+
* <p>A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
4040
3583
|
* @public
|
|
4041
3584
|
*/
|
|
4042
3585
|
tags?: Tag[] | undefined;
|
|
4043
3586
|
/**
|
|
4044
|
-
* <p>A token you provide to identify a request to create an Amazon Q Business web experience.
|
|
4045
|
-
* </p>
|
|
3587
|
+
* <p>A token you provide to identify a request to create an Amazon Q Business web experience. </p>
|
|
4046
3588
|
* @public
|
|
4047
3589
|
*/
|
|
4048
3590
|
clientToken?: string | undefined;
|
|
4049
3591
|
/**
|
|
4050
|
-
* <p>Information about the identity provider (IdP) used to authenticate end users of an
|
|
4051
|
-
* Amazon Q Business web experience.</p>
|
|
3592
|
+
* <p>Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
|
|
4052
3593
|
* @public
|
|
4053
3594
|
*/
|
|
4054
3595
|
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
4055
3596
|
/**
|
|
4056
|
-
* <p>The browser extension configuration for an Amazon Q Business web experience.</p>
|
|
4057
|
-
* <note>
|
|
4058
|
-
* <p>
|
|
4059
|
-
* For Amazon Q Business application using external OIDC-compliant identity providers (IdPs).
|
|
4060
|
-
* The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application.
|
|
4061
|
-
* For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html">Configure external OIDC identity provider for your browser extensions.</a>.
|
|
4062
|
-
* </p>
|
|
4063
|
-
* </note>
|
|
3597
|
+
* <p>The browser extension configuration for an Amazon Q Business web experience.</p> <note> <p> For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html">Configure external OIDC identity provider for your browser extensions.</a>. </p> </note>
|
|
4064
3598
|
* @public
|
|
4065
3599
|
*/
|
|
4066
3600
|
browserExtensionConfiguration?: BrowserExtensionConfiguration | undefined;
|
|
@@ -4090,8 +3624,7 @@ export interface CreateWebExperienceResponse {
|
|
|
4090
3624
|
*/
|
|
4091
3625
|
export interface DeleteWebExperienceRequest {
|
|
4092
3626
|
/**
|
|
4093
|
-
* <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business web
|
|
4094
|
-
* experience.</p>
|
|
3627
|
+
* <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.</p>
|
|
4095
3628
|
* @public
|
|
4096
3629
|
*/
|
|
4097
3630
|
applicationId: string | undefined;
|
|
@@ -4122,8 +3655,7 @@ export interface GetWebExperienceRequest {
|
|
|
4122
3655
|
webExperienceId: string | undefined;
|
|
4123
3656
|
}
|
|
4124
3657
|
/**
|
|
4125
|
-
* <p>Provides the SAML 2.0 compliant identity provider (IdP) configuration information
|
|
4126
|
-
* Amazon Q Business needs to deploy a Amazon Q Business web experience.</p>
|
|
3658
|
+
* <p>Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.</p>
|
|
4127
3659
|
* @public
|
|
4128
3660
|
*/
|
|
4129
3661
|
export interface SamlConfiguration {
|
|
@@ -4133,9 +3665,7 @@ export interface SamlConfiguration {
|
|
|
4133
3665
|
*/
|
|
4134
3666
|
metadataXML: string | undefined;
|
|
4135
3667
|
/**
|
|
4136
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role assumed by users when
|
|
4137
|
-
* they authenticate into their Amazon Q Business web experience, containing the relevant
|
|
4138
|
-
* Amazon Q Business permissions for conversing with Amazon Q Business.</p>
|
|
3668
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.</p>
|
|
4139
3669
|
* @public
|
|
4140
3670
|
*/
|
|
4141
3671
|
roleArn: string | undefined;
|
|
@@ -4151,8 +3681,7 @@ export interface SamlConfiguration {
|
|
|
4151
3681
|
userGroupAttribute?: string | undefined;
|
|
4152
3682
|
}
|
|
4153
3683
|
/**
|
|
4154
|
-
* <p>Provides the authorization configuration information needed to deploy a Amazon Q Business
|
|
4155
|
-
* web experience to end users.</p>
|
|
3684
|
+
* <p>Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.</p>
|
|
4156
3685
|
* @public
|
|
4157
3686
|
*/
|
|
4158
3687
|
export type WebExperienceAuthConfiguration = WebExperienceAuthConfiguration.SamlConfigurationMember | WebExperienceAuthConfiguration.$UnknownMember;
|
|
@@ -4161,8 +3690,7 @@ export type WebExperienceAuthConfiguration = WebExperienceAuthConfiguration.Saml
|
|
|
4161
3690
|
*/
|
|
4162
3691
|
export declare namespace WebExperienceAuthConfiguration {
|
|
4163
3692
|
/**
|
|
4164
|
-
* <p>Provides the SAML 2.0 compliant identity provider (IdP) configuration information
|
|
4165
|
-
* Amazon Q Business needs to deploy a Amazon Q Business web experience.</p>
|
|
3693
|
+
* <p>Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.</p>
|
|
4166
3694
|
* @public
|
|
4167
3695
|
*/
|
|
4168
3696
|
interface SamlConfigurationMember {
|
|
@@ -4212,8 +3740,7 @@ export interface GetWebExperienceResponse {
|
|
|
4212
3740
|
*/
|
|
4213
3741
|
webExperienceId?: string | undefined;
|
|
4214
3742
|
/**
|
|
4215
|
-
* <p>The Amazon Resource Name (ARN) of the role with the permission to access the
|
|
4216
|
-
* Amazon Q Business web experience and required resources.</p>
|
|
3743
|
+
* <p>The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.</p>
|
|
4217
3744
|
* @public
|
|
4218
3745
|
*/
|
|
4219
3746
|
webExperienceArn?: string | undefined;
|
|
@@ -4223,9 +3750,7 @@ export interface GetWebExperienceResponse {
|
|
|
4223
3750
|
*/
|
|
4224
3751
|
defaultEndpoint?: string | undefined;
|
|
4225
3752
|
/**
|
|
4226
|
-
* <p>The current status of the Amazon Q Business web experience. When the <code>Status</code>
|
|
4227
|
-
* field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a
|
|
4228
|
-
* description of the error that caused the data source connector to fail. </p>
|
|
3753
|
+
* <p>The current status of the Amazon Q Business web experience. When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail. </p>
|
|
4229
3754
|
* @public
|
|
4230
3755
|
*/
|
|
4231
3756
|
status?: WebExperienceStatus | undefined;
|
|
@@ -4250,52 +3775,39 @@ export interface GetWebExperienceResponse {
|
|
|
4250
3775
|
*/
|
|
4251
3776
|
subtitle?: string | undefined;
|
|
4252
3777
|
/**
|
|
4253
|
-
* <p>The customized welcome message for end users of an Amazon Q Business web
|
|
4254
|
-
* experience.</p>
|
|
3778
|
+
* <p>The customized welcome message for end users of an Amazon Q Business web experience.</p>
|
|
4255
3779
|
* @public
|
|
4256
3780
|
*/
|
|
4257
3781
|
welcomeMessage?: string | undefined;
|
|
4258
3782
|
/**
|
|
4259
|
-
* <p>Determines whether sample prompts are enabled in the web experience for an end
|
|
4260
|
-
* user.</p>
|
|
3783
|
+
* <p>Determines whether sample prompts are enabled in the web experience for an end user.</p>
|
|
4261
3784
|
* @public
|
|
4262
3785
|
*/
|
|
4263
3786
|
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
4264
3787
|
/**
|
|
4265
|
-
* <p>Gets the website domain origins that
|
|
4266
|
-
* are allowed to embed the Amazon Q Business web experience.
|
|
4267
|
-
*
|
|
4268
|
-
* The <i>domain origin</i> refers to the
|
|
4269
|
-
* base URL for accessing a website including the protocol
|
|
4270
|
-
* (<code>http/https</code>), the domain name, and the port number (if specified).
|
|
4271
|
-
* </p>
|
|
3788
|
+
* <p>Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p>
|
|
4272
3789
|
* @public
|
|
4273
3790
|
*/
|
|
4274
3791
|
origins?: string[] | undefined;
|
|
4275
3792
|
/**
|
|
4276
|
-
* <p> The Amazon Resource Name (ARN) of the service role attached to your web
|
|
4277
|
-
* experience.</p>
|
|
3793
|
+
* <p> The Amazon Resource Name (ARN) of the service role attached to your web experience.</p>
|
|
4278
3794
|
* @public
|
|
4279
3795
|
*/
|
|
4280
3796
|
roleArn?: string | undefined;
|
|
4281
3797
|
/**
|
|
4282
|
-
* <p>Information about the identity provider (IdP) used to authenticate end users of an
|
|
4283
|
-
* Amazon Q Business web experience.</p>
|
|
3798
|
+
* <p>Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
|
|
4284
3799
|
* @public
|
|
4285
3800
|
*/
|
|
4286
3801
|
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
4287
3802
|
/**
|
|
4288
|
-
* <p>The authentication configuration information for your Amazon Q Business web
|
|
4289
|
-
* experience.</p>
|
|
3803
|
+
* <p>The authentication configuration information for your Amazon Q Business web experience.</p>
|
|
4290
3804
|
*
|
|
4291
3805
|
* @deprecated
|
|
4292
3806
|
* @public
|
|
4293
3807
|
*/
|
|
4294
3808
|
authenticationConfiguration?: WebExperienceAuthConfiguration | undefined;
|
|
4295
3809
|
/**
|
|
4296
|
-
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
4297
|
-
* <code>ErrorMessage</code> field contains a description of the error that caused the
|
|
4298
|
-
* data source connector to fail.</p>
|
|
3810
|
+
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>
|
|
4299
3811
|
* @public
|
|
4300
3812
|
*/
|
|
4301
3813
|
error?: ErrorDetail | undefined;
|
|
@@ -4305,8 +3817,7 @@ export interface GetWebExperienceResponse {
|
|
|
4305
3817
|
*/
|
|
4306
3818
|
browserExtensionConfiguration?: BrowserExtensionConfiguration | undefined;
|
|
4307
3819
|
/**
|
|
4308
|
-
* <p>Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.
|
|
4309
|
-
* </p>
|
|
3820
|
+
* <p>Gets the custom logo, favicon, font, and color used in the Amazon Q web experience. </p>
|
|
4310
3821
|
* @public
|
|
4311
3822
|
*/
|
|
4312
3823
|
customizationConfiguration?: CustomizationConfiguration | undefined;
|
|
@@ -4316,15 +3827,12 @@ export interface GetWebExperienceResponse {
|
|
|
4316
3827
|
*/
|
|
4317
3828
|
export interface ListWebExperiencesRequest {
|
|
4318
3829
|
/**
|
|
4319
|
-
* <p>The identifier of the Amazon Q Business application linked to the listed web
|
|
4320
|
-
* experiences.</p>
|
|
3830
|
+
* <p>The identifier of the Amazon Q Business application linked to the listed web experiences.</p>
|
|
4321
3831
|
* @public
|
|
4322
3832
|
*/
|
|
4323
3833
|
applicationId: string | undefined;
|
|
4324
3834
|
/**
|
|
4325
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
4326
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
4327
|
-
* pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
3835
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
4328
3836
|
* @public
|
|
4329
3837
|
*/
|
|
4330
3838
|
nextToken?: string | undefined;
|
|
@@ -4355,8 +3863,7 @@ export interface WebExperience {
|
|
|
4355
3863
|
*/
|
|
4356
3864
|
updatedAt?: Date | undefined;
|
|
4357
3865
|
/**
|
|
4358
|
-
* <p>The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully
|
|
4359
|
-
* hosted by Amazon Web Services.</p>
|
|
3866
|
+
* <p>The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.</p>
|
|
4360
3867
|
* @public
|
|
4361
3868
|
*/
|
|
4362
3869
|
defaultEndpoint?: string | undefined;
|
|
@@ -4376,8 +3883,7 @@ export interface ListWebExperiencesResponse {
|
|
|
4376
3883
|
*/
|
|
4377
3884
|
webExperiences?: WebExperience[] | undefined;
|
|
4378
3885
|
/**
|
|
4379
|
-
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
4380
|
-
* later request to list the next set of messages.</p>
|
|
3886
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.</p>
|
|
4381
3887
|
* @public
|
|
4382
3888
|
*/
|
|
4383
3889
|
nextToken?: string | undefined;
|
|
@@ -4397,8 +3903,7 @@ export interface UpdateWebExperienceRequest {
|
|
|
4397
3903
|
*/
|
|
4398
3904
|
webExperienceId: string | undefined;
|
|
4399
3905
|
/**
|
|
4400
|
-
* <p>The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business
|
|
4401
|
-
* web experience and required resources.</p>
|
|
3906
|
+
* <p>The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.</p>
|
|
4402
3907
|
* @public
|
|
4403
3908
|
*/
|
|
4404
3909
|
roleArn?: string | undefined;
|
|
@@ -4420,54 +3925,27 @@ export interface UpdateWebExperienceRequest {
|
|
|
4420
3925
|
*/
|
|
4421
3926
|
subtitle?: string | undefined;
|
|
4422
3927
|
/**
|
|
4423
|
-
* <p>A customized welcome message for an end user in an Amazon Q Business web
|
|
4424
|
-
* experience.</p>
|
|
3928
|
+
* <p>A customized welcome message for an end user in an Amazon Q Business web experience.</p>
|
|
4425
3929
|
* @public
|
|
4426
3930
|
*/
|
|
4427
3931
|
welcomeMessage?: string | undefined;
|
|
4428
3932
|
/**
|
|
4429
|
-
* <p>Determines whether sample prompts are enabled in the web experience for an end
|
|
4430
|
-
* user.</p>
|
|
3933
|
+
* <p>Determines whether sample prompts are enabled in the web experience for an end user.</p>
|
|
4431
3934
|
* @public
|
|
4432
3935
|
*/
|
|
4433
3936
|
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
4434
3937
|
/**
|
|
4435
|
-
* <p>Information about the identity provider (IdP) used to authenticate end users of an
|
|
4436
|
-
* Amazon Q Business web experience.</p>
|
|
3938
|
+
* <p>Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
|
|
4437
3939
|
* @public
|
|
4438
3940
|
*/
|
|
4439
3941
|
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
4440
3942
|
/**
|
|
4441
|
-
* <p>Updates the website domain origins that
|
|
4442
|
-
* are allowed to embed the Amazon Q Business web experience.
|
|
4443
|
-
*
|
|
4444
|
-
* The <i>domain origin</i> refers to the
|
|
4445
|
-
* <i>base URL</i> for accessing a website including the protocol
|
|
4446
|
-
* (<code>http/https</code>), the domain name, and the port number (if specified).</p>
|
|
4447
|
-
* <note>
|
|
4448
|
-
* <ul>
|
|
4449
|
-
* <li>
|
|
4450
|
-
* <p>Any values except <code>null</code> submitted as part of this
|
|
4451
|
-
* update will replace all previous values.</p>
|
|
4452
|
-
* </li>
|
|
4453
|
-
* <li>
|
|
4454
|
-
* <p>You must only submit a <i>base URL</i> and
|
|
4455
|
-
* not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p>
|
|
4456
|
-
* </li>
|
|
4457
|
-
* </ul>
|
|
4458
|
-
* </note>
|
|
3943
|
+
* <p>Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the <i>base URL</i> for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p> <note> <ul> <li> <p>Any values except <code>null</code> submitted as part of this update will replace all previous values.</p> </li> <li> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
|
|
4459
3944
|
* @public
|
|
4460
3945
|
*/
|
|
4461
3946
|
origins?: string[] | undefined;
|
|
4462
3947
|
/**
|
|
4463
|
-
* <p>The browser extension configuration for an Amazon Q Business web experience.</p>
|
|
4464
|
-
* <note>
|
|
4465
|
-
* <p>
|
|
4466
|
-
* For Amazon Q Business application using external OIDC-compliant identity providers (IdPs).
|
|
4467
|
-
* The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application.
|
|
4468
|
-
* For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html">Configure external OIDC identity provider for your browser extensions.</a>.
|
|
4469
|
-
* </p>
|
|
4470
|
-
* </note>
|
|
3948
|
+
* <p>The browser extension configuration for an Amazon Q Business web experience.</p> <note> <p> For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html">Configure external OIDC identity provider for your browser extensions.</a>. </p> </note>
|
|
4471
3949
|
* @public
|
|
4472
3950
|
*/
|
|
4473
3951
|
browserExtensionConfiguration?: BrowserExtensionConfiguration | undefined;
|
|
@@ -4495,16 +3973,12 @@ export declare const CreatorModeControl: {
|
|
|
4495
3973
|
*/
|
|
4496
3974
|
export type CreatorModeControl = (typeof CreatorModeControl)[keyof typeof CreatorModeControl];
|
|
4497
3975
|
/**
|
|
4498
|
-
* <p>The creator mode specific admin controls configured for an Amazon Q Business application.
|
|
4499
|
-
* Determines whether an end user can generate LLM-only responses when they use the web
|
|
4500
|
-
* experience.</p>
|
|
4501
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
3976
|
+
* <p>The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
4502
3977
|
* @public
|
|
4503
3978
|
*/
|
|
4504
3979
|
export interface AppliedCreatorModeConfiguration {
|
|
4505
3980
|
/**
|
|
4506
|
-
* <p> Information about whether creator mode is enabled or disabled for an Amazon Q Business
|
|
4507
|
-
* application. </p>
|
|
3981
|
+
* <p> Information about whether creator mode is enabled or disabled for an Amazon Q Business application. </p>
|
|
4508
3982
|
* @public
|
|
4509
3983
|
*/
|
|
4510
3984
|
creatorModeControl: CreatorModeControl | undefined;
|
|
@@ -4522,20 +3996,48 @@ export declare const OrchestrationControl: {
|
|
|
4522
3996
|
*/
|
|
4523
3997
|
export type OrchestrationControl = (typeof OrchestrationControl)[keyof typeof OrchestrationControl];
|
|
4524
3998
|
/**
|
|
4525
|
-
* <p>The chat orchestration specific admin controls configured for an Amazon Q Business
|
|
4526
|
-
* application. Determines whether Amazon Q Business automatically routes chat requests across
|
|
4527
|
-
* configured plugins and data sources in your Amazon Q Business application.</p>
|
|
4528
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails-global-controls.html#guardrails-global-orchestration">Chat orchestration settings</a>.</p>
|
|
3999
|
+
* <p>The chat orchestration specific admin controls configured for an Amazon Q Business application. Determines whether Amazon Q Business automatically routes chat requests across configured plugins and data sources in your Amazon Q Business application.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails-global-controls.html#guardrails-global-orchestration">Chat orchestration settings</a>.</p>
|
|
4529
4000
|
* @public
|
|
4530
4001
|
*/
|
|
4531
4002
|
export interface AppliedOrchestrationConfiguration {
|
|
4532
4003
|
/**
|
|
4533
|
-
* <p> Information about whether chat orchestration is enabled or disabled for an
|
|
4534
|
-
* Amazon Q Business application. </p>
|
|
4004
|
+
* <p> Information about whether chat orchestration is enabled or disabled for an Amazon Q Business application. </p>
|
|
4535
4005
|
* @public
|
|
4536
4006
|
*/
|
|
4537
4007
|
control: OrchestrationControl | undefined;
|
|
4538
4008
|
}
|
|
4009
|
+
/**
|
|
4010
|
+
* <p>Represents a group associated with a given user in the access control system.</p>
|
|
4011
|
+
* @public
|
|
4012
|
+
*/
|
|
4013
|
+
export interface AssociatedGroup {
|
|
4014
|
+
/**
|
|
4015
|
+
* <p>The name of the group associated with the user. This is used to identify the group in access control decisions.</p>
|
|
4016
|
+
* @public
|
|
4017
|
+
*/
|
|
4018
|
+
name?: string | undefined;
|
|
4019
|
+
/**
|
|
4020
|
+
* <p>The type of the associated group. This indicates the scope of the group's applicability.</p>
|
|
4021
|
+
* @public
|
|
4022
|
+
*/
|
|
4023
|
+
type?: MembershipType | undefined;
|
|
4024
|
+
}
|
|
4025
|
+
/**
|
|
4026
|
+
* <p>Represents an associated user in the access control system.</p>
|
|
4027
|
+
* @public
|
|
4028
|
+
*/
|
|
4029
|
+
export interface AssociatedUser {
|
|
4030
|
+
/**
|
|
4031
|
+
* <p>The unique identifier of the associated user. This is used to identify the user in access control decisions.</p>
|
|
4032
|
+
* @public
|
|
4033
|
+
*/
|
|
4034
|
+
id?: string | undefined;
|
|
4035
|
+
/**
|
|
4036
|
+
* <p>The type of the associated user. This indicates the scope of the user's association.</p>
|
|
4037
|
+
* @public
|
|
4038
|
+
*/
|
|
4039
|
+
type?: MembershipType | undefined;
|
|
4040
|
+
}
|
|
4539
4041
|
/**
|
|
4540
4042
|
* @public
|
|
4541
4043
|
*/
|
|
@@ -4707,8 +4209,7 @@ export interface AttachmentInput {
|
|
|
4707
4209
|
copyFrom?: CopyFromSource | undefined;
|
|
4708
4210
|
}
|
|
4709
4211
|
/**
|
|
4710
|
-
* <p>A file input event activated by a end user request to upload files into their web
|
|
4711
|
-
* experience chat.</p>
|
|
4212
|
+
* <p>A file input event activated by a end user request to upload files into their web experience chat.</p>
|
|
4712
4213
|
* @public
|
|
4713
4214
|
*/
|
|
4714
4215
|
export interface AttachmentInputEvent {
|
|
@@ -4793,35 +4294,29 @@ export interface AudioSourceDetails {
|
|
|
4793
4294
|
audioExtractionType?: AudioExtractionType | undefined;
|
|
4794
4295
|
}
|
|
4795
4296
|
/**
|
|
4796
|
-
* <p>A request made by Amazon Q Business to a third paty authentication server to authenticate
|
|
4797
|
-
* a custom plugin user.</p>
|
|
4297
|
+
* <p>A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.</p>
|
|
4798
4298
|
* @public
|
|
4799
4299
|
*/
|
|
4800
4300
|
export interface AuthChallengeRequest {
|
|
4801
4301
|
/**
|
|
4802
|
-
* <p>The URL sent by Amazon Q Business to the third party authentication server to authenticate
|
|
4803
|
-
* a custom plugin user through an OAuth protocol.</p>
|
|
4302
|
+
* <p>The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.</p>
|
|
4804
4303
|
* @public
|
|
4805
4304
|
*/
|
|
4806
4305
|
authorizationUrl: string | undefined;
|
|
4807
4306
|
}
|
|
4808
4307
|
/**
|
|
4809
|
-
* <p>An authentication verification event activated by an end user request to use a custom
|
|
4810
|
-
* plugin.</p>
|
|
4308
|
+
* <p>An authentication verification event activated by an end user request to use a custom plugin.</p>
|
|
4811
4309
|
* @public
|
|
4812
4310
|
*/
|
|
4813
4311
|
export interface AuthChallengeRequestEvent {
|
|
4814
4312
|
/**
|
|
4815
|
-
* <p>The URL sent by Amazon Q Business to a third party authentication server in response to an
|
|
4816
|
-
* authentication verification event activated by an end user request to use a custom
|
|
4817
|
-
* plugin. </p>
|
|
4313
|
+
* <p>The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin. </p>
|
|
4818
4314
|
* @public
|
|
4819
4315
|
*/
|
|
4820
4316
|
authorizationUrl: string | undefined;
|
|
4821
4317
|
}
|
|
4822
4318
|
/**
|
|
4823
|
-
* <p>Contains details of the authentication information received from a third party
|
|
4824
|
-
* authentication server in response to an authentication challenge.</p>
|
|
4319
|
+
* <p>Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.</p>
|
|
4825
4320
|
* @public
|
|
4826
4321
|
*/
|
|
4827
4322
|
export interface AuthChallengeResponse {
|
|
@@ -4832,8 +4327,7 @@ export interface AuthChallengeResponse {
|
|
|
4832
4327
|
responseMap: Record<string, string> | undefined;
|
|
4833
4328
|
}
|
|
4834
4329
|
/**
|
|
4835
|
-
* <p>An authentication verification event response by a third party authentication server
|
|
4836
|
-
* to Amazon Q Business.</p>
|
|
4330
|
+
* <p>An authentication verification event response by a third party authentication server to Amazon Q Business.</p>
|
|
4837
4331
|
* @public
|
|
4838
4332
|
*/
|
|
4839
4333
|
export interface AuthChallengeResponseEvent {
|
|
@@ -4864,8 +4358,7 @@ export interface BatchDeleteDocumentRequest {
|
|
|
4864
4358
|
*/
|
|
4865
4359
|
applicationId: string | undefined;
|
|
4866
4360
|
/**
|
|
4867
|
-
* <p>The identifier of the Amazon Q Business index that contains the documents to
|
|
4868
|
-
* delete.</p>
|
|
4361
|
+
* <p>The identifier of the Amazon Q Business index that contains the documents to delete.</p>
|
|
4869
4362
|
* @public
|
|
4870
4363
|
*/
|
|
4871
4364
|
indexId: string | undefined;
|
|
@@ -4881,15 +4374,12 @@ export interface BatchDeleteDocumentRequest {
|
|
|
4881
4374
|
dataSourceSyncId?: string | undefined;
|
|
4882
4375
|
}
|
|
4883
4376
|
/**
|
|
4884
|
-
* <p>A list of documents that could not be removed from an Amazon Q Business index. Each entry
|
|
4885
|
-
* contains an error message that indicates why the document couldn't be removed from the
|
|
4886
|
-
* index.</p>
|
|
4377
|
+
* <p>A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.</p>
|
|
4887
4378
|
* @public
|
|
4888
4379
|
*/
|
|
4889
4380
|
export interface FailedDocument {
|
|
4890
4381
|
/**
|
|
4891
|
-
* <p>The identifier of the document that couldn't be removed from the Amazon Q Business
|
|
4892
|
-
* index.</p>
|
|
4382
|
+
* <p>The identifier of the document that couldn't be removed from the Amazon Q Business index.</p>
|
|
4893
4383
|
* @public
|
|
4894
4384
|
*/
|
|
4895
4385
|
id?: string | undefined;
|
|
@@ -4899,8 +4389,7 @@ export interface FailedDocument {
|
|
|
4899
4389
|
*/
|
|
4900
4390
|
error?: ErrorDetail | undefined;
|
|
4901
4391
|
/**
|
|
4902
|
-
* <p>The identifier of the Amazon Q Business data source connector that contains the failed
|
|
4903
|
-
* document.</p>
|
|
4392
|
+
* <p>The identifier of the Amazon Q Business data source connector that contains the failed document.</p>
|
|
4904
4393
|
* @public
|
|
4905
4394
|
*/
|
|
4906
4395
|
dataSourceId?: string | undefined;
|
|
@@ -4910,9 +4399,7 @@ export interface FailedDocument {
|
|
|
4910
4399
|
*/
|
|
4911
4400
|
export interface BatchDeleteDocumentResponse {
|
|
4912
4401
|
/**
|
|
4913
|
-
* <p>A list of documents that couldn't be removed from the Amazon Q Business index. Each entry
|
|
4914
|
-
* contains an error message that indicates why the document couldn't be removed from the
|
|
4915
|
-
* index. </p>
|
|
4402
|
+
* <p>A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index. </p>
|
|
4916
4403
|
* @public
|
|
4917
4404
|
*/
|
|
4918
4405
|
failedDocuments?: FailedDocument[] | undefined;
|
|
@@ -4927,11 +4414,7 @@ export type DocumentContent = DocumentContent.BlobMember | DocumentContent.S3Mem
|
|
|
4927
4414
|
*/
|
|
4928
4415
|
export declare namespace DocumentContent {
|
|
4929
4416
|
/**
|
|
4930
|
-
* <p>The contents of the document. Documents passed to the <code>blob</code> parameter must
|
|
4931
|
-
* be base64 encoded. Your code might not need to encode the document file bytes if you're
|
|
4932
|
-
* using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the
|
|
4933
|
-
* Amazon Q Business endpoint directly using REST, you must base64 encode the contents before
|
|
4934
|
-
* sending.</p>
|
|
4417
|
+
* <p>The contents of the document. Documents passed to the <code>blob</code> parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.</p>
|
|
4935
4418
|
* @public
|
|
4936
4419
|
*/
|
|
4937
4420
|
interface BlobMember {
|
|
@@ -4996,8 +4479,7 @@ export interface Document {
|
|
|
4996
4479
|
*/
|
|
4997
4480
|
id: string | undefined;
|
|
4998
4481
|
/**
|
|
4999
|
-
* <p>Custom attributes to apply to the document for refining Amazon Q Business web experience
|
|
5000
|
-
* responses.</p>
|
|
4482
|
+
* <p>Custom attributes to apply to the document for refining Amazon Q Business web experience responses.</p>
|
|
5001
4483
|
* @public
|
|
5002
4484
|
*/
|
|
5003
4485
|
attributes?: DocumentAttribute[] | undefined;
|
|
@@ -5007,10 +4489,7 @@ export interface Document {
|
|
|
5007
4489
|
*/
|
|
5008
4490
|
content?: DocumentContent | undefined;
|
|
5009
4491
|
/**
|
|
5010
|
-
* <p>The file type of the document in the Blob field.</p>
|
|
5011
|
-
* <p>If you want to index snippets or subsets of HTML documents instead of the entirety of
|
|
5012
|
-
* the HTML documents, you add the <code>HTML</code> start and closing tags
|
|
5013
|
-
* (<code><HTML>content</HTML></code>) around the content.</p>
|
|
4492
|
+
* <p>The file type of the document in the Blob field.</p> <p>If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the <code>HTML</code> start and closing tags (<code><HTML>content</HTML></code>) around the content.</p>
|
|
5014
4493
|
* @public
|
|
5015
4494
|
*/
|
|
5016
4495
|
contentType?: ContentType | undefined;
|
|
@@ -5025,8 +4504,7 @@ export interface Document {
|
|
|
5025
4504
|
*/
|
|
5026
4505
|
accessConfiguration?: AccessConfiguration | undefined;
|
|
5027
4506
|
/**
|
|
5028
|
-
* <p>The configuration information for altering document metadata and content during the
|
|
5029
|
-
* document ingestion process.</p>
|
|
4507
|
+
* <p>The configuration information for altering document metadata and content during the document ingestion process.</p>
|
|
5030
4508
|
* @public
|
|
5031
4509
|
*/
|
|
5032
4510
|
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
@@ -5056,8 +4534,7 @@ export interface BatchPutDocumentRequest {
|
|
|
5056
4534
|
*/
|
|
5057
4535
|
documents: Document[] | undefined;
|
|
5058
4536
|
/**
|
|
5059
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3
|
|
5060
|
-
* bucket.</p>
|
|
4537
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.</p>
|
|
5061
4538
|
* @public
|
|
5062
4539
|
*/
|
|
5063
4540
|
roleArn?: string | undefined;
|
|
@@ -5072,16 +4549,13 @@ export interface BatchPutDocumentRequest {
|
|
|
5072
4549
|
*/
|
|
5073
4550
|
export interface BatchPutDocumentResponse {
|
|
5074
4551
|
/**
|
|
5075
|
-
* <p> A list of documents that were not added to the Amazon Q Business index because the
|
|
5076
|
-
* document failed a validation check. Each document contains an error message that
|
|
5077
|
-
* indicates why the document couldn't be added to the index. </p>
|
|
4552
|
+
* <p> A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index. </p>
|
|
5078
4553
|
* @public
|
|
5079
4554
|
*/
|
|
5080
4555
|
failedDocuments?: FailedDocument[] | undefined;
|
|
5081
4556
|
}
|
|
5082
4557
|
/**
|
|
5083
|
-
* <p>Provides information about the phrases blocked from chat by your chat control
|
|
5084
|
-
* configuration.</p>
|
|
4558
|
+
* <p>Provides information about the phrases blocked from chat by your chat control configuration.</p>
|
|
5085
4559
|
* @public
|
|
5086
4560
|
*/
|
|
5087
4561
|
export interface BlockedPhrasesConfiguration {
|
|
@@ -5091,8 +4565,7 @@ export interface BlockedPhrasesConfiguration {
|
|
|
5091
4565
|
*/
|
|
5092
4566
|
blockedPhrases?: string[] | undefined;
|
|
5093
4567
|
/**
|
|
5094
|
-
* <p>The configured custom message displayed to an end user informing them that they've
|
|
5095
|
-
* used a blocked phrase during chat.</p>
|
|
4568
|
+
* <p>The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.</p>
|
|
5096
4569
|
* @public
|
|
5097
4570
|
*/
|
|
5098
4571
|
systemMessageOverride?: string | undefined;
|
|
@@ -5103,8 +4576,7 @@ export interface BlockedPhrasesConfiguration {
|
|
|
5103
4576
|
*/
|
|
5104
4577
|
export interface BlockedPhrasesConfigurationUpdate {
|
|
5105
4578
|
/**
|
|
5106
|
-
* <p>Creates or updates a blocked phrases configuration in your Amazon Q Business
|
|
5107
|
-
* application.</p>
|
|
4579
|
+
* <p>Creates or updates a blocked phrases configuration in your Amazon Q Business application.</p>
|
|
5108
4580
|
* @public
|
|
5109
4581
|
*/
|
|
5110
4582
|
blockedPhrasesToCreateOrUpdate?: string[] | undefined;
|
|
@@ -5114,8 +4586,7 @@ export interface BlockedPhrasesConfigurationUpdate {
|
|
|
5114
4586
|
*/
|
|
5115
4587
|
blockedPhrasesToDelete?: string[] | undefined;
|
|
5116
4588
|
/**
|
|
5117
|
-
* <p>The configured custom message displayed to your end user when they use blocked phrase
|
|
5118
|
-
* during chat.</p>
|
|
4589
|
+
* <p>The configured custom message displayed to your end user when they use blocked phrase during chat.</p>
|
|
5119
4590
|
* @public
|
|
5120
4591
|
*/
|
|
5121
4592
|
systemMessageOverride?: string | undefined;
|
|
@@ -5125,8 +4596,7 @@ export interface BlockedPhrasesConfigurationUpdate {
|
|
|
5125
4596
|
*/
|
|
5126
4597
|
export interface CancelSubscriptionRequest {
|
|
5127
4598
|
/**
|
|
5128
|
-
* <p>The identifier of the Amazon Q Business application for which the subscription is being
|
|
5129
|
-
* cancelled.</p>
|
|
4599
|
+
* <p>The identifier of the Amazon Q Business application for which the subscription is being cancelled.</p>
|
|
5130
4600
|
* @public
|
|
5131
4601
|
*/
|
|
5132
4602
|
applicationId: string | undefined;
|
|
@@ -5152,8 +4622,7 @@ export interface SubscriptionDetails {
|
|
|
5152
4622
|
*/
|
|
5153
4623
|
export interface CancelSubscriptionResponse {
|
|
5154
4624
|
/**
|
|
5155
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription being
|
|
5156
|
-
* cancelled.</p>
|
|
4625
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled.</p>
|
|
5157
4626
|
* @public
|
|
5158
4627
|
*/
|
|
5159
4628
|
subscriptionArn?: string | undefined;
|
|
@@ -5182,9 +4651,7 @@ export declare const ChatMode: {
|
|
|
5182
4651
|
*/
|
|
5183
4652
|
export type ChatMode = (typeof ChatMode)[keyof typeof ChatMode];
|
|
5184
4653
|
/**
|
|
5185
|
-
* <p>Configuration information required to invoke chat in <code>PLUGIN_MODE</code>.</p>
|
|
5186
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>,
|
|
5187
|
-
* and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
4654
|
+
* <p>Configuration information required to invoke chat in <code>PLUGIN_MODE</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>, and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
5188
4655
|
* @public
|
|
5189
4656
|
*/
|
|
5190
4657
|
export interface PluginConfiguration {
|
|
@@ -5195,8 +4662,7 @@ export interface PluginConfiguration {
|
|
|
5195
4662
|
pluginId: string | undefined;
|
|
5196
4663
|
}
|
|
5197
4664
|
/**
|
|
5198
|
-
* <p>Configuration information for Amazon Q Business conversation modes.</p>
|
|
5199
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
4665
|
+
* <p>Configuration information for Amazon Q Business conversation modes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
5200
4666
|
* @public
|
|
5201
4667
|
*/
|
|
5202
4668
|
export type ChatModeConfiguration = ChatModeConfiguration.PluginConfigurationMember | ChatModeConfiguration.$UnknownMember;
|
|
@@ -5269,14 +4735,12 @@ export interface FailedAttachmentEvent {
|
|
|
5269
4735
|
attachment?: AttachmentOutput | undefined;
|
|
5270
4736
|
}
|
|
5271
4737
|
/**
|
|
5272
|
-
* <p>Contains the relevant text excerpt from a source that was used to generate a citation
|
|
5273
|
-
* text segment in an Amazon Q Business chat response.</p>
|
|
4738
|
+
* <p>Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.</p>
|
|
5274
4739
|
* @public
|
|
5275
4740
|
*/
|
|
5276
4741
|
export interface SnippetExcerpt {
|
|
5277
4742
|
/**
|
|
5278
|
-
* <p>The relevant text excerpt from a source that was used to generate a citation text
|
|
5279
|
-
* segment in an Amazon Q chat response.</p>
|
|
4743
|
+
* <p>The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.</p>
|
|
5280
4744
|
* @public
|
|
5281
4745
|
*/
|
|
5282
4746
|
text?: string | undefined;
|
|
@@ -5397,26 +4861,22 @@ export declare namespace SourceDetails {
|
|
|
5397
4861
|
const visit: <T>(value: SourceDetails, visitor: Visitor<T>) => T;
|
|
5398
4862
|
}
|
|
5399
4863
|
/**
|
|
5400
|
-
* <p>Provides information about a text extract in a chat response that can be attributed to
|
|
5401
|
-
* a source document.</p>
|
|
4864
|
+
* <p>Provides information about a text extract in a chat response that can be attributed to a source document.</p>
|
|
5402
4865
|
* @public
|
|
5403
4866
|
*/
|
|
5404
4867
|
export interface TextSegment {
|
|
5405
4868
|
/**
|
|
5406
|
-
* <p>The zero-based location in the response string where the source attribution
|
|
5407
|
-
* starts.</p>
|
|
4869
|
+
* <p>The zero-based location in the response string where the source attribution starts.</p>
|
|
5408
4870
|
* @public
|
|
5409
4871
|
*/
|
|
5410
4872
|
beginOffset?: number | undefined;
|
|
5411
4873
|
/**
|
|
5412
|
-
* <p>The zero-based location in the response string where the source attribution
|
|
5413
|
-
* ends.</p>
|
|
4874
|
+
* <p>The zero-based location in the response string where the source attribution ends.</p>
|
|
5414
4875
|
* @public
|
|
5415
4876
|
*/
|
|
5416
4877
|
endOffset?: number | undefined;
|
|
5417
4878
|
/**
|
|
5418
|
-
* <p>The relevant text excerpt from a source that was used to generate a citation text
|
|
5419
|
-
* segment in an Amazon Q Business chat response.</p>
|
|
4879
|
+
* <p>The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.</p>
|
|
5420
4880
|
* @public
|
|
5421
4881
|
*/
|
|
5422
4882
|
snippetExcerpt?: SnippetExcerpt | undefined;
|
|
@@ -5446,20 +4906,17 @@ export interface TextSegment {
|
|
|
5446
4906
|
*/
|
|
5447
4907
|
export interface SourceAttribution {
|
|
5448
4908
|
/**
|
|
5449
|
-
* <p>The title of the document which is the source for the Amazon Q Business generated
|
|
5450
|
-
* response. </p>
|
|
4909
|
+
* <p>The title of the document which is the source for the Amazon Q Business generated response. </p>
|
|
5451
4910
|
* @public
|
|
5452
4911
|
*/
|
|
5453
4912
|
title?: string | undefined;
|
|
5454
4913
|
/**
|
|
5455
|
-
* <p>The content extract from the document on which the generated response is based.
|
|
5456
|
-
* </p>
|
|
4914
|
+
* <p>The content extract from the document on which the generated response is based. </p>
|
|
5457
4915
|
* @public
|
|
5458
4916
|
*/
|
|
5459
4917
|
snippet?: string | undefined;
|
|
5460
4918
|
/**
|
|
5461
|
-
* <p>The URL of the document which is the source for the Amazon Q Business generated response.
|
|
5462
|
-
* </p>
|
|
4919
|
+
* <p>The URL of the document which is the source for the Amazon Q Business generated response. </p>
|
|
5463
4920
|
* @public
|
|
5464
4921
|
*/
|
|
5465
4922
|
url?: string | undefined;
|
|
@@ -5480,26 +4937,22 @@ export interface SourceAttribution {
|
|
|
5480
4937
|
textMessageSegments?: TextSegment[] | undefined;
|
|
5481
4938
|
}
|
|
5482
4939
|
/**
|
|
5483
|
-
* <p>A metadata event for a AI-generated text output message in a Amazon Q Business
|
|
5484
|
-
* conversation, containing associated metadata generated.</p>
|
|
4940
|
+
* <p>A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.</p>
|
|
5485
4941
|
* @public
|
|
5486
4942
|
*/
|
|
5487
4943
|
export interface MetadataEvent {
|
|
5488
4944
|
/**
|
|
5489
|
-
* <p>The identifier of the conversation with which the generated metadata is
|
|
5490
|
-
* associated.</p>
|
|
4945
|
+
* <p>The identifier of the conversation with which the generated metadata is associated.</p>
|
|
5491
4946
|
* @public
|
|
5492
4947
|
*/
|
|
5493
4948
|
conversationId?: string | undefined;
|
|
5494
4949
|
/**
|
|
5495
|
-
* <p>The identifier of an Amazon Q Business end user text input message within the
|
|
5496
|
-
* conversation.</p>
|
|
4950
|
+
* <p>The identifier of an Amazon Q Business end user text input message within the conversation.</p>
|
|
5497
4951
|
* @public
|
|
5498
4952
|
*/
|
|
5499
4953
|
userMessageId?: string | undefined;
|
|
5500
4954
|
/**
|
|
5501
|
-
* <p>The identifier of an Amazon Q Business AI generated message within the
|
|
5502
|
-
* conversation.</p>
|
|
4955
|
+
* <p>The identifier of an Amazon Q Business AI generated message within the conversation.</p>
|
|
5503
4956
|
* @public
|
|
5504
4957
|
*/
|
|
5505
4958
|
systemMessageId?: string | undefined;
|
|
@@ -5515,14 +4968,29 @@ export interface MetadataEvent {
|
|
|
5515
4968
|
finalTextMessage?: string | undefined;
|
|
5516
4969
|
}
|
|
5517
4970
|
/**
|
|
5518
|
-
*
|
|
5519
|
-
*
|
|
4971
|
+
* @public
|
|
4972
|
+
* @enum
|
|
4973
|
+
*/
|
|
4974
|
+
export declare const SystemMessageType: {
|
|
4975
|
+
readonly GROUNDED_RESPONSE: "GROUNDED_RESPONSE";
|
|
4976
|
+
readonly RESPONSE: "RESPONSE";
|
|
4977
|
+
};
|
|
4978
|
+
/**
|
|
4979
|
+
* @public
|
|
4980
|
+
*/
|
|
4981
|
+
export type SystemMessageType = (typeof SystemMessageType)[keyof typeof SystemMessageType];
|
|
4982
|
+
/**
|
|
4983
|
+
* <p>An output event for an AI-generated response in an Amazon Q Business web experience.</p>
|
|
5520
4984
|
* @public
|
|
5521
4985
|
*/
|
|
5522
4986
|
export interface TextOutputEvent {
|
|
5523
4987
|
/**
|
|
5524
|
-
* <p>The
|
|
5525
|
-
*
|
|
4988
|
+
* <p>The type of AI-generated message in a <code>TextOutputEvent</code>. Amazon Q Business currently supports two types of messages:</p> <ul> <li> <p> <code>RESPONSE</code> - The Amazon Q Business system response.</p> </li> <li> <p> <code>GROUNDED_RESPONSE</code> - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.</p> </li> </ul>
|
|
4989
|
+
* @public
|
|
4990
|
+
*/
|
|
4991
|
+
systemMessageType?: SystemMessageType | undefined;
|
|
4992
|
+
/**
|
|
4993
|
+
* <p>The identifier of the conversation with which the text output event is associated.</p>
|
|
5526
4994
|
* @public
|
|
5527
4995
|
*/
|
|
5528
4996
|
conversationId?: string | undefined;
|
|
@@ -5552,8 +5020,7 @@ export type ChatOutputStream = ChatOutputStream.ActionReviewEventMember | ChatOu
|
|
|
5552
5020
|
*/
|
|
5553
5021
|
export declare namespace ChatOutputStream {
|
|
5554
5022
|
/**
|
|
5555
|
-
* <p>Information about the payload of the <code>ChatOutputStream</code> event containing
|
|
5556
|
-
* the AI-generated message output.</p>
|
|
5023
|
+
* <p>Information about the payload of the <code>ChatOutputStream</code> event containing the AI-generated message output.</p>
|
|
5557
5024
|
* @public
|
|
5558
5025
|
*/
|
|
5559
5026
|
interface TextEventMember {
|
|
@@ -5565,8 +5032,7 @@ export declare namespace ChatOutputStream {
|
|
|
5565
5032
|
$unknown?: never;
|
|
5566
5033
|
}
|
|
5567
5034
|
/**
|
|
5568
|
-
* <p>A metadata event for a AI-generated text output message in a Amazon Q Business
|
|
5569
|
-
* conversation. </p>
|
|
5035
|
+
* <p>A metadata event for a AI-generated text output message in a Amazon Q Business conversation. </p>
|
|
5570
5036
|
* @public
|
|
5571
5037
|
*/
|
|
5572
5038
|
interface MetadataEventMember {
|
|
@@ -5578,8 +5044,7 @@ export declare namespace ChatOutputStream {
|
|
|
5578
5044
|
$unknown?: never;
|
|
5579
5045
|
}
|
|
5580
5046
|
/**
|
|
5581
|
-
* <p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to
|
|
5582
|
-
* successfully complete a requested plugin action.</p>
|
|
5047
|
+
* <p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.</p>
|
|
5583
5048
|
* @public
|
|
5584
5049
|
*/
|
|
5585
5050
|
interface ActionReviewEventMember {
|
|
@@ -5603,8 +5068,7 @@ export declare namespace ChatOutputStream {
|
|
|
5603
5068
|
$unknown?: never;
|
|
5604
5069
|
}
|
|
5605
5070
|
/**
|
|
5606
|
-
* <p>An authentication verification event activated by an end user request to use a custom
|
|
5607
|
-
* plugin.</p>
|
|
5071
|
+
* <p>An authentication verification event activated by an end user request to use a custom plugin.</p>
|
|
5608
5072
|
* @public
|
|
5609
5073
|
*/
|
|
5610
5074
|
interface AuthChallengeRequestEventMember {
|
|
@@ -5647,9 +5111,7 @@ export interface ChatOutput {
|
|
|
5647
5111
|
outputStream?: AsyncIterable<ChatOutputStream> | undefined;
|
|
5648
5112
|
}
|
|
5649
5113
|
/**
|
|
5650
|
-
* <p>An external resource that you configured with your application is returning errors and
|
|
5651
|
-
* preventing this operation from succeeding. Fix those errors and try again.
|
|
5652
|
-
* </p>
|
|
5114
|
+
* <p>An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again. </p>
|
|
5653
5115
|
* @public
|
|
5654
5116
|
*/
|
|
5655
5117
|
export declare class ExternalResourceException extends __BaseException {
|
|
@@ -5661,8 +5123,7 @@ export declare class ExternalResourceException extends __BaseException {
|
|
|
5661
5123
|
constructor(opts: __ExceptionOptionType<ExternalResourceException, __BaseException>);
|
|
5662
5124
|
}
|
|
5663
5125
|
/**
|
|
5664
|
-
* <p>You don't have permissions to perform the action because your license is inactive. Ask
|
|
5665
|
-
* your admin to activate your license and try again after your licence is active.</p>
|
|
5126
|
+
* <p>You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.</p>
|
|
5666
5127
|
* @public
|
|
5667
5128
|
*/
|
|
5668
5129
|
export declare class LicenseNotFoundException extends __BaseException {
|
|
@@ -5688,26 +5149,22 @@ export interface ChatSyncOutput {
|
|
|
5688
5149
|
*/
|
|
5689
5150
|
systemMessage?: string | undefined;
|
|
5690
5151
|
/**
|
|
5691
|
-
* <p>The identifier of an Amazon Q Business AI generated message within the
|
|
5692
|
-
* conversation.</p>
|
|
5152
|
+
* <p>The identifier of an Amazon Q Business AI generated message within the conversation.</p>
|
|
5693
5153
|
* @public
|
|
5694
5154
|
*/
|
|
5695
5155
|
systemMessageId?: string | undefined;
|
|
5696
5156
|
/**
|
|
5697
|
-
* <p>The identifier of an Amazon Q Business end user text input message within the
|
|
5698
|
-
* conversation.</p>
|
|
5157
|
+
* <p>The identifier of an Amazon Q Business end user text input message within the conversation.</p>
|
|
5699
5158
|
* @public
|
|
5700
5159
|
*/
|
|
5701
5160
|
userMessageId?: string | undefined;
|
|
5702
5161
|
/**
|
|
5703
|
-
* <p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to
|
|
5704
|
-
* successfully complete a requested plugin action.</p>
|
|
5162
|
+
* <p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.</p>
|
|
5705
5163
|
* @public
|
|
5706
5164
|
*/
|
|
5707
5165
|
actionReview?: ActionReview | undefined;
|
|
5708
5166
|
/**
|
|
5709
|
-
* <p>An authentication verification event activated by an end user request to use a custom
|
|
5710
|
-
* plugin.</p>
|
|
5167
|
+
* <p>An authentication verification event activated by an end user request to use a custom plugin.</p>
|
|
5711
5168
|
* @public
|
|
5712
5169
|
*/
|
|
5713
5170
|
authChallengeRequest?: AuthChallengeRequest | undefined;
|
|
@@ -5723,15 +5180,152 @@ export interface ChatSyncOutput {
|
|
|
5723
5180
|
failedAttachments?: AttachmentOutput[] | undefined;
|
|
5724
5181
|
}
|
|
5725
5182
|
/**
|
|
5726
|
-
*
|
|
5727
|
-
|
|
5728
|
-
|
|
5183
|
+
* @public
|
|
5184
|
+
*/
|
|
5185
|
+
export interface CheckDocumentAccessRequest {
|
|
5186
|
+
/**
|
|
5187
|
+
* <p>The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.</p>
|
|
5188
|
+
* @public
|
|
5189
|
+
*/
|
|
5190
|
+
applicationId: string | undefined;
|
|
5191
|
+
/**
|
|
5192
|
+
* <p>The unique identifier of the index. Used to locate the correct index within the application where the document is stored.</p>
|
|
5193
|
+
* @public
|
|
5194
|
+
*/
|
|
5195
|
+
indexId: string | undefined;
|
|
5196
|
+
/**
|
|
5197
|
+
* <p>The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.</p>
|
|
5198
|
+
* @public
|
|
5199
|
+
*/
|
|
5200
|
+
userId: string | undefined;
|
|
5201
|
+
/**
|
|
5202
|
+
* <p>The unique identifier of the document. Specifies which document's access permissions are being checked.</p>
|
|
5203
|
+
* @public
|
|
5204
|
+
*/
|
|
5205
|
+
documentId: string | undefined;
|
|
5206
|
+
/**
|
|
5207
|
+
* <p>The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary. </p>
|
|
5208
|
+
* @public
|
|
5209
|
+
*/
|
|
5210
|
+
dataSourceId?: string | undefined;
|
|
5211
|
+
}
|
|
5212
|
+
/**
|
|
5213
|
+
* <p>Represents a group in the document's ACL, used to define access permissions for multiple users collectively.</p>
|
|
5214
|
+
* @public
|
|
5215
|
+
*/
|
|
5216
|
+
export interface DocumentAclGroup {
|
|
5217
|
+
/**
|
|
5218
|
+
* <p>The name of the group in the document's ACL. This is used to identify the group when applying access rules.</p>
|
|
5219
|
+
* @public
|
|
5220
|
+
*/
|
|
5221
|
+
name?: string | undefined;
|
|
5222
|
+
/**
|
|
5223
|
+
* <p>The type of the group. This indicates the scope of the group's applicability in access control.</p>
|
|
5224
|
+
* @public
|
|
5225
|
+
*/
|
|
5226
|
+
type?: MembershipType | undefined;
|
|
5227
|
+
}
|
|
5228
|
+
/**
|
|
5229
|
+
* <p>Represents a user in the document's ACL, used to define access permissions for individual users.</p>
|
|
5230
|
+
* @public
|
|
5231
|
+
*/
|
|
5232
|
+
export interface DocumentAclUser {
|
|
5233
|
+
/**
|
|
5234
|
+
* <p>The unique identifier of the user in the document's ACL. This is used to identify the user when applying access rules.</p>
|
|
5235
|
+
* @public
|
|
5236
|
+
*/
|
|
5237
|
+
id?: string | undefined;
|
|
5238
|
+
/**
|
|
5239
|
+
* <p>The type of the user. This indicates the scope of the user's applicability in access control.</p>
|
|
5240
|
+
* @public
|
|
5241
|
+
*/
|
|
5242
|
+
type?: MembershipType | undefined;
|
|
5243
|
+
}
|
|
5244
|
+
/**
|
|
5245
|
+
* <p>Represents a condition in the document's ACL, specifying access rules for users and groups.</p>
|
|
5246
|
+
* @public
|
|
5247
|
+
*/
|
|
5248
|
+
export interface DocumentAclCondition {
|
|
5249
|
+
/**
|
|
5250
|
+
* <p>The logical relation between members in the condition, determining how multiple user or group conditions are combined.</p>
|
|
5251
|
+
* @public
|
|
5252
|
+
*/
|
|
5253
|
+
memberRelation?: MemberRelation | undefined;
|
|
5254
|
+
/**
|
|
5255
|
+
* <p>An array of user identifiers that this condition applies to. Users listed here are subject to the access rule defined by this condition.</p>
|
|
5256
|
+
* @public
|
|
5257
|
+
*/
|
|
5258
|
+
users?: DocumentAclUser[] | undefined;
|
|
5259
|
+
/**
|
|
5260
|
+
* <p>An array of group identifiers that this condition applies to. Groups listed here are subject to the access rule defined by this condition.</p>
|
|
5261
|
+
* @public
|
|
5262
|
+
*/
|
|
5263
|
+
groups?: DocumentAclGroup[] | undefined;
|
|
5264
|
+
}
|
|
5265
|
+
/**
|
|
5266
|
+
* <p>Represents membership rules in the document's ACL, defining how users or groups are associated with access permissions.</p>
|
|
5267
|
+
* @public
|
|
5268
|
+
*/
|
|
5269
|
+
export interface DocumentAclMembership {
|
|
5270
|
+
/**
|
|
5271
|
+
* <p>The logical relation between members in the membership rule, determining how multiple conditions are combined.</p>
|
|
5272
|
+
* @public
|
|
5273
|
+
*/
|
|
5274
|
+
memberRelation?: MemberRelation | undefined;
|
|
5275
|
+
/**
|
|
5276
|
+
* <p>An array of conditions that define the membership rules. Each condition specifies criteria for users or groups to be included in this membership.</p>
|
|
5277
|
+
* @public
|
|
5278
|
+
*/
|
|
5279
|
+
conditions?: DocumentAclCondition[] | undefined;
|
|
5280
|
+
}
|
|
5281
|
+
/**
|
|
5282
|
+
* <p>Represents the Access Control List (ACL) for a document, containing both allowlist and denylist conditions.</p>
|
|
5283
|
+
* @public
|
|
5284
|
+
*/
|
|
5285
|
+
export interface DocumentAcl {
|
|
5286
|
+
/**
|
|
5287
|
+
* <p>The allowlist conditions for the document. Users or groups matching these conditions are granted access to the document.</p>
|
|
5288
|
+
* @public
|
|
5289
|
+
*/
|
|
5290
|
+
allowlist?: DocumentAclMembership | undefined;
|
|
5291
|
+
/**
|
|
5292
|
+
* <p>The denylist conditions for the document. Users or groups matching these conditions are denied access to the document, overriding allowlist permissions.</p>
|
|
5293
|
+
* @public
|
|
5294
|
+
*/
|
|
5295
|
+
denyList?: DocumentAclMembership | undefined;
|
|
5296
|
+
}
|
|
5297
|
+
/**
|
|
5298
|
+
* @public
|
|
5299
|
+
*/
|
|
5300
|
+
export interface CheckDocumentAccessResponse {
|
|
5301
|
+
/**
|
|
5302
|
+
* <p>An array of groups the user is part of for the specified data source. Each group has a name and type.</p>
|
|
5303
|
+
* @public
|
|
5304
|
+
*/
|
|
5305
|
+
userGroups?: AssociatedGroup[] | undefined;
|
|
5306
|
+
/**
|
|
5307
|
+
* <p>An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.</p>
|
|
5308
|
+
* @public
|
|
5309
|
+
*/
|
|
5310
|
+
userAliases?: AssociatedUser[] | undefined;
|
|
5311
|
+
/**
|
|
5312
|
+
* <p>A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document.</p>
|
|
5313
|
+
* @public
|
|
5314
|
+
*/
|
|
5315
|
+
hasAccess?: boolean | undefined;
|
|
5316
|
+
/**
|
|
5317
|
+
* <p>The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.</p>
|
|
5318
|
+
* @public
|
|
5319
|
+
*/
|
|
5320
|
+
documentAcl?: DocumentAcl | undefined;
|
|
5321
|
+
}
|
|
5322
|
+
/**
|
|
5323
|
+
* <p>A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.</p>
|
|
5729
5324
|
* @public
|
|
5730
5325
|
*/
|
|
5731
5326
|
export interface ContentBlockerRule {
|
|
5732
5327
|
/**
|
|
5733
|
-
* <p>The configured custom message displayed to an end user informing them that they've
|
|
5734
|
-
* used a blocked phrase during chat.</p>
|
|
5328
|
+
* <p>The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.</p>
|
|
5735
5329
|
* @public
|
|
5736
5330
|
*/
|
|
5737
5331
|
systemMessageOverride?: string | undefined;
|
|
@@ -5753,14 +5347,12 @@ export interface EligibleDataSource {
|
|
|
5753
5347
|
dataSourceId?: string | undefined;
|
|
5754
5348
|
}
|
|
5755
5349
|
/**
|
|
5756
|
-
* <p>Rules for retrieving content from data sources connected to a Amazon Q Business
|
|
5757
|
-
* application for a specific topic control configuration.</p>
|
|
5350
|
+
* <p>Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.</p>
|
|
5758
5351
|
* @public
|
|
5759
5352
|
*/
|
|
5760
5353
|
export interface ContentRetrievalRule {
|
|
5761
5354
|
/**
|
|
5762
|
-
* <p>Specifies data sources in a Amazon Q Business application to use for content
|
|
5763
|
-
* generation.</p>
|
|
5355
|
+
* <p>Specifies data sources in a Amazon Q Business application to use for content generation.</p>
|
|
5764
5356
|
* @public
|
|
5765
5357
|
*/
|
|
5766
5358
|
eligibleDataSources?: EligibleDataSource[] | undefined;
|
|
@@ -5828,8 +5420,7 @@ export interface Conversation {
|
|
|
5828
5420
|
startTime?: Date | undefined;
|
|
5829
5421
|
}
|
|
5830
5422
|
/**
|
|
5831
|
-
* <p>A user or group in the IAM Identity Center instance connected to the Amazon Q Business
|
|
5832
|
-
* application.</p>
|
|
5423
|
+
* <p>A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
5833
5424
|
* @public
|
|
5834
5425
|
*/
|
|
5835
5426
|
export type SubscriptionPrincipal = SubscriptionPrincipal.GroupMember | SubscriptionPrincipal.UserMember | SubscriptionPrincipal.$UnknownMember;
|
|
@@ -5838,8 +5429,7 @@ export type SubscriptionPrincipal = SubscriptionPrincipal.GroupMember | Subscrip
|
|
|
5838
5429
|
*/
|
|
5839
5430
|
export declare namespace SubscriptionPrincipal {
|
|
5840
5431
|
/**
|
|
5841
|
-
* <p>The identifier of a user in the IAM Identity Center instance connected to the
|
|
5842
|
-
* Amazon Q Business application.</p>
|
|
5432
|
+
* <p>The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
5843
5433
|
* @public
|
|
5844
5434
|
*/
|
|
5845
5435
|
interface UserMember {
|
|
@@ -5848,8 +5438,7 @@ export declare namespace SubscriptionPrincipal {
|
|
|
5848
5438
|
$unknown?: never;
|
|
5849
5439
|
}
|
|
5850
5440
|
/**
|
|
5851
|
-
* <p>The identifier of a group in the IAM Identity Center instance connected to the
|
|
5852
|
-
* Amazon Q Business application.</p>
|
|
5441
|
+
* <p>The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
5853
5442
|
* @public
|
|
5854
5443
|
*/
|
|
5855
5444
|
interface GroupMember {
|
|
@@ -5877,14 +5466,12 @@ export declare namespace SubscriptionPrincipal {
|
|
|
5877
5466
|
*/
|
|
5878
5467
|
export interface CreateSubscriptionRequest {
|
|
5879
5468
|
/**
|
|
5880
|
-
* <p>The identifier of the Amazon Q Business application the subscription should be added
|
|
5881
|
-
* to.</p>
|
|
5469
|
+
* <p>The identifier of the Amazon Q Business application the subscription should be added to.</p>
|
|
5882
5470
|
* @public
|
|
5883
5471
|
*/
|
|
5884
5472
|
applicationId: string | undefined;
|
|
5885
5473
|
/**
|
|
5886
|
-
* <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group
|
|
5887
|
-
* in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
5474
|
+
* <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
5888
5475
|
* @public
|
|
5889
5476
|
*/
|
|
5890
5477
|
principal: SubscriptionPrincipal | undefined;
|
|
@@ -5894,8 +5481,7 @@ export interface CreateSubscriptionRequest {
|
|
|
5894
5481
|
*/
|
|
5895
5482
|
type: SubscriptionType | undefined;
|
|
5896
5483
|
/**
|
|
5897
|
-
* <p>A token that you provide to identify the request to create a subscription for your
|
|
5898
|
-
* Amazon Q Business application.</p>
|
|
5484
|
+
* <p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p>
|
|
5899
5485
|
* @public
|
|
5900
5486
|
*/
|
|
5901
5487
|
clientToken?: string | undefined;
|
|
@@ -5966,8 +5552,7 @@ export interface CreateUserRequest {
|
|
|
5966
5552
|
*/
|
|
5967
5553
|
userAliases?: UserAlias[] | undefined;
|
|
5968
5554
|
/**
|
|
5969
|
-
* <p>A token that you provide to identify the request to create your Amazon Q Business user
|
|
5970
|
-
* mapping.</p>
|
|
5555
|
+
* <p>A token that you provide to identify the request to create your Amazon Q Business user mapping.</p>
|
|
5971
5556
|
* @public
|
|
5972
5557
|
*/
|
|
5973
5558
|
clientToken?: string | undefined;
|
|
@@ -5978,51 +5563,43 @@ export interface CreateUserRequest {
|
|
|
5978
5563
|
export interface CreateUserResponse {
|
|
5979
5564
|
}
|
|
5980
5565
|
/**
|
|
5981
|
-
* <p>Configuration information required to invoke chat in <code>CREATOR_MODE</code>.</p>
|
|
5982
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
5566
|
+
* <p>Configuration information required to invoke chat in <code>CREATOR_MODE</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
5983
5567
|
* @public
|
|
5984
5568
|
*/
|
|
5985
5569
|
export interface CreatorModeConfiguration {
|
|
5986
5570
|
/**
|
|
5987
|
-
* <p>Status information about whether <code>CREATOR_MODE</code> has been enabled or
|
|
5988
|
-
* disabled. The default status is <code>DISABLED</code>.</p>
|
|
5571
|
+
* <p>Status information about whether <code>CREATOR_MODE</code> has been enabled or disabled. The default status is <code>DISABLED</code>.</p>
|
|
5989
5572
|
* @public
|
|
5990
5573
|
*/
|
|
5991
5574
|
creatorModeControl: CreatorModeControl | undefined;
|
|
5992
5575
|
}
|
|
5993
5576
|
/**
|
|
5994
|
-
* <p>Maps a batch delete document request to a specific Amazon Q Business data source connector
|
|
5995
|
-
* sync job.</p>
|
|
5577
|
+
* <p>Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.</p>
|
|
5996
5578
|
* @public
|
|
5997
5579
|
*/
|
|
5998
5580
|
export interface DataSourceSyncJobMetrics {
|
|
5999
5581
|
/**
|
|
6000
|
-
* <p>The current count of documents added from the data source during the data source
|
|
6001
|
-
* sync.</p>
|
|
5582
|
+
* <p>The current count of documents added from the data source during the data source sync.</p>
|
|
6002
5583
|
* @public
|
|
6003
5584
|
*/
|
|
6004
5585
|
documentsAdded?: string | undefined;
|
|
6005
5586
|
/**
|
|
6006
|
-
* <p>The current count of documents modified in the data source during the data source
|
|
6007
|
-
* sync.</p>
|
|
5587
|
+
* <p>The current count of documents modified in the data source during the data source sync.</p>
|
|
6008
5588
|
* @public
|
|
6009
5589
|
*/
|
|
6010
5590
|
documentsModified?: string | undefined;
|
|
6011
5591
|
/**
|
|
6012
|
-
* <p>The current count of documents deleted from the data source during the data source
|
|
6013
|
-
* sync.</p>
|
|
5592
|
+
* <p>The current count of documents deleted from the data source during the data source sync.</p>
|
|
6014
5593
|
* @public
|
|
6015
5594
|
*/
|
|
6016
5595
|
documentsDeleted?: string | undefined;
|
|
6017
5596
|
/**
|
|
6018
|
-
* <p>The current count of documents that failed to sync from the data source during the
|
|
6019
|
-
* data source sync.</p>
|
|
5597
|
+
* <p>The current count of documents that failed to sync from the data source during the data source sync.</p>
|
|
6020
5598
|
* @public
|
|
6021
5599
|
*/
|
|
6022
5600
|
documentsFailed?: string | undefined;
|
|
6023
5601
|
/**
|
|
6024
|
-
* <p>The current count of documents crawled by the ongoing sync job in the data
|
|
6025
|
-
* source.</p>
|
|
5602
|
+
* <p>The current count of documents crawled by the ongoing sync job in the data source.</p>
|
|
6026
5603
|
* @public
|
|
6027
5604
|
*/
|
|
6028
5605
|
documentsScanned?: string | undefined;
|
|
@@ -6045,8 +5622,7 @@ export declare const DataSourceSyncJobStatus: {
|
|
|
6045
5622
|
*/
|
|
6046
5623
|
export type DataSourceSyncJobStatus = (typeof DataSourceSyncJobStatus)[keyof typeof DataSourceSyncJobStatus];
|
|
6047
5624
|
/**
|
|
6048
|
-
* <p>Provides information about an Amazon Q Business data source connector synchronization
|
|
6049
|
-
* job.</p>
|
|
5625
|
+
* <p>Provides information about an Amazon Q Business data source connector synchronization job.</p>
|
|
6050
5626
|
* @public
|
|
6051
5627
|
*/
|
|
6052
5628
|
export interface DataSourceSyncJob {
|
|
@@ -6066,29 +5642,22 @@ export interface DataSourceSyncJob {
|
|
|
6066
5642
|
*/
|
|
6067
5643
|
endTime?: Date | undefined;
|
|
6068
5644
|
/**
|
|
6069
|
-
* <p>The status of the synchronization job. When the <code>Status</code> field is set to
|
|
6070
|
-
* <code>SUCCEEDED</code>, the synchronization job is done. If the status code is
|
|
6071
|
-
* <code>FAILED</code>, the <code>ErrorCode</code> and <code>ErrorMessage</code> fields
|
|
6072
|
-
* give you the reason for the failure.</p>
|
|
5645
|
+
* <p>The status of the synchronization job. When the <code>Status</code> field is set to <code>SUCCEEDED</code>, the synchronization job is done. If the status code is <code>FAILED</code>, the <code>ErrorCode</code> and <code>ErrorMessage</code> fields give you the reason for the failure.</p>
|
|
6073
5646
|
* @public
|
|
6074
5647
|
*/
|
|
6075
5648
|
status?: DataSourceSyncJobStatus | undefined;
|
|
6076
5649
|
/**
|
|
6077
|
-
* <p>If the <code>Status</code> field is set to <code>FAILED</code>, the
|
|
6078
|
-
* <code>ErrorCode</code> field indicates the reason the synchronization failed. </p>
|
|
5650
|
+
* <p>If the <code>Status</code> field is set to <code>FAILED</code>, the <code>ErrorCode</code> field indicates the reason the synchronization failed. </p>
|
|
6079
5651
|
* @public
|
|
6080
5652
|
*/
|
|
6081
5653
|
error?: ErrorDetail | undefined;
|
|
6082
5654
|
/**
|
|
6083
|
-
* <p>If the reason that the synchronization failed is due to an error with the underlying
|
|
6084
|
-
* data source, this field contains a code that identifies the error.</p>
|
|
5655
|
+
* <p>If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.</p>
|
|
6085
5656
|
* @public
|
|
6086
5657
|
*/
|
|
6087
5658
|
dataSourceErrorCode?: string | undefined;
|
|
6088
5659
|
/**
|
|
6089
|
-
* <p>Maps a batch delete document request to a specific data source sync job. This is
|
|
6090
|
-
* optional and should only be supplied when documents are deleted by a data source
|
|
6091
|
-
* connector.</p>
|
|
5660
|
+
* <p>Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.</p>
|
|
6092
5661
|
* @public
|
|
6093
5662
|
*/
|
|
6094
5663
|
metrics?: DataSourceSyncJobMetrics | undefined;
|
|
@@ -6148,8 +5717,7 @@ export interface DeleteConversationRequest {
|
|
|
6148
5717
|
*/
|
|
6149
5718
|
conversationId: string | undefined;
|
|
6150
5719
|
/**
|
|
6151
|
-
* <p>The identifier of the Amazon Q Business application associated with the
|
|
6152
|
-
* conversation.</p>
|
|
5720
|
+
* <p>The identifier of the Amazon Q Business application associated with the conversation.</p>
|
|
6153
5721
|
* @public
|
|
6154
5722
|
*/
|
|
6155
5723
|
applicationId: string | undefined;
|
|
@@ -6184,14 +5752,7 @@ export interface DeleteGroupRequest {
|
|
|
6184
5752
|
*/
|
|
6185
5753
|
groupName: string | undefined;
|
|
6186
5754
|
/**
|
|
6187
|
-
* <p>The identifier of the data source linked to the group</p>
|
|
6188
|
-
* <p>A group can be tied to multiple data sources. You can delete a group from accessing
|
|
6189
|
-
* documents in a certain data source. For example, the groups "Research", "Engineering",
|
|
6190
|
-
* and "Sales and Marketing" are all tied to the company's documents stored in the data
|
|
6191
|
-
* sources Confluence and Salesforce. You want to delete "Research" and "Engineering"
|
|
6192
|
-
* groups from Salesforce, so that these groups cannot access customer-related documents
|
|
6193
|
-
* stored in Salesforce. Only "Sales and Marketing" should access documents in the
|
|
6194
|
-
* Salesforce data source.</p>
|
|
5755
|
+
* <p>The identifier of the data source linked to the group</p> <p>A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.</p>
|
|
6195
5756
|
* @public
|
|
6196
5757
|
*/
|
|
6197
5758
|
dataSourceId?: string | undefined;
|
|
@@ -6305,14 +5866,34 @@ export interface GetChatControlsConfigurationRequest {
|
|
|
6305
5866
|
*/
|
|
6306
5867
|
maxResults?: number | undefined;
|
|
6307
5868
|
/**
|
|
6308
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
6309
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
6310
|
-
* pagination token to retrieve the next set of Amazon Q Business chat controls
|
|
6311
|
-
* configured.</p>
|
|
5869
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.</p>
|
|
6312
5870
|
* @public
|
|
6313
5871
|
*/
|
|
6314
5872
|
nextToken?: string | undefined;
|
|
6315
5873
|
}
|
|
5874
|
+
/**
|
|
5875
|
+
* @public
|
|
5876
|
+
* @enum
|
|
5877
|
+
*/
|
|
5878
|
+
export declare const HallucinationReductionControl: {
|
|
5879
|
+
readonly DISABLED: "DISABLED";
|
|
5880
|
+
readonly ENABLED: "ENABLED";
|
|
5881
|
+
};
|
|
5882
|
+
/**
|
|
5883
|
+
* @public
|
|
5884
|
+
*/
|
|
5885
|
+
export type HallucinationReductionControl = (typeof HallucinationReductionControl)[keyof typeof HallucinationReductionControl];
|
|
5886
|
+
/**
|
|
5887
|
+
* <p>Configuration information required to setup hallucination reduction. For more information, see <a href="amazonq/latest/qbusiness-ug/hallucination-reduction.html">hallucination reduction</a>.</p> <note> <p>The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.</p> </note>
|
|
5888
|
+
* @public
|
|
5889
|
+
*/
|
|
5890
|
+
export interface HallucinationReductionConfiguration {
|
|
5891
|
+
/**
|
|
5892
|
+
* <p>Controls whether hallucination reduction has been enabled or disabled for your application. The default status is <code>DISABLED</code>. </p>
|
|
5893
|
+
* @public
|
|
5894
|
+
*/
|
|
5895
|
+
hallucinationReductionControl?: HallucinationReductionControl | undefined;
|
|
5896
|
+
}
|
|
6316
5897
|
/**
|
|
6317
5898
|
* @public
|
|
6318
5899
|
* @enum
|
|
@@ -6326,8 +5907,7 @@ export declare const ResponseScope: {
|
|
|
6326
5907
|
*/
|
|
6327
5908
|
export type ResponseScope = (typeof ResponseScope)[keyof typeof ResponseScope];
|
|
6328
5909
|
/**
|
|
6329
|
-
* <p>Provides information about users and group names associated with a topic control
|
|
6330
|
-
* rule.</p>
|
|
5910
|
+
* <p>Provides information about users and group names associated with a topic control rule.</p>
|
|
6331
5911
|
* @public
|
|
6332
5912
|
*/
|
|
6333
5913
|
export interface UsersAndGroups {
|
|
@@ -6352,8 +5932,7 @@ export type RuleConfiguration = RuleConfiguration.ContentBlockerRuleMember | Rul
|
|
|
6352
5932
|
*/
|
|
6353
5933
|
export declare namespace RuleConfiguration {
|
|
6354
5934
|
/**
|
|
6355
|
-
* <p>A rule for configuring how Amazon Q Business responds when it encounters a a blocked
|
|
6356
|
-
* topic.</p>
|
|
5935
|
+
* <p>A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.</p>
|
|
6357
5936
|
* @public
|
|
6358
5937
|
*/
|
|
6359
5938
|
interface ContentBlockerRuleMember {
|
|
@@ -6362,8 +5941,7 @@ export declare namespace RuleConfiguration {
|
|
|
6362
5941
|
$unknown?: never;
|
|
6363
5942
|
}
|
|
6364
5943
|
/**
|
|
6365
|
-
* <p>Rules for retrieving content from data sources connected to a Amazon Q Business
|
|
6366
|
-
* application for a specific topic control configuration.</p>
|
|
5944
|
+
* <p>Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.</p>
|
|
6367
5945
|
* @public
|
|
6368
5946
|
*/
|
|
6369
5947
|
interface ContentRetrievalRuleMember {
|
|
@@ -6399,8 +5977,7 @@ export declare const RuleType: {
|
|
|
6399
5977
|
*/
|
|
6400
5978
|
export type RuleType = (typeof RuleType)[keyof typeof RuleType];
|
|
6401
5979
|
/**
|
|
6402
|
-
* <p>Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule
|
|
6403
|
-
* at a time.</p>
|
|
5980
|
+
* <p>Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.</p>
|
|
6404
5981
|
* @public
|
|
6405
5982
|
*/
|
|
6406
5983
|
export interface Rule {
|
|
@@ -6436,14 +6013,12 @@ export interface TopicConfiguration {
|
|
|
6436
6013
|
*/
|
|
6437
6014
|
name: string | undefined;
|
|
6438
6015
|
/**
|
|
6439
|
-
* <p>A description for your topic control configuration. Use this to outline how the large
|
|
6440
|
-
* language model (LLM) should use this topic control configuration.</p>
|
|
6016
|
+
* <p>A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.</p>
|
|
6441
6017
|
* @public
|
|
6442
6018
|
*/
|
|
6443
6019
|
description?: string | undefined;
|
|
6444
6020
|
/**
|
|
6445
|
-
* <p>A list of example phrases that you expect the end user to use in relation to the
|
|
6446
|
-
* topic.</p>
|
|
6021
|
+
* <p>A list of example phrases that you expect the end user to use in relation to the topic.</p>
|
|
6447
6022
|
* @public
|
|
6448
6023
|
*/
|
|
6449
6024
|
exampleChatMessages?: string[] | undefined;
|
|
@@ -6458,19 +6033,12 @@ export interface TopicConfiguration {
|
|
|
6458
6033
|
*/
|
|
6459
6034
|
export interface GetChatControlsConfigurationResponse {
|
|
6460
6035
|
/**
|
|
6461
|
-
* <p>The response scope configured for a Amazon Q Business application. This determines whether
|
|
6462
|
-
* your application uses its retrieval augmented generation (RAG) system to generate
|
|
6463
|
-
* answers only from your enterprise data, or also uses the large language models (LLM)
|
|
6464
|
-
* knowledge to respons to end user questions in chat.</p>
|
|
6036
|
+
* <p>The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.</p>
|
|
6465
6037
|
* @public
|
|
6466
6038
|
*/
|
|
6467
6039
|
responseScope?: ResponseScope | undefined;
|
|
6468
6040
|
/**
|
|
6469
|
-
* <p> The chat response orchestration settings for your application.</p>
|
|
6470
|
-
* <note>
|
|
6471
|
-
* <p>Chat orchestration is optimized to work for English language content. For more
|
|
6472
|
-
* details on language support in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html">Supported languages</a>.</p>
|
|
6473
|
-
* </note>
|
|
6041
|
+
* <p> The chat response orchestration settings for your application.</p> <note> <p>Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html">Supported languages</a>.</p> </note>
|
|
6474
6042
|
* @public
|
|
6475
6043
|
*/
|
|
6476
6044
|
orchestrationConfiguration?: AppliedOrchestrationConfiguration | undefined;
|
|
@@ -6490,13 +6058,15 @@ export interface GetChatControlsConfigurationResponse {
|
|
|
6490
6058
|
*/
|
|
6491
6059
|
creatorModeConfiguration?: AppliedCreatorModeConfiguration | undefined;
|
|
6492
6060
|
/**
|
|
6493
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
6494
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
6495
|
-
* pagination token to retrieve the next set of Amazon Q Business chat controls
|
|
6496
|
-
* configured.</p>
|
|
6061
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.</p>
|
|
6497
6062
|
* @public
|
|
6498
6063
|
*/
|
|
6499
6064
|
nextToken?: string | undefined;
|
|
6065
|
+
/**
|
|
6066
|
+
* <p> The hallucination reduction settings for your application.</p>
|
|
6067
|
+
* @public
|
|
6068
|
+
*/
|
|
6069
|
+
hallucinationReductionConfiguration?: HallucinationReductionConfiguration | undefined;
|
|
6500
6070
|
}
|
|
6501
6071
|
/**
|
|
6502
6072
|
* @public
|
|
@@ -6691,8 +6261,7 @@ export interface ListAttachmentsRequest {
|
|
|
6691
6261
|
*/
|
|
6692
6262
|
userId?: string | undefined;
|
|
6693
6263
|
/**
|
|
6694
|
-
* <p>If the number of attachments returned exceeds <code>maxResults</code>, Amazon Q Business
|
|
6695
|
-
* returns a next token as a pagination token to retrieve the next set of attachments.</p>
|
|
6264
|
+
* <p>If the number of attachments returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments.</p>
|
|
6696
6265
|
* @public
|
|
6697
6266
|
*/
|
|
6698
6267
|
nextToken?: string | undefined;
|
|
@@ -6712,8 +6281,7 @@ export interface ListAttachmentsResponse {
|
|
|
6712
6281
|
*/
|
|
6713
6282
|
attachments?: Attachment[] | undefined;
|
|
6714
6283
|
/**
|
|
6715
|
-
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
6716
|
-
* later request to list the next set of attachments.</p>
|
|
6284
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of attachments.</p>
|
|
6717
6285
|
* @public
|
|
6718
6286
|
*/
|
|
6719
6287
|
nextToken?: string | undefined;
|
|
@@ -6728,15 +6296,12 @@ export interface ListConversationsRequest {
|
|
|
6728
6296
|
*/
|
|
6729
6297
|
applicationId: string | undefined;
|
|
6730
6298
|
/**
|
|
6731
|
-
* <p>The identifier of the user involved in the Amazon Q Business web experience conversation.
|
|
6732
|
-
* </p>
|
|
6299
|
+
* <p>The identifier of the user involved in the Amazon Q Business web experience conversation. </p>
|
|
6733
6300
|
* @public
|
|
6734
6301
|
*/
|
|
6735
6302
|
userId?: string | undefined;
|
|
6736
6303
|
/**
|
|
6737
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
6738
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
6739
|
-
* pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
6304
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
6740
6305
|
* @public
|
|
6741
6306
|
*/
|
|
6742
6307
|
nextToken?: string | undefined;
|
|
@@ -6751,14 +6316,12 @@ export interface ListConversationsRequest {
|
|
|
6751
6316
|
*/
|
|
6752
6317
|
export interface ListConversationsResponse {
|
|
6753
6318
|
/**
|
|
6754
|
-
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
6755
|
-
* later request to list the next set of messages.</p>
|
|
6319
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.</p>
|
|
6756
6320
|
* @public
|
|
6757
6321
|
*/
|
|
6758
6322
|
nextToken?: string | undefined;
|
|
6759
6323
|
/**
|
|
6760
|
-
* <p>An array of summary information on the configuration of one or more Amazon Q Business web
|
|
6761
|
-
* experiences.</p>
|
|
6324
|
+
* <p>An array of summary information on the configuration of one or more Amazon Q Business web experiences.</p>
|
|
6762
6325
|
* @public
|
|
6763
6326
|
*/
|
|
6764
6327
|
conversations?: Conversation[] | undefined;
|
|
@@ -6783,9 +6346,7 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
6783
6346
|
*/
|
|
6784
6347
|
indexId: string | undefined;
|
|
6785
6348
|
/**
|
|
6786
|
-
* <p>If the <code>maxResults</code> response was incpmplete because there is more data to
|
|
6787
|
-
* retriever, Amazon Q Business returns a pagination token in the response. You can use this
|
|
6788
|
-
* pagination token to retrieve the next set of responses.</p>
|
|
6349
|
+
* <p>If the <code>maxResults</code> response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.</p>
|
|
6789
6350
|
* @public
|
|
6790
6351
|
*/
|
|
6791
6352
|
nextToken?: string | undefined;
|
|
@@ -6805,8 +6366,7 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
6805
6366
|
*/
|
|
6806
6367
|
endTime?: Date | undefined;
|
|
6807
6368
|
/**
|
|
6808
|
-
* <p>Only returns synchronization jobs with the <code>Status</code> field equal to the
|
|
6809
|
-
* specified status.</p>
|
|
6369
|
+
* <p>Only returns synchronization jobs with the <code>Status</code> field equal to the specified status.</p>
|
|
6810
6370
|
* @public
|
|
6811
6371
|
*/
|
|
6812
6372
|
statusFilter?: DataSourceSyncJobStatus | undefined;
|
|
@@ -6821,8 +6381,7 @@ export interface ListDataSourceSyncJobsResponse {
|
|
|
6821
6381
|
*/
|
|
6822
6382
|
history?: DataSourceSyncJob[] | undefined;
|
|
6823
6383
|
/**
|
|
6824
|
-
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
6825
|
-
* in any subsequent request to retrieve the next set of jobs.</p>
|
|
6384
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.</p>
|
|
6826
6385
|
* @public
|
|
6827
6386
|
*/
|
|
6828
6387
|
nextToken?: string | undefined;
|
|
@@ -6847,9 +6406,7 @@ export interface ListDocumentsRequest {
|
|
|
6847
6406
|
*/
|
|
6848
6407
|
dataSourceIds?: string[] | undefined;
|
|
6849
6408
|
/**
|
|
6850
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
6851
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
6852
|
-
* pagination token to retrieve the next set of documents.</p>
|
|
6409
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.</p>
|
|
6853
6410
|
* @public
|
|
6854
6411
|
*/
|
|
6855
6412
|
nextToken?: string | undefined;
|
|
@@ -6859,279 +6416,6 @@ export interface ListDocumentsRequest {
|
|
|
6859
6416
|
*/
|
|
6860
6417
|
maxResults?: number | undefined;
|
|
6861
6418
|
}
|
|
6862
|
-
/**
|
|
6863
|
-
* @public
|
|
6864
|
-
*/
|
|
6865
|
-
export interface ListDocumentsResponse {
|
|
6866
|
-
/**
|
|
6867
|
-
* <p>A list of document details.</p>
|
|
6868
|
-
* @public
|
|
6869
|
-
*/
|
|
6870
|
-
documentDetailList?: DocumentDetails[] | undefined;
|
|
6871
|
-
/**
|
|
6872
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
6873
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
6874
|
-
* pagination token to retrieve the next set of documents.</p>
|
|
6875
|
-
* @public
|
|
6876
|
-
*/
|
|
6877
|
-
nextToken?: string | undefined;
|
|
6878
|
-
}
|
|
6879
|
-
/**
|
|
6880
|
-
* @public
|
|
6881
|
-
*/
|
|
6882
|
-
export interface ListGroupsRequest {
|
|
6883
|
-
/**
|
|
6884
|
-
* <p>The identifier of the application for getting a list of groups mapped to users.</p>
|
|
6885
|
-
* @public
|
|
6886
|
-
*/
|
|
6887
|
-
applicationId: string | undefined;
|
|
6888
|
-
/**
|
|
6889
|
-
* <p>The identifier of the index for getting a list of groups mapped to users.</p>
|
|
6890
|
-
* @public
|
|
6891
|
-
*/
|
|
6892
|
-
indexId: string | undefined;
|
|
6893
|
-
/**
|
|
6894
|
-
* <p>The timestamp identifier used for the latest <code>PUT</code> or <code>DELETE</code>
|
|
6895
|
-
* action for mapping users to their groups.</p>
|
|
6896
|
-
* @public
|
|
6897
|
-
*/
|
|
6898
|
-
updatedEarlierThan: Date | undefined;
|
|
6899
|
-
/**
|
|
6900
|
-
* <p>The identifier of the data source for getting a list of groups mapped to users.</p>
|
|
6901
|
-
* @public
|
|
6902
|
-
*/
|
|
6903
|
-
dataSourceId?: string | undefined;
|
|
6904
|
-
/**
|
|
6905
|
-
* <p>If the previous response was incomplete (because there is more data to retrieve),
|
|
6906
|
-
* Amazon Q Business returns a pagination token in the response. You can use this pagination
|
|
6907
|
-
* token to retrieve the next set of groups that are mapped to users.</p>
|
|
6908
|
-
* @public
|
|
6909
|
-
*/
|
|
6910
|
-
nextToken?: string | undefined;
|
|
6911
|
-
/**
|
|
6912
|
-
* <p>The maximum number of returned groups that are mapped to users.</p>
|
|
6913
|
-
* @public
|
|
6914
|
-
*/
|
|
6915
|
-
maxResults?: number | undefined;
|
|
6916
|
-
}
|
|
6917
|
-
/**
|
|
6918
|
-
* <p>Summary information for groups.</p>
|
|
6919
|
-
* @public
|
|
6920
|
-
*/
|
|
6921
|
-
export interface GroupSummary {
|
|
6922
|
-
/**
|
|
6923
|
-
* <p>The name of the group the summary information is for.</p>
|
|
6924
|
-
* @public
|
|
6925
|
-
*/
|
|
6926
|
-
groupName?: string | undefined;
|
|
6927
|
-
}
|
|
6928
|
-
/**
|
|
6929
|
-
* @public
|
|
6930
|
-
*/
|
|
6931
|
-
export interface ListGroupsResponse {
|
|
6932
|
-
/**
|
|
6933
|
-
* <p>If the response is truncated, Amazon Q Business returns this token that you can use in the
|
|
6934
|
-
* subsequent request to retrieve the next set of groups that are mapped to users.</p>
|
|
6935
|
-
* @public
|
|
6936
|
-
*/
|
|
6937
|
-
nextToken?: string | undefined;
|
|
6938
|
-
/**
|
|
6939
|
-
* <p>Summary information for list of groups that are mapped to users.</p>
|
|
6940
|
-
* @public
|
|
6941
|
-
*/
|
|
6942
|
-
items?: GroupSummary[] | undefined;
|
|
6943
|
-
}
|
|
6944
|
-
/**
|
|
6945
|
-
* @public
|
|
6946
|
-
*/
|
|
6947
|
-
export interface ListMessagesRequest {
|
|
6948
|
-
/**
|
|
6949
|
-
* <p>The identifier of the Amazon Q Business web experience conversation.</p>
|
|
6950
|
-
* @public
|
|
6951
|
-
*/
|
|
6952
|
-
conversationId: string | undefined;
|
|
6953
|
-
/**
|
|
6954
|
-
* <p>The identifier for the Amazon Q Business application.</p>
|
|
6955
|
-
* @public
|
|
6956
|
-
*/
|
|
6957
|
-
applicationId: string | undefined;
|
|
6958
|
-
/**
|
|
6959
|
-
* <p>The identifier of the user involved in the Amazon Q Business web experience
|
|
6960
|
-
* conversation.</p>
|
|
6961
|
-
* @public
|
|
6962
|
-
*/
|
|
6963
|
-
userId?: string | undefined;
|
|
6964
|
-
/**
|
|
6965
|
-
* <p>If the number of messages returned exceeds <code>maxResults</code>, Amazon Q Business
|
|
6966
|
-
* returns a next token as a pagination token to retrieve the next set of messages.</p>
|
|
6967
|
-
* @public
|
|
6968
|
-
*/
|
|
6969
|
-
nextToken?: string | undefined;
|
|
6970
|
-
/**
|
|
6971
|
-
* <p>The maximum number of messages to return.</p>
|
|
6972
|
-
* @public
|
|
6973
|
-
*/
|
|
6974
|
-
maxResults?: number | undefined;
|
|
6975
|
-
}
|
|
6976
|
-
/**
|
|
6977
|
-
* @public
|
|
6978
|
-
* @enum
|
|
6979
|
-
*/
|
|
6980
|
-
export declare const MessageType: {
|
|
6981
|
-
readonly SYSTEM: "SYSTEM";
|
|
6982
|
-
readonly USER: "USER";
|
|
6983
|
-
};
|
|
6984
|
-
/**
|
|
6985
|
-
* @public
|
|
6986
|
-
*/
|
|
6987
|
-
export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
6988
|
-
/**
|
|
6989
|
-
* <p>A message in an Amazon Q Business web experience.</p>
|
|
6990
|
-
* @public
|
|
6991
|
-
*/
|
|
6992
|
-
export interface Message {
|
|
6993
|
-
/**
|
|
6994
|
-
* <p>The identifier of the Amazon Q Business web experience message.</p>
|
|
6995
|
-
* @public
|
|
6996
|
-
*/
|
|
6997
|
-
messageId?: string | undefined;
|
|
6998
|
-
/**
|
|
6999
|
-
* <p>The content of the Amazon Q Business web experience message.</p>
|
|
7000
|
-
* @public
|
|
7001
|
-
*/
|
|
7002
|
-
body?: string | undefined;
|
|
7003
|
-
/**
|
|
7004
|
-
* <p>The timestamp of the first Amazon Q Business web experience message.</p>
|
|
7005
|
-
* @public
|
|
7006
|
-
*/
|
|
7007
|
-
time?: Date | undefined;
|
|
7008
|
-
/**
|
|
7009
|
-
* <p>The type of Amazon Q Business message, whether <code>HUMAN</code> or <code>AI</code>
|
|
7010
|
-
* generated.</p>
|
|
7011
|
-
* @public
|
|
7012
|
-
*/
|
|
7013
|
-
type?: MessageType | undefined;
|
|
7014
|
-
/**
|
|
7015
|
-
* <p>A file directly uploaded into an Amazon Q Business web experience chat.</p>
|
|
7016
|
-
* @public
|
|
7017
|
-
*/
|
|
7018
|
-
attachments?: AttachmentOutput[] | undefined;
|
|
7019
|
-
/**
|
|
7020
|
-
* <p>The source documents used to generate Amazon Q Business web experience message.</p>
|
|
7021
|
-
* @public
|
|
7022
|
-
*/
|
|
7023
|
-
sourceAttribution?: SourceAttribution[] | undefined;
|
|
7024
|
-
/**
|
|
7025
|
-
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin
|
|
7026
|
-
* action during a non-streaming chat conversation. It contains information about the
|
|
7027
|
-
* selected action with a list of possible user input fields, some pre-populated by
|
|
7028
|
-
* Amazon Q Business.</p>
|
|
7029
|
-
* @public
|
|
7030
|
-
*/
|
|
7031
|
-
actionReview?: ActionReview | undefined;
|
|
7032
|
-
/**
|
|
7033
|
-
* <p>Performs an Amazon Q Business plugin action during a non-streaming chat
|
|
7034
|
-
* conversation.</p>
|
|
7035
|
-
* @public
|
|
7036
|
-
*/
|
|
7037
|
-
actionExecution?: ActionExecution | undefined;
|
|
7038
|
-
}
|
|
7039
|
-
/**
|
|
7040
|
-
* @public
|
|
7041
|
-
*/
|
|
7042
|
-
export interface ListMessagesResponse {
|
|
7043
|
-
/**
|
|
7044
|
-
* <p>An array of information on one or more messages.</p>
|
|
7045
|
-
* @public
|
|
7046
|
-
*/
|
|
7047
|
-
messages?: Message[] | undefined;
|
|
7048
|
-
/**
|
|
7049
|
-
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
7050
|
-
* later request to list the next set of messages.</p>
|
|
7051
|
-
* @public
|
|
7052
|
-
*/
|
|
7053
|
-
nextToken?: string | undefined;
|
|
7054
|
-
}
|
|
7055
|
-
/**
|
|
7056
|
-
* @public
|
|
7057
|
-
*/
|
|
7058
|
-
export interface ListPluginActionsRequest {
|
|
7059
|
-
/**
|
|
7060
|
-
* <p>The identifier of the Amazon Q Business application the plugin is attached
|
|
7061
|
-
* to.</p>
|
|
7062
|
-
* @public
|
|
7063
|
-
*/
|
|
7064
|
-
applicationId: string | undefined;
|
|
7065
|
-
/**
|
|
7066
|
-
* <p>The identifier of the Amazon Q Business plugin.</p>
|
|
7067
|
-
* @public
|
|
7068
|
-
*/
|
|
7069
|
-
pluginId: string | undefined;
|
|
7070
|
-
/**
|
|
7071
|
-
* <p>If the number of plugin actions returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set
|
|
7072
|
-
* of plugin actions.</p>
|
|
7073
|
-
* @public
|
|
7074
|
-
*/
|
|
7075
|
-
nextToken?: string | undefined;
|
|
7076
|
-
/**
|
|
7077
|
-
* <p>The maximum number of plugin actions to return.</p>
|
|
7078
|
-
* @public
|
|
7079
|
-
*/
|
|
7080
|
-
maxResults?: number | undefined;
|
|
7081
|
-
}
|
|
7082
|
-
/**
|
|
7083
|
-
* @public
|
|
7084
|
-
*/
|
|
7085
|
-
export interface ListPluginActionsResponse {
|
|
7086
|
-
/**
|
|
7087
|
-
* <p>If the response is truncated, Amazon Q Business returns this token, which you
|
|
7088
|
-
* can use in a later request to list the next set of plugin actions.</p>
|
|
7089
|
-
* @public
|
|
7090
|
-
*/
|
|
7091
|
-
nextToken?: string | undefined;
|
|
7092
|
-
/**
|
|
7093
|
-
* <p>An array of information on one or more plugin actions.</p>
|
|
7094
|
-
* @public
|
|
7095
|
-
*/
|
|
7096
|
-
items?: ActionSummary[] | undefined;
|
|
7097
|
-
}
|
|
7098
|
-
/**
|
|
7099
|
-
* @public
|
|
7100
|
-
*/
|
|
7101
|
-
export interface ListPluginTypeActionsRequest {
|
|
7102
|
-
/**
|
|
7103
|
-
* <p>The type of the plugin.</p>
|
|
7104
|
-
* @public
|
|
7105
|
-
*/
|
|
7106
|
-
pluginType: PluginType | undefined;
|
|
7107
|
-
/**
|
|
7108
|
-
* <p>If the number of plugins returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set
|
|
7109
|
-
* of plugins.</p>
|
|
7110
|
-
* @public
|
|
7111
|
-
*/
|
|
7112
|
-
nextToken?: string | undefined;
|
|
7113
|
-
/**
|
|
7114
|
-
* <p>The maximum number of plugins to return.</p>
|
|
7115
|
-
* @public
|
|
7116
|
-
*/
|
|
7117
|
-
maxResults?: number | undefined;
|
|
7118
|
-
}
|
|
7119
|
-
/**
|
|
7120
|
-
* @public
|
|
7121
|
-
*/
|
|
7122
|
-
export interface ListPluginTypeActionsResponse {
|
|
7123
|
-
/**
|
|
7124
|
-
* <p>If the response is truncated, Amazon Q Business returns this token, which you
|
|
7125
|
-
* can use in a later request to list the next set of plugins.</p>
|
|
7126
|
-
* @public
|
|
7127
|
-
*/
|
|
7128
|
-
nextToken?: string | undefined;
|
|
7129
|
-
/**
|
|
7130
|
-
* <p>An array of information on one or more plugins.</p>
|
|
7131
|
-
* @public
|
|
7132
|
-
*/
|
|
7133
|
-
items?: ActionSummary[] | undefined;
|
|
7134
|
-
}
|
|
7135
6419
|
/**
|
|
7136
6420
|
* @internal
|
|
7137
6421
|
*/
|