@aws-sdk/client-qbusiness 3.688.0 → 3.692.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/dist-types/models/models_0.d.ts +489 -489
- package/dist-types/ts3.4/models/models_0.d.ts +499 -489
- package/package.json +40 -40
|
@@ -46,7 +46,7 @@ export interface PrincipalGroup {
|
|
|
46
46
|
* <p>The name of the group.</p>
|
|
47
47
|
* @public
|
|
48
48
|
*/
|
|
49
|
-
name?: string;
|
|
49
|
+
name?: string | undefined;
|
|
50
50
|
/**
|
|
51
51
|
* <p>Provides information about whether to allow or deny access to the principal.</p>
|
|
52
52
|
* @public
|
|
@@ -56,7 +56,7 @@ export interface PrincipalGroup {
|
|
|
56
56
|
* <p>The type of group.</p>
|
|
57
57
|
* @public
|
|
58
58
|
*/
|
|
59
|
-
membershipType?: MembershipType;
|
|
59
|
+
membershipType?: MembershipType | undefined;
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
62
|
* <p>Provides information about a user associated with a principal.</p>
|
|
@@ -67,7 +67,7 @@ export interface PrincipalUser {
|
|
|
67
67
|
* <p> The identifier of the user. </p>
|
|
68
68
|
* @public
|
|
69
69
|
*/
|
|
70
|
-
id?: string;
|
|
70
|
+
id?: string | undefined;
|
|
71
71
|
/**
|
|
72
72
|
* <p>Provides information about whether to allow or deny access to the principal.</p>
|
|
73
73
|
* @public
|
|
@@ -77,7 +77,7 @@ export interface PrincipalUser {
|
|
|
77
77
|
* <p>The type of group.</p>
|
|
78
78
|
* @public
|
|
79
79
|
*/
|
|
80
|
-
membershipType?: MembershipType;
|
|
80
|
+
membershipType?: MembershipType | undefined;
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
83
|
* <p>Provides user and group information used for filtering documents to use for generating
|
|
@@ -140,7 +140,7 @@ export interface AccessControl {
|
|
|
140
140
|
* <p>Describes the member relation within a principal list.</p>
|
|
141
141
|
* @public
|
|
142
142
|
*/
|
|
143
|
-
memberRelation?: MemberRelation;
|
|
143
|
+
memberRelation?: MemberRelation | undefined;
|
|
144
144
|
}
|
|
145
145
|
/**
|
|
146
146
|
* <p>Used to configure access permissions for a document.</p>
|
|
@@ -156,7 +156,7 @@ export interface AccessConfiguration {
|
|
|
156
156
|
* <p>Describes the member relation within the <code>AccessControlList</code> object.</p>
|
|
157
157
|
* @public
|
|
158
158
|
*/
|
|
159
|
-
memberRelation?: MemberRelation;
|
|
159
|
+
memberRelation?: MemberRelation | undefined;
|
|
160
160
|
}
|
|
161
161
|
/**
|
|
162
162
|
* <p> You don't have access to perform this action. Make sure you have the required
|
|
@@ -254,12 +254,12 @@ export interface ActionReviewPayloadFieldAllowedValue {
|
|
|
254
254
|
* <p>The field value.</p>
|
|
255
255
|
* @public
|
|
256
256
|
*/
|
|
257
|
-
value?: __DocumentType;
|
|
257
|
+
value?: __DocumentType | undefined;
|
|
258
258
|
/**
|
|
259
259
|
* <p>The name of the field.</p>
|
|
260
260
|
* @public
|
|
261
261
|
*/
|
|
262
|
-
displayValue?: __DocumentType;
|
|
262
|
+
displayValue?: __DocumentType | undefined;
|
|
263
263
|
}
|
|
264
264
|
/**
|
|
265
265
|
* <p>A user input field in an plugin action review payload.</p>
|
|
@@ -270,53 +270,53 @@ export interface ActionReviewPayloadField {
|
|
|
270
270
|
* <p> The name of the field. </p>
|
|
271
271
|
* @public
|
|
272
272
|
*/
|
|
273
|
-
displayName?: string;
|
|
273
|
+
displayName?: string | undefined;
|
|
274
274
|
/**
|
|
275
275
|
* <p>The display order of fields in a payload.</p>
|
|
276
276
|
* @public
|
|
277
277
|
*/
|
|
278
|
-
displayOrder?: number;
|
|
278
|
+
displayOrder?: number | undefined;
|
|
279
279
|
/**
|
|
280
280
|
* <p>The field level description of each action review input field. This could be an
|
|
281
281
|
* explanation of the field. In the Amazon Q Business web experience, these descriptions could
|
|
282
282
|
* be used to display as tool tips to help users understand the field. </p>
|
|
283
283
|
* @public
|
|
284
284
|
*/
|
|
285
|
-
displayDescription?: string;
|
|
285
|
+
displayDescription?: string | undefined;
|
|
286
286
|
/**
|
|
287
287
|
* <p>The type of field. </p>
|
|
288
288
|
* @public
|
|
289
289
|
*/
|
|
290
|
-
type?: ActionPayloadFieldType;
|
|
290
|
+
type?: ActionPayloadFieldType | undefined;
|
|
291
291
|
/**
|
|
292
292
|
* <p>The field value.</p>
|
|
293
293
|
* @public
|
|
294
294
|
*/
|
|
295
|
-
value?: __DocumentType;
|
|
295
|
+
value?: __DocumentType | undefined;
|
|
296
296
|
/**
|
|
297
297
|
* <p>Information about the field values that an end user can use to provide to
|
|
298
298
|
* Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
299
299
|
* @public
|
|
300
300
|
*/
|
|
301
|
-
allowedValues?: ActionReviewPayloadFieldAllowedValue[];
|
|
301
|
+
allowedValues?: ActionReviewPayloadFieldAllowedValue[] | undefined;
|
|
302
302
|
/**
|
|
303
303
|
* <p>The expected data format for the action review input field value. For example, in PTO
|
|
304
304
|
* request, <code>from</code> and <code>to</code> would be of <code>datetime</code> allowed
|
|
305
305
|
* format. </p>
|
|
306
306
|
* @public
|
|
307
307
|
*/
|
|
308
|
-
allowedFormat?: string;
|
|
308
|
+
allowedFormat?: string | undefined;
|
|
309
309
|
/**
|
|
310
310
|
* <p>Use to create a custom form with array fields (fields with nested objects inside an
|
|
311
311
|
* array). </p>
|
|
312
312
|
* @public
|
|
313
313
|
*/
|
|
314
|
-
arrayItemJsonSchema?: __DocumentType;
|
|
314
|
+
arrayItemJsonSchema?: __DocumentType | undefined;
|
|
315
315
|
/**
|
|
316
316
|
* <p>Information about whether the field is required.</p>
|
|
317
317
|
* @public
|
|
318
318
|
*/
|
|
319
|
-
required?: boolean;
|
|
319
|
+
required?: boolean | undefined;
|
|
320
320
|
}
|
|
321
321
|
/**
|
|
322
322
|
* @public
|
|
@@ -345,24 +345,24 @@ export interface ActionReview {
|
|
|
345
345
|
* <p>The identifier of the plugin associated with the action review.</p>
|
|
346
346
|
* @public
|
|
347
347
|
*/
|
|
348
|
-
pluginId?: string;
|
|
348
|
+
pluginId?: string | undefined;
|
|
349
349
|
/**
|
|
350
350
|
* <p>The type of plugin.</p>
|
|
351
351
|
* @public
|
|
352
352
|
*/
|
|
353
|
-
pluginType?: PluginType;
|
|
353
|
+
pluginType?: PluginType | undefined;
|
|
354
354
|
/**
|
|
355
355
|
* <p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to
|
|
356
356
|
* perform the requested plugin action.</p>
|
|
357
357
|
* @public
|
|
358
358
|
*/
|
|
359
|
-
payload?: Record<string, ActionReviewPayloadField
|
|
359
|
+
payload?: Record<string, ActionReviewPayloadField> | undefined;
|
|
360
360
|
/**
|
|
361
361
|
* <p>A string used to retain information about the hierarchical contexts within an action
|
|
362
362
|
* review payload.</p>
|
|
363
363
|
* @public
|
|
364
364
|
*/
|
|
365
|
-
payloadFieldNameSeparator?: string;
|
|
365
|
+
payloadFieldNameSeparator?: string | undefined;
|
|
366
366
|
}
|
|
367
367
|
/**
|
|
368
368
|
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin
|
|
@@ -377,40 +377,40 @@ export interface ActionReviewEvent {
|
|
|
377
377
|
* associated.</p>
|
|
378
378
|
* @public
|
|
379
379
|
*/
|
|
380
|
-
conversationId?: string;
|
|
380
|
+
conversationId?: string | undefined;
|
|
381
381
|
/**
|
|
382
382
|
* <p>The identifier of the conversation with which the plugin action is associated.</p>
|
|
383
383
|
* @public
|
|
384
384
|
*/
|
|
385
|
-
userMessageId?: string;
|
|
385
|
+
userMessageId?: string | undefined;
|
|
386
386
|
/**
|
|
387
387
|
* <p>The identifier of an Amazon Q Business AI generated associated with the action review
|
|
388
388
|
* event.</p>
|
|
389
389
|
* @public
|
|
390
390
|
*/
|
|
391
|
-
systemMessageId?: string;
|
|
391
|
+
systemMessageId?: string | undefined;
|
|
392
392
|
/**
|
|
393
393
|
* <p>The identifier of the plugin associated with the action review event.</p>
|
|
394
394
|
* @public
|
|
395
395
|
*/
|
|
396
|
-
pluginId?: string;
|
|
396
|
+
pluginId?: string | undefined;
|
|
397
397
|
/**
|
|
398
398
|
* <p>The type of plugin.</p>
|
|
399
399
|
* @public
|
|
400
400
|
*/
|
|
401
|
-
pluginType?: PluginType;
|
|
401
|
+
pluginType?: PluginType | undefined;
|
|
402
402
|
/**
|
|
403
403
|
* <p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to
|
|
404
404
|
* perform the requested plugin action.</p>
|
|
405
405
|
* @public
|
|
406
406
|
*/
|
|
407
|
-
payload?: Record<string, ActionReviewPayloadField
|
|
407
|
+
payload?: Record<string, ActionReviewPayloadField> | undefined;
|
|
408
408
|
/**
|
|
409
409
|
* <p>A string used to retain information about the hierarchical contexts within an action
|
|
410
410
|
* review event payload.</p>
|
|
411
411
|
* @public
|
|
412
412
|
*/
|
|
413
|
-
payloadFieldNameSeparator?: string;
|
|
413
|
+
payloadFieldNameSeparator?: string | undefined;
|
|
414
414
|
}
|
|
415
415
|
/**
|
|
416
416
|
* <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
|
|
@@ -524,33 +524,33 @@ export interface Application {
|
|
|
524
524
|
* <p>The name of the Amazon Q Business application.</p>
|
|
525
525
|
* @public
|
|
526
526
|
*/
|
|
527
|
-
displayName?: string;
|
|
527
|
+
displayName?: string | undefined;
|
|
528
528
|
/**
|
|
529
529
|
* <p>The identifier for the Amazon Q Business application.</p>
|
|
530
530
|
* @public
|
|
531
531
|
*/
|
|
532
|
-
applicationId?: string;
|
|
532
|
+
applicationId?: string | undefined;
|
|
533
533
|
/**
|
|
534
534
|
* <p>The Unix timestamp when the Amazon Q Business application was created.</p>
|
|
535
535
|
* @public
|
|
536
536
|
*/
|
|
537
|
-
createdAt?: Date;
|
|
537
|
+
createdAt?: Date | undefined;
|
|
538
538
|
/**
|
|
539
539
|
* <p>The Unix timestamp when the Amazon Q Business application was last updated. </p>
|
|
540
540
|
* @public
|
|
541
541
|
*/
|
|
542
|
-
updatedAt?: Date;
|
|
542
|
+
updatedAt?: Date | undefined;
|
|
543
543
|
/**
|
|
544
544
|
* <p>The status of the Amazon Q Business application. The application is ready to use when the
|
|
545
545
|
* status is <code>ACTIVE</code>.</p>
|
|
546
546
|
* @public
|
|
547
547
|
*/
|
|
548
|
-
status?: ApplicationStatus;
|
|
548
|
+
status?: ApplicationStatus | undefined;
|
|
549
549
|
/**
|
|
550
550
|
* <p>The authentication type being used by a Amazon Q Business application.</p>
|
|
551
551
|
* @public
|
|
552
552
|
*/
|
|
553
|
-
identityType?: IdentityType;
|
|
553
|
+
identityType?: IdentityType | undefined;
|
|
554
554
|
}
|
|
555
555
|
/**
|
|
556
556
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
@@ -610,7 +610,7 @@ export interface EncryptionConfiguration {
|
|
|
610
610
|
* keys.</p>
|
|
611
611
|
* @public
|
|
612
612
|
*/
|
|
613
|
-
kmsKeyId?: string;
|
|
613
|
+
kmsKeyId?: string | undefined;
|
|
614
614
|
}
|
|
615
615
|
/**
|
|
616
616
|
* @public
|
|
@@ -697,39 +697,39 @@ export interface CreateApplicationRequest {
|
|
|
697
697
|
* application's role.</p>
|
|
698
698
|
* @public
|
|
699
699
|
*/
|
|
700
|
-
roleArn?: string;
|
|
700
|
+
roleArn?: string | undefined;
|
|
701
701
|
/**
|
|
702
702
|
* <p>The authentication type being used by a Amazon Q Business application.</p>
|
|
703
703
|
* @public
|
|
704
704
|
*/
|
|
705
|
-
identityType?: IdentityType;
|
|
705
|
+
identityType?: IdentityType | undefined;
|
|
706
706
|
/**
|
|
707
707
|
* <p>The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.</p>
|
|
708
708
|
* @public
|
|
709
709
|
*/
|
|
710
|
-
iamIdentityProviderArn?: string;
|
|
710
|
+
iamIdentityProviderArn?: string | undefined;
|
|
711
711
|
/**
|
|
712
712
|
* <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either
|
|
713
713
|
* creating for—or connecting to—your Amazon Q Business application.</p>
|
|
714
714
|
* @public
|
|
715
715
|
*/
|
|
716
|
-
identityCenterInstanceArn?: string;
|
|
716
|
+
identityCenterInstanceArn?: string | undefined;
|
|
717
717
|
/**
|
|
718
718
|
* <p>The OIDC client ID for a Amazon Q Business application.</p>
|
|
719
719
|
* @public
|
|
720
720
|
*/
|
|
721
|
-
clientIdsForOIDC?: string[];
|
|
721
|
+
clientIdsForOIDC?: string[] | undefined;
|
|
722
722
|
/**
|
|
723
723
|
* <p>A description for the Amazon Q Business application. </p>
|
|
724
724
|
* @public
|
|
725
725
|
*/
|
|
726
|
-
description?: string;
|
|
726
|
+
description?: string | undefined;
|
|
727
727
|
/**
|
|
728
728
|
* <p>The identifier of the KMS key that is used to encrypt your data.
|
|
729
729
|
* Amazon Q Business doesn't support asymmetric keys.</p>
|
|
730
730
|
* @public
|
|
731
731
|
*/
|
|
732
|
-
encryptionConfiguration?: EncryptionConfiguration;
|
|
732
|
+
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
733
733
|
/**
|
|
734
734
|
* <p>A list of key-value pairs that identify or categorize your Amazon Q Business application.
|
|
735
735
|
* You can also use tags to help control access to the application. Tag keys and values can
|
|
@@ -737,31 +737,31 @@ export interface CreateApplicationRequest {
|
|
|
737
737
|
* / = + - @.</p>
|
|
738
738
|
* @public
|
|
739
739
|
*/
|
|
740
|
-
tags?: Tag[];
|
|
740
|
+
tags?: Tag[] | undefined;
|
|
741
741
|
/**
|
|
742
742
|
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
743
743
|
* application.</p>
|
|
744
744
|
* @public
|
|
745
745
|
*/
|
|
746
|
-
clientToken?: string;
|
|
746
|
+
clientToken?: string | undefined;
|
|
747
747
|
/**
|
|
748
748
|
* <p>An option to allow end users to upload files directly during chat.</p>
|
|
749
749
|
* @public
|
|
750
750
|
*/
|
|
751
|
-
attachmentsConfiguration?: AttachmentsConfiguration;
|
|
751
|
+
attachmentsConfiguration?: AttachmentsConfiguration | undefined;
|
|
752
752
|
/**
|
|
753
753
|
* <p>An option to allow end users to create and use Amazon Q Apps in the web
|
|
754
754
|
* experience.</p>
|
|
755
755
|
* @public
|
|
756
756
|
*/
|
|
757
|
-
qAppsConfiguration?: QAppsConfiguration;
|
|
757
|
+
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
758
758
|
/**
|
|
759
759
|
* <p>Configuration information about chat response personalization. For more information,
|
|
760
760
|
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>
|
|
761
761
|
* </p>
|
|
762
762
|
* @public
|
|
763
763
|
*/
|
|
764
|
-
personalizationConfiguration?: PersonalizationConfiguration;
|
|
764
|
+
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
765
765
|
}
|
|
766
766
|
/**
|
|
767
767
|
* @public
|
|
@@ -771,12 +771,12 @@ export interface CreateApplicationResponse {
|
|
|
771
771
|
* <p>The identifier of the Amazon Q Business application.</p>
|
|
772
772
|
* @public
|
|
773
773
|
*/
|
|
774
|
-
applicationId?: string;
|
|
774
|
+
applicationId?: string | undefined;
|
|
775
775
|
/**
|
|
776
776
|
* <p> The Amazon Resource Name (ARN) of the Amazon Q Business application. </p>
|
|
777
777
|
* @public
|
|
778
778
|
*/
|
|
779
|
-
applicationArn?: string;
|
|
779
|
+
applicationArn?: string | undefined;
|
|
780
780
|
}
|
|
781
781
|
/**
|
|
782
782
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -896,7 +896,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
896
896
|
* <p>The input field(s) that failed validation.</p>
|
|
897
897
|
* @public
|
|
898
898
|
*/
|
|
899
|
-
fields?: ValidationExceptionField[];
|
|
899
|
+
fields?: ValidationExceptionField[] | undefined;
|
|
900
900
|
/**
|
|
901
901
|
* @internal
|
|
902
902
|
*/
|
|
@@ -938,7 +938,7 @@ export interface AppliedAttachmentsConfiguration {
|
|
|
938
938
|
* application.</p>
|
|
939
939
|
* @public
|
|
940
940
|
*/
|
|
941
|
-
attachmentsControlMode?: AttachmentsControlMode;
|
|
941
|
+
attachmentsControlMode?: AttachmentsControlMode | undefined;
|
|
942
942
|
}
|
|
943
943
|
/**
|
|
944
944
|
* @public
|
|
@@ -983,7 +983,7 @@ export interface AutoSubscriptionConfiguration {
|
|
|
983
983
|
* value for this field.</p>
|
|
984
984
|
* @public
|
|
985
985
|
*/
|
|
986
|
-
defaultSubscriptionType?: SubscriptionType;
|
|
986
|
+
defaultSubscriptionType?: SubscriptionType | undefined;
|
|
987
987
|
}
|
|
988
988
|
/**
|
|
989
989
|
* @public
|
|
@@ -1008,12 +1008,12 @@ export interface ErrorDetail {
|
|
|
1008
1008
|
* <p>The message explaining the data source sync error.</p>
|
|
1009
1009
|
* @public
|
|
1010
1010
|
*/
|
|
1011
|
-
errorMessage?: string;
|
|
1011
|
+
errorMessage?: string | undefined;
|
|
1012
1012
|
/**
|
|
1013
1013
|
* <p>The code associated with the data source sync error.</p>
|
|
1014
1014
|
* @public
|
|
1015
1015
|
*/
|
|
1016
|
-
errorCode?: ErrorCode;
|
|
1016
|
+
errorCode?: ErrorCode | undefined;
|
|
1017
1017
|
}
|
|
1018
1018
|
/**
|
|
1019
1019
|
* @public
|
|
@@ -1023,101 +1023,101 @@ export interface GetApplicationResponse {
|
|
|
1023
1023
|
* <p>The name of the Amazon Q Business application.</p>
|
|
1024
1024
|
* @public
|
|
1025
1025
|
*/
|
|
1026
|
-
displayName?: string;
|
|
1026
|
+
displayName?: string | undefined;
|
|
1027
1027
|
/**
|
|
1028
1028
|
* <p>The identifier of the Amazon Q Business application.</p>
|
|
1029
1029
|
* @public
|
|
1030
1030
|
*/
|
|
1031
|
-
applicationId?: string;
|
|
1031
|
+
applicationId?: string | undefined;
|
|
1032
1032
|
/**
|
|
1033
1033
|
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application.</p>
|
|
1034
1034
|
* @public
|
|
1035
1035
|
*/
|
|
1036
|
-
applicationArn?: string;
|
|
1036
|
+
applicationArn?: string | undefined;
|
|
1037
1037
|
/**
|
|
1038
1038
|
* <p>The authentication type being used by a Amazon Q Business application.</p>
|
|
1039
1039
|
* @public
|
|
1040
1040
|
*/
|
|
1041
|
-
identityType?: IdentityType;
|
|
1041
|
+
identityType?: IdentityType | undefined;
|
|
1042
1042
|
/**
|
|
1043
1043
|
* <p>The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.</p>
|
|
1044
1044
|
* @public
|
|
1045
1045
|
*/
|
|
1046
|
-
iamIdentityProviderArn?: string;
|
|
1046
|
+
iamIdentityProviderArn?: string | undefined;
|
|
1047
1047
|
/**
|
|
1048
1048
|
* <p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to
|
|
1049
1049
|
* your Amazon Q Business application.</p>
|
|
1050
1050
|
* @public
|
|
1051
1051
|
*/
|
|
1052
|
-
identityCenterApplicationArn?: string;
|
|
1052
|
+
identityCenterApplicationArn?: string | undefined;
|
|
1053
1053
|
/**
|
|
1054
1054
|
* <p>The Amazon Resource Name (ARN) of the IAM with permissions to access
|
|
1055
1055
|
* your CloudWatch logs and metrics.</p>
|
|
1056
1056
|
* @public
|
|
1057
1057
|
*/
|
|
1058
|
-
roleArn?: string;
|
|
1058
|
+
roleArn?: string | undefined;
|
|
1059
1059
|
/**
|
|
1060
1060
|
* <p>The status of the Amazon Q Business application.</p>
|
|
1061
1061
|
* @public
|
|
1062
1062
|
*/
|
|
1063
|
-
status?: ApplicationStatus;
|
|
1063
|
+
status?: ApplicationStatus | undefined;
|
|
1064
1064
|
/**
|
|
1065
1065
|
* <p>A description for the Amazon Q Business application.</p>
|
|
1066
1066
|
* @public
|
|
1067
1067
|
*/
|
|
1068
|
-
description?: string;
|
|
1068
|
+
description?: string | undefined;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* <p>The identifier of the Amazon Web Services
|
|
1071
1071
|
* KMS key that is used to encrypt your data. Amazon Q Business doesn't support
|
|
1072
1072
|
* asymmetric keys.</p>
|
|
1073
1073
|
* @public
|
|
1074
1074
|
*/
|
|
1075
|
-
encryptionConfiguration?: EncryptionConfiguration;
|
|
1075
|
+
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
1076
1076
|
/**
|
|
1077
1077
|
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
1078
1078
|
* @public
|
|
1079
1079
|
*/
|
|
1080
|
-
createdAt?: Date;
|
|
1080
|
+
createdAt?: Date | undefined;
|
|
1081
1081
|
/**
|
|
1082
1082
|
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
1083
1083
|
* @public
|
|
1084
1084
|
*/
|
|
1085
|
-
updatedAt?: Date;
|
|
1085
|
+
updatedAt?: Date | undefined;
|
|
1086
1086
|
/**
|
|
1087
1087
|
* <p>If the <code>Status</code> field is set to <code>ERROR</code>, the
|
|
1088
1088
|
* <code>ErrorMessage</code> field contains a description of the error that caused the
|
|
1089
1089
|
* synchronization to fail.</p>
|
|
1090
1090
|
* @public
|
|
1091
1091
|
*/
|
|
1092
|
-
error?: ErrorDetail;
|
|
1092
|
+
error?: ErrorDetail | undefined;
|
|
1093
1093
|
/**
|
|
1094
1094
|
* <p>Settings for whether end users can upload files directly during chat.</p>
|
|
1095
1095
|
* @public
|
|
1096
1096
|
*/
|
|
1097
|
-
attachmentsConfiguration?: AppliedAttachmentsConfiguration;
|
|
1097
|
+
attachmentsConfiguration?: AppliedAttachmentsConfiguration | undefined;
|
|
1098
1098
|
/**
|
|
1099
1099
|
* <p>Settings for whether end users can create and use Amazon Q Apps in the web
|
|
1100
1100
|
* experience.</p>
|
|
1101
1101
|
* @public
|
|
1102
1102
|
*/
|
|
1103
|
-
qAppsConfiguration?: QAppsConfiguration;
|
|
1103
|
+
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
1104
1104
|
/**
|
|
1105
1105
|
* <p>Configuration information about chat response personalization. For more information,
|
|
1106
1106
|
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
1107
1107
|
* @public
|
|
1108
1108
|
*/
|
|
1109
|
-
personalizationConfiguration?: PersonalizationConfiguration;
|
|
1109
|
+
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
1110
1110
|
/**
|
|
1111
1111
|
* <p>Settings for auto-subscription behavior for this application. This is only applicable
|
|
1112
1112
|
* to SAML and OIDC applications.</p>
|
|
1113
1113
|
* @public
|
|
1114
1114
|
*/
|
|
1115
|
-
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
|
|
1115
|
+
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration | undefined;
|
|
1116
1116
|
/**
|
|
1117
1117
|
* <p>The OIDC client ID for a Amazon Q Business application.</p>
|
|
1118
1118
|
* @public
|
|
1119
1119
|
*/
|
|
1120
|
-
clientIdsForOIDC?: string[];
|
|
1120
|
+
clientIdsForOIDC?: string[] | undefined;
|
|
1121
1121
|
}
|
|
1122
1122
|
/**
|
|
1123
1123
|
* <p>Provides information about index capacity configuration.</p>
|
|
@@ -1128,7 +1128,7 @@ export interface IndexCapacityConfiguration {
|
|
|
1128
1128
|
* <p>The number of storage units configured for an Amazon Q Business index.</p>
|
|
1129
1129
|
* @public
|
|
1130
1130
|
*/
|
|
1131
|
-
units?: number;
|
|
1131
|
+
units?: number | undefined;
|
|
1132
1132
|
}
|
|
1133
1133
|
/**
|
|
1134
1134
|
* @public
|
|
@@ -1162,32 +1162,32 @@ export interface CreateIndexRequest {
|
|
|
1162
1162
|
* tiers</a>.</p>
|
|
1163
1163
|
* @public
|
|
1164
1164
|
*/
|
|
1165
|
-
type?: IndexType;
|
|
1165
|
+
type?: IndexType | undefined;
|
|
1166
1166
|
/**
|
|
1167
1167
|
* <p>A description for the Amazon Q Business index.</p>
|
|
1168
1168
|
* @public
|
|
1169
1169
|
*/
|
|
1170
|
-
description?: string;
|
|
1170
|
+
description?: string | undefined;
|
|
1171
1171
|
/**
|
|
1172
1172
|
* <p>A list of key-value pairs that identify or categorize the index. You can also use tags
|
|
1173
1173
|
* to help control access to the index. Tag keys and values can consist of Unicode letters,
|
|
1174
1174
|
* digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
1175
1175
|
* @public
|
|
1176
1176
|
*/
|
|
1177
|
-
tags?: Tag[];
|
|
1177
|
+
tags?: Tag[] | undefined;
|
|
1178
1178
|
/**
|
|
1179
1179
|
* <p>The capacity units you want to provision for your index. You can add and remove
|
|
1180
1180
|
* capacity to fit your usage needs.</p>
|
|
1181
1181
|
* @public
|
|
1182
1182
|
*/
|
|
1183
|
-
capacityConfiguration?: IndexCapacityConfiguration;
|
|
1183
|
+
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
1184
1184
|
/**
|
|
1185
1185
|
* <p>A token that you provide to identify the request to create an index. Multiple calls to
|
|
1186
1186
|
* the <code>CreateIndex</code> API with the same client token will create only one
|
|
1187
1187
|
* index.</p>
|
|
1188
1188
|
* @public
|
|
1189
1189
|
*/
|
|
1190
|
-
clientToken?: string;
|
|
1190
|
+
clientToken?: string | undefined;
|
|
1191
1191
|
}
|
|
1192
1192
|
/**
|
|
1193
1193
|
* @public
|
|
@@ -1197,12 +1197,12 @@ export interface CreateIndexResponse {
|
|
|
1197
1197
|
* <p>The identifier for the Amazon Q Business index.</p>
|
|
1198
1198
|
* @public
|
|
1199
1199
|
*/
|
|
1200
|
-
indexId?: string;
|
|
1200
|
+
indexId?: string | undefined;
|
|
1201
1201
|
/**
|
|
1202
1202
|
* <p> The Amazon Resource Name (ARN) of an Amazon Q Business index.</p>
|
|
1203
1203
|
* @public
|
|
1204
1204
|
*/
|
|
1205
|
-
indexArn?: string;
|
|
1205
|
+
indexArn?: string | undefined;
|
|
1206
1206
|
}
|
|
1207
1207
|
/**
|
|
1208
1208
|
* @public
|
|
@@ -1341,7 +1341,7 @@ export interface DocumentAttributeCondition {
|
|
|
1341
1341
|
* attribute.</p>
|
|
1342
1342
|
* @public
|
|
1343
1343
|
*/
|
|
1344
|
-
value?: DocumentAttributeValue;
|
|
1344
|
+
value?: DocumentAttributeValue | undefined;
|
|
1345
1345
|
}
|
|
1346
1346
|
/**
|
|
1347
1347
|
* @public
|
|
@@ -1397,7 +1397,7 @@ export interface DocumentAttributeTarget {
|
|
|
1397
1397
|
* attribute.</p>
|
|
1398
1398
|
* @public
|
|
1399
1399
|
*/
|
|
1400
|
-
value?: DocumentAttributeValue;
|
|
1400
|
+
value?: DocumentAttributeValue | undefined;
|
|
1401
1401
|
/**
|
|
1402
1402
|
* <p>
|
|
1403
1403
|
* <code>TRUE</code> to delete the existing target value for your specified target
|
|
@@ -1405,7 +1405,7 @@ export interface DocumentAttributeTarget {
|
|
|
1405
1405
|
* <code>TRUE</code>.</p>
|
|
1406
1406
|
* @public
|
|
1407
1407
|
*/
|
|
1408
|
-
attributeValueOperator?: AttributeValueOperator;
|
|
1408
|
+
attributeValueOperator?: AttributeValueOperator | undefined;
|
|
1409
1409
|
}
|
|
1410
1410
|
/**
|
|
1411
1411
|
* <p>Provides the configuration information for applying basic logic to alter document
|
|
@@ -1433,7 +1433,7 @@ export interface InlineDocumentEnrichmentConfiguration {
|
|
|
1433
1433
|
* created metadata field to your index field.</p>
|
|
1434
1434
|
* @public
|
|
1435
1435
|
*/
|
|
1436
|
-
condition?: DocumentAttributeCondition;
|
|
1436
|
+
condition?: DocumentAttributeCondition | undefined;
|
|
1437
1437
|
/**
|
|
1438
1438
|
* <p>The target document attribute or metadata field you want to alter when ingesting
|
|
1439
1439
|
* documents into Amazon Q Business.</p>
|
|
@@ -1453,14 +1453,14 @@ export interface InlineDocumentEnrichmentConfiguration {
|
|
|
1453
1453
|
* </a>.</p>
|
|
1454
1454
|
* @public
|
|
1455
1455
|
*/
|
|
1456
|
-
target?: DocumentAttributeTarget;
|
|
1456
|
+
target?: DocumentAttributeTarget | undefined;
|
|
1457
1457
|
/**
|
|
1458
1458
|
* <p>
|
|
1459
1459
|
* <code>TRUE</code> to delete content if the condition used for the target attribute is
|
|
1460
1460
|
* met.</p>
|
|
1461
1461
|
* @public
|
|
1462
1462
|
*/
|
|
1463
|
-
documentContentOperator?: DocumentContentOperator;
|
|
1463
|
+
documentContentOperator?: DocumentContentOperator | undefined;
|
|
1464
1464
|
}
|
|
1465
1465
|
/**
|
|
1466
1466
|
* <p>Provides the configuration information for invoking a Lambda function in
|
|
@@ -1484,20 +1484,20 @@ export interface HookConfiguration {
|
|
|
1484
1484
|
* then Amazon Q Business should invoke a function that inserts the current date-time.</p>
|
|
1485
1485
|
* @public
|
|
1486
1486
|
*/
|
|
1487
|
-
invocationCondition?: DocumentAttributeCondition;
|
|
1487
|
+
invocationCondition?: DocumentAttributeCondition | undefined;
|
|
1488
1488
|
/**
|
|
1489
1489
|
* <p>The Amazon Resource Name (ARN) of a role with permission to run a Lambda
|
|
1490
1490
|
* 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
|
|
1491
1491
|
* Custom Document Enrichment (CDE)</a>.</p>
|
|
1492
1492
|
* @public
|
|
1493
1493
|
*/
|
|
1494
|
-
lambdaArn?: string;
|
|
1494
|
+
lambdaArn?: string | undefined;
|
|
1495
1495
|
/**
|
|
1496
1496
|
* <p>Stores the original, raw documents or the structured, parsed documents before and
|
|
1497
1497
|
* 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>
|
|
1498
1498
|
* @public
|
|
1499
1499
|
*/
|
|
1500
|
-
s3BucketName?: string;
|
|
1500
|
+
s3BucketName?: string | undefined;
|
|
1501
1501
|
/**
|
|
1502
1502
|
* <p>The Amazon Resource Name (ARN) of a role with permission to run
|
|
1503
1503
|
* <code>PreExtractionHookConfiguration</code> and
|
|
@@ -1505,7 +1505,7 @@ export interface HookConfiguration {
|
|
|
1505
1505
|
* content during the document ingestion process.</p>
|
|
1506
1506
|
* @public
|
|
1507
1507
|
*/
|
|
1508
|
-
roleArn?: string;
|
|
1508
|
+
roleArn?: string | undefined;
|
|
1509
1509
|
}
|
|
1510
1510
|
/**
|
|
1511
1511
|
* <p>Provides the configuration information for altering document metadata and content
|
|
@@ -1520,7 +1520,7 @@ export interface DocumentEnrichmentConfiguration {
|
|
|
1520
1520
|
* when ingesting documents into Amazon Q Business.</p>
|
|
1521
1521
|
* @public
|
|
1522
1522
|
*/
|
|
1523
|
-
inlineConfigurations?: InlineDocumentEnrichmentConfiguration[];
|
|
1523
|
+
inlineConfigurations?: InlineDocumentEnrichmentConfiguration[] | undefined;
|
|
1524
1524
|
/**
|
|
1525
1525
|
* <p>Provides the configuration information for invoking a Lambda function in
|
|
1526
1526
|
* Lambda to alter document metadata and content when ingesting
|
|
@@ -1536,7 +1536,7 @@ export interface DocumentEnrichmentConfiguration {
|
|
|
1536
1536
|
* <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>
|
|
1537
1537
|
* @public
|
|
1538
1538
|
*/
|
|
1539
|
-
preExtractionHookConfiguration?: HookConfiguration;
|
|
1539
|
+
preExtractionHookConfiguration?: HookConfiguration | undefined;
|
|
1540
1540
|
/**
|
|
1541
1541
|
* <p>Provides the configuration information for invoking a Lambda function in
|
|
1542
1542
|
* Lambda to alter document metadata and content when ingesting
|
|
@@ -1552,7 +1552,7 @@ export interface DocumentEnrichmentConfiguration {
|
|
|
1552
1552
|
* <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>
|
|
1553
1553
|
* @public
|
|
1554
1554
|
*/
|
|
1555
|
-
postExtractionHookConfiguration?: HookConfiguration;
|
|
1555
|
+
postExtractionHookConfiguration?: HookConfiguration | undefined;
|
|
1556
1556
|
}
|
|
1557
1557
|
/**
|
|
1558
1558
|
* <p>Provides configuration information needed to connect to an Amazon VPC (Virtual
|
|
@@ -1635,12 +1635,12 @@ export interface CreateDataSourceRequest {
|
|
|
1635
1635
|
* Amazon VPC with Amazon Q Business connectors</a>.</p>
|
|
1636
1636
|
* @public
|
|
1637
1637
|
*/
|
|
1638
|
-
vpcConfiguration?: DataSourceVpcConfiguration;
|
|
1638
|
+
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
1639
1639
|
/**
|
|
1640
1640
|
* <p>A description for the data source connector.</p>
|
|
1641
1641
|
* @public
|
|
1642
1642
|
*/
|
|
1643
|
-
description?: string;
|
|
1643
|
+
description?: string | undefined;
|
|
1644
1644
|
/**
|
|
1645
1645
|
* <p>A list of key-value pairs that identify or categorize the data source connector. You
|
|
1646
1646
|
* can also use tags to help control access to the data source connector. Tag keys and
|
|
@@ -1648,7 +1648,7 @@ export interface CreateDataSourceRequest {
|
|
|
1648
1648
|
* symbols: _ . : / = + - @.</p>
|
|
1649
1649
|
* @public
|
|
1650
1650
|
*/
|
|
1651
|
-
tags?: Tag[];
|
|
1651
|
+
tags?: Tag[] | undefined;
|
|
1652
1652
|
/**
|
|
1653
1653
|
* <p>Sets the frequency for Amazon Q Business to check the documents in your data source
|
|
1654
1654
|
* repository and update your index. If you don't set a schedule, Amazon Q Business won't
|
|
@@ -1659,20 +1659,20 @@ export interface CreateDataSourceRequest {
|
|
|
1659
1659
|
* you receive a <code>ValidationException</code> exception. </p>
|
|
1660
1660
|
* @public
|
|
1661
1661
|
*/
|
|
1662
|
-
syncSchedule?: string;
|
|
1662
|
+
syncSchedule?: string | undefined;
|
|
1663
1663
|
/**
|
|
1664
1664
|
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
1665
1665
|
* the data source and required resources.</p>
|
|
1666
1666
|
* @public
|
|
1667
1667
|
*/
|
|
1668
|
-
roleArn?: string;
|
|
1668
|
+
roleArn?: string | undefined;
|
|
1669
1669
|
/**
|
|
1670
1670
|
* <p>A token you provide to identify a request to create a data source connector. Multiple
|
|
1671
1671
|
* calls to the <code>CreateDataSource</code> API with the same client token will create
|
|
1672
1672
|
* only one data source connector. </p>
|
|
1673
1673
|
* @public
|
|
1674
1674
|
*/
|
|
1675
|
-
clientToken?: string;
|
|
1675
|
+
clientToken?: string | undefined;
|
|
1676
1676
|
/**
|
|
1677
1677
|
* <p>Provides the configuration information for altering document metadata and content
|
|
1678
1678
|
* during the document ingestion process.</p>
|
|
@@ -1680,7 +1680,7 @@ export interface CreateDataSourceRequest {
|
|
|
1680
1680
|
* enrichment</a>.</p>
|
|
1681
1681
|
* @public
|
|
1682
1682
|
*/
|
|
1683
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
|
1683
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
1684
1684
|
}
|
|
1685
1685
|
/**
|
|
1686
1686
|
* @public
|
|
@@ -1690,13 +1690,13 @@ export interface CreateDataSourceResponse {
|
|
|
1690
1690
|
* <p>The identifier of the data source connector.</p>
|
|
1691
1691
|
* @public
|
|
1692
1692
|
*/
|
|
1693
|
-
dataSourceId?: string;
|
|
1693
|
+
dataSourceId?: string | undefined;
|
|
1694
1694
|
/**
|
|
1695
1695
|
* <p> The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
|
|
1696
1696
|
* </p>
|
|
1697
1697
|
* @public
|
|
1698
1698
|
*/
|
|
1699
|
-
dataSourceArn?: string;
|
|
1699
|
+
dataSourceArn?: string | undefined;
|
|
1700
1700
|
}
|
|
1701
1701
|
/**
|
|
1702
1702
|
* @public
|
|
@@ -1768,83 +1768,83 @@ export interface GetDataSourceResponse {
|
|
|
1768
1768
|
* <p>The identifier of the Amazon Q Business application.</p>
|
|
1769
1769
|
* @public
|
|
1770
1770
|
*/
|
|
1771
|
-
applicationId?: string;
|
|
1771
|
+
applicationId?: string | undefined;
|
|
1772
1772
|
/**
|
|
1773
1773
|
* <p>The identifier of the index linked to the data source connector.</p>
|
|
1774
1774
|
* @public
|
|
1775
1775
|
*/
|
|
1776
|
-
indexId?: string;
|
|
1776
|
+
indexId?: string | undefined;
|
|
1777
1777
|
/**
|
|
1778
1778
|
* <p>The identifier of the data source connector.</p>
|
|
1779
1779
|
* @public
|
|
1780
1780
|
*/
|
|
1781
|
-
dataSourceId?: string;
|
|
1781
|
+
dataSourceId?: string | undefined;
|
|
1782
1782
|
/**
|
|
1783
1783
|
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
1784
1784
|
* @public
|
|
1785
1785
|
*/
|
|
1786
|
-
dataSourceArn?: string;
|
|
1786
|
+
dataSourceArn?: string | undefined;
|
|
1787
1787
|
/**
|
|
1788
1788
|
* <p>The name for the data source connector.</p>
|
|
1789
1789
|
* @public
|
|
1790
1790
|
*/
|
|
1791
|
-
displayName?: string;
|
|
1791
|
+
displayName?: string | undefined;
|
|
1792
1792
|
/**
|
|
1793
1793
|
* <p>The type of the data source connector. For example, <code>S3</code>.</p>
|
|
1794
1794
|
* @public
|
|
1795
1795
|
*/
|
|
1796
|
-
type?: string;
|
|
1796
|
+
type?: string | undefined;
|
|
1797
1797
|
/**
|
|
1798
1798
|
* <p>The details of how the data source connector is configured.</p>
|
|
1799
1799
|
* @public
|
|
1800
1800
|
*/
|
|
1801
|
-
configuration?: __DocumentType;
|
|
1801
|
+
configuration?: __DocumentType | undefined;
|
|
1802
1802
|
/**
|
|
1803
1803
|
* <p>Configuration information for an Amazon VPC (Virtual Private Cloud) to connect
|
|
1804
1804
|
* to your data source.</p>
|
|
1805
1805
|
* @public
|
|
1806
1806
|
*/
|
|
1807
|
-
vpcConfiguration?: DataSourceVpcConfiguration;
|
|
1807
|
+
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
1808
1808
|
/**
|
|
1809
1809
|
* <p>The Unix timestamp when the data source connector was created.</p>
|
|
1810
1810
|
* @public
|
|
1811
1811
|
*/
|
|
1812
|
-
createdAt?: Date;
|
|
1812
|
+
createdAt?: Date | undefined;
|
|
1813
1813
|
/**
|
|
1814
1814
|
* <p>The Unix timestamp when the data source connector was last updated.</p>
|
|
1815
1815
|
* @public
|
|
1816
1816
|
*/
|
|
1817
|
-
updatedAt?: Date;
|
|
1817
|
+
updatedAt?: Date | undefined;
|
|
1818
1818
|
/**
|
|
1819
1819
|
* <p>The description for the data source connector.</p>
|
|
1820
1820
|
* @public
|
|
1821
1821
|
*/
|
|
1822
|
-
description?: string;
|
|
1822
|
+
description?: string | undefined;
|
|
1823
1823
|
/**
|
|
1824
1824
|
* <p>The current status of the data source connector. When the <code>Status</code> field
|
|
1825
1825
|
* value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description
|
|
1826
1826
|
* of the error that caused the data source connector to fail.</p>
|
|
1827
1827
|
* @public
|
|
1828
1828
|
*/
|
|
1829
|
-
status?: DataSourceStatus;
|
|
1829
|
+
status?: DataSourceStatus | undefined;
|
|
1830
1830
|
/**
|
|
1831
1831
|
* <p>The schedule for Amazon Q Business to update the index.</p>
|
|
1832
1832
|
* @public
|
|
1833
1833
|
*/
|
|
1834
|
-
syncSchedule?: string;
|
|
1834
|
+
syncSchedule?: string | undefined;
|
|
1835
1835
|
/**
|
|
1836
1836
|
* <p>The Amazon Resource Name (ARN) of the role with permission to access the data source
|
|
1837
1837
|
* and required resources.</p>
|
|
1838
1838
|
* @public
|
|
1839
1839
|
*/
|
|
1840
|
-
roleArn?: string;
|
|
1840
|
+
roleArn?: string | undefined;
|
|
1841
1841
|
/**
|
|
1842
1842
|
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
1843
1843
|
* <code>ErrorMessage</code> field contains a description of the error that caused the
|
|
1844
1844
|
* data source connector to fail.</p>
|
|
1845
1845
|
* @public
|
|
1846
1846
|
*/
|
|
1847
|
-
error?: ErrorDetail;
|
|
1847
|
+
error?: ErrorDetail | undefined;
|
|
1848
1848
|
/**
|
|
1849
1849
|
* <p>Provides the configuration information for altering document metadata and content
|
|
1850
1850
|
* during the document ingestion process.</p>
|
|
@@ -1852,7 +1852,7 @@ export interface GetDataSourceResponse {
|
|
|
1852
1852
|
* enrichment</a>.</p>
|
|
1853
1853
|
* @public
|
|
1854
1854
|
*/
|
|
1855
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
|
1855
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
1856
1856
|
}
|
|
1857
1857
|
/**
|
|
1858
1858
|
* @public
|
|
@@ -1876,12 +1876,12 @@ export interface ListDataSourcesRequest {
|
|
|
1876
1876
|
* connectors.</p>
|
|
1877
1877
|
* @public
|
|
1878
1878
|
*/
|
|
1879
|
-
nextToken?: string;
|
|
1879
|
+
nextToken?: string | undefined;
|
|
1880
1880
|
/**
|
|
1881
1881
|
* <p>The maximum number of data source connectors to return.</p>
|
|
1882
1882
|
* @public
|
|
1883
1883
|
*/
|
|
1884
|
-
maxResults?: number;
|
|
1884
|
+
maxResults?: number | undefined;
|
|
1885
1885
|
}
|
|
1886
1886
|
/**
|
|
1887
1887
|
* <p>A data source in an Amazon Q Business application.</p>
|
|
@@ -1892,32 +1892,32 @@ export interface DataSource {
|
|
|
1892
1892
|
* <p>The name of the Amazon Q Business data source.</p>
|
|
1893
1893
|
* @public
|
|
1894
1894
|
*/
|
|
1895
|
-
displayName?: string;
|
|
1895
|
+
displayName?: string | undefined;
|
|
1896
1896
|
/**
|
|
1897
1897
|
* <p>The identifier of the Amazon Q Business data source.</p>
|
|
1898
1898
|
* @public
|
|
1899
1899
|
*/
|
|
1900
|
-
dataSourceId?: string;
|
|
1900
|
+
dataSourceId?: string | undefined;
|
|
1901
1901
|
/**
|
|
1902
1902
|
* <p>The type of the Amazon Q Business data source.</p>
|
|
1903
1903
|
* @public
|
|
1904
1904
|
*/
|
|
1905
|
-
type?: string;
|
|
1905
|
+
type?: string | undefined;
|
|
1906
1906
|
/**
|
|
1907
1907
|
* <p>The Unix timestamp when the Amazon Q Business data source was created.</p>
|
|
1908
1908
|
* @public
|
|
1909
1909
|
*/
|
|
1910
|
-
createdAt?: Date;
|
|
1910
|
+
createdAt?: Date | undefined;
|
|
1911
1911
|
/**
|
|
1912
1912
|
* <p>The Unix timestamp when the Amazon Q Business data source was last updated. </p>
|
|
1913
1913
|
* @public
|
|
1914
1914
|
*/
|
|
1915
|
-
updatedAt?: Date;
|
|
1915
|
+
updatedAt?: Date | undefined;
|
|
1916
1916
|
/**
|
|
1917
1917
|
* <p>The status of the Amazon Q Business data source.</p>
|
|
1918
1918
|
* @public
|
|
1919
1919
|
*/
|
|
1920
|
-
status?: DataSourceStatus;
|
|
1920
|
+
status?: DataSourceStatus | undefined;
|
|
1921
1921
|
}
|
|
1922
1922
|
/**
|
|
1923
1923
|
* @public
|
|
@@ -1927,13 +1927,13 @@ export interface ListDataSourcesResponse {
|
|
|
1927
1927
|
* <p>An array of summary information for one or more data source connector.</p>
|
|
1928
1928
|
* @public
|
|
1929
1929
|
*/
|
|
1930
|
-
dataSources?: DataSource[];
|
|
1930
|
+
dataSources?: DataSource[] | undefined;
|
|
1931
1931
|
/**
|
|
1932
1932
|
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
1933
1933
|
* in a subsequent request to retrieve the next set of data source connectors.</p>
|
|
1934
1934
|
* @public
|
|
1935
1935
|
*/
|
|
1936
|
-
nextToken?: string;
|
|
1936
|
+
nextToken?: string | undefined;
|
|
1937
1937
|
}
|
|
1938
1938
|
/**
|
|
1939
1939
|
* @public
|
|
@@ -1959,34 +1959,34 @@ export interface UpdateDataSourceRequest {
|
|
|
1959
1959
|
* <p>A name of the data source connector.</p>
|
|
1960
1960
|
* @public
|
|
1961
1961
|
*/
|
|
1962
|
-
displayName?: string;
|
|
1962
|
+
displayName?: string | undefined;
|
|
1963
1963
|
/**
|
|
1964
1964
|
* <p>Provides the configuration information for an Amazon Q Business data source.</p>
|
|
1965
1965
|
* @public
|
|
1966
1966
|
*/
|
|
1967
|
-
configuration?: __DocumentType;
|
|
1967
|
+
configuration?: __DocumentType | undefined;
|
|
1968
1968
|
/**
|
|
1969
1969
|
* <p>Provides configuration information needed to connect to an Amazon VPC (Virtual
|
|
1970
1970
|
* Private Cloud).</p>
|
|
1971
1971
|
* @public
|
|
1972
1972
|
*/
|
|
1973
|
-
vpcConfiguration?: DataSourceVpcConfiguration;
|
|
1973
|
+
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
1974
1974
|
/**
|
|
1975
1975
|
* <p>The description of the data source connector.</p>
|
|
1976
1976
|
* @public
|
|
1977
1977
|
*/
|
|
1978
|
-
description?: string;
|
|
1978
|
+
description?: string | undefined;
|
|
1979
1979
|
/**
|
|
1980
1980
|
* <p>The chosen update frequency for your data source.</p>
|
|
1981
1981
|
* @public
|
|
1982
1982
|
*/
|
|
1983
|
-
syncSchedule?: string;
|
|
1983
|
+
syncSchedule?: string | undefined;
|
|
1984
1984
|
/**
|
|
1985
1985
|
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
1986
1986
|
* the data source and required resources.</p>
|
|
1987
1987
|
* @public
|
|
1988
1988
|
*/
|
|
1989
|
-
roleArn?: string;
|
|
1989
|
+
roleArn?: string | undefined;
|
|
1990
1990
|
/**
|
|
1991
1991
|
* <p>Provides the configuration information for altering document metadata and content
|
|
1992
1992
|
* during the document ingestion process.</p>
|
|
@@ -1994,7 +1994,7 @@ export interface UpdateDataSourceRequest {
|
|
|
1994
1994
|
* enrichment</a>.</p>
|
|
1995
1995
|
* @public
|
|
1996
1996
|
*/
|
|
1997
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
|
1997
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
1998
1998
|
}
|
|
1999
1999
|
/**
|
|
2000
2000
|
* @public
|
|
@@ -2075,18 +2075,18 @@ export interface DocumentAttributeConfiguration {
|
|
|
2075
2075
|
* <p>The name of the document attribute.</p>
|
|
2076
2076
|
* @public
|
|
2077
2077
|
*/
|
|
2078
|
-
name?: string;
|
|
2078
|
+
name?: string | undefined;
|
|
2079
2079
|
/**
|
|
2080
2080
|
* <p>The type of document attribute.</p>
|
|
2081
2081
|
* @public
|
|
2082
2082
|
*/
|
|
2083
|
-
type?: AttributeType;
|
|
2083
|
+
type?: AttributeType | undefined;
|
|
2084
2084
|
/**
|
|
2085
2085
|
* <p>Information about whether the document attribute can be used by an end user to search
|
|
2086
2086
|
* for information on their web experience.</p>
|
|
2087
2087
|
* @public
|
|
2088
2088
|
*/
|
|
2089
|
-
search?: Status;
|
|
2089
|
+
search?: Status | undefined;
|
|
2090
2090
|
}
|
|
2091
2091
|
/**
|
|
2092
2092
|
* <p>Provides information about text documents in an index.</p>
|
|
@@ -2097,12 +2097,12 @@ export interface TextDocumentStatistics {
|
|
|
2097
2097
|
* <p>The total size, in bytes, of the indexed documents.</p>
|
|
2098
2098
|
* @public
|
|
2099
2099
|
*/
|
|
2100
|
-
indexedTextBytes?: number;
|
|
2100
|
+
indexedTextBytes?: number | undefined;
|
|
2101
2101
|
/**
|
|
2102
2102
|
* <p>The number of text documents indexed.</p>
|
|
2103
2103
|
* @public
|
|
2104
2104
|
*/
|
|
2105
|
-
indexedTextDocumentCount?: number;
|
|
2105
|
+
indexedTextDocumentCount?: number | undefined;
|
|
2106
2106
|
}
|
|
2107
2107
|
/**
|
|
2108
2108
|
* <p>Provides information about the number of documents in an index.</p>
|
|
@@ -2113,7 +2113,7 @@ export interface IndexStatistics {
|
|
|
2113
2113
|
* <p>The number of documents indexed.</p>
|
|
2114
2114
|
* @public
|
|
2115
2115
|
*/
|
|
2116
|
-
textDocumentStatistics?: TextDocumentStatistics;
|
|
2116
|
+
textDocumentStatistics?: TextDocumentStatistics | undefined;
|
|
2117
2117
|
}
|
|
2118
2118
|
/**
|
|
2119
2119
|
* @public
|
|
@@ -2138,72 +2138,72 @@ export interface GetIndexResponse {
|
|
|
2138
2138
|
* <p>The identifier of the Amazon Q Business application associated with the index.</p>
|
|
2139
2139
|
* @public
|
|
2140
2140
|
*/
|
|
2141
|
-
applicationId?: string;
|
|
2141
|
+
applicationId?: string | undefined;
|
|
2142
2142
|
/**
|
|
2143
2143
|
* <p>The identifier of the Amazon Q Business index.</p>
|
|
2144
2144
|
* @public
|
|
2145
2145
|
*/
|
|
2146
|
-
indexId?: string;
|
|
2146
|
+
indexId?: string | undefined;
|
|
2147
2147
|
/**
|
|
2148
2148
|
* <p>The name of the Amazon Q Business index.</p>
|
|
2149
2149
|
* @public
|
|
2150
2150
|
*/
|
|
2151
|
-
displayName?: string;
|
|
2151
|
+
displayName?: string | undefined;
|
|
2152
2152
|
/**
|
|
2153
2153
|
* <p>The type of index attached to your Amazon Q Business application.</p>
|
|
2154
2154
|
* @public
|
|
2155
2155
|
*/
|
|
2156
|
-
type?: IndexType;
|
|
2156
|
+
type?: IndexType | undefined;
|
|
2157
2157
|
/**
|
|
2158
2158
|
* <p> The Amazon Resource Name (ARN) of the Amazon Q Business index. </p>
|
|
2159
2159
|
* @public
|
|
2160
2160
|
*/
|
|
2161
|
-
indexArn?: string;
|
|
2161
|
+
indexArn?: string | undefined;
|
|
2162
2162
|
/**
|
|
2163
2163
|
* <p>The current status of the index. When the value is <code>ACTIVE</code>, the index is
|
|
2164
2164
|
* ready for use. If the <code>Status</code> field value is <code>FAILED</code>, the
|
|
2165
2165
|
* <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
2166
2166
|
* @public
|
|
2167
2167
|
*/
|
|
2168
|
-
status?: IndexStatus;
|
|
2168
|
+
status?: IndexStatus | undefined;
|
|
2169
2169
|
/**
|
|
2170
2170
|
* <p>The description for the Amazon Q Business index.</p>
|
|
2171
2171
|
* @public
|
|
2172
2172
|
*/
|
|
2173
|
-
description?: string;
|
|
2173
|
+
description?: string | undefined;
|
|
2174
2174
|
/**
|
|
2175
2175
|
* <p>The Unix timestamp when the Amazon Q Business index was created.</p>
|
|
2176
2176
|
* @public
|
|
2177
2177
|
*/
|
|
2178
|
-
createdAt?: Date;
|
|
2178
|
+
createdAt?: Date | undefined;
|
|
2179
2179
|
/**
|
|
2180
2180
|
* <p>The Unix timestamp when the Amazon Q Business index was last updated.</p>
|
|
2181
2181
|
* @public
|
|
2182
2182
|
*/
|
|
2183
|
-
updatedAt?: Date;
|
|
2183
|
+
updatedAt?: Date | undefined;
|
|
2184
2184
|
/**
|
|
2185
2185
|
* <p>The storage capacity units chosen for your Amazon Q Business index.</p>
|
|
2186
2186
|
* @public
|
|
2187
2187
|
*/
|
|
2188
|
-
capacityConfiguration?: IndexCapacityConfiguration;
|
|
2188
|
+
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
2189
2189
|
/**
|
|
2190
2190
|
* <p>Configuration information for document attributes or metadata. Document metadata are
|
|
2191
2191
|
* fields associated with your documents. For example, the company department name
|
|
2192
2192
|
* 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>
|
|
2193
2193
|
* @public
|
|
2194
2194
|
*/
|
|
2195
|
-
documentAttributeConfigurations?: DocumentAttributeConfiguration[];
|
|
2195
|
+
documentAttributeConfigurations?: DocumentAttributeConfiguration[] | undefined;
|
|
2196
2196
|
/**
|
|
2197
2197
|
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
2198
2198
|
* <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
2199
2199
|
* @public
|
|
2200
2200
|
*/
|
|
2201
|
-
error?: ErrorDetail;
|
|
2201
|
+
error?: ErrorDetail | undefined;
|
|
2202
2202
|
/**
|
|
2203
2203
|
* <p>Provides information about the number of documents indexed.</p>
|
|
2204
2204
|
* @public
|
|
2205
2205
|
*/
|
|
2206
|
-
indexStatistics?: IndexStatistics;
|
|
2206
|
+
indexStatistics?: IndexStatistics | undefined;
|
|
2207
2207
|
}
|
|
2208
2208
|
/**
|
|
2209
2209
|
* @public
|
|
@@ -2220,12 +2220,12 @@ export interface ListIndicesRequest {
|
|
|
2220
2220
|
* token to retrieve the next set of Amazon Q Business indices.</p>
|
|
2221
2221
|
* @public
|
|
2222
2222
|
*/
|
|
2223
|
-
nextToken?: string;
|
|
2223
|
+
nextToken?: string | undefined;
|
|
2224
2224
|
/**
|
|
2225
2225
|
* <p>The maximum number of indices to return.</p>
|
|
2226
2226
|
* @public
|
|
2227
2227
|
*/
|
|
2228
|
-
maxResults?: number;
|
|
2228
|
+
maxResults?: number | undefined;
|
|
2229
2229
|
}
|
|
2230
2230
|
/**
|
|
2231
2231
|
* <p>Summary information for your Amazon Q Business index.</p>
|
|
@@ -2236,28 +2236,28 @@ export interface Index {
|
|
|
2236
2236
|
* <p>The name of the index.</p>
|
|
2237
2237
|
* @public
|
|
2238
2238
|
*/
|
|
2239
|
-
displayName?: string;
|
|
2239
|
+
displayName?: string | undefined;
|
|
2240
2240
|
/**
|
|
2241
2241
|
* <p>The identifier for the index.</p>
|
|
2242
2242
|
* @public
|
|
2243
2243
|
*/
|
|
2244
|
-
indexId?: string;
|
|
2244
|
+
indexId?: string | undefined;
|
|
2245
2245
|
/**
|
|
2246
2246
|
* <p>The Unix timestamp when the index was created.</p>
|
|
2247
2247
|
* @public
|
|
2248
2248
|
*/
|
|
2249
|
-
createdAt?: Date;
|
|
2249
|
+
createdAt?: Date | undefined;
|
|
2250
2250
|
/**
|
|
2251
2251
|
* <p>The Unix timestamp when the index was last updated.</p>
|
|
2252
2252
|
* @public
|
|
2253
2253
|
*/
|
|
2254
|
-
updatedAt?: Date;
|
|
2254
|
+
updatedAt?: Date | undefined;
|
|
2255
2255
|
/**
|
|
2256
2256
|
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the index is
|
|
2257
2257
|
* ready.</p>
|
|
2258
2258
|
* @public
|
|
2259
2259
|
*/
|
|
2260
|
-
status?: IndexStatus;
|
|
2260
|
+
status?: IndexStatus | undefined;
|
|
2261
2261
|
}
|
|
2262
2262
|
/**
|
|
2263
2263
|
* @public
|
|
@@ -2268,12 +2268,12 @@ export interface ListIndicesResponse {
|
|
|
2268
2268
|
* subsequent request to retrieve the next set of indexes.</p>
|
|
2269
2269
|
* @public
|
|
2270
2270
|
*/
|
|
2271
|
-
nextToken?: string;
|
|
2271
|
+
nextToken?: string | undefined;
|
|
2272
2272
|
/**
|
|
2273
2273
|
* <p>An array of information on the items in one or more indexes.</p>
|
|
2274
2274
|
* @public
|
|
2275
2275
|
*/
|
|
2276
|
-
indices?: Index[];
|
|
2276
|
+
indices?: Index[] | undefined;
|
|
2277
2277
|
}
|
|
2278
2278
|
/**
|
|
2279
2279
|
* @public
|
|
@@ -2293,25 +2293,25 @@ export interface UpdateIndexRequest {
|
|
|
2293
2293
|
* <p>The name of the Amazon Q Business index.</p>
|
|
2294
2294
|
* @public
|
|
2295
2295
|
*/
|
|
2296
|
-
displayName?: string;
|
|
2296
|
+
displayName?: string | undefined;
|
|
2297
2297
|
/**
|
|
2298
2298
|
* <p>The description of the Amazon Q Business index.</p>
|
|
2299
2299
|
* @public
|
|
2300
2300
|
*/
|
|
2301
|
-
description?: string;
|
|
2301
|
+
description?: string | undefined;
|
|
2302
2302
|
/**
|
|
2303
2303
|
* <p>The storage capacity units you want to provision for your Amazon Q Business index. You can
|
|
2304
2304
|
* add and remove capacity to fit your usage needs.</p>
|
|
2305
2305
|
* @public
|
|
2306
2306
|
*/
|
|
2307
|
-
capacityConfiguration?: IndexCapacityConfiguration;
|
|
2307
|
+
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
2308
2308
|
/**
|
|
2309
2309
|
* <p>Configuration information for document metadata or fields. Document metadata are
|
|
2310
2310
|
* fields or attributes associated with your documents. For example, the company department
|
|
2311
2311
|
* 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>
|
|
2312
2312
|
* @public
|
|
2313
2313
|
*/
|
|
2314
|
-
documentAttributeConfigurations?: DocumentAttributeConfiguration[];
|
|
2314
|
+
documentAttributeConfigurations?: DocumentAttributeConfiguration[] | undefined;
|
|
2315
2315
|
}
|
|
2316
2316
|
/**
|
|
2317
2317
|
* @public
|
|
@@ -2328,12 +2328,12 @@ export interface ListApplicationsRequest {
|
|
|
2328
2328
|
* pagination token to retrieve the next set of Amazon Q Business applications.</p>
|
|
2329
2329
|
* @public
|
|
2330
2330
|
*/
|
|
2331
|
-
nextToken?: string;
|
|
2331
|
+
nextToken?: string | undefined;
|
|
2332
2332
|
/**
|
|
2333
2333
|
* <p>The maximum number of Amazon Q Business applications to return.</p>
|
|
2334
2334
|
* @public
|
|
2335
2335
|
*/
|
|
2336
|
-
maxResults?: number;
|
|
2336
|
+
maxResults?: number | undefined;
|
|
2337
2337
|
}
|
|
2338
2338
|
/**
|
|
2339
2339
|
* @public
|
|
@@ -2344,13 +2344,13 @@ export interface ListApplicationsResponse {
|
|
|
2344
2344
|
* in a subsequent request to retrieve the next set of applications.</p>
|
|
2345
2345
|
* @public
|
|
2346
2346
|
*/
|
|
2347
|
-
nextToken?: string;
|
|
2347
|
+
nextToken?: string | undefined;
|
|
2348
2348
|
/**
|
|
2349
2349
|
* <p>An array of summary information on the configuration of one or more Amazon Q Business
|
|
2350
2350
|
* applications.</p>
|
|
2351
2351
|
* @public
|
|
2352
2352
|
*/
|
|
2353
|
-
applications?: Application[];
|
|
2353
|
+
applications?: Application[] | undefined;
|
|
2354
2354
|
}
|
|
2355
2355
|
/**
|
|
2356
2356
|
* <p>Information about the basic authentication credentials used to configure a
|
|
@@ -2505,12 +2505,12 @@ export interface CreatePluginRequest {
|
|
|
2505
2505
|
* <p>The source URL used for plugin configuration.</p>
|
|
2506
2506
|
* @public
|
|
2507
2507
|
*/
|
|
2508
|
-
serverUrl?: string;
|
|
2508
|
+
serverUrl?: string | undefined;
|
|
2509
2509
|
/**
|
|
2510
2510
|
* <p>Contains configuration for a custom plugin.</p>
|
|
2511
2511
|
* @public
|
|
2512
2512
|
*/
|
|
2513
|
-
customPluginConfiguration?: CustomPluginConfiguration;
|
|
2513
|
+
customPluginConfiguration?: CustomPluginConfiguration | undefined;
|
|
2514
2514
|
/**
|
|
2515
2515
|
* <p>A list of key-value pairs that identify or categorize the data source connector. You
|
|
2516
2516
|
* can also use tags to help control access to the data source connector. Tag keys and
|
|
@@ -2518,13 +2518,13 @@ export interface CreatePluginRequest {
|
|
|
2518
2518
|
* symbols: _ . : / = + - @.</p>
|
|
2519
2519
|
* @public
|
|
2520
2520
|
*/
|
|
2521
|
-
tags?: Tag[];
|
|
2521
|
+
tags?: Tag[] | undefined;
|
|
2522
2522
|
/**
|
|
2523
2523
|
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
2524
2524
|
* plugin.</p>
|
|
2525
2525
|
* @public
|
|
2526
2526
|
*/
|
|
2527
|
-
clientToken?: string;
|
|
2527
|
+
clientToken?: string | undefined;
|
|
2528
2528
|
}
|
|
2529
2529
|
/**
|
|
2530
2530
|
* @public
|
|
@@ -2551,17 +2551,17 @@ export interface CreatePluginResponse {
|
|
|
2551
2551
|
* <p>The identifier of the plugin created.</p>
|
|
2552
2552
|
* @public
|
|
2553
2553
|
*/
|
|
2554
|
-
pluginId?: string;
|
|
2554
|
+
pluginId?: string | undefined;
|
|
2555
2555
|
/**
|
|
2556
2556
|
* <p>The Amazon Resource Name (ARN) of a plugin.</p>
|
|
2557
2557
|
* @public
|
|
2558
2558
|
*/
|
|
2559
|
-
pluginArn?: string;
|
|
2559
|
+
pluginArn?: string | undefined;
|
|
2560
2560
|
/**
|
|
2561
2561
|
* <p>The current status of a plugin. A plugin is modified asynchronously.</p>
|
|
2562
2562
|
* @public
|
|
2563
2563
|
*/
|
|
2564
|
-
buildStatus?: PluginBuildStatus;
|
|
2564
|
+
buildStatus?: PluginBuildStatus | undefined;
|
|
2565
2565
|
}
|
|
2566
2566
|
/**
|
|
2567
2567
|
* @public
|
|
@@ -2618,63 +2618,63 @@ export interface GetPluginResponse {
|
|
|
2618
2618
|
* <p>The identifier of the application which contains the plugin.</p>
|
|
2619
2619
|
* @public
|
|
2620
2620
|
*/
|
|
2621
|
-
applicationId?: string;
|
|
2621
|
+
applicationId?: string | undefined;
|
|
2622
2622
|
/**
|
|
2623
2623
|
* <p>The identifier of the plugin.</p>
|
|
2624
2624
|
* @public
|
|
2625
2625
|
*/
|
|
2626
|
-
pluginId?: string;
|
|
2626
|
+
pluginId?: string | undefined;
|
|
2627
2627
|
/**
|
|
2628
2628
|
* <p>The name of the plugin.</p>
|
|
2629
2629
|
* @public
|
|
2630
2630
|
*/
|
|
2631
|
-
displayName?: string;
|
|
2631
|
+
displayName?: string | undefined;
|
|
2632
2632
|
/**
|
|
2633
2633
|
* <p>The type of the plugin.</p>
|
|
2634
2634
|
* @public
|
|
2635
2635
|
*/
|
|
2636
|
-
type?: PluginType;
|
|
2636
|
+
type?: PluginType | undefined;
|
|
2637
2637
|
/**
|
|
2638
2638
|
* <p>The source URL used for plugin configuration.</p>
|
|
2639
2639
|
* @public
|
|
2640
2640
|
*/
|
|
2641
|
-
serverUrl?: string;
|
|
2641
|
+
serverUrl?: string | undefined;
|
|
2642
2642
|
/**
|
|
2643
2643
|
* <p>Authentication configuration information for an Amazon Q Business plugin.</p>
|
|
2644
2644
|
* @public
|
|
2645
2645
|
*/
|
|
2646
|
-
authConfiguration?: PluginAuthConfiguration;
|
|
2646
|
+
authConfiguration?: PluginAuthConfiguration | undefined;
|
|
2647
2647
|
/**
|
|
2648
2648
|
* <p>Configuration information required to create a custom plugin.</p>
|
|
2649
2649
|
* @public
|
|
2650
2650
|
*/
|
|
2651
|
-
customPluginConfiguration?: CustomPluginConfiguration;
|
|
2651
|
+
customPluginConfiguration?: CustomPluginConfiguration | undefined;
|
|
2652
2652
|
/**
|
|
2653
2653
|
* <p>The current status of a plugin. A plugin is modified asynchronously.</p>
|
|
2654
2654
|
* @public
|
|
2655
2655
|
*/
|
|
2656
|
-
buildStatus?: PluginBuildStatus;
|
|
2656
|
+
buildStatus?: PluginBuildStatus | undefined;
|
|
2657
2657
|
/**
|
|
2658
2658
|
* <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed
|
|
2659
2659
|
* to create the plugin.</p>
|
|
2660
2660
|
* @public
|
|
2661
2661
|
*/
|
|
2662
|
-
pluginArn?: string;
|
|
2662
|
+
pluginArn?: string | undefined;
|
|
2663
2663
|
/**
|
|
2664
2664
|
* <p>The current state of the plugin.</p>
|
|
2665
2665
|
* @public
|
|
2666
2666
|
*/
|
|
2667
|
-
state?: PluginState;
|
|
2667
|
+
state?: PluginState | undefined;
|
|
2668
2668
|
/**
|
|
2669
2669
|
* <p>The timestamp for when the plugin was created.</p>
|
|
2670
2670
|
* @public
|
|
2671
2671
|
*/
|
|
2672
|
-
createdAt?: Date;
|
|
2672
|
+
createdAt?: Date | undefined;
|
|
2673
2673
|
/**
|
|
2674
2674
|
* <p>The timestamp for when the plugin was last updated.</p>
|
|
2675
2675
|
* @public
|
|
2676
2676
|
*/
|
|
2677
|
-
updatedAt?: Date;
|
|
2677
|
+
updatedAt?: Date | undefined;
|
|
2678
2678
|
}
|
|
2679
2679
|
/**
|
|
2680
2680
|
* @public
|
|
@@ -2691,12 +2691,12 @@ export interface ListPluginsRequest {
|
|
|
2691
2691
|
* pagination token to retrieve the next set of plugins.</p>
|
|
2692
2692
|
* @public
|
|
2693
2693
|
*/
|
|
2694
|
-
nextToken?: string;
|
|
2694
|
+
nextToken?: string | undefined;
|
|
2695
2695
|
/**
|
|
2696
2696
|
* <p>The maximum number of documents to return.</p>
|
|
2697
2697
|
* @public
|
|
2698
2698
|
*/
|
|
2699
|
-
maxResults?: number;
|
|
2699
|
+
maxResults?: number | undefined;
|
|
2700
2700
|
}
|
|
2701
2701
|
/**
|
|
2702
2702
|
* <p>Information about an Amazon Q Business plugin and its configuration.</p>
|
|
@@ -2707,42 +2707,42 @@ export interface Plugin {
|
|
|
2707
2707
|
* <p>The identifier of the plugin.</p>
|
|
2708
2708
|
* @public
|
|
2709
2709
|
*/
|
|
2710
|
-
pluginId?: string;
|
|
2710
|
+
pluginId?: string | undefined;
|
|
2711
2711
|
/**
|
|
2712
2712
|
* <p>The name of the plugin.</p>
|
|
2713
2713
|
* @public
|
|
2714
2714
|
*/
|
|
2715
|
-
displayName?: string;
|
|
2715
|
+
displayName?: string | undefined;
|
|
2716
2716
|
/**
|
|
2717
2717
|
* <p>The type of the plugin.</p>
|
|
2718
2718
|
* @public
|
|
2719
2719
|
*/
|
|
2720
|
-
type?: PluginType;
|
|
2720
|
+
type?: PluginType | undefined;
|
|
2721
2721
|
/**
|
|
2722
2722
|
* <p>The plugin server URL used for configuration.</p>
|
|
2723
2723
|
* @public
|
|
2724
2724
|
*/
|
|
2725
|
-
serverUrl?: string;
|
|
2725
|
+
serverUrl?: string | undefined;
|
|
2726
2726
|
/**
|
|
2727
2727
|
* <p>The current status of the plugin.</p>
|
|
2728
2728
|
* @public
|
|
2729
2729
|
*/
|
|
2730
|
-
state?: PluginState;
|
|
2730
|
+
state?: PluginState | undefined;
|
|
2731
2731
|
/**
|
|
2732
2732
|
* <p>The status of the plugin.</p>
|
|
2733
2733
|
* @public
|
|
2734
2734
|
*/
|
|
2735
|
-
buildStatus?: PluginBuildStatus;
|
|
2735
|
+
buildStatus?: PluginBuildStatus | undefined;
|
|
2736
2736
|
/**
|
|
2737
2737
|
* <p>The timestamp for when the plugin was created.</p>
|
|
2738
2738
|
* @public
|
|
2739
2739
|
*/
|
|
2740
|
-
createdAt?: Date;
|
|
2740
|
+
createdAt?: Date | undefined;
|
|
2741
2741
|
/**
|
|
2742
2742
|
* <p>The timestamp for when the plugin was last updated.</p>
|
|
2743
2743
|
* @public
|
|
2744
2744
|
*/
|
|
2745
|
-
updatedAt?: Date;
|
|
2745
|
+
updatedAt?: Date | undefined;
|
|
2746
2746
|
}
|
|
2747
2747
|
/**
|
|
2748
2748
|
* @public
|
|
@@ -2754,12 +2754,12 @@ export interface ListPluginsResponse {
|
|
|
2754
2754
|
* pagination token to retrieve the next set of plugins.</p>
|
|
2755
2755
|
* @public
|
|
2756
2756
|
*/
|
|
2757
|
-
nextToken?: string;
|
|
2757
|
+
nextToken?: string | undefined;
|
|
2758
2758
|
/**
|
|
2759
2759
|
* <p>Information about a configured plugin.</p>
|
|
2760
2760
|
* @public
|
|
2761
2761
|
*/
|
|
2762
|
-
plugins?: Plugin[];
|
|
2762
|
+
plugins?: Plugin[] | undefined;
|
|
2763
2763
|
}
|
|
2764
2764
|
/**
|
|
2765
2765
|
* @public
|
|
@@ -2779,27 +2779,27 @@ export interface UpdatePluginRequest {
|
|
|
2779
2779
|
* <p>The name of the plugin.</p>
|
|
2780
2780
|
* @public
|
|
2781
2781
|
*/
|
|
2782
|
-
displayName?: string;
|
|
2782
|
+
displayName?: string | undefined;
|
|
2783
2783
|
/**
|
|
2784
2784
|
* <p>The status of the plugin. </p>
|
|
2785
2785
|
* @public
|
|
2786
2786
|
*/
|
|
2787
|
-
state?: PluginState;
|
|
2787
|
+
state?: PluginState | undefined;
|
|
2788
2788
|
/**
|
|
2789
2789
|
* <p>The source URL used for plugin configuration.</p>
|
|
2790
2790
|
* @public
|
|
2791
2791
|
*/
|
|
2792
|
-
serverUrl?: string;
|
|
2792
|
+
serverUrl?: string | undefined;
|
|
2793
2793
|
/**
|
|
2794
2794
|
* <p>The configuration for a custom plugin.</p>
|
|
2795
2795
|
* @public
|
|
2796
2796
|
*/
|
|
2797
|
-
customPluginConfiguration?: CustomPluginConfiguration;
|
|
2797
|
+
customPluginConfiguration?: CustomPluginConfiguration | undefined;
|
|
2798
2798
|
/**
|
|
2799
2799
|
* <p>The authentication configuration the plugin is using.</p>
|
|
2800
2800
|
* @public
|
|
2801
2801
|
*/
|
|
2802
|
-
authConfiguration?: PluginAuthConfiguration;
|
|
2802
|
+
authConfiguration?: PluginAuthConfiguration | undefined;
|
|
2803
2803
|
}
|
|
2804
2804
|
/**
|
|
2805
2805
|
* @public
|
|
@@ -2849,7 +2849,7 @@ export interface DateAttributeBoostingConfiguration {
|
|
|
2849
2849
|
* document attribute.</p>
|
|
2850
2850
|
* @public
|
|
2851
2851
|
*/
|
|
2852
|
-
boostingDurationInSeconds?: number;
|
|
2852
|
+
boostingDurationInSeconds?: number | undefined;
|
|
2853
2853
|
}
|
|
2854
2854
|
/**
|
|
2855
2855
|
* @public
|
|
@@ -2880,7 +2880,7 @@ export interface NumberAttributeBoostingConfiguration {
|
|
|
2880
2880
|
* <p>Specifies how much a document attribute is boosted.</p>
|
|
2881
2881
|
* @public
|
|
2882
2882
|
*/
|
|
2883
|
-
boostingType?: NumberAttributeBoostingType;
|
|
2883
|
+
boostingType?: NumberAttributeBoostingType | undefined;
|
|
2884
2884
|
}
|
|
2885
2885
|
/**
|
|
2886
2886
|
* @public
|
|
@@ -2920,7 +2920,7 @@ export interface StringAttributeBoostingConfiguration {
|
|
|
2920
2920
|
* boosted.</p>
|
|
2921
2921
|
* @public
|
|
2922
2922
|
*/
|
|
2923
|
-
attributeValueBoosting?: Record<string, StringAttributeValueBoostingLevel
|
|
2923
|
+
attributeValueBoosting?: Record<string, StringAttributeValueBoostingLevel> | undefined;
|
|
2924
2924
|
}
|
|
2925
2925
|
/**
|
|
2926
2926
|
* <p>Provides information on boosting <code>STRING_LIST</code> type document
|
|
@@ -3043,7 +3043,7 @@ export interface NativeIndexConfiguration {
|
|
|
3043
3043
|
* data types.</p>
|
|
3044
3044
|
* @public
|
|
3045
3045
|
*/
|
|
3046
|
-
boostingOverride?: Record<string, DocumentAttributeBoostingConfiguration
|
|
3046
|
+
boostingOverride?: Record<string, DocumentAttributeBoostingConfiguration> | undefined;
|
|
3047
3047
|
}
|
|
3048
3048
|
/**
|
|
3049
3049
|
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
@@ -3132,20 +3132,20 @@ export interface CreateRetrieverRequest {
|
|
|
3132
3132
|
* authentication credentials stored in a Secrets Manager secret.</p>
|
|
3133
3133
|
* @public
|
|
3134
3134
|
*/
|
|
3135
|
-
roleArn?: string;
|
|
3135
|
+
roleArn?: string | undefined;
|
|
3136
3136
|
/**
|
|
3137
3137
|
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
3138
3138
|
* application retriever.</p>
|
|
3139
3139
|
* @public
|
|
3140
3140
|
*/
|
|
3141
|
-
clientToken?: string;
|
|
3141
|
+
clientToken?: string | undefined;
|
|
3142
3142
|
/**
|
|
3143
3143
|
* <p>A list of key-value pairs that identify or categorize the retriever. You can also use
|
|
3144
3144
|
* tags to help control access to the retriever. Tag keys and values can consist of Unicode
|
|
3145
3145
|
* letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
3146
3146
|
* @public
|
|
3147
3147
|
*/
|
|
3148
|
-
tags?: Tag[];
|
|
3148
|
+
tags?: Tag[] | undefined;
|
|
3149
3149
|
}
|
|
3150
3150
|
/**
|
|
3151
3151
|
* @public
|
|
@@ -3155,12 +3155,12 @@ export interface CreateRetrieverResponse {
|
|
|
3155
3155
|
* <p>The identifier of the retriever you are using.</p>
|
|
3156
3156
|
* @public
|
|
3157
3157
|
*/
|
|
3158
|
-
retrieverId?: string;
|
|
3158
|
+
retrieverId?: string | undefined;
|
|
3159
3159
|
/**
|
|
3160
3160
|
* <p>The Amazon Resource Name (ARN) of an IAM role associated with a retriever.</p>
|
|
3161
3161
|
* @public
|
|
3162
3162
|
*/
|
|
3163
|
-
retrieverArn?: string;
|
|
3163
|
+
retrieverArn?: string | undefined;
|
|
3164
3164
|
}
|
|
3165
3165
|
/**
|
|
3166
3166
|
* @public
|
|
@@ -3218,54 +3218,54 @@ export interface GetRetrieverResponse {
|
|
|
3218
3218
|
* <p>The identifier of the Amazon Q Business application using the retriever. </p>
|
|
3219
3219
|
* @public
|
|
3220
3220
|
*/
|
|
3221
|
-
applicationId?: string;
|
|
3221
|
+
applicationId?: string | undefined;
|
|
3222
3222
|
/**
|
|
3223
3223
|
* <p>The identifier of the retriever.</p>
|
|
3224
3224
|
* @public
|
|
3225
3225
|
*/
|
|
3226
|
-
retrieverId?: string;
|
|
3226
|
+
retrieverId?: string | undefined;
|
|
3227
3227
|
/**
|
|
3228
3228
|
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the retriever.</p>
|
|
3229
3229
|
* @public
|
|
3230
3230
|
*/
|
|
3231
|
-
retrieverArn?: string;
|
|
3231
|
+
retrieverArn?: string | undefined;
|
|
3232
3232
|
/**
|
|
3233
3233
|
* <p>The type of the retriever.</p>
|
|
3234
3234
|
* @public
|
|
3235
3235
|
*/
|
|
3236
|
-
type?: RetrieverType;
|
|
3236
|
+
type?: RetrieverType | undefined;
|
|
3237
3237
|
/**
|
|
3238
3238
|
* <p>The status of the retriever.</p>
|
|
3239
3239
|
* @public
|
|
3240
3240
|
*/
|
|
3241
|
-
status?: RetrieverStatus;
|
|
3241
|
+
status?: RetrieverStatus | undefined;
|
|
3242
3242
|
/**
|
|
3243
3243
|
* <p>The name of the retriever.</p>
|
|
3244
3244
|
* @public
|
|
3245
3245
|
*/
|
|
3246
|
-
displayName?: string;
|
|
3246
|
+
displayName?: string | undefined;
|
|
3247
3247
|
/**
|
|
3248
3248
|
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
3249
3249
|
* configured.</p>
|
|
3250
3250
|
* @public
|
|
3251
3251
|
*/
|
|
3252
|
-
configuration?: RetrieverConfiguration;
|
|
3252
|
+
configuration?: RetrieverConfiguration | undefined;
|
|
3253
3253
|
/**
|
|
3254
3254
|
* <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever
|
|
3255
3255
|
* and required resources.</p>
|
|
3256
3256
|
* @public
|
|
3257
3257
|
*/
|
|
3258
|
-
roleArn?: string;
|
|
3258
|
+
roleArn?: string | undefined;
|
|
3259
3259
|
/**
|
|
3260
3260
|
* <p>The Unix timestamp when the retriever was created.</p>
|
|
3261
3261
|
* @public
|
|
3262
3262
|
*/
|
|
3263
|
-
createdAt?: Date;
|
|
3263
|
+
createdAt?: Date | undefined;
|
|
3264
3264
|
/**
|
|
3265
3265
|
* <p>The Unix timestamp when the retriever was last updated.</p>
|
|
3266
3266
|
* @public
|
|
3267
3267
|
*/
|
|
3268
|
-
updatedAt?: Date;
|
|
3268
|
+
updatedAt?: Date | undefined;
|
|
3269
3269
|
}
|
|
3270
3270
|
/**
|
|
3271
3271
|
* @public
|
|
@@ -3282,12 +3282,12 @@ export interface ListRetrieversRequest {
|
|
|
3282
3282
|
* retrievers.</p>
|
|
3283
3283
|
* @public
|
|
3284
3284
|
*/
|
|
3285
|
-
nextToken?: string;
|
|
3285
|
+
nextToken?: string | undefined;
|
|
3286
3286
|
/**
|
|
3287
3287
|
* <p>The maximum number of retrievers returned.</p>
|
|
3288
3288
|
* @public
|
|
3289
3289
|
*/
|
|
3290
|
-
maxResults?: number;
|
|
3290
|
+
maxResults?: number | undefined;
|
|
3291
3291
|
}
|
|
3292
3292
|
/**
|
|
3293
3293
|
* <p>Summary information for the retriever used for your Amazon Q Business application.</p>
|
|
@@ -3298,27 +3298,27 @@ export interface Retriever {
|
|
|
3298
3298
|
* <p>The identifier of the Amazon Q Business application using the retriever.</p>
|
|
3299
3299
|
* @public
|
|
3300
3300
|
*/
|
|
3301
|
-
applicationId?: string;
|
|
3301
|
+
applicationId?: string | undefined;
|
|
3302
3302
|
/**
|
|
3303
3303
|
* <p>The identifier of the retriever used by your Amazon Q Business application.</p>
|
|
3304
3304
|
* @public
|
|
3305
3305
|
*/
|
|
3306
|
-
retrieverId?: string;
|
|
3306
|
+
retrieverId?: string | undefined;
|
|
3307
3307
|
/**
|
|
3308
3308
|
* <p>The type of your retriever.</p>
|
|
3309
3309
|
* @public
|
|
3310
3310
|
*/
|
|
3311
|
-
type?: RetrieverType;
|
|
3311
|
+
type?: RetrieverType | undefined;
|
|
3312
3312
|
/**
|
|
3313
3313
|
* <p>The status of your retriever.</p>
|
|
3314
3314
|
* @public
|
|
3315
3315
|
*/
|
|
3316
|
-
status?: RetrieverStatus;
|
|
3316
|
+
status?: RetrieverStatus | undefined;
|
|
3317
3317
|
/**
|
|
3318
3318
|
* <p>The name of your retriever.</p>
|
|
3319
3319
|
* @public
|
|
3320
3320
|
*/
|
|
3321
|
-
displayName?: string;
|
|
3321
|
+
displayName?: string | undefined;
|
|
3322
3322
|
}
|
|
3323
3323
|
/**
|
|
3324
3324
|
* @public
|
|
@@ -3328,13 +3328,13 @@ export interface ListRetrieversResponse {
|
|
|
3328
3328
|
* <p>An array of summary information for one or more retrievers.</p>
|
|
3329
3329
|
* @public
|
|
3330
3330
|
*/
|
|
3331
|
-
retrievers?: Retriever[];
|
|
3331
|
+
retrievers?: Retriever[] | undefined;
|
|
3332
3332
|
/**
|
|
3333
3333
|
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
3334
3334
|
* later request to list the next set of retrievers.</p>
|
|
3335
3335
|
* @public
|
|
3336
3336
|
*/
|
|
3337
|
-
nextToken?: string;
|
|
3337
|
+
nextToken?: string | undefined;
|
|
3338
3338
|
}
|
|
3339
3339
|
/**
|
|
3340
3340
|
* @public
|
|
@@ -3355,18 +3355,18 @@ export interface UpdateRetrieverRequest {
|
|
|
3355
3355
|
* configured.</p>
|
|
3356
3356
|
* @public
|
|
3357
3357
|
*/
|
|
3358
|
-
configuration?: RetrieverConfiguration;
|
|
3358
|
+
configuration?: RetrieverConfiguration | undefined;
|
|
3359
3359
|
/**
|
|
3360
3360
|
* <p>The name of your retriever.</p>
|
|
3361
3361
|
* @public
|
|
3362
3362
|
*/
|
|
3363
|
-
displayName?: string;
|
|
3363
|
+
displayName?: string | undefined;
|
|
3364
3364
|
/**
|
|
3365
3365
|
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever
|
|
3366
3366
|
* and required resources. </p>
|
|
3367
3367
|
* @public
|
|
3368
3368
|
*/
|
|
3369
|
-
roleArn?: string;
|
|
3369
|
+
roleArn?: string | undefined;
|
|
3370
3370
|
}
|
|
3371
3371
|
/**
|
|
3372
3372
|
* @public
|
|
@@ -3387,47 +3387,47 @@ export interface UpdateApplicationRequest {
|
|
|
3387
3387
|
* creating for—or connecting to—your Amazon Q Business application.</p>
|
|
3388
3388
|
* @public
|
|
3389
3389
|
*/
|
|
3390
|
-
identityCenterInstanceArn?: string;
|
|
3390
|
+
identityCenterInstanceArn?: string | undefined;
|
|
3391
3391
|
/**
|
|
3392
3392
|
* <p>A name for the Amazon Q Business application.</p>
|
|
3393
3393
|
* @public
|
|
3394
3394
|
*/
|
|
3395
|
-
displayName?: string;
|
|
3395
|
+
displayName?: string | undefined;
|
|
3396
3396
|
/**
|
|
3397
3397
|
* <p>A description for the Amazon Q Business application.</p>
|
|
3398
3398
|
* @public
|
|
3399
3399
|
*/
|
|
3400
|
-
description?: string;
|
|
3400
|
+
description?: string | undefined;
|
|
3401
3401
|
/**
|
|
3402
3402
|
* <p>An Amazon Web Services Identity and Access Management (IAM) role that
|
|
3403
3403
|
* gives Amazon Q Business permission to access Amazon CloudWatch logs and
|
|
3404
3404
|
* metrics.</p>
|
|
3405
3405
|
* @public
|
|
3406
3406
|
*/
|
|
3407
|
-
roleArn?: string;
|
|
3407
|
+
roleArn?: string | undefined;
|
|
3408
3408
|
/**
|
|
3409
3409
|
* <p>An option to allow end users to upload files directly during chat.</p>
|
|
3410
3410
|
* @public
|
|
3411
3411
|
*/
|
|
3412
|
-
attachmentsConfiguration?: AttachmentsConfiguration;
|
|
3412
|
+
attachmentsConfiguration?: AttachmentsConfiguration | undefined;
|
|
3413
3413
|
/**
|
|
3414
3414
|
* <p>An option to allow end users to create and use Amazon Q Apps in the web
|
|
3415
3415
|
* experience.</p>
|
|
3416
3416
|
* @public
|
|
3417
3417
|
*/
|
|
3418
|
-
qAppsConfiguration?: QAppsConfiguration;
|
|
3418
|
+
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
3419
3419
|
/**
|
|
3420
3420
|
* <p>Configuration information about chat response personalization. For more information,
|
|
3421
3421
|
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
3422
3422
|
* @public
|
|
3423
3423
|
*/
|
|
3424
|
-
personalizationConfiguration?: PersonalizationConfiguration;
|
|
3424
|
+
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
3425
3425
|
/**
|
|
3426
3426
|
* <p>An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user
|
|
3427
3427
|
* management.</p>
|
|
3428
3428
|
* @public
|
|
3429
3429
|
*/
|
|
3430
|
-
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
|
|
3430
|
+
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration | undefined;
|
|
3431
3431
|
}
|
|
3432
3432
|
/**
|
|
3433
3433
|
* @public
|
|
@@ -3536,24 +3536,24 @@ export interface CreateWebExperienceRequest {
|
|
|
3536
3536
|
* <p>The title for your Amazon Q Business web experience.</p>
|
|
3537
3537
|
* @public
|
|
3538
3538
|
*/
|
|
3539
|
-
title?: string;
|
|
3539
|
+
title?: string | undefined;
|
|
3540
3540
|
/**
|
|
3541
3541
|
* <p>A subtitle to personalize your Amazon Q Business web experience.</p>
|
|
3542
3542
|
* @public
|
|
3543
3543
|
*/
|
|
3544
|
-
subtitle?: string;
|
|
3544
|
+
subtitle?: string | undefined;
|
|
3545
3545
|
/**
|
|
3546
3546
|
* <p>The customized welcome message for end users of an Amazon Q Business web
|
|
3547
3547
|
* experience.</p>
|
|
3548
3548
|
* @public
|
|
3549
3549
|
*/
|
|
3550
|
-
welcomeMessage?: string;
|
|
3550
|
+
welcomeMessage?: string | undefined;
|
|
3551
3551
|
/**
|
|
3552
3552
|
* <p>Determines whether sample prompts are enabled in the web experience for an end
|
|
3553
3553
|
* user.</p>
|
|
3554
3554
|
* @public
|
|
3555
3555
|
*/
|
|
3556
|
-
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
|
3556
|
+
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
3557
3557
|
/**
|
|
3558
3558
|
* <p>Sets the website domain origins that
|
|
3559
3559
|
* are allowed to embed the Amazon Q Business web experience.
|
|
@@ -3568,7 +3568,7 @@ export interface CreateWebExperienceRequest {
|
|
|
3568
3568
|
* </note>
|
|
3569
3569
|
* @public
|
|
3570
3570
|
*/
|
|
3571
|
-
origins?: string[];
|
|
3571
|
+
origins?: string[] | undefined;
|
|
3572
3572
|
/**
|
|
3573
3573
|
* <p>The Amazon Resource Name (ARN) of the service role attached to your web
|
|
3574
3574
|
* experience.</p>
|
|
@@ -3579,7 +3579,7 @@ export interface CreateWebExperienceRequest {
|
|
|
3579
3579
|
* </note>
|
|
3580
3580
|
* @public
|
|
3581
3581
|
*/
|
|
3582
|
-
roleArn?: string;
|
|
3582
|
+
roleArn?: string | undefined;
|
|
3583
3583
|
/**
|
|
3584
3584
|
* <p>A list of key-value pairs that identify or categorize your Amazon Q Business web
|
|
3585
3585
|
* experience. You can also use tags to help control access to the web experience. Tag keys
|
|
@@ -3587,19 +3587,19 @@ export interface CreateWebExperienceRequest {
|
|
|
3587
3587
|
* symbols: _ . : / = + - @.</p>
|
|
3588
3588
|
* @public
|
|
3589
3589
|
*/
|
|
3590
|
-
tags?: Tag[];
|
|
3590
|
+
tags?: Tag[] | undefined;
|
|
3591
3591
|
/**
|
|
3592
3592
|
* <p>A token you provide to identify a request to create an Amazon Q Business web experience.
|
|
3593
3593
|
* </p>
|
|
3594
3594
|
* @public
|
|
3595
3595
|
*/
|
|
3596
|
-
clientToken?: string;
|
|
3596
|
+
clientToken?: string | undefined;
|
|
3597
3597
|
/**
|
|
3598
3598
|
* <p>Information about the identity provider (IdP) used to authenticate end users of an
|
|
3599
3599
|
* Amazon Q Business web experience.</p>
|
|
3600
3600
|
* @public
|
|
3601
3601
|
*/
|
|
3602
|
-
identityProviderConfiguration?: IdentityProviderConfiguration;
|
|
3602
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
3603
3603
|
}
|
|
3604
3604
|
/**
|
|
3605
3605
|
* @public
|
|
@@ -3609,12 +3609,12 @@ export interface CreateWebExperienceResponse {
|
|
|
3609
3609
|
* <p>The identifier of the Amazon Q Business web experience.</p>
|
|
3610
3610
|
* @public
|
|
3611
3611
|
*/
|
|
3612
|
-
webExperienceId?: string;
|
|
3612
|
+
webExperienceId?: string | undefined;
|
|
3613
3613
|
/**
|
|
3614
3614
|
* <p> The Amazon Resource Name (ARN) of an Amazon Q Business web experience.</p>
|
|
3615
3615
|
* @public
|
|
3616
3616
|
*/
|
|
3617
|
-
webExperienceArn?: string;
|
|
3617
|
+
webExperienceArn?: string | undefined;
|
|
3618
3618
|
}
|
|
3619
3619
|
/**
|
|
3620
3620
|
* @public
|
|
@@ -3679,7 +3679,7 @@ export interface SamlConfiguration {
|
|
|
3679
3679
|
* <p>The group attribute name in your IdP that maps to user groups.</p>
|
|
3680
3680
|
* @public
|
|
3681
3681
|
*/
|
|
3682
|
-
userGroupAttribute?: string;
|
|
3682
|
+
userGroupAttribute?: string | undefined;
|
|
3683
3683
|
}
|
|
3684
3684
|
/**
|
|
3685
3685
|
* <p>Provides the authorization configuration information needed to deploy a Amazon Q Business
|
|
@@ -3736,62 +3736,62 @@ export interface GetWebExperienceResponse {
|
|
|
3736
3736
|
* <p>The identifier of the Amazon Q Business application linked to the web experience.</p>
|
|
3737
3737
|
* @public
|
|
3738
3738
|
*/
|
|
3739
|
-
applicationId?: string;
|
|
3739
|
+
applicationId?: string | undefined;
|
|
3740
3740
|
/**
|
|
3741
3741
|
* <p>The identifier of the Amazon Q Business web experience.</p>
|
|
3742
3742
|
* @public
|
|
3743
3743
|
*/
|
|
3744
|
-
webExperienceId?: string;
|
|
3744
|
+
webExperienceId?: string | undefined;
|
|
3745
3745
|
/**
|
|
3746
3746
|
* <p>The Amazon Resource Name (ARN) of the role with the permission to access the
|
|
3747
3747
|
* Amazon Q Business web experience and required resources.</p>
|
|
3748
3748
|
* @public
|
|
3749
3749
|
*/
|
|
3750
|
-
webExperienceArn?: string;
|
|
3750
|
+
webExperienceArn?: string | undefined;
|
|
3751
3751
|
/**
|
|
3752
3752
|
* <p>The endpoint of your Amazon Q Business web experience.</p>
|
|
3753
3753
|
* @public
|
|
3754
3754
|
*/
|
|
3755
|
-
defaultEndpoint?: string;
|
|
3755
|
+
defaultEndpoint?: string | undefined;
|
|
3756
3756
|
/**
|
|
3757
3757
|
* <p>The current status of the Amazon Q Business web experience. When the <code>Status</code>
|
|
3758
3758
|
* field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a
|
|
3759
3759
|
* description of the error that caused the data source connector to fail. </p>
|
|
3760
3760
|
* @public
|
|
3761
3761
|
*/
|
|
3762
|
-
status?: WebExperienceStatus;
|
|
3762
|
+
status?: WebExperienceStatus | undefined;
|
|
3763
3763
|
/**
|
|
3764
3764
|
* <p>The Unix timestamp when the Amazon Q Business web experience was last created.</p>
|
|
3765
3765
|
* @public
|
|
3766
3766
|
*/
|
|
3767
|
-
createdAt?: Date;
|
|
3767
|
+
createdAt?: Date | undefined;
|
|
3768
3768
|
/**
|
|
3769
3769
|
* <p>The Unix timestamp when the Amazon Q Business web experience was last updated.</p>
|
|
3770
3770
|
* @public
|
|
3771
3771
|
*/
|
|
3772
|
-
updatedAt?: Date;
|
|
3772
|
+
updatedAt?: Date | undefined;
|
|
3773
3773
|
/**
|
|
3774
3774
|
* <p>The title for your Amazon Q Business web experience. </p>
|
|
3775
3775
|
* @public
|
|
3776
3776
|
*/
|
|
3777
|
-
title?: string;
|
|
3777
|
+
title?: string | undefined;
|
|
3778
3778
|
/**
|
|
3779
3779
|
* <p>The subtitle for your Amazon Q Business web experience. </p>
|
|
3780
3780
|
* @public
|
|
3781
3781
|
*/
|
|
3782
|
-
subtitle?: string;
|
|
3782
|
+
subtitle?: string | undefined;
|
|
3783
3783
|
/**
|
|
3784
3784
|
* <p>The customized welcome message for end users of an Amazon Q Business web
|
|
3785
3785
|
* experience.</p>
|
|
3786
3786
|
* @public
|
|
3787
3787
|
*/
|
|
3788
|
-
welcomeMessage?: string;
|
|
3788
|
+
welcomeMessage?: string | undefined;
|
|
3789
3789
|
/**
|
|
3790
3790
|
* <p>Determines whether sample prompts are enabled in the web experience for an end
|
|
3791
3791
|
* user.</p>
|
|
3792
3792
|
* @public
|
|
3793
3793
|
*/
|
|
3794
|
-
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
|
3794
|
+
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
3795
3795
|
/**
|
|
3796
3796
|
* <p>Gets the website domain origins that
|
|
3797
3797
|
* are allowed to embed the Amazon Q Business web experience.
|
|
@@ -3802,19 +3802,19 @@ export interface GetWebExperienceResponse {
|
|
|
3802
3802
|
* </p>
|
|
3803
3803
|
* @public
|
|
3804
3804
|
*/
|
|
3805
|
-
origins?: string[];
|
|
3805
|
+
origins?: string[] | undefined;
|
|
3806
3806
|
/**
|
|
3807
3807
|
* <p> The Amazon Resource Name (ARN) of the service role attached to your web
|
|
3808
3808
|
* experience.</p>
|
|
3809
3809
|
* @public
|
|
3810
3810
|
*/
|
|
3811
|
-
roleArn?: string;
|
|
3811
|
+
roleArn?: string | undefined;
|
|
3812
3812
|
/**
|
|
3813
3813
|
* <p>Information about the identity provider (IdP) used to authenticate end users of an
|
|
3814
3814
|
* Amazon Q Business web experience.</p>
|
|
3815
3815
|
* @public
|
|
3816
3816
|
*/
|
|
3817
|
-
identityProviderConfiguration?: IdentityProviderConfiguration;
|
|
3817
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
3818
3818
|
/**
|
|
3819
3819
|
* @deprecated
|
|
3820
3820
|
*
|
|
@@ -3822,14 +3822,14 @@ export interface GetWebExperienceResponse {
|
|
|
3822
3822
|
* experience.</p>
|
|
3823
3823
|
* @public
|
|
3824
3824
|
*/
|
|
3825
|
-
authenticationConfiguration?: WebExperienceAuthConfiguration;
|
|
3825
|
+
authenticationConfiguration?: WebExperienceAuthConfiguration | undefined;
|
|
3826
3826
|
/**
|
|
3827
3827
|
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
3828
3828
|
* <code>ErrorMessage</code> field contains a description of the error that caused the
|
|
3829
3829
|
* data source connector to fail.</p>
|
|
3830
3830
|
* @public
|
|
3831
3831
|
*/
|
|
3832
|
-
error?: ErrorDetail;
|
|
3832
|
+
error?: ErrorDetail | undefined;
|
|
3833
3833
|
}
|
|
3834
3834
|
/**
|
|
3835
3835
|
* @public
|
|
@@ -3847,12 +3847,12 @@ export interface ListWebExperiencesRequest {
|
|
|
3847
3847
|
* pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
3848
3848
|
* @public
|
|
3849
3849
|
*/
|
|
3850
|
-
nextToken?: string;
|
|
3850
|
+
nextToken?: string | undefined;
|
|
3851
3851
|
/**
|
|
3852
3852
|
* <p>The maximum number of Amazon Q Business Web Experiences to return.</p>
|
|
3853
3853
|
* @public
|
|
3854
3854
|
*/
|
|
3855
|
-
maxResults?: number;
|
|
3855
|
+
maxResults?: number | undefined;
|
|
3856
3856
|
}
|
|
3857
3857
|
/**
|
|
3858
3858
|
* <p>Provides information for an Amazon Q Business web experience.</p>
|
|
@@ -3863,28 +3863,28 @@ export interface WebExperience {
|
|
|
3863
3863
|
* <p>The identifier of your Amazon Q Business web experience.</p>
|
|
3864
3864
|
* @public
|
|
3865
3865
|
*/
|
|
3866
|
-
webExperienceId?: string;
|
|
3866
|
+
webExperienceId?: string | undefined;
|
|
3867
3867
|
/**
|
|
3868
3868
|
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
3869
3869
|
* @public
|
|
3870
3870
|
*/
|
|
3871
|
-
createdAt?: Date;
|
|
3871
|
+
createdAt?: Date | undefined;
|
|
3872
3872
|
/**
|
|
3873
3873
|
* <p>The Unix timestamp when your Amazon Q Business web experience was updated.</p>
|
|
3874
3874
|
* @public
|
|
3875
3875
|
*/
|
|
3876
|
-
updatedAt?: Date;
|
|
3876
|
+
updatedAt?: Date | undefined;
|
|
3877
3877
|
/**
|
|
3878
3878
|
* <p>The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully
|
|
3879
3879
|
* hosted by Amazon Web Services.</p>
|
|
3880
3880
|
* @public
|
|
3881
3881
|
*/
|
|
3882
|
-
defaultEndpoint?: string;
|
|
3882
|
+
defaultEndpoint?: string | undefined;
|
|
3883
3883
|
/**
|
|
3884
3884
|
* <p>The status of your Amazon Q Business web experience.</p>
|
|
3885
3885
|
* @public
|
|
3886
3886
|
*/
|
|
3887
|
-
status?: WebExperienceStatus;
|
|
3887
|
+
status?: WebExperienceStatus | undefined;
|
|
3888
3888
|
}
|
|
3889
3889
|
/**
|
|
3890
3890
|
* @public
|
|
@@ -3894,13 +3894,13 @@ export interface ListWebExperiencesResponse {
|
|
|
3894
3894
|
* <p>An array of summary information for one or more Amazon Q Business experiences.</p>
|
|
3895
3895
|
* @public
|
|
3896
3896
|
*/
|
|
3897
|
-
webExperiences?: WebExperience[];
|
|
3897
|
+
webExperiences?: WebExperience[] | undefined;
|
|
3898
3898
|
/**
|
|
3899
3899
|
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
3900
3900
|
* later request to list the next set of messages.</p>
|
|
3901
3901
|
* @public
|
|
3902
3902
|
*/
|
|
3903
|
-
nextToken?: string;
|
|
3903
|
+
nextToken?: string | undefined;
|
|
3904
3904
|
}
|
|
3905
3905
|
/**
|
|
3906
3906
|
* @public
|
|
@@ -3921,42 +3921,42 @@ export interface UpdateWebExperienceRequest {
|
|
|
3921
3921
|
* web experience and required resources.</p>
|
|
3922
3922
|
* @public
|
|
3923
3923
|
*/
|
|
3924
|
-
roleArn?: string;
|
|
3924
|
+
roleArn?: string | undefined;
|
|
3925
3925
|
/**
|
|
3926
3926
|
* @deprecated
|
|
3927
3927
|
*
|
|
3928
3928
|
* <p>The authentication configuration of the Amazon Q Business web experience.</p>
|
|
3929
3929
|
* @public
|
|
3930
3930
|
*/
|
|
3931
|
-
authenticationConfiguration?: WebExperienceAuthConfiguration;
|
|
3931
|
+
authenticationConfiguration?: WebExperienceAuthConfiguration | undefined;
|
|
3932
3932
|
/**
|
|
3933
3933
|
* <p>The title of the Amazon Q Business web experience.</p>
|
|
3934
3934
|
* @public
|
|
3935
3935
|
*/
|
|
3936
|
-
title?: string;
|
|
3936
|
+
title?: string | undefined;
|
|
3937
3937
|
/**
|
|
3938
3938
|
* <p>The subtitle of the Amazon Q Business web experience.</p>
|
|
3939
3939
|
* @public
|
|
3940
3940
|
*/
|
|
3941
|
-
subtitle?: string;
|
|
3941
|
+
subtitle?: string | undefined;
|
|
3942
3942
|
/**
|
|
3943
3943
|
* <p>A customized welcome message for an end user in an Amazon Q Business web
|
|
3944
3944
|
* experience.</p>
|
|
3945
3945
|
* @public
|
|
3946
3946
|
*/
|
|
3947
|
-
welcomeMessage?: string;
|
|
3947
|
+
welcomeMessage?: string | undefined;
|
|
3948
3948
|
/**
|
|
3949
3949
|
* <p>Determines whether sample prompts are enabled in the web experience for an end
|
|
3950
3950
|
* user.</p>
|
|
3951
3951
|
* @public
|
|
3952
3952
|
*/
|
|
3953
|
-
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
|
3953
|
+
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
3954
3954
|
/**
|
|
3955
3955
|
* <p>Information about the identity provider (IdP) used to authenticate end users of an
|
|
3956
3956
|
* Amazon Q Business web experience.</p>
|
|
3957
3957
|
* @public
|
|
3958
3958
|
*/
|
|
3959
|
-
identityProviderConfiguration?: IdentityProviderConfiguration;
|
|
3959
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
3960
3960
|
/**
|
|
3961
3961
|
* <p>Updates the website domain origins that
|
|
3962
3962
|
* are allowed to embed the Amazon Q Business web experience.
|
|
@@ -3978,7 +3978,7 @@ export interface UpdateWebExperienceRequest {
|
|
|
3978
3978
|
* </note>
|
|
3979
3979
|
* @public
|
|
3980
3980
|
*/
|
|
3981
|
-
origins?: string[];
|
|
3981
|
+
origins?: string[] | undefined;
|
|
3982
3982
|
}
|
|
3983
3983
|
/**
|
|
3984
3984
|
* @public
|
|
@@ -4038,7 +4038,7 @@ export interface AttachmentInputEvent {
|
|
|
4038
4038
|
* <p>A file directly uploaded into a web experience chat.</p>
|
|
4039
4039
|
* @public
|
|
4040
4040
|
*/
|
|
4041
|
-
attachment?: AttachmentInput;
|
|
4041
|
+
attachment?: AttachmentInput | undefined;
|
|
4042
4042
|
}
|
|
4043
4043
|
/**
|
|
4044
4044
|
* @public
|
|
@@ -4061,17 +4061,17 @@ export interface AttachmentOutput {
|
|
|
4061
4061
|
* <p>The name of a file uploaded during chat.</p>
|
|
4062
4062
|
* @public
|
|
4063
4063
|
*/
|
|
4064
|
-
name?: string;
|
|
4064
|
+
name?: string | undefined;
|
|
4065
4065
|
/**
|
|
4066
4066
|
* <p>The status of a file uploaded during chat.</p>
|
|
4067
4067
|
* @public
|
|
4068
4068
|
*/
|
|
4069
|
-
status?: AttachmentStatus;
|
|
4069
|
+
status?: AttachmentStatus | undefined;
|
|
4070
4070
|
/**
|
|
4071
4071
|
* <p>An error associated with a file uploaded during chat.</p>
|
|
4072
4072
|
* @public
|
|
4073
4073
|
*/
|
|
4074
|
-
error?: ErrorDetail;
|
|
4074
|
+
error?: ErrorDetail | undefined;
|
|
4075
4075
|
}
|
|
4076
4076
|
/**
|
|
4077
4077
|
* <p>A document attribute or metadata field.</p>
|
|
@@ -4175,7 +4175,7 @@ export interface BatchDeleteDocumentRequest {
|
|
|
4175
4175
|
* <p>The identifier of the data source sync during which the documents were deleted.</p>
|
|
4176
4176
|
* @public
|
|
4177
4177
|
*/
|
|
4178
|
-
dataSourceSyncId?: string;
|
|
4178
|
+
dataSourceSyncId?: string | undefined;
|
|
4179
4179
|
}
|
|
4180
4180
|
/**
|
|
4181
4181
|
* <p>A list of documents that could not be removed from an Amazon Q Business index. Each entry
|
|
@@ -4189,18 +4189,18 @@ export interface FailedDocument {
|
|
|
4189
4189
|
* index.</p>
|
|
4190
4190
|
* @public
|
|
4191
4191
|
*/
|
|
4192
|
-
id?: string;
|
|
4192
|
+
id?: string | undefined;
|
|
4193
4193
|
/**
|
|
4194
4194
|
* <p>An explanation for why the document couldn't be removed from the index.</p>
|
|
4195
4195
|
* @public
|
|
4196
4196
|
*/
|
|
4197
|
-
error?: ErrorDetail;
|
|
4197
|
+
error?: ErrorDetail | undefined;
|
|
4198
4198
|
/**
|
|
4199
4199
|
* <p>The identifier of the Amazon Q Business data source connector that contains the failed
|
|
4200
4200
|
* document.</p>
|
|
4201
4201
|
* @public
|
|
4202
4202
|
*/
|
|
4203
|
-
dataSourceId?: string;
|
|
4203
|
+
dataSourceId?: string | undefined;
|
|
4204
4204
|
}
|
|
4205
4205
|
/**
|
|
4206
4206
|
* @public
|
|
@@ -4212,7 +4212,7 @@ export interface BatchDeleteDocumentResponse {
|
|
|
4212
4212
|
* index. </p>
|
|
4213
4213
|
* @public
|
|
4214
4214
|
*/
|
|
4215
|
-
failedDocuments?: FailedDocument[];
|
|
4215
|
+
failedDocuments?: FailedDocument[] | undefined;
|
|
4216
4216
|
}
|
|
4217
4217
|
/**
|
|
4218
4218
|
* <p>The contents of a document.</p>
|
|
@@ -4297,12 +4297,12 @@ export interface Document {
|
|
|
4297
4297
|
* responses.</p>
|
|
4298
4298
|
* @public
|
|
4299
4299
|
*/
|
|
4300
|
-
attributes?: DocumentAttribute[];
|
|
4300
|
+
attributes?: DocumentAttribute[] | undefined;
|
|
4301
4301
|
/**
|
|
4302
4302
|
* <p>The contents of the document.</p>
|
|
4303
4303
|
* @public
|
|
4304
4304
|
*/
|
|
4305
|
-
content?: DocumentContent;
|
|
4305
|
+
content?: DocumentContent | undefined;
|
|
4306
4306
|
/**
|
|
4307
4307
|
* <p>The file type of the document in the Blob field.</p>
|
|
4308
4308
|
* <p>If you want to index snippets or subsets of HTML documents instead of the entirety of
|
|
@@ -4310,23 +4310,23 @@ export interface Document {
|
|
|
4310
4310
|
* (<code><HTML>content</HTML></code>) around the content.</p>
|
|
4311
4311
|
* @public
|
|
4312
4312
|
*/
|
|
4313
|
-
contentType?: ContentType;
|
|
4313
|
+
contentType?: ContentType | undefined;
|
|
4314
4314
|
/**
|
|
4315
4315
|
* <p>The title of the document.</p>
|
|
4316
4316
|
* @public
|
|
4317
4317
|
*/
|
|
4318
|
-
title?: string;
|
|
4318
|
+
title?: string | undefined;
|
|
4319
4319
|
/**
|
|
4320
4320
|
* <p>Configuration information for access permission to a document.</p>
|
|
4321
4321
|
* @public
|
|
4322
4322
|
*/
|
|
4323
|
-
accessConfiguration?: AccessConfiguration;
|
|
4323
|
+
accessConfiguration?: AccessConfiguration | undefined;
|
|
4324
4324
|
/**
|
|
4325
4325
|
* <p>The configuration information for altering document metadata and content during the
|
|
4326
4326
|
* document ingestion process.</p>
|
|
4327
4327
|
* @public
|
|
4328
4328
|
*/
|
|
4329
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
|
4329
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
4330
4330
|
}
|
|
4331
4331
|
/**
|
|
4332
4332
|
* @public
|
|
@@ -4352,12 +4352,12 @@ export interface BatchPutDocumentRequest {
|
|
|
4352
4352
|
* bucket.</p>
|
|
4353
4353
|
* @public
|
|
4354
4354
|
*/
|
|
4355
|
-
roleArn?: string;
|
|
4355
|
+
roleArn?: string | undefined;
|
|
4356
4356
|
/**
|
|
4357
4357
|
* <p>The identifier of the data source sync during which the documents were added.</p>
|
|
4358
4358
|
* @public
|
|
4359
4359
|
*/
|
|
4360
|
-
dataSourceSyncId?: string;
|
|
4360
|
+
dataSourceSyncId?: string | undefined;
|
|
4361
4361
|
}
|
|
4362
4362
|
/**
|
|
4363
4363
|
* @public
|
|
@@ -4369,7 +4369,7 @@ export interface BatchPutDocumentResponse {
|
|
|
4369
4369
|
* indicates why the document couldn't be added to the index. </p>
|
|
4370
4370
|
* @public
|
|
4371
4371
|
*/
|
|
4372
|
-
failedDocuments?: FailedDocument[];
|
|
4372
|
+
failedDocuments?: FailedDocument[] | undefined;
|
|
4373
4373
|
}
|
|
4374
4374
|
/**
|
|
4375
4375
|
* <p>Provides information about the phrases blocked from chat by your chat control
|
|
@@ -4381,13 +4381,13 @@ export interface BlockedPhrasesConfiguration {
|
|
|
4381
4381
|
* <p>A list of phrases blocked from a Amazon Q Business web experience chat.</p>
|
|
4382
4382
|
* @public
|
|
4383
4383
|
*/
|
|
4384
|
-
blockedPhrases?: string[];
|
|
4384
|
+
blockedPhrases?: string[] | undefined;
|
|
4385
4385
|
/**
|
|
4386
4386
|
* <p>The configured custom message displayed to an end user informing them that they've
|
|
4387
4387
|
* used a blocked phrase during chat.</p>
|
|
4388
4388
|
* @public
|
|
4389
4389
|
*/
|
|
4390
|
-
systemMessageOverride?: string;
|
|
4390
|
+
systemMessageOverride?: string | undefined;
|
|
4391
4391
|
}
|
|
4392
4392
|
/**
|
|
4393
4393
|
* <p>Updates a blocked phrases configuration in your Amazon Q Business application.</p>
|
|
@@ -4399,18 +4399,18 @@ export interface BlockedPhrasesConfigurationUpdate {
|
|
|
4399
4399
|
* application.</p>
|
|
4400
4400
|
* @public
|
|
4401
4401
|
*/
|
|
4402
|
-
blockedPhrasesToCreateOrUpdate?: string[];
|
|
4402
|
+
blockedPhrasesToCreateOrUpdate?: string[] | undefined;
|
|
4403
4403
|
/**
|
|
4404
4404
|
* <p>Deletes a blocked phrases configuration in your Amazon Q Business application.</p>
|
|
4405
4405
|
* @public
|
|
4406
4406
|
*/
|
|
4407
|
-
blockedPhrasesToDelete?: string[];
|
|
4407
|
+
blockedPhrasesToDelete?: string[] | undefined;
|
|
4408
4408
|
/**
|
|
4409
4409
|
* <p>The configured custom message displayed to your end user when they use blocked phrase
|
|
4410
4410
|
* during chat.</p>
|
|
4411
4411
|
* @public
|
|
4412
4412
|
*/
|
|
4413
|
-
systemMessageOverride?: string;
|
|
4413
|
+
systemMessageOverride?: string | undefined;
|
|
4414
4414
|
}
|
|
4415
4415
|
/**
|
|
4416
4416
|
* @public
|
|
@@ -4495,22 +4495,22 @@ export interface FailedAttachmentEvent {
|
|
|
4495
4495
|
* <p> The identifier of the conversation associated with the failed file upload.</p>
|
|
4496
4496
|
* @public
|
|
4497
4497
|
*/
|
|
4498
|
-
conversationId?: string;
|
|
4498
|
+
conversationId?: string | undefined;
|
|
4499
4499
|
/**
|
|
4500
4500
|
* <p>The identifier of the end user chat message associated with the file upload.</p>
|
|
4501
4501
|
* @public
|
|
4502
4502
|
*/
|
|
4503
|
-
userMessageId?: string;
|
|
4503
|
+
userMessageId?: string | undefined;
|
|
4504
4504
|
/**
|
|
4505
4505
|
* <p>The identifier of the AI-generated message associated with the file upload.</p>
|
|
4506
4506
|
* @public
|
|
4507
4507
|
*/
|
|
4508
|
-
systemMessageId?: string;
|
|
4508
|
+
systemMessageId?: string | undefined;
|
|
4509
4509
|
/**
|
|
4510
4510
|
* <p>The details of a file uploaded during chat.</p>
|
|
4511
4511
|
* @public
|
|
4512
4512
|
*/
|
|
4513
|
-
attachment?: AttachmentOutput;
|
|
4513
|
+
attachment?: AttachmentOutput | undefined;
|
|
4514
4514
|
}
|
|
4515
4515
|
/**
|
|
4516
4516
|
* <p>Contains the relevant text excerpt from a source that was used to generate a citation
|
|
@@ -4523,7 +4523,7 @@ export interface SnippetExcerpt {
|
|
|
4523
4523
|
* segment in an Amazon Q chat response.</p>
|
|
4524
4524
|
* @public
|
|
4525
4525
|
*/
|
|
4526
|
-
text?: string;
|
|
4526
|
+
text?: string | undefined;
|
|
4527
4527
|
}
|
|
4528
4528
|
/**
|
|
4529
4529
|
* <p>Provides information about a text extract in a chat response that can be attributed to
|
|
@@ -4536,19 +4536,19 @@ export interface TextSegment {
|
|
|
4536
4536
|
* starts.</p>
|
|
4537
4537
|
* @public
|
|
4538
4538
|
*/
|
|
4539
|
-
beginOffset?: number;
|
|
4539
|
+
beginOffset?: number | undefined;
|
|
4540
4540
|
/**
|
|
4541
4541
|
* <p>The zero-based location in the response string where the source attribution
|
|
4542
4542
|
* ends.</p>
|
|
4543
4543
|
* @public
|
|
4544
4544
|
*/
|
|
4545
|
-
endOffset?: number;
|
|
4545
|
+
endOffset?: number | undefined;
|
|
4546
4546
|
/**
|
|
4547
4547
|
* <p>The relevant text excerpt from a source that was used to generate a citation text
|
|
4548
4548
|
* segment in an Amazon Q Business chat response.</p>
|
|
4549
4549
|
* @public
|
|
4550
4550
|
*/
|
|
4551
|
-
snippetExcerpt?: SnippetExcerpt;
|
|
4551
|
+
snippetExcerpt?: SnippetExcerpt | undefined;
|
|
4552
4552
|
}
|
|
4553
4553
|
/**
|
|
4554
4554
|
* <p>The documents used to generate an Amazon Q Business web experience response.</p>
|
|
@@ -4560,34 +4560,34 @@ export interface SourceAttribution {
|
|
|
4560
4560
|
* response. </p>
|
|
4561
4561
|
* @public
|
|
4562
4562
|
*/
|
|
4563
|
-
title?: string;
|
|
4563
|
+
title?: string | undefined;
|
|
4564
4564
|
/**
|
|
4565
4565
|
* <p>The content extract from the document on which the generated response is based.
|
|
4566
4566
|
* </p>
|
|
4567
4567
|
* @public
|
|
4568
4568
|
*/
|
|
4569
|
-
snippet?: string;
|
|
4569
|
+
snippet?: string | undefined;
|
|
4570
4570
|
/**
|
|
4571
4571
|
* <p>The URL of the document which is the source for the Amazon Q Business generated response.
|
|
4572
4572
|
* </p>
|
|
4573
4573
|
* @public
|
|
4574
4574
|
*/
|
|
4575
|
-
url?: string;
|
|
4575
|
+
url?: string | undefined;
|
|
4576
4576
|
/**
|
|
4577
4577
|
* <p>The number attached to a citation in an Amazon Q Business generated response.</p>
|
|
4578
4578
|
* @public
|
|
4579
4579
|
*/
|
|
4580
|
-
citationNumber?: number;
|
|
4580
|
+
citationNumber?: number | undefined;
|
|
4581
4581
|
/**
|
|
4582
4582
|
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
4583
4583
|
* @public
|
|
4584
4584
|
*/
|
|
4585
|
-
updatedAt?: Date;
|
|
4585
|
+
updatedAt?: Date | undefined;
|
|
4586
4586
|
/**
|
|
4587
4587
|
* <p>A text extract from a source document that is used for source attribution.</p>
|
|
4588
4588
|
* @public
|
|
4589
4589
|
*/
|
|
4590
|
-
textMessageSegments?: TextSegment[];
|
|
4590
|
+
textMessageSegments?: TextSegment[] | undefined;
|
|
4591
4591
|
}
|
|
4592
4592
|
/**
|
|
4593
4593
|
* <p>A metadata event for a AI-generated text output message in a Amazon Q Business
|
|
@@ -4600,29 +4600,29 @@ export interface MetadataEvent {
|
|
|
4600
4600
|
* associated.</p>
|
|
4601
4601
|
* @public
|
|
4602
4602
|
*/
|
|
4603
|
-
conversationId?: string;
|
|
4603
|
+
conversationId?: string | undefined;
|
|
4604
4604
|
/**
|
|
4605
4605
|
* <p>The identifier of an Amazon Q Business end user text input message within the
|
|
4606
4606
|
* conversation.</p>
|
|
4607
4607
|
* @public
|
|
4608
4608
|
*/
|
|
4609
|
-
userMessageId?: string;
|
|
4609
|
+
userMessageId?: string | undefined;
|
|
4610
4610
|
/**
|
|
4611
4611
|
* <p>The identifier of an Amazon Q Business AI generated message within the
|
|
4612
4612
|
* conversation.</p>
|
|
4613
4613
|
* @public
|
|
4614
4614
|
*/
|
|
4615
|
-
systemMessageId?: string;
|
|
4615
|
+
systemMessageId?: string | undefined;
|
|
4616
4616
|
/**
|
|
4617
4617
|
* <p>The source documents used to generate the conversation response.</p>
|
|
4618
4618
|
* @public
|
|
4619
4619
|
*/
|
|
4620
|
-
sourceAttributions?: SourceAttribution[];
|
|
4620
|
+
sourceAttributions?: SourceAttribution[] | undefined;
|
|
4621
4621
|
/**
|
|
4622
4622
|
* <p>The final text output message generated by the system.</p>
|
|
4623
4623
|
* @public
|
|
4624
4624
|
*/
|
|
4625
|
-
finalTextMessage?: string;
|
|
4625
|
+
finalTextMessage?: string | undefined;
|
|
4626
4626
|
}
|
|
4627
4627
|
/**
|
|
4628
4628
|
* <p>An output event for an AI-generated response in an Amazon Q Business web
|
|
@@ -4635,22 +4635,22 @@ export interface TextOutputEvent {
|
|
|
4635
4635
|
* associated.</p>
|
|
4636
4636
|
* @public
|
|
4637
4637
|
*/
|
|
4638
|
-
conversationId?: string;
|
|
4638
|
+
conversationId?: string | undefined;
|
|
4639
4639
|
/**
|
|
4640
4640
|
* <p>The identifier of an end user message in a <code>TextOutputEvent</code>.</p>
|
|
4641
4641
|
* @public
|
|
4642
4642
|
*/
|
|
4643
|
-
userMessageId?: string;
|
|
4643
|
+
userMessageId?: string | undefined;
|
|
4644
4644
|
/**
|
|
4645
4645
|
* <p>The identifier of an AI-generated message in a <code>TextOutputEvent</code>.</p>
|
|
4646
4646
|
* @public
|
|
4647
4647
|
*/
|
|
4648
|
-
systemMessageId?: string;
|
|
4648
|
+
systemMessageId?: string | undefined;
|
|
4649
4649
|
/**
|
|
4650
4650
|
* <p>An AI-generated message in a <code>TextOutputEvent</code>.</p>
|
|
4651
4651
|
* @public
|
|
4652
4652
|
*/
|
|
4653
|
-
systemMessage?: string;
|
|
4653
|
+
systemMessage?: string | undefined;
|
|
4654
4654
|
}
|
|
4655
4655
|
/**
|
|
4656
4656
|
* <p>The streaming output for the <code>Chat</code> API.</p>
|
|
@@ -4754,7 +4754,7 @@ export interface ChatOutput {
|
|
|
4754
4754
|
* <p>The streaming output for the <code>Chat</code> API.</p>
|
|
4755
4755
|
* @public
|
|
4756
4756
|
*/
|
|
4757
|
-
outputStream?: AsyncIterable<ChatOutputStream
|
|
4757
|
+
outputStream?: AsyncIterable<ChatOutputStream> | undefined;
|
|
4758
4758
|
}
|
|
4759
4759
|
/**
|
|
4760
4760
|
* <p>You don't have permissions to perform the action because your license is inactive. Ask
|
|
@@ -4777,46 +4777,46 @@ export interface ChatSyncOutput {
|
|
|
4777
4777
|
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
4778
4778
|
* @public
|
|
4779
4779
|
*/
|
|
4780
|
-
conversationId?: string;
|
|
4780
|
+
conversationId?: string | undefined;
|
|
4781
4781
|
/**
|
|
4782
4782
|
* <p>An AI-generated message in a conversation.</p>
|
|
4783
4783
|
* @public
|
|
4784
4784
|
*/
|
|
4785
|
-
systemMessage?: string;
|
|
4785
|
+
systemMessage?: string | undefined;
|
|
4786
4786
|
/**
|
|
4787
4787
|
* <p>The identifier of an Amazon Q Business AI generated message within the
|
|
4788
4788
|
* conversation.</p>
|
|
4789
4789
|
* @public
|
|
4790
4790
|
*/
|
|
4791
|
-
systemMessageId?: string;
|
|
4791
|
+
systemMessageId?: string | undefined;
|
|
4792
4792
|
/**
|
|
4793
4793
|
* <p>The identifier of an Amazon Q Business end user text input message within the
|
|
4794
4794
|
* conversation.</p>
|
|
4795
4795
|
* @public
|
|
4796
4796
|
*/
|
|
4797
|
-
userMessageId?: string;
|
|
4797
|
+
userMessageId?: string | undefined;
|
|
4798
4798
|
/**
|
|
4799
4799
|
* <p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to
|
|
4800
4800
|
* successfully complete a requested plugin action.</p>
|
|
4801
4801
|
* @public
|
|
4802
4802
|
*/
|
|
4803
|
-
actionReview?: ActionReview;
|
|
4803
|
+
actionReview?: ActionReview | undefined;
|
|
4804
4804
|
/**
|
|
4805
4805
|
* <p>An authentication verification event activated by an end user request to use a custom
|
|
4806
4806
|
* plugin.</p>
|
|
4807
4807
|
* @public
|
|
4808
4808
|
*/
|
|
4809
|
-
authChallengeRequest?: AuthChallengeRequest;
|
|
4809
|
+
authChallengeRequest?: AuthChallengeRequest | undefined;
|
|
4810
4810
|
/**
|
|
4811
4811
|
* <p>The source documents used to generate the conversation response.</p>
|
|
4812
4812
|
* @public
|
|
4813
4813
|
*/
|
|
4814
|
-
sourceAttributions?: SourceAttribution[];
|
|
4814
|
+
sourceAttributions?: SourceAttribution[] | undefined;
|
|
4815
4815
|
/**
|
|
4816
4816
|
* <p>A list of files which failed to upload during chat.</p>
|
|
4817
4817
|
* @public
|
|
4818
4818
|
*/
|
|
4819
|
-
failedAttachments?: AttachmentOutput[];
|
|
4819
|
+
failedAttachments?: AttachmentOutput[] | undefined;
|
|
4820
4820
|
}
|
|
4821
4821
|
/**
|
|
4822
4822
|
* <p>A rule for configuring how Amazon Q Business responds when it encounters a a blocked
|
|
@@ -4830,7 +4830,7 @@ export interface ContentBlockerRule {
|
|
|
4830
4830
|
* used a blocked phrase during chat.</p>
|
|
4831
4831
|
* @public
|
|
4832
4832
|
*/
|
|
4833
|
-
systemMessageOverride?: string;
|
|
4833
|
+
systemMessageOverride?: string | undefined;
|
|
4834
4834
|
}
|
|
4835
4835
|
/**
|
|
4836
4836
|
* <p>The identifier of the data source Amazon Q Business will generate responses from.</p>
|
|
@@ -4841,12 +4841,12 @@ export interface EligibleDataSource {
|
|
|
4841
4841
|
* <p>The identifier of the index the data source is attached to.</p>
|
|
4842
4842
|
* @public
|
|
4843
4843
|
*/
|
|
4844
|
-
indexId?: string;
|
|
4844
|
+
indexId?: string | undefined;
|
|
4845
4845
|
/**
|
|
4846
4846
|
* <p>The identifier of the data source.</p>
|
|
4847
4847
|
* @public
|
|
4848
4848
|
*/
|
|
4849
|
-
dataSourceId?: string;
|
|
4849
|
+
dataSourceId?: string | undefined;
|
|
4850
4850
|
}
|
|
4851
4851
|
/**
|
|
4852
4852
|
* <p>Rules for retrieving content from data sources connected to a Amazon Q Business
|
|
@@ -4859,7 +4859,7 @@ export interface ContentRetrievalRule {
|
|
|
4859
4859
|
* generation.</p>
|
|
4860
4860
|
* @public
|
|
4861
4861
|
*/
|
|
4862
|
-
eligibleDataSources?: EligibleDataSource[];
|
|
4862
|
+
eligibleDataSources?: EligibleDataSource[] | undefined;
|
|
4863
4863
|
}
|
|
4864
4864
|
/**
|
|
4865
4865
|
* <p>A conversation in an Amazon Q Business application.</p>
|
|
@@ -4870,17 +4870,17 @@ export interface Conversation {
|
|
|
4870
4870
|
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
4871
4871
|
* @public
|
|
4872
4872
|
*/
|
|
4873
|
-
conversationId?: string;
|
|
4873
|
+
conversationId?: string | undefined;
|
|
4874
4874
|
/**
|
|
4875
4875
|
* <p>The title of the conversation.</p>
|
|
4876
4876
|
* @public
|
|
4877
4877
|
*/
|
|
4878
|
-
title?: string;
|
|
4878
|
+
title?: string | undefined;
|
|
4879
4879
|
/**
|
|
4880
4880
|
* <p>The start time of the conversation.</p>
|
|
4881
4881
|
* @public
|
|
4882
4882
|
*/
|
|
4883
|
-
startTime?: Date;
|
|
4883
|
+
startTime?: Date | undefined;
|
|
4884
4884
|
}
|
|
4885
4885
|
/**
|
|
4886
4886
|
* <p>Aliases attached to a user id within an Amazon Q Business application.</p>
|
|
@@ -4891,12 +4891,12 @@ export interface UserAlias {
|
|
|
4891
4891
|
* <p>The identifier of the index that the user aliases are associated with.</p>
|
|
4892
4892
|
* @public
|
|
4893
4893
|
*/
|
|
4894
|
-
indexId?: string;
|
|
4894
|
+
indexId?: string | undefined;
|
|
4895
4895
|
/**
|
|
4896
4896
|
* <p>The identifier of the data source that the user aliases are associated with.</p>
|
|
4897
4897
|
* @public
|
|
4898
4898
|
*/
|
|
4899
|
-
dataSourceId?: string;
|
|
4899
|
+
dataSourceId?: string | undefined;
|
|
4900
4900
|
/**
|
|
4901
4901
|
* <p>The identifier of the user id associated with the user aliases.</p>
|
|
4902
4902
|
* @public
|
|
@@ -4921,13 +4921,13 @@ export interface CreateUserRequest {
|
|
|
4921
4921
|
* <p>The list of user aliases in the mapping.</p>
|
|
4922
4922
|
* @public
|
|
4923
4923
|
*/
|
|
4924
|
-
userAliases?: UserAlias[];
|
|
4924
|
+
userAliases?: UserAlias[] | undefined;
|
|
4925
4925
|
/**
|
|
4926
4926
|
* <p>A token that you provide to identify the request to create your Amazon Q Business user
|
|
4927
4927
|
* mapping.</p>
|
|
4928
4928
|
* @public
|
|
4929
4929
|
*/
|
|
4930
|
-
clientToken?: string;
|
|
4930
|
+
clientToken?: string | undefined;
|
|
4931
4931
|
}
|
|
4932
4932
|
/**
|
|
4933
4933
|
* @public
|
|
@@ -4958,31 +4958,31 @@ export interface DataSourceSyncJobMetrics {
|
|
|
4958
4958
|
* sync.</p>
|
|
4959
4959
|
* @public
|
|
4960
4960
|
*/
|
|
4961
|
-
documentsAdded?: string;
|
|
4961
|
+
documentsAdded?: string | undefined;
|
|
4962
4962
|
/**
|
|
4963
4963
|
* <p>The current count of documents modified in the data source during the data source
|
|
4964
4964
|
* sync.</p>
|
|
4965
4965
|
* @public
|
|
4966
4966
|
*/
|
|
4967
|
-
documentsModified?: string;
|
|
4967
|
+
documentsModified?: string | undefined;
|
|
4968
4968
|
/**
|
|
4969
4969
|
* <p>The current count of documents deleted from the data source during the data source
|
|
4970
4970
|
* sync.</p>
|
|
4971
4971
|
* @public
|
|
4972
4972
|
*/
|
|
4973
|
-
documentsDeleted?: string;
|
|
4973
|
+
documentsDeleted?: string | undefined;
|
|
4974
4974
|
/**
|
|
4975
4975
|
* <p>The current count of documents that failed to sync from the data source during the
|
|
4976
4976
|
* data source sync.</p>
|
|
4977
4977
|
* @public
|
|
4978
4978
|
*/
|
|
4979
|
-
documentsFailed?: string;
|
|
4979
|
+
documentsFailed?: string | undefined;
|
|
4980
4980
|
/**
|
|
4981
4981
|
* <p>The current count of documents crawled by the ongoing sync job in the data
|
|
4982
4982
|
* source.</p>
|
|
4983
4983
|
* @public
|
|
4984
4984
|
*/
|
|
4985
|
-
documentsScanned?: string;
|
|
4985
|
+
documentsScanned?: string | undefined;
|
|
4986
4986
|
}
|
|
4987
4987
|
/**
|
|
4988
4988
|
* @public
|
|
@@ -5011,17 +5011,17 @@ export interface DataSourceSyncJob {
|
|
|
5011
5011
|
* <p>The identifier of a data source synchronization job.</p>
|
|
5012
5012
|
* @public
|
|
5013
5013
|
*/
|
|
5014
|
-
executionId?: string;
|
|
5014
|
+
executionId?: string | undefined;
|
|
5015
5015
|
/**
|
|
5016
5016
|
* <p>The Unix time stamp when the data source synchronization job started.</p>
|
|
5017
5017
|
* @public
|
|
5018
5018
|
*/
|
|
5019
|
-
startTime?: Date;
|
|
5019
|
+
startTime?: Date | undefined;
|
|
5020
5020
|
/**
|
|
5021
5021
|
* <p>The Unix timestamp when the synchronization job completed.</p>
|
|
5022
5022
|
* @public
|
|
5023
5023
|
*/
|
|
5024
|
-
endTime?: Date;
|
|
5024
|
+
endTime?: Date | undefined;
|
|
5025
5025
|
/**
|
|
5026
5026
|
* <p>The status of the synchronization job. When the <code>Status</code> field is set to
|
|
5027
5027
|
* <code>SUCCEEDED</code>, the synchronization job is done. If the status code is
|
|
@@ -5029,26 +5029,26 @@ export interface DataSourceSyncJob {
|
|
|
5029
5029
|
* give you the reason for the failure.</p>
|
|
5030
5030
|
* @public
|
|
5031
5031
|
*/
|
|
5032
|
-
status?: DataSourceSyncJobStatus;
|
|
5032
|
+
status?: DataSourceSyncJobStatus | undefined;
|
|
5033
5033
|
/**
|
|
5034
5034
|
* <p>If the <code>Status</code> field is set to <code>FAILED</code>, the
|
|
5035
5035
|
* <code>ErrorCode</code> field indicates the reason the synchronization failed. </p>
|
|
5036
5036
|
* @public
|
|
5037
5037
|
*/
|
|
5038
|
-
error?: ErrorDetail;
|
|
5038
|
+
error?: ErrorDetail | undefined;
|
|
5039
5039
|
/**
|
|
5040
5040
|
* <p>If the reason that the synchronization failed is due to an error with the underlying
|
|
5041
5041
|
* data source, this field contains a code that identifies the error.</p>
|
|
5042
5042
|
* @public
|
|
5043
5043
|
*/
|
|
5044
|
-
dataSourceErrorCode?: string;
|
|
5044
|
+
dataSourceErrorCode?: string | undefined;
|
|
5045
5045
|
/**
|
|
5046
5046
|
* <p>Maps a batch delete document request to a specific data source sync job. This is
|
|
5047
5047
|
* optional and should only be supplied when documents are deleted by a data source
|
|
5048
5048
|
* connector.</p>
|
|
5049
5049
|
* @public
|
|
5050
5050
|
*/
|
|
5051
|
-
metrics?: DataSourceSyncJobMetrics;
|
|
5051
|
+
metrics?: DataSourceSyncJobMetrics | undefined;
|
|
5052
5052
|
}
|
|
5053
5053
|
/**
|
|
5054
5054
|
* @public
|
|
@@ -5084,7 +5084,7 @@ export interface DeleteConversationRequest {
|
|
|
5084
5084
|
* <p>The identifier of the user who is deleting the conversation.</p>
|
|
5085
5085
|
* @public
|
|
5086
5086
|
*/
|
|
5087
|
-
userId?: string;
|
|
5087
|
+
userId?: string | undefined;
|
|
5088
5088
|
}
|
|
5089
5089
|
/**
|
|
5090
5090
|
* @public
|
|
@@ -5121,7 +5121,7 @@ export interface DeleteGroupRequest {
|
|
|
5121
5121
|
* Salesforce data source.</p>
|
|
5122
5122
|
* @public
|
|
5123
5123
|
*/
|
|
5124
|
-
dataSourceId?: string;
|
|
5124
|
+
dataSourceId?: string | undefined;
|
|
5125
5125
|
}
|
|
5126
5126
|
/**
|
|
5127
5127
|
* @public
|
|
@@ -5175,27 +5175,27 @@ export interface DocumentDetails {
|
|
|
5175
5175
|
* <p>The identifier of the document.</p>
|
|
5176
5176
|
* @public
|
|
5177
5177
|
*/
|
|
5178
|
-
documentId?: string;
|
|
5178
|
+
documentId?: string | undefined;
|
|
5179
5179
|
/**
|
|
5180
5180
|
* <p>The current status of the document.</p>
|
|
5181
5181
|
* @public
|
|
5182
5182
|
*/
|
|
5183
|
-
status?: DocumentStatus;
|
|
5183
|
+
status?: DocumentStatus | undefined;
|
|
5184
5184
|
/**
|
|
5185
5185
|
* <p>An error message associated with the document.</p>
|
|
5186
5186
|
* @public
|
|
5187
5187
|
*/
|
|
5188
|
-
error?: ErrorDetail;
|
|
5188
|
+
error?: ErrorDetail | undefined;
|
|
5189
5189
|
/**
|
|
5190
5190
|
* <p>The timestamp for when the document was created.</p>
|
|
5191
5191
|
* @public
|
|
5192
5192
|
*/
|
|
5193
|
-
createdAt?: Date;
|
|
5193
|
+
createdAt?: Date | undefined;
|
|
5194
5194
|
/**
|
|
5195
5195
|
* <p>The timestamp for when the document was last updated.</p>
|
|
5196
5196
|
* @public
|
|
5197
5197
|
*/
|
|
5198
|
-
updatedAt?: Date;
|
|
5198
|
+
updatedAt?: Date | undefined;
|
|
5199
5199
|
}
|
|
5200
5200
|
/**
|
|
5201
5201
|
* @public
|
|
@@ -5210,7 +5210,7 @@ export interface GetChatControlsConfigurationRequest {
|
|
|
5210
5210
|
* <p>The maximum number of configured chat controls to return.</p>
|
|
5211
5211
|
* @public
|
|
5212
5212
|
*/
|
|
5213
|
-
maxResults?: number;
|
|
5213
|
+
maxResults?: number | undefined;
|
|
5214
5214
|
/**
|
|
5215
5215
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
5216
5216
|
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
@@ -5218,7 +5218,7 @@ export interface GetChatControlsConfigurationRequest {
|
|
|
5218
5218
|
* configured.</p>
|
|
5219
5219
|
* @public
|
|
5220
5220
|
*/
|
|
5221
|
-
nextToken?: string;
|
|
5221
|
+
nextToken?: string | undefined;
|
|
5222
5222
|
}
|
|
5223
5223
|
/**
|
|
5224
5224
|
* @public
|
|
@@ -5242,12 +5242,12 @@ export interface UsersAndGroups {
|
|
|
5242
5242
|
* <p>The user ids associated with a topic control rule.</p>
|
|
5243
5243
|
* @public
|
|
5244
5244
|
*/
|
|
5245
|
-
userIds?: string[];
|
|
5245
|
+
userIds?: string[] | undefined;
|
|
5246
5246
|
/**
|
|
5247
5247
|
* <p>The user group names associated with a topic control rule.</p>
|
|
5248
5248
|
* @public
|
|
5249
5249
|
*/
|
|
5250
|
-
userGroups?: string[];
|
|
5250
|
+
userGroups?: string[] | undefined;
|
|
5251
5251
|
}
|
|
5252
5252
|
/**
|
|
5253
5253
|
* <p>Provides configuration information about a rule.</p>
|
|
@@ -5315,12 +5315,12 @@ export interface Rule {
|
|
|
5315
5315
|
* <p>Users and groups to be included in a rule.</p>
|
|
5316
5316
|
* @public
|
|
5317
5317
|
*/
|
|
5318
|
-
includedUsersAndGroups?: UsersAndGroups;
|
|
5318
|
+
includedUsersAndGroups?: UsersAndGroups | undefined;
|
|
5319
5319
|
/**
|
|
5320
5320
|
* <p>Users and groups to be excluded from a rule.</p>
|
|
5321
5321
|
* @public
|
|
5322
5322
|
*/
|
|
5323
|
-
excludedUsersAndGroups?: UsersAndGroups;
|
|
5323
|
+
excludedUsersAndGroups?: UsersAndGroups | undefined;
|
|
5324
5324
|
/**
|
|
5325
5325
|
* <p>The type of rule.</p>
|
|
5326
5326
|
* @public
|
|
@@ -5330,7 +5330,7 @@ export interface Rule {
|
|
|
5330
5330
|
* <p>The configuration information for a rule.</p>
|
|
5331
5331
|
* @public
|
|
5332
5332
|
*/
|
|
5333
|
-
ruleConfiguration?: RuleConfiguration;
|
|
5333
|
+
ruleConfiguration?: RuleConfiguration | undefined;
|
|
5334
5334
|
}
|
|
5335
5335
|
/**
|
|
5336
5336
|
* <p>The topic specific controls configured for an Amazon Q Business application.</p>
|
|
@@ -5347,13 +5347,13 @@ export interface TopicConfiguration {
|
|
|
5347
5347
|
* language model (LLM) should use this topic control configuration.</p>
|
|
5348
5348
|
* @public
|
|
5349
5349
|
*/
|
|
5350
|
-
description?: string;
|
|
5350
|
+
description?: string | undefined;
|
|
5351
5351
|
/**
|
|
5352
5352
|
* <p>A list of example phrases that you expect the end user to use in relation to the
|
|
5353
5353
|
* topic.</p>
|
|
5354
5354
|
* @public
|
|
5355
5355
|
*/
|
|
5356
|
-
exampleChatMessages?: string[];
|
|
5356
|
+
exampleChatMessages?: string[] | undefined;
|
|
5357
5357
|
/**
|
|
5358
5358
|
* <p>Rules defined for a topic configuration.</p>
|
|
5359
5359
|
* @public
|
|
@@ -5371,22 +5371,22 @@ export interface GetChatControlsConfigurationResponse {
|
|
|
5371
5371
|
* knowledge to respons to end user questions in chat.</p>
|
|
5372
5372
|
* @public
|
|
5373
5373
|
*/
|
|
5374
|
-
responseScope?: ResponseScope;
|
|
5374
|
+
responseScope?: ResponseScope | undefined;
|
|
5375
5375
|
/**
|
|
5376
5376
|
* <p>The phrases blocked from chat by your chat control configuration.</p>
|
|
5377
5377
|
* @public
|
|
5378
5378
|
*/
|
|
5379
|
-
blockedPhrases?: BlockedPhrasesConfiguration;
|
|
5379
|
+
blockedPhrases?: BlockedPhrasesConfiguration | undefined;
|
|
5380
5380
|
/**
|
|
5381
5381
|
* <p>The topic specific controls configured for a Amazon Q Business application.</p>
|
|
5382
5382
|
* @public
|
|
5383
5383
|
*/
|
|
5384
|
-
topicConfigurations?: TopicConfiguration[];
|
|
5384
|
+
topicConfigurations?: TopicConfiguration[] | undefined;
|
|
5385
5385
|
/**
|
|
5386
5386
|
* <p>The configuration details for <code>CREATOR_MODE</code>.</p>
|
|
5387
5387
|
* @public
|
|
5388
5388
|
*/
|
|
5389
|
-
creatorModeConfiguration?: AppliedCreatorModeConfiguration;
|
|
5389
|
+
creatorModeConfiguration?: AppliedCreatorModeConfiguration | undefined;
|
|
5390
5390
|
/**
|
|
5391
5391
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
5392
5392
|
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
@@ -5394,7 +5394,7 @@ export interface GetChatControlsConfigurationResponse {
|
|
|
5394
5394
|
* configured.</p>
|
|
5395
5395
|
* @public
|
|
5396
5396
|
*/
|
|
5397
|
-
nextToken?: string;
|
|
5397
|
+
nextToken?: string | undefined;
|
|
5398
5398
|
}
|
|
5399
5399
|
/**
|
|
5400
5400
|
* @public
|
|
@@ -5419,7 +5419,7 @@ export interface GetGroupRequest {
|
|
|
5419
5419
|
* <p>The identifier of the data source the group is attached to.</p>
|
|
5420
5420
|
* @public
|
|
5421
5421
|
*/
|
|
5422
|
-
dataSourceId?: string;
|
|
5422
|
+
dataSourceId?: string | undefined;
|
|
5423
5423
|
}
|
|
5424
5424
|
/**
|
|
5425
5425
|
* @public
|
|
@@ -5445,17 +5445,17 @@ export interface GroupStatusDetail {
|
|
|
5445
5445
|
* <p>The status of a group.</p>
|
|
5446
5446
|
* @public
|
|
5447
5447
|
*/
|
|
5448
|
-
status?: GroupStatus;
|
|
5448
|
+
status?: GroupStatus | undefined;
|
|
5449
5449
|
/**
|
|
5450
5450
|
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
5451
5451
|
* @public
|
|
5452
5452
|
*/
|
|
5453
|
-
lastUpdatedAt?: Date;
|
|
5453
|
+
lastUpdatedAt?: Date | undefined;
|
|
5454
5454
|
/**
|
|
5455
5455
|
* <p>The details of an error associated a group status.</p>
|
|
5456
5456
|
* @public
|
|
5457
5457
|
*/
|
|
5458
|
-
errorDetail?: ErrorDetail;
|
|
5458
|
+
errorDetail?: ErrorDetail | undefined;
|
|
5459
5459
|
}
|
|
5460
5460
|
/**
|
|
5461
5461
|
* @public
|
|
@@ -5465,12 +5465,12 @@ export interface GetGroupResponse {
|
|
|
5465
5465
|
* <p>The current status of the group.</p>
|
|
5466
5466
|
* @public
|
|
5467
5467
|
*/
|
|
5468
|
-
status?: GroupStatusDetail;
|
|
5468
|
+
status?: GroupStatusDetail | undefined;
|
|
5469
5469
|
/**
|
|
5470
5470
|
* <p>The status history of the group.</p>
|
|
5471
5471
|
* @public
|
|
5472
5472
|
*/
|
|
5473
|
-
statusHistory?: GroupStatusDetail[];
|
|
5473
|
+
statusHistory?: GroupStatusDetail[] | undefined;
|
|
5474
5474
|
}
|
|
5475
5475
|
/**
|
|
5476
5476
|
* @public
|
|
@@ -5495,7 +5495,7 @@ export interface GetUserResponse {
|
|
|
5495
5495
|
* <p>A list of user aliases attached to a user.</p>
|
|
5496
5496
|
* @public
|
|
5497
5497
|
*/
|
|
5498
|
-
userAliases?: UserAlias[];
|
|
5498
|
+
userAliases?: UserAlias[] | undefined;
|
|
5499
5499
|
}
|
|
5500
5500
|
/**
|
|
5501
5501
|
* @public
|
|
@@ -5511,19 +5511,19 @@ export interface ListConversationsRequest {
|
|
|
5511
5511
|
* </p>
|
|
5512
5512
|
* @public
|
|
5513
5513
|
*/
|
|
5514
|
-
userId?: string;
|
|
5514
|
+
userId?: string | undefined;
|
|
5515
5515
|
/**
|
|
5516
5516
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
5517
5517
|
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
5518
5518
|
* pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
5519
5519
|
* @public
|
|
5520
5520
|
*/
|
|
5521
|
-
nextToken?: string;
|
|
5521
|
+
nextToken?: string | undefined;
|
|
5522
5522
|
/**
|
|
5523
5523
|
* <p>The maximum number of Amazon Q Business conversations to return.</p>
|
|
5524
5524
|
* @public
|
|
5525
5525
|
*/
|
|
5526
|
-
maxResults?: number;
|
|
5526
|
+
maxResults?: number | undefined;
|
|
5527
5527
|
}
|
|
5528
5528
|
/**
|
|
5529
5529
|
* @public
|
|
@@ -5534,13 +5534,13 @@ export interface ListConversationsResponse {
|
|
|
5534
5534
|
* later request to list the next set of messages.</p>
|
|
5535
5535
|
* @public
|
|
5536
5536
|
*/
|
|
5537
|
-
nextToken?: string;
|
|
5537
|
+
nextToken?: string | undefined;
|
|
5538
5538
|
/**
|
|
5539
5539
|
* <p>An array of summary information on the configuration of one or more Amazon Q Business web
|
|
5540
5540
|
* experiences.</p>
|
|
5541
5541
|
* @public
|
|
5542
5542
|
*/
|
|
5543
|
-
conversations?: Conversation[];
|
|
5543
|
+
conversations?: Conversation[] | undefined;
|
|
5544
5544
|
}
|
|
5545
5545
|
/**
|
|
5546
5546
|
* @public
|
|
@@ -5567,28 +5567,28 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
5567
5567
|
* pagination token to retrieve the next set of responses.</p>
|
|
5568
5568
|
* @public
|
|
5569
5569
|
*/
|
|
5570
|
-
nextToken?: string;
|
|
5570
|
+
nextToken?: string | undefined;
|
|
5571
5571
|
/**
|
|
5572
5572
|
* <p>The maximum number of synchronization jobs to return in the response.</p>
|
|
5573
5573
|
* @public
|
|
5574
5574
|
*/
|
|
5575
|
-
maxResults?: number;
|
|
5575
|
+
maxResults?: number | undefined;
|
|
5576
5576
|
/**
|
|
5577
5577
|
* <p> The start time of the data source connector sync. </p>
|
|
5578
5578
|
* @public
|
|
5579
5579
|
*/
|
|
5580
|
-
startTime?: Date;
|
|
5580
|
+
startTime?: Date | undefined;
|
|
5581
5581
|
/**
|
|
5582
5582
|
* <p> The end time of the data source connector sync.</p>
|
|
5583
5583
|
* @public
|
|
5584
5584
|
*/
|
|
5585
|
-
endTime?: Date;
|
|
5585
|
+
endTime?: Date | undefined;
|
|
5586
5586
|
/**
|
|
5587
5587
|
* <p>Only returns synchronization jobs with the <code>Status</code> field equal to the
|
|
5588
5588
|
* specified status.</p>
|
|
5589
5589
|
* @public
|
|
5590
5590
|
*/
|
|
5591
|
-
statusFilter?: DataSourceSyncJobStatus;
|
|
5591
|
+
statusFilter?: DataSourceSyncJobStatus | undefined;
|
|
5592
5592
|
}
|
|
5593
5593
|
/**
|
|
5594
5594
|
* @public
|
|
@@ -5598,13 +5598,13 @@ export interface ListDataSourceSyncJobsResponse {
|
|
|
5598
5598
|
* <p>A history of synchronization jobs for the data source connector.</p>
|
|
5599
5599
|
* @public
|
|
5600
5600
|
*/
|
|
5601
|
-
history?: DataSourceSyncJob[];
|
|
5601
|
+
history?: DataSourceSyncJob[] | undefined;
|
|
5602
5602
|
/**
|
|
5603
5603
|
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
5604
5604
|
* in any subsequent request to retrieve the next set of jobs.</p>
|
|
5605
5605
|
* @public
|
|
5606
5606
|
*/
|
|
5607
|
-
nextToken?: string;
|
|
5607
|
+
nextToken?: string | undefined;
|
|
5608
5608
|
}
|
|
5609
5609
|
/**
|
|
5610
5610
|
* @public
|
|
@@ -5624,19 +5624,19 @@ export interface ListDocumentsRequest {
|
|
|
5624
5624
|
* <p>The identifier of the data sources the documents are attached to.</p>
|
|
5625
5625
|
* @public
|
|
5626
5626
|
*/
|
|
5627
|
-
dataSourceIds?: string[];
|
|
5627
|
+
dataSourceIds?: string[] | undefined;
|
|
5628
5628
|
/**
|
|
5629
5629
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
5630
5630
|
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
5631
5631
|
* pagination token to retrieve the next set of documents.</p>
|
|
5632
5632
|
* @public
|
|
5633
5633
|
*/
|
|
5634
|
-
nextToken?: string;
|
|
5634
|
+
nextToken?: string | undefined;
|
|
5635
5635
|
/**
|
|
5636
5636
|
* <p>The maximum number of documents to return.</p>
|
|
5637
5637
|
* @public
|
|
5638
5638
|
*/
|
|
5639
|
-
maxResults?: number;
|
|
5639
|
+
maxResults?: number | undefined;
|
|
5640
5640
|
}
|
|
5641
5641
|
/**
|
|
5642
5642
|
* @public
|
|
@@ -5646,14 +5646,14 @@ export interface ListDocumentsResponse {
|
|
|
5646
5646
|
* <p>A list of document details.</p>
|
|
5647
5647
|
* @public
|
|
5648
5648
|
*/
|
|
5649
|
-
documentDetailList?: DocumentDetails[];
|
|
5649
|
+
documentDetailList?: DocumentDetails[] | undefined;
|
|
5650
5650
|
/**
|
|
5651
5651
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
5652
5652
|
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
5653
5653
|
* pagination token to retrieve the next set of documents.</p>
|
|
5654
5654
|
* @public
|
|
5655
5655
|
*/
|
|
5656
|
-
nextToken?: string;
|
|
5656
|
+
nextToken?: string | undefined;
|
|
5657
5657
|
}
|
|
5658
5658
|
/**
|
|
5659
5659
|
* @public
|
|
@@ -5679,19 +5679,19 @@ export interface ListGroupsRequest {
|
|
|
5679
5679
|
* <p>The identifier of the data source for getting a list of groups mapped to users.</p>
|
|
5680
5680
|
* @public
|
|
5681
5681
|
*/
|
|
5682
|
-
dataSourceId?: string;
|
|
5682
|
+
dataSourceId?: string | undefined;
|
|
5683
5683
|
/**
|
|
5684
5684
|
* <p>If the previous response was incomplete (because there is more data to retrieve),
|
|
5685
5685
|
* Amazon Q Business returns a pagination token in the response. You can use this pagination
|
|
5686
5686
|
* token to retrieve the next set of groups that are mapped to users.</p>
|
|
5687
5687
|
* @public
|
|
5688
5688
|
*/
|
|
5689
|
-
nextToken?: string;
|
|
5689
|
+
nextToken?: string | undefined;
|
|
5690
5690
|
/**
|
|
5691
5691
|
* <p>The maximum number of returned groups that are mapped to users.</p>
|
|
5692
5692
|
* @public
|
|
5693
5693
|
*/
|
|
5694
|
-
maxResults?: number;
|
|
5694
|
+
maxResults?: number | undefined;
|
|
5695
5695
|
}
|
|
5696
5696
|
/**
|
|
5697
5697
|
* <p>Summary information for groups.</p>
|
|
@@ -5702,7 +5702,7 @@ export interface GroupSummary {
|
|
|
5702
5702
|
* <p>The name of the group the summary information is for.</p>
|
|
5703
5703
|
* @public
|
|
5704
5704
|
*/
|
|
5705
|
-
groupName?: string;
|
|
5705
|
+
groupName?: string | undefined;
|
|
5706
5706
|
}
|
|
5707
5707
|
/**
|
|
5708
5708
|
* @public
|
|
@@ -5713,12 +5713,12 @@ export interface ListGroupsResponse {
|
|
|
5713
5713
|
* subsequent request to retrieve the next set of groups that are mapped to users.</p>
|
|
5714
5714
|
* @public
|
|
5715
5715
|
*/
|
|
5716
|
-
nextToken?: string;
|
|
5716
|
+
nextToken?: string | undefined;
|
|
5717
5717
|
/**
|
|
5718
5718
|
* <p>Summary information for list of groups that are mapped to users.</p>
|
|
5719
5719
|
* @public
|
|
5720
5720
|
*/
|
|
5721
|
-
items?: GroupSummary[];
|
|
5721
|
+
items?: GroupSummary[] | undefined;
|
|
5722
5722
|
}
|
|
5723
5723
|
/**
|
|
5724
5724
|
* @public
|
|
@@ -5739,18 +5739,18 @@ export interface ListMessagesRequest {
|
|
|
5739
5739
|
* conversation.</p>
|
|
5740
5740
|
* @public
|
|
5741
5741
|
*/
|
|
5742
|
-
userId?: string;
|
|
5742
|
+
userId?: string | undefined;
|
|
5743
5743
|
/**
|
|
5744
5744
|
* <p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q Business
|
|
5745
5745
|
* returns a next token as a pagination token to retrieve the next set of messages.</p>
|
|
5746
5746
|
* @public
|
|
5747
5747
|
*/
|
|
5748
|
-
nextToken?: string;
|
|
5748
|
+
nextToken?: string | undefined;
|
|
5749
5749
|
/**
|
|
5750
5750
|
* <p>The maximum number of messages to return.</p>
|
|
5751
5751
|
* @public
|
|
5752
5752
|
*/
|
|
5753
|
-
maxResults?: number;
|
|
5753
|
+
maxResults?: number | undefined;
|
|
5754
5754
|
}
|
|
5755
5755
|
/**
|
|
5756
5756
|
* @public
|
|
@@ -5773,33 +5773,33 @@ export interface Message {
|
|
|
5773
5773
|
* <p>The identifier of the Amazon Q Business web experience message.</p>
|
|
5774
5774
|
* @public
|
|
5775
5775
|
*/
|
|
5776
|
-
messageId?: string;
|
|
5776
|
+
messageId?: string | undefined;
|
|
5777
5777
|
/**
|
|
5778
5778
|
* <p>The content of the Amazon Q Business web experience message.</p>
|
|
5779
5779
|
* @public
|
|
5780
5780
|
*/
|
|
5781
|
-
body?: string;
|
|
5781
|
+
body?: string | undefined;
|
|
5782
5782
|
/**
|
|
5783
5783
|
* <p>The timestamp of the first Amazon Q Business web experience message.</p>
|
|
5784
5784
|
* @public
|
|
5785
5785
|
*/
|
|
5786
|
-
time?: Date;
|
|
5786
|
+
time?: Date | undefined;
|
|
5787
5787
|
/**
|
|
5788
5788
|
* <p>The type of Amazon Q Business message, whether <code>HUMAN</code> or <code>AI</code>
|
|
5789
5789
|
* generated.</p>
|
|
5790
5790
|
* @public
|
|
5791
5791
|
*/
|
|
5792
|
-
type?: MessageType;
|
|
5792
|
+
type?: MessageType | undefined;
|
|
5793
5793
|
/**
|
|
5794
5794
|
* <p>A file directly uploaded into an Amazon Q Business web experience chat.</p>
|
|
5795
5795
|
* @public
|
|
5796
5796
|
*/
|
|
5797
|
-
attachments?: AttachmentOutput[];
|
|
5797
|
+
attachments?: AttachmentOutput[] | undefined;
|
|
5798
5798
|
/**
|
|
5799
5799
|
* <p>The source documents used to generate Amazon Q Business web experience message.</p>
|
|
5800
5800
|
* @public
|
|
5801
5801
|
*/
|
|
5802
|
-
sourceAttribution?: SourceAttribution[];
|
|
5802
|
+
sourceAttribution?: SourceAttribution[] | undefined;
|
|
5803
5803
|
/**
|
|
5804
5804
|
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin
|
|
5805
5805
|
* action during a non-streaming chat conversation. It contains information about the
|
|
@@ -5807,13 +5807,13 @@ export interface Message {
|
|
|
5807
5807
|
* Amazon Q Business.</p>
|
|
5808
5808
|
* @public
|
|
5809
5809
|
*/
|
|
5810
|
-
actionReview?: ActionReview;
|
|
5810
|
+
actionReview?: ActionReview | undefined;
|
|
5811
5811
|
/**
|
|
5812
5812
|
* <p>Performs an Amazon Q Business plugin action during a non-streaming chat
|
|
5813
5813
|
* conversation.</p>
|
|
5814
5814
|
* @public
|
|
5815
5815
|
*/
|
|
5816
|
-
actionExecution?: ActionExecution;
|
|
5816
|
+
actionExecution?: ActionExecution | undefined;
|
|
5817
5817
|
}
|
|
5818
5818
|
/**
|
|
5819
5819
|
* @public
|
|
@@ -5823,13 +5823,13 @@ export interface ListMessagesResponse {
|
|
|
5823
5823
|
* <p>An array of information on one or more messages.</p>
|
|
5824
5824
|
* @public
|
|
5825
5825
|
*/
|
|
5826
|
-
messages?: Message[];
|
|
5826
|
+
messages?: Message[] | undefined;
|
|
5827
5827
|
/**
|
|
5828
5828
|
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
5829
5829
|
* later request to list the next set of messages.</p>
|
|
5830
5830
|
* @public
|
|
5831
5831
|
*/
|
|
5832
|
-
nextToken?: string;
|
|
5832
|
+
nextToken?: string | undefined;
|
|
5833
5833
|
}
|
|
5834
5834
|
/**
|
|
5835
5835
|
* @public
|
|
@@ -5850,7 +5850,7 @@ export interface ListTagsForResourceResponse {
|
|
|
5850
5850
|
* <p>A list of tags associated with the Amazon Q Business application or data source.</p>
|
|
5851
5851
|
* @public
|
|
5852
5852
|
*/
|
|
5853
|
-
tags?: Tag[];
|
|
5853
|
+
tags?: Tag[] | undefined;
|
|
5854
5854
|
}
|
|
5855
5855
|
/**
|
|
5856
5856
|
* @public
|
|
@@ -5900,13 +5900,13 @@ export interface MessageUsefulnessFeedback {
|
|
|
5900
5900
|
* <p>The reason for a usefulness rating.</p>
|
|
5901
5901
|
* @public
|
|
5902
5902
|
*/
|
|
5903
|
-
reason?: MessageUsefulnessReason;
|
|
5903
|
+
reason?: MessageUsefulnessReason | undefined;
|
|
5904
5904
|
/**
|
|
5905
5905
|
* <p>A comment given by an end user on the usefulness of an AI-generated chat
|
|
5906
5906
|
* message.</p>
|
|
5907
5907
|
* @public
|
|
5908
5908
|
*/
|
|
5909
|
-
comment?: string;
|
|
5909
|
+
comment?: string | undefined;
|
|
5910
5910
|
/**
|
|
5911
5911
|
* <p>The timestamp for when the feedback was submitted.</p>
|
|
5912
5912
|
* @public
|
|
@@ -5926,7 +5926,7 @@ export interface PutFeedbackRequest {
|
|
|
5926
5926
|
* <p>The identifier of the user giving the feedback.</p>
|
|
5927
5927
|
* @public
|
|
5928
5928
|
*/
|
|
5929
|
-
userId?: string;
|
|
5929
|
+
userId?: string | undefined;
|
|
5930
5930
|
/**
|
|
5931
5931
|
* <p>The identifier of the conversation the feedback is attached to.</p>
|
|
5932
5932
|
* @public
|
|
@@ -5941,12 +5941,12 @@ export interface PutFeedbackRequest {
|
|
|
5941
5941
|
* <p>The timestamp for when the feedback was recorded.</p>
|
|
5942
5942
|
* @public
|
|
5943
5943
|
*/
|
|
5944
|
-
messageCopiedAt?: Date;
|
|
5944
|
+
messageCopiedAt?: Date | undefined;
|
|
5945
5945
|
/**
|
|
5946
5946
|
* <p>The feedback usefulness value given by the user to the chat message.</p>
|
|
5947
5947
|
* @public
|
|
5948
5948
|
*/
|
|
5949
|
-
messageUsefulness?: MessageUsefulnessFeedback;
|
|
5949
|
+
messageUsefulness?: MessageUsefulnessFeedback | undefined;
|
|
5950
5950
|
}
|
|
5951
5951
|
/**
|
|
5952
5952
|
* <p>The sub groups that belong to a group.</p>
|
|
@@ -5962,7 +5962,7 @@ export interface MemberGroup {
|
|
|
5962
5962
|
* <p>The type of the sub group.</p>
|
|
5963
5963
|
* @public
|
|
5964
5964
|
*/
|
|
5965
|
-
type?: MembershipType;
|
|
5965
|
+
type?: MembershipType | undefined;
|
|
5966
5966
|
}
|
|
5967
5967
|
/**
|
|
5968
5968
|
* <p>The users that belong to a group.</p>
|
|
@@ -5978,7 +5978,7 @@ export interface MemberUser {
|
|
|
5978
5978
|
* <p>The type of the user.</p>
|
|
5979
5979
|
* @public
|
|
5980
5980
|
*/
|
|
5981
|
-
type?: MembershipType;
|
|
5981
|
+
type?: MembershipType | undefined;
|
|
5982
5982
|
}
|
|
5983
5983
|
/**
|
|
5984
5984
|
* <p>A list of users or sub groups that belong to a group. This is for generating
|
|
@@ -5991,19 +5991,19 @@ export interface GroupMembers {
|
|
|
5991
5991
|
* "Engineering", and "Sales and Marketing" all belong to the group "Company".</p>
|
|
5992
5992
|
* @public
|
|
5993
5993
|
*/
|
|
5994
|
-
memberGroups?: MemberGroup[];
|
|
5994
|
+
memberGroups?: MemberGroup[] | undefined;
|
|
5995
5995
|
/**
|
|
5996
5996
|
* <p>A list of users that belong to a group. For example, a list of interns all belong to
|
|
5997
5997
|
* the "Interns" group.</p>
|
|
5998
5998
|
* @public
|
|
5999
5999
|
*/
|
|
6000
|
-
memberUsers?: MemberUser[];
|
|
6000
|
+
memberUsers?: MemberUser[] | undefined;
|
|
6001
6001
|
/**
|
|
6002
6002
|
* <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
|
|
6003
6003
|
* bucket.</p>
|
|
6004
6004
|
* @public
|
|
6005
6005
|
*/
|
|
6006
|
-
s3PathForGroupMembers?: S3;
|
|
6006
|
+
s3PathForGroupMembers?: S3 | undefined;
|
|
6007
6007
|
}
|
|
6008
6008
|
/**
|
|
6009
6009
|
* @public
|
|
@@ -6035,7 +6035,7 @@ export interface PutGroupRequest {
|
|
|
6035
6035
|
* needs access to customer-related documents stored in Salesforce.</p>
|
|
6036
6036
|
* @public
|
|
6037
6037
|
*/
|
|
6038
|
-
dataSourceId?: string;
|
|
6038
|
+
dataSourceId?: string | undefined;
|
|
6039
6039
|
/**
|
|
6040
6040
|
* <p>The type of the group.</p>
|
|
6041
6041
|
* @public
|
|
@@ -6053,7 +6053,7 @@ export interface PutGroupRequest {
|
|
|
6053
6053
|
* has access to the S3 file that contains your list of users that belong to a group.</p>
|
|
6054
6054
|
* @public
|
|
6055
6055
|
*/
|
|
6056
|
-
roleArn?: string;
|
|
6056
|
+
roleArn?: string | undefined;
|
|
6057
6057
|
}
|
|
6058
6058
|
/**
|
|
6059
6059
|
* @public
|
|
@@ -6088,7 +6088,7 @@ export interface StartDataSourceSyncJobResponse {
|
|
|
6088
6088
|
* <p>The identifier for a particular synchronization job.</p>
|
|
6089
6089
|
* @public
|
|
6090
6090
|
*/
|
|
6091
|
-
executionId?: string;
|
|
6091
|
+
executionId?: string | undefined;
|
|
6092
6092
|
}
|
|
6093
6093
|
/**
|
|
6094
6094
|
* @public
|
|
@@ -6174,7 +6174,7 @@ export interface UpdateChatControlsConfigurationRequest {
|
|
|
6174
6174
|
* chat configuration.</p>
|
|
6175
6175
|
* @public
|
|
6176
6176
|
*/
|
|
6177
|
-
clientToken?: string;
|
|
6177
|
+
clientToken?: string | undefined;
|
|
6178
6178
|
/**
|
|
6179
6179
|
* <p>The response scope configured for your application. This determines whether your
|
|
6180
6180
|
* application uses its retrieval augmented generation (RAG) system to generate answers
|
|
@@ -6182,27 +6182,27 @@ export interface UpdateChatControlsConfigurationRequest {
|
|
|
6182
6182
|
* to respons to end user questions in chat.</p>
|
|
6183
6183
|
* @public
|
|
6184
6184
|
*/
|
|
6185
|
-
responseScope?: ResponseScope;
|
|
6185
|
+
responseScope?: ResponseScope | undefined;
|
|
6186
6186
|
/**
|
|
6187
6187
|
* <p>The phrases blocked from chat by your chat control configuration.</p>
|
|
6188
6188
|
* @public
|
|
6189
6189
|
*/
|
|
6190
|
-
blockedPhrasesConfigurationUpdate?: BlockedPhrasesConfigurationUpdate;
|
|
6190
|
+
blockedPhrasesConfigurationUpdate?: BlockedPhrasesConfigurationUpdate | undefined;
|
|
6191
6191
|
/**
|
|
6192
6192
|
* <p>The configured topic specific chat controls you want to update.</p>
|
|
6193
6193
|
* @public
|
|
6194
6194
|
*/
|
|
6195
|
-
topicConfigurationsToCreateOrUpdate?: TopicConfiguration[];
|
|
6195
|
+
topicConfigurationsToCreateOrUpdate?: TopicConfiguration[] | undefined;
|
|
6196
6196
|
/**
|
|
6197
6197
|
* <p>The configured topic specific chat controls you want to delete.</p>
|
|
6198
6198
|
* @public
|
|
6199
6199
|
*/
|
|
6200
|
-
topicConfigurationsToDelete?: TopicConfiguration[];
|
|
6200
|
+
topicConfigurationsToDelete?: TopicConfiguration[] | undefined;
|
|
6201
6201
|
/**
|
|
6202
6202
|
* <p>The configuration details for <code>CREATOR_MODE</code>.</p>
|
|
6203
6203
|
* @public
|
|
6204
6204
|
*/
|
|
6205
|
-
creatorModeConfiguration?: CreatorModeConfiguration;
|
|
6205
|
+
creatorModeConfiguration?: CreatorModeConfiguration | undefined;
|
|
6206
6206
|
}
|
|
6207
6207
|
/**
|
|
6208
6208
|
* @public
|
|
@@ -6227,12 +6227,12 @@ export interface UpdateUserRequest {
|
|
|
6227
6227
|
* <p>The user aliases attached to the user id that are to be updated.</p>
|
|
6228
6228
|
* @public
|
|
6229
6229
|
*/
|
|
6230
|
-
userAliasesToUpdate?: UserAlias[];
|
|
6230
|
+
userAliasesToUpdate?: UserAlias[] | undefined;
|
|
6231
6231
|
/**
|
|
6232
6232
|
* <p>The user aliases attached to the user id that are to be deleted.</p>
|
|
6233
6233
|
* @public
|
|
6234
6234
|
*/
|
|
6235
|
-
userAliasesToDelete?: UserAlias[];
|
|
6235
|
+
userAliasesToDelete?: UserAlias[] | undefined;
|
|
6236
6236
|
}
|
|
6237
6237
|
/**
|
|
6238
6238
|
* @public
|
|
@@ -6242,17 +6242,17 @@ export interface UpdateUserResponse {
|
|
|
6242
6242
|
* <p>The user aliases that have been to be added to a user id.</p>
|
|
6243
6243
|
* @public
|
|
6244
6244
|
*/
|
|
6245
|
-
userAliasesAdded?: UserAlias[];
|
|
6245
|
+
userAliasesAdded?: UserAlias[] | undefined;
|
|
6246
6246
|
/**
|
|
6247
6247
|
* <p>The user aliases attached to a user id that have been updated.</p>
|
|
6248
6248
|
* @public
|
|
6249
6249
|
*/
|
|
6250
|
-
userAliasesUpdated?: UserAlias[];
|
|
6250
|
+
userAliasesUpdated?: UserAlias[] | undefined;
|
|
6251
6251
|
/**
|
|
6252
6252
|
* <p>The user aliases that have been deleted from a user id.</p>
|
|
6253
6253
|
* @public
|
|
6254
6254
|
*/
|
|
6255
|
-
userAliasesDeleted?: UserAlias[];
|
|
6255
|
+
userAliasesDeleted?: UserAlias[] | undefined;
|
|
6256
6256
|
}
|
|
6257
6257
|
/**
|
|
6258
6258
|
* <p>Enables filtering of responses based on document attributes or metadata fields.</p>
|
|
@@ -6263,17 +6263,17 @@ export interface AttributeFilter {
|
|
|
6263
6263
|
* <p>Performs a logical <code>AND</code> operation on all supplied filters.</p>
|
|
6264
6264
|
* @public
|
|
6265
6265
|
*/
|
|
6266
|
-
andAllFilters?: AttributeFilter[];
|
|
6266
|
+
andAllFilters?: AttributeFilter[] | undefined;
|
|
6267
6267
|
/**
|
|
6268
6268
|
* <p> Performs a logical <code>OR</code> operation on all supplied filters. </p>
|
|
6269
6269
|
* @public
|
|
6270
6270
|
*/
|
|
6271
|
-
orAllFilters?: AttributeFilter[];
|
|
6271
|
+
orAllFilters?: AttributeFilter[] | undefined;
|
|
6272
6272
|
/**
|
|
6273
6273
|
* <p>Performs a logical <code>NOT</code> operation on all supplied filters. </p>
|
|
6274
6274
|
* @public
|
|
6275
6275
|
*/
|
|
6276
|
-
notFilter?: AttributeFilter;
|
|
6276
|
+
notFilter?: AttributeFilter | undefined;
|
|
6277
6277
|
/**
|
|
6278
6278
|
* <p>Performs an equals operation on two document attributes or metadata fields. Supported
|
|
6279
6279
|
* for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>,
|
|
@@ -6281,49 +6281,49 @@ export interface AttributeFilter {
|
|
|
6281
6281
|
* <code>stringValue</code>.</p>
|
|
6282
6282
|
* @public
|
|
6283
6283
|
*/
|
|
6284
|
-
equalsTo?: DocumentAttribute;
|
|
6284
|
+
equalsTo?: DocumentAttribute | undefined;
|
|
6285
6285
|
/**
|
|
6286
6286
|
* <p>Returns <code>true</code> when a document contains all the specified document
|
|
6287
6287
|
* attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
|
|
6288
6288
|
* <code>stringListValue</code>.</p>
|
|
6289
6289
|
* @public
|
|
6290
6290
|
*/
|
|
6291
|
-
containsAll?: DocumentAttribute;
|
|
6291
|
+
containsAll?: DocumentAttribute | undefined;
|
|
6292
6292
|
/**
|
|
6293
6293
|
* <p>Returns <code>true</code> when a document contains any of the specified document
|
|
6294
6294
|
* attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
|
|
6295
6295
|
* <code>stringListValue</code>.</p>
|
|
6296
6296
|
* @public
|
|
6297
6297
|
*/
|
|
6298
|
-
containsAny?: DocumentAttribute;
|
|
6298
|
+
containsAny?: DocumentAttribute | undefined;
|
|
6299
6299
|
/**
|
|
6300
6300
|
* <p>Performs a greater than operation on two document attributes or metadata fields.
|
|
6301
6301
|
* Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
6302
6302
|
* and <code>longValue</code>.</p>
|
|
6303
6303
|
* @public
|
|
6304
6304
|
*/
|
|
6305
|
-
greaterThan?: DocumentAttribute;
|
|
6305
|
+
greaterThan?: DocumentAttribute | undefined;
|
|
6306
6306
|
/**
|
|
6307
6307
|
* <p>Performs a greater or equals than operation on two document attributes or metadata
|
|
6308
6308
|
* fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
6309
6309
|
* and <code>longValue</code>. </p>
|
|
6310
6310
|
* @public
|
|
6311
6311
|
*/
|
|
6312
|
-
greaterThanOrEquals?: DocumentAttribute;
|
|
6312
|
+
greaterThanOrEquals?: DocumentAttribute | undefined;
|
|
6313
6313
|
/**
|
|
6314
6314
|
* <p>Performs a less than operation on two document attributes or metadata fields.
|
|
6315
6315
|
* Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
6316
6316
|
* and <code>longValue</code>.</p>
|
|
6317
6317
|
* @public
|
|
6318
6318
|
*/
|
|
6319
|
-
lessThan?: DocumentAttribute;
|
|
6319
|
+
lessThan?: DocumentAttribute | undefined;
|
|
6320
6320
|
/**
|
|
6321
6321
|
* <p>Performs a less than or equals operation on two document attributes or metadata
|
|
6322
6322
|
* fields.Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value type</a>: <code>dateValue</code>
|
|
6323
6323
|
* and <code>longValue</code>. </p>
|
|
6324
6324
|
* @public
|
|
6325
6325
|
*/
|
|
6326
|
-
lessThanOrEquals?: DocumentAttribute;
|
|
6326
|
+
lessThanOrEquals?: DocumentAttribute | undefined;
|
|
6327
6327
|
}
|
|
6328
6328
|
/**
|
|
6329
6329
|
* @public
|
|
@@ -6339,50 +6339,50 @@ export interface ChatSyncInput {
|
|
|
6339
6339
|
* <p>The identifier of the user attached to the chat input.</p>
|
|
6340
6340
|
* @public
|
|
6341
6341
|
*/
|
|
6342
|
-
userId?: string;
|
|
6342
|
+
userId?: string | undefined;
|
|
6343
6343
|
/**
|
|
6344
6344
|
* <p>The group names that a user associated with the chat input belongs to.</p>
|
|
6345
6345
|
* @public
|
|
6346
6346
|
*/
|
|
6347
|
-
userGroups?: string[];
|
|
6347
|
+
userGroups?: string[] | undefined;
|
|
6348
6348
|
/**
|
|
6349
6349
|
* <p>A end user message in a conversation.</p>
|
|
6350
6350
|
* @public
|
|
6351
6351
|
*/
|
|
6352
|
-
userMessage?: string;
|
|
6352
|
+
userMessage?: string | undefined;
|
|
6353
6353
|
/**
|
|
6354
6354
|
* <p>A list of files uploaded directly during chat. You can upload a maximum of 5 files of
|
|
6355
6355
|
* upto 10 MB each.</p>
|
|
6356
6356
|
* @public
|
|
6357
6357
|
*/
|
|
6358
|
-
attachments?: AttachmentInput[];
|
|
6358
|
+
attachments?: AttachmentInput[] | undefined;
|
|
6359
6359
|
/**
|
|
6360
6360
|
* <p>A request from an end user to perform an Amazon Q Business plugin action.</p>
|
|
6361
6361
|
* @public
|
|
6362
6362
|
*/
|
|
6363
|
-
actionExecution?: ActionExecution;
|
|
6363
|
+
actionExecution?: ActionExecution | undefined;
|
|
6364
6364
|
/**
|
|
6365
6365
|
* <p>An authentication verification event response by a third party authentication server
|
|
6366
6366
|
* to Amazon Q Business.</p>
|
|
6367
6367
|
* @public
|
|
6368
6368
|
*/
|
|
6369
|
-
authChallengeResponse?: AuthChallengeResponse;
|
|
6369
|
+
authChallengeResponse?: AuthChallengeResponse | undefined;
|
|
6370
6370
|
/**
|
|
6371
6371
|
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
6372
6372
|
* @public
|
|
6373
6373
|
*/
|
|
6374
|
-
conversationId?: string;
|
|
6374
|
+
conversationId?: string | undefined;
|
|
6375
6375
|
/**
|
|
6376
6376
|
* <p>The identifier of the previous system message in a conversation.</p>
|
|
6377
6377
|
* @public
|
|
6378
6378
|
*/
|
|
6379
|
-
parentMessageId?: string;
|
|
6379
|
+
parentMessageId?: string | undefined;
|
|
6380
6380
|
/**
|
|
6381
6381
|
* <p>Enables filtering of Amazon Q Business web experience responses based on document
|
|
6382
6382
|
* attributes or metadata fields.</p>
|
|
6383
6383
|
* @public
|
|
6384
6384
|
*/
|
|
6385
|
-
attributeFilter?: AttributeFilter;
|
|
6385
|
+
attributeFilter?: AttributeFilter | undefined;
|
|
6386
6386
|
/**
|
|
6387
6387
|
* <p>The chat modes available to an Amazon Q Business end user.</p>
|
|
6388
6388
|
* <ul>
|
|
@@ -6409,17 +6409,17 @@ export interface ChatSyncInput {
|
|
|
6409
6409
|
* and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
6410
6410
|
* @public
|
|
6411
6411
|
*/
|
|
6412
|
-
chatMode?: ChatMode;
|
|
6412
|
+
chatMode?: ChatMode | undefined;
|
|
6413
6413
|
/**
|
|
6414
6414
|
* <p>The chat mode configuration for an Amazon Q Business application.</p>
|
|
6415
6415
|
* @public
|
|
6416
6416
|
*/
|
|
6417
|
-
chatModeConfiguration?: ChatModeConfiguration;
|
|
6417
|
+
chatModeConfiguration?: ChatModeConfiguration | undefined;
|
|
6418
6418
|
/**
|
|
6419
6419
|
* <p>A token that you provide to identify a chat request.</p>
|
|
6420
6420
|
* @public
|
|
6421
6421
|
*/
|
|
6422
|
-
clientToken?: string;
|
|
6422
|
+
clientToken?: string | undefined;
|
|
6423
6423
|
}
|
|
6424
6424
|
/**
|
|
6425
6425
|
* <p>A configuration event activated by an end user request to select a specific chat
|
|
@@ -6453,18 +6453,18 @@ export interface ConfigurationEvent {
|
|
|
6453
6453
|
* and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
6454
6454
|
* @public
|
|
6455
6455
|
*/
|
|
6456
|
-
chatMode?: ChatMode;
|
|
6456
|
+
chatMode?: ChatMode | undefined;
|
|
6457
6457
|
/**
|
|
6458
6458
|
* <p>Configuration information for Amazon Q Business conversation modes.</p>
|
|
6459
6459
|
* <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>
|
|
6460
6460
|
* @public
|
|
6461
6461
|
*/
|
|
6462
|
-
chatModeConfiguration?: ChatModeConfiguration;
|
|
6462
|
+
chatModeConfiguration?: ChatModeConfiguration | undefined;
|
|
6463
6463
|
/**
|
|
6464
6464
|
* <p>Enables filtering of responses based on document attributes or metadata fields.</p>
|
|
6465
6465
|
* @public
|
|
6466
6466
|
*/
|
|
6467
|
-
attributeFilter?: AttributeFilter;
|
|
6467
|
+
attributeFilter?: AttributeFilter | undefined;
|
|
6468
6468
|
}
|
|
6469
6469
|
/**
|
|
6470
6470
|
* <p>The streaming input for the <code>Chat</code> API.</p>
|
|
@@ -6593,32 +6593,32 @@ export interface ChatInput {
|
|
|
6593
6593
|
* <p>The identifier of the user attached to the chat input. </p>
|
|
6594
6594
|
* @public
|
|
6595
6595
|
*/
|
|
6596
|
-
userId?: string;
|
|
6596
|
+
userId?: string | undefined;
|
|
6597
6597
|
/**
|
|
6598
6598
|
* <p>The group names that a user associated with the chat input belongs to.</p>
|
|
6599
6599
|
* @public
|
|
6600
6600
|
*/
|
|
6601
|
-
userGroups?: string[];
|
|
6601
|
+
userGroups?: string[] | undefined;
|
|
6602
6602
|
/**
|
|
6603
6603
|
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
6604
6604
|
* @public
|
|
6605
6605
|
*/
|
|
6606
|
-
conversationId?: string;
|
|
6606
|
+
conversationId?: string | undefined;
|
|
6607
6607
|
/**
|
|
6608
6608
|
* <p>The identifier used to associate a user message with a AI generated response.</p>
|
|
6609
6609
|
* @public
|
|
6610
6610
|
*/
|
|
6611
|
-
parentMessageId?: string;
|
|
6611
|
+
parentMessageId?: string | undefined;
|
|
6612
6612
|
/**
|
|
6613
6613
|
* <p>A token that you provide to identify the chat input.</p>
|
|
6614
6614
|
* @public
|
|
6615
6615
|
*/
|
|
6616
|
-
clientToken?: string;
|
|
6616
|
+
clientToken?: string | undefined;
|
|
6617
6617
|
/**
|
|
6618
6618
|
* <p>The streaming input for the <code>Chat</code> API.</p>
|
|
6619
6619
|
* @public
|
|
6620
6620
|
*/
|
|
6621
|
-
inputStream?: AsyncIterable<ChatInputStream
|
|
6621
|
+
inputStream?: AsyncIterable<ChatInputStream> | undefined;
|
|
6622
6622
|
}
|
|
6623
6623
|
/**
|
|
6624
6624
|
* @internal
|