@aws-sdk/client-qbusiness 3.688.0 → 3.691.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 +8 -8
|
@@ -20,14 +20,14 @@ export declare const MembershipType: {
|
|
|
20
20
|
export type MembershipType =
|
|
21
21
|
(typeof MembershipType)[keyof typeof MembershipType];
|
|
22
22
|
export interface PrincipalGroup {
|
|
23
|
-
name?: string;
|
|
23
|
+
name?: string | undefined;
|
|
24
24
|
access: ReadAccessType | undefined;
|
|
25
|
-
membershipType?: MembershipType;
|
|
25
|
+
membershipType?: MembershipType | undefined;
|
|
26
26
|
}
|
|
27
27
|
export interface PrincipalUser {
|
|
28
|
-
id?: string;
|
|
28
|
+
id?: string | undefined;
|
|
29
29
|
access: ReadAccessType | undefined;
|
|
30
|
-
membershipType?: MembershipType;
|
|
30
|
+
membershipType?: MembershipType | undefined;
|
|
31
31
|
}
|
|
32
32
|
export type Principal =
|
|
33
33
|
| Principal.GroupMember
|
|
@@ -58,11 +58,11 @@ export declare namespace Principal {
|
|
|
58
58
|
}
|
|
59
59
|
export interface AccessControl {
|
|
60
60
|
principals: Principal[] | undefined;
|
|
61
|
-
memberRelation?: MemberRelation;
|
|
61
|
+
memberRelation?: MemberRelation | undefined;
|
|
62
62
|
}
|
|
63
63
|
export interface AccessConfiguration {
|
|
64
64
|
accessControls: AccessControl[] | undefined;
|
|
65
|
-
memberRelation?: MemberRelation;
|
|
65
|
+
memberRelation?: MemberRelation | undefined;
|
|
66
66
|
}
|
|
67
67
|
export declare class AccessDeniedException extends __BaseException {
|
|
68
68
|
readonly name: "AccessDeniedException";
|
|
@@ -93,19 +93,19 @@ export declare const ActionPayloadFieldType: {
|
|
|
93
93
|
export type ActionPayloadFieldType =
|
|
94
94
|
(typeof ActionPayloadFieldType)[keyof typeof ActionPayloadFieldType];
|
|
95
95
|
export interface ActionReviewPayloadFieldAllowedValue {
|
|
96
|
-
value?: __DocumentType;
|
|
97
|
-
displayValue?: __DocumentType;
|
|
96
|
+
value?: __DocumentType | undefined;
|
|
97
|
+
displayValue?: __DocumentType | undefined;
|
|
98
98
|
}
|
|
99
99
|
export interface ActionReviewPayloadField {
|
|
100
|
-
displayName?: string;
|
|
101
|
-
displayOrder?: number;
|
|
102
|
-
displayDescription?: string;
|
|
103
|
-
type?: ActionPayloadFieldType;
|
|
104
|
-
value?: __DocumentType;
|
|
105
|
-
allowedValues?: ActionReviewPayloadFieldAllowedValue[];
|
|
106
|
-
allowedFormat?: string;
|
|
107
|
-
arrayItemJsonSchema?: __DocumentType;
|
|
108
|
-
required?: boolean;
|
|
100
|
+
displayName?: string | undefined;
|
|
101
|
+
displayOrder?: number | undefined;
|
|
102
|
+
displayDescription?: string | undefined;
|
|
103
|
+
type?: ActionPayloadFieldType | undefined;
|
|
104
|
+
value?: __DocumentType | undefined;
|
|
105
|
+
allowedValues?: ActionReviewPayloadFieldAllowedValue[] | undefined;
|
|
106
|
+
allowedFormat?: string | undefined;
|
|
107
|
+
arrayItemJsonSchema?: __DocumentType | undefined;
|
|
108
|
+
required?: boolean | undefined;
|
|
109
109
|
}
|
|
110
110
|
export declare const PluginType: {
|
|
111
111
|
readonly CUSTOM: "CUSTOM";
|
|
@@ -116,19 +116,19 @@ export declare const PluginType: {
|
|
|
116
116
|
};
|
|
117
117
|
export type PluginType = (typeof PluginType)[keyof typeof PluginType];
|
|
118
118
|
export interface ActionReview {
|
|
119
|
-
pluginId?: string;
|
|
120
|
-
pluginType?: PluginType;
|
|
121
|
-
payload?: Record<string, ActionReviewPayloadField
|
|
122
|
-
payloadFieldNameSeparator?: string;
|
|
119
|
+
pluginId?: string | undefined;
|
|
120
|
+
pluginType?: PluginType | undefined;
|
|
121
|
+
payload?: Record<string, ActionReviewPayloadField> | undefined;
|
|
122
|
+
payloadFieldNameSeparator?: string | undefined;
|
|
123
123
|
}
|
|
124
124
|
export interface ActionReviewEvent {
|
|
125
|
-
conversationId?: string;
|
|
126
|
-
userMessageId?: string;
|
|
127
|
-
systemMessageId?: string;
|
|
128
|
-
pluginId?: string;
|
|
129
|
-
pluginType?: PluginType;
|
|
130
|
-
payload?: Record<string, ActionReviewPayloadField
|
|
131
|
-
payloadFieldNameSeparator?: string;
|
|
125
|
+
conversationId?: string | undefined;
|
|
126
|
+
userMessageId?: string | undefined;
|
|
127
|
+
systemMessageId?: string | undefined;
|
|
128
|
+
pluginId?: string | undefined;
|
|
129
|
+
pluginType?: PluginType | undefined;
|
|
130
|
+
payload?: Record<string, ActionReviewPayloadField> | undefined;
|
|
131
|
+
payloadFieldNameSeparator?: string | undefined;
|
|
132
132
|
}
|
|
133
133
|
export interface S3 {
|
|
134
134
|
bucket: string | undefined;
|
|
@@ -181,12 +181,12 @@ export declare const ApplicationStatus: {
|
|
|
181
181
|
export type ApplicationStatus =
|
|
182
182
|
(typeof ApplicationStatus)[keyof typeof ApplicationStatus];
|
|
183
183
|
export interface Application {
|
|
184
|
-
displayName?: string;
|
|
185
|
-
applicationId?: string;
|
|
186
|
-
createdAt?: Date;
|
|
187
|
-
updatedAt?: Date;
|
|
188
|
-
status?: ApplicationStatus;
|
|
189
|
-
identityType?: IdentityType;
|
|
184
|
+
displayName?: string | undefined;
|
|
185
|
+
applicationId?: string | undefined;
|
|
186
|
+
createdAt?: Date | undefined;
|
|
187
|
+
updatedAt?: Date | undefined;
|
|
188
|
+
status?: ApplicationStatus | undefined;
|
|
189
|
+
identityType?: IdentityType | undefined;
|
|
190
190
|
}
|
|
191
191
|
export declare class ConflictException extends __BaseException {
|
|
192
192
|
readonly name: "ConflictException";
|
|
@@ -205,7 +205,7 @@ export interface AttachmentsConfiguration {
|
|
|
205
205
|
attachmentsControlMode: AttachmentsControlMode | undefined;
|
|
206
206
|
}
|
|
207
207
|
export interface EncryptionConfiguration {
|
|
208
|
-
kmsKeyId?: string;
|
|
208
|
+
kmsKeyId?: string | undefined;
|
|
209
209
|
}
|
|
210
210
|
export declare const PersonalizationControlMode: {
|
|
211
211
|
readonly DISABLED: "DISABLED";
|
|
@@ -231,22 +231,22 @@ export interface Tag {
|
|
|
231
231
|
}
|
|
232
232
|
export interface CreateApplicationRequest {
|
|
233
233
|
displayName: string | undefined;
|
|
234
|
-
roleArn?: string;
|
|
235
|
-
identityType?: IdentityType;
|
|
236
|
-
iamIdentityProviderArn?: string;
|
|
237
|
-
identityCenterInstanceArn?: string;
|
|
238
|
-
clientIdsForOIDC?: string[];
|
|
239
|
-
description?: string;
|
|
240
|
-
encryptionConfiguration?: EncryptionConfiguration;
|
|
241
|
-
tags?: Tag[];
|
|
242
|
-
clientToken?: string;
|
|
243
|
-
attachmentsConfiguration?: AttachmentsConfiguration;
|
|
244
|
-
qAppsConfiguration?: QAppsConfiguration;
|
|
245
|
-
personalizationConfiguration?: PersonalizationConfiguration;
|
|
234
|
+
roleArn?: string | undefined;
|
|
235
|
+
identityType?: IdentityType | undefined;
|
|
236
|
+
iamIdentityProviderArn?: string | undefined;
|
|
237
|
+
identityCenterInstanceArn?: string | undefined;
|
|
238
|
+
clientIdsForOIDC?: string[] | undefined;
|
|
239
|
+
description?: string | undefined;
|
|
240
|
+
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
241
|
+
tags?: Tag[] | undefined;
|
|
242
|
+
clientToken?: string | undefined;
|
|
243
|
+
attachmentsConfiguration?: AttachmentsConfiguration | undefined;
|
|
244
|
+
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
245
|
+
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
246
246
|
}
|
|
247
247
|
export interface CreateApplicationResponse {
|
|
248
|
-
applicationId?: string;
|
|
249
|
-
applicationArn?: string;
|
|
248
|
+
applicationId?: string | undefined;
|
|
249
|
+
applicationArn?: string | undefined;
|
|
250
250
|
}
|
|
251
251
|
export declare class InternalServerException extends __BaseException {
|
|
252
252
|
readonly name: "InternalServerException";
|
|
@@ -295,7 +295,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
295
295
|
readonly name: "ValidationException";
|
|
296
296
|
readonly $fault: "client";
|
|
297
297
|
reason: ValidationExceptionReason | undefined;
|
|
298
|
-
fields?: ValidationExceptionField[];
|
|
298
|
+
fields?: ValidationExceptionField[] | undefined;
|
|
299
299
|
constructor(
|
|
300
300
|
opts: __ExceptionOptionType<ValidationException, __BaseException>
|
|
301
301
|
);
|
|
@@ -308,7 +308,7 @@ export interface GetApplicationRequest {
|
|
|
308
308
|
applicationId: string | undefined;
|
|
309
309
|
}
|
|
310
310
|
export interface AppliedAttachmentsConfiguration {
|
|
311
|
-
attachmentsControlMode?: AttachmentsControlMode;
|
|
311
|
+
attachmentsControlMode?: AttachmentsControlMode | undefined;
|
|
312
312
|
}
|
|
313
313
|
export declare const AutoSubscriptionStatus: {
|
|
314
314
|
readonly DISABLED: "DISABLED";
|
|
@@ -324,7 +324,7 @@ export type SubscriptionType =
|
|
|
324
324
|
(typeof SubscriptionType)[keyof typeof SubscriptionType];
|
|
325
325
|
export interface AutoSubscriptionConfiguration {
|
|
326
326
|
autoSubscribe: AutoSubscriptionStatus | undefined;
|
|
327
|
-
defaultSubscriptionType?: SubscriptionType;
|
|
327
|
+
defaultSubscriptionType?: SubscriptionType | undefined;
|
|
328
328
|
}
|
|
329
329
|
export declare const ErrorCode: {
|
|
330
330
|
readonly INTERNAL_ERROR: "InternalError";
|
|
@@ -334,31 +334,31 @@ export declare const ErrorCode: {
|
|
|
334
334
|
};
|
|
335
335
|
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
336
336
|
export interface ErrorDetail {
|
|
337
|
-
errorMessage?: string;
|
|
338
|
-
errorCode?: ErrorCode;
|
|
337
|
+
errorMessage?: string | undefined;
|
|
338
|
+
errorCode?: ErrorCode | undefined;
|
|
339
339
|
}
|
|
340
340
|
export interface GetApplicationResponse {
|
|
341
|
-
displayName?: string;
|
|
342
|
-
applicationId?: string;
|
|
343
|
-
applicationArn?: string;
|
|
344
|
-
identityType?: IdentityType;
|
|
345
|
-
iamIdentityProviderArn?: string;
|
|
346
|
-
identityCenterApplicationArn?: string;
|
|
347
|
-
roleArn?: string;
|
|
348
|
-
status?: ApplicationStatus;
|
|
349
|
-
description?: string;
|
|
350
|
-
encryptionConfiguration?: EncryptionConfiguration;
|
|
351
|
-
createdAt?: Date;
|
|
352
|
-
updatedAt?: Date;
|
|
353
|
-
error?: ErrorDetail;
|
|
354
|
-
attachmentsConfiguration?: AppliedAttachmentsConfiguration;
|
|
355
|
-
qAppsConfiguration?: QAppsConfiguration;
|
|
356
|
-
personalizationConfiguration?: PersonalizationConfiguration;
|
|
357
|
-
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
|
|
358
|
-
clientIdsForOIDC?: string[];
|
|
341
|
+
displayName?: string | undefined;
|
|
342
|
+
applicationId?: string | undefined;
|
|
343
|
+
applicationArn?: string | undefined;
|
|
344
|
+
identityType?: IdentityType | undefined;
|
|
345
|
+
iamIdentityProviderArn?: string | undefined;
|
|
346
|
+
identityCenterApplicationArn?: string | undefined;
|
|
347
|
+
roleArn?: string | undefined;
|
|
348
|
+
status?: ApplicationStatus | undefined;
|
|
349
|
+
description?: string | undefined;
|
|
350
|
+
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
351
|
+
createdAt?: Date | undefined;
|
|
352
|
+
updatedAt?: Date | undefined;
|
|
353
|
+
error?: ErrorDetail | undefined;
|
|
354
|
+
attachmentsConfiguration?: AppliedAttachmentsConfiguration | undefined;
|
|
355
|
+
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
356
|
+
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
357
|
+
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration | undefined;
|
|
358
|
+
clientIdsForOIDC?: string[] | undefined;
|
|
359
359
|
}
|
|
360
360
|
export interface IndexCapacityConfiguration {
|
|
361
|
-
units?: number;
|
|
361
|
+
units?: number | undefined;
|
|
362
362
|
}
|
|
363
363
|
export declare const IndexType: {
|
|
364
364
|
readonly ENTERPRISE: "ENTERPRISE";
|
|
@@ -368,15 +368,15 @@ export type IndexType = (typeof IndexType)[keyof typeof IndexType];
|
|
|
368
368
|
export interface CreateIndexRequest {
|
|
369
369
|
applicationId: string | undefined;
|
|
370
370
|
displayName: string | undefined;
|
|
371
|
-
type?: IndexType;
|
|
372
|
-
description?: string;
|
|
373
|
-
tags?: Tag[];
|
|
374
|
-
capacityConfiguration?: IndexCapacityConfiguration;
|
|
375
|
-
clientToken?: string;
|
|
371
|
+
type?: IndexType | undefined;
|
|
372
|
+
description?: string | undefined;
|
|
373
|
+
tags?: Tag[] | undefined;
|
|
374
|
+
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
375
|
+
clientToken?: string | undefined;
|
|
376
376
|
}
|
|
377
377
|
export interface CreateIndexResponse {
|
|
378
|
-
indexId?: string;
|
|
379
|
-
indexArn?: string;
|
|
378
|
+
indexId?: string | undefined;
|
|
379
|
+
indexArn?: string | undefined;
|
|
380
380
|
}
|
|
381
381
|
export declare const DocumentEnrichmentConditionOperator: {
|
|
382
382
|
readonly BEGINS_WITH: "BEGINS_WITH";
|
|
@@ -447,7 +447,7 @@ export declare namespace DocumentAttributeValue {
|
|
|
447
447
|
export interface DocumentAttributeCondition {
|
|
448
448
|
key: string | undefined;
|
|
449
449
|
operator: DocumentEnrichmentConditionOperator | undefined;
|
|
450
|
-
value?: DocumentAttributeValue;
|
|
450
|
+
value?: DocumentAttributeValue | undefined;
|
|
451
451
|
}
|
|
452
452
|
export declare const DocumentContentOperator: {
|
|
453
453
|
readonly DELETE: "DELETE";
|
|
@@ -461,24 +461,24 @@ export type AttributeValueOperator =
|
|
|
461
461
|
(typeof AttributeValueOperator)[keyof typeof AttributeValueOperator];
|
|
462
462
|
export interface DocumentAttributeTarget {
|
|
463
463
|
key: string | undefined;
|
|
464
|
-
value?: DocumentAttributeValue;
|
|
465
|
-
attributeValueOperator?: AttributeValueOperator;
|
|
464
|
+
value?: DocumentAttributeValue | undefined;
|
|
465
|
+
attributeValueOperator?: AttributeValueOperator | undefined;
|
|
466
466
|
}
|
|
467
467
|
export interface InlineDocumentEnrichmentConfiguration {
|
|
468
|
-
condition?: DocumentAttributeCondition;
|
|
469
|
-
target?: DocumentAttributeTarget;
|
|
470
|
-
documentContentOperator?: DocumentContentOperator;
|
|
468
|
+
condition?: DocumentAttributeCondition | undefined;
|
|
469
|
+
target?: DocumentAttributeTarget | undefined;
|
|
470
|
+
documentContentOperator?: DocumentContentOperator | undefined;
|
|
471
471
|
}
|
|
472
472
|
export interface HookConfiguration {
|
|
473
|
-
invocationCondition?: DocumentAttributeCondition;
|
|
474
|
-
lambdaArn?: string;
|
|
475
|
-
s3BucketName?: string;
|
|
476
|
-
roleArn?: string;
|
|
473
|
+
invocationCondition?: DocumentAttributeCondition | undefined;
|
|
474
|
+
lambdaArn?: string | undefined;
|
|
475
|
+
s3BucketName?: string | undefined;
|
|
476
|
+
roleArn?: string | undefined;
|
|
477
477
|
}
|
|
478
478
|
export interface DocumentEnrichmentConfiguration {
|
|
479
|
-
inlineConfigurations?: InlineDocumentEnrichmentConfiguration[];
|
|
480
|
-
preExtractionHookConfiguration?: HookConfiguration;
|
|
481
|
-
postExtractionHookConfiguration?: HookConfiguration;
|
|
479
|
+
inlineConfigurations?: InlineDocumentEnrichmentConfiguration[] | undefined;
|
|
480
|
+
preExtractionHookConfiguration?: HookConfiguration | undefined;
|
|
481
|
+
postExtractionHookConfiguration?: HookConfiguration | undefined;
|
|
482
482
|
}
|
|
483
483
|
export interface DataSourceVpcConfiguration {
|
|
484
484
|
subnetIds: string[] | undefined;
|
|
@@ -489,17 +489,17 @@ export interface CreateDataSourceRequest {
|
|
|
489
489
|
indexId: string | undefined;
|
|
490
490
|
displayName: string | undefined;
|
|
491
491
|
configuration: __DocumentType | undefined;
|
|
492
|
-
vpcConfiguration?: DataSourceVpcConfiguration;
|
|
493
|
-
description?: string;
|
|
494
|
-
tags?: Tag[];
|
|
495
|
-
syncSchedule?: string;
|
|
496
|
-
roleArn?: string;
|
|
497
|
-
clientToken?: string;
|
|
498
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
|
492
|
+
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
493
|
+
description?: string | undefined;
|
|
494
|
+
tags?: Tag[] | undefined;
|
|
495
|
+
syncSchedule?: string | undefined;
|
|
496
|
+
roleArn?: string | undefined;
|
|
497
|
+
clientToken?: string | undefined;
|
|
498
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
499
499
|
}
|
|
500
500
|
export interface CreateDataSourceResponse {
|
|
501
|
-
dataSourceId?: string;
|
|
502
|
-
dataSourceArn?: string;
|
|
501
|
+
dataSourceId?: string | undefined;
|
|
502
|
+
dataSourceArn?: string | undefined;
|
|
503
503
|
}
|
|
504
504
|
export interface DeleteDataSourceRequest {
|
|
505
505
|
applicationId: string | undefined;
|
|
@@ -523,52 +523,52 @@ export declare const DataSourceStatus: {
|
|
|
523
523
|
export type DataSourceStatus =
|
|
524
524
|
(typeof DataSourceStatus)[keyof typeof DataSourceStatus];
|
|
525
525
|
export interface GetDataSourceResponse {
|
|
526
|
-
applicationId?: string;
|
|
527
|
-
indexId?: string;
|
|
528
|
-
dataSourceId?: string;
|
|
529
|
-
dataSourceArn?: string;
|
|
530
|
-
displayName?: string;
|
|
531
|
-
type?: string;
|
|
532
|
-
configuration?: __DocumentType;
|
|
533
|
-
vpcConfiguration?: DataSourceVpcConfiguration;
|
|
534
|
-
createdAt?: Date;
|
|
535
|
-
updatedAt?: Date;
|
|
536
|
-
description?: string;
|
|
537
|
-
status?: DataSourceStatus;
|
|
538
|
-
syncSchedule?: string;
|
|
539
|
-
roleArn?: string;
|
|
540
|
-
error?: ErrorDetail;
|
|
541
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
|
526
|
+
applicationId?: string | undefined;
|
|
527
|
+
indexId?: string | undefined;
|
|
528
|
+
dataSourceId?: string | undefined;
|
|
529
|
+
dataSourceArn?: string | undefined;
|
|
530
|
+
displayName?: string | undefined;
|
|
531
|
+
type?: string | undefined;
|
|
532
|
+
configuration?: __DocumentType | undefined;
|
|
533
|
+
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
534
|
+
createdAt?: Date | undefined;
|
|
535
|
+
updatedAt?: Date | undefined;
|
|
536
|
+
description?: string | undefined;
|
|
537
|
+
status?: DataSourceStatus | undefined;
|
|
538
|
+
syncSchedule?: string | undefined;
|
|
539
|
+
roleArn?: string | undefined;
|
|
540
|
+
error?: ErrorDetail | undefined;
|
|
541
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
542
542
|
}
|
|
543
543
|
export interface ListDataSourcesRequest {
|
|
544
544
|
applicationId: string | undefined;
|
|
545
545
|
indexId: string | undefined;
|
|
546
|
-
nextToken?: string;
|
|
547
|
-
maxResults?: number;
|
|
546
|
+
nextToken?: string | undefined;
|
|
547
|
+
maxResults?: number | undefined;
|
|
548
548
|
}
|
|
549
549
|
export interface DataSource {
|
|
550
|
-
displayName?: string;
|
|
551
|
-
dataSourceId?: string;
|
|
552
|
-
type?: string;
|
|
553
|
-
createdAt?: Date;
|
|
554
|
-
updatedAt?: Date;
|
|
555
|
-
status?: DataSourceStatus;
|
|
550
|
+
displayName?: string | undefined;
|
|
551
|
+
dataSourceId?: string | undefined;
|
|
552
|
+
type?: string | undefined;
|
|
553
|
+
createdAt?: Date | undefined;
|
|
554
|
+
updatedAt?: Date | undefined;
|
|
555
|
+
status?: DataSourceStatus | undefined;
|
|
556
556
|
}
|
|
557
557
|
export interface ListDataSourcesResponse {
|
|
558
|
-
dataSources?: DataSource[];
|
|
559
|
-
nextToken?: string;
|
|
558
|
+
dataSources?: DataSource[] | undefined;
|
|
559
|
+
nextToken?: string | undefined;
|
|
560
560
|
}
|
|
561
561
|
export interface UpdateDataSourceRequest {
|
|
562
562
|
applicationId: string | undefined;
|
|
563
563
|
indexId: string | undefined;
|
|
564
564
|
dataSourceId: string | undefined;
|
|
565
|
-
displayName?: string;
|
|
566
|
-
configuration?: __DocumentType;
|
|
567
|
-
vpcConfiguration?: DataSourceVpcConfiguration;
|
|
568
|
-
description?: string;
|
|
569
|
-
syncSchedule?: string;
|
|
570
|
-
roleArn?: string;
|
|
571
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
|
565
|
+
displayName?: string | undefined;
|
|
566
|
+
configuration?: __DocumentType | undefined;
|
|
567
|
+
vpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
568
|
+
description?: string | undefined;
|
|
569
|
+
syncSchedule?: string | undefined;
|
|
570
|
+
roleArn?: string | undefined;
|
|
571
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
572
572
|
}
|
|
573
573
|
export interface UpdateDataSourceResponse {}
|
|
574
574
|
export interface DeleteIndexRequest {
|
|
@@ -593,16 +593,16 @@ export declare const AttributeType: {
|
|
|
593
593
|
};
|
|
594
594
|
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
595
595
|
export interface DocumentAttributeConfiguration {
|
|
596
|
-
name?: string;
|
|
597
|
-
type?: AttributeType;
|
|
598
|
-
search?: Status;
|
|
596
|
+
name?: string | undefined;
|
|
597
|
+
type?: AttributeType | undefined;
|
|
598
|
+
search?: Status | undefined;
|
|
599
599
|
}
|
|
600
600
|
export interface TextDocumentStatistics {
|
|
601
|
-
indexedTextBytes?: number;
|
|
602
|
-
indexedTextDocumentCount?: number;
|
|
601
|
+
indexedTextBytes?: number | undefined;
|
|
602
|
+
indexedTextDocumentCount?: number | undefined;
|
|
603
603
|
}
|
|
604
604
|
export interface IndexStatistics {
|
|
605
|
-
textDocumentStatistics?: TextDocumentStatistics;
|
|
605
|
+
textDocumentStatistics?: TextDocumentStatistics | undefined;
|
|
606
606
|
}
|
|
607
607
|
export declare const IndexStatus: {
|
|
608
608
|
readonly ACTIVE: "ACTIVE";
|
|
@@ -613,52 +613,56 @@ export declare const IndexStatus: {
|
|
|
613
613
|
};
|
|
614
614
|
export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
615
615
|
export interface GetIndexResponse {
|
|
616
|
-
applicationId?: string;
|
|
617
|
-
indexId?: string;
|
|
618
|
-
displayName?: string;
|
|
619
|
-
type?: IndexType;
|
|
620
|
-
indexArn?: string;
|
|
621
|
-
status?: IndexStatus;
|
|
622
|
-
description?: string;
|
|
623
|
-
createdAt?: Date;
|
|
624
|
-
updatedAt?: Date;
|
|
625
|
-
capacityConfiguration?: IndexCapacityConfiguration;
|
|
626
|
-
documentAttributeConfigurations?:
|
|
627
|
-
|
|
628
|
-
|
|
616
|
+
applicationId?: string | undefined;
|
|
617
|
+
indexId?: string | undefined;
|
|
618
|
+
displayName?: string | undefined;
|
|
619
|
+
type?: IndexType | undefined;
|
|
620
|
+
indexArn?: string | undefined;
|
|
621
|
+
status?: IndexStatus | undefined;
|
|
622
|
+
description?: string | undefined;
|
|
623
|
+
createdAt?: Date | undefined;
|
|
624
|
+
updatedAt?: Date | undefined;
|
|
625
|
+
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
626
|
+
documentAttributeConfigurations?:
|
|
627
|
+
| DocumentAttributeConfiguration[]
|
|
628
|
+
| undefined;
|
|
629
|
+
error?: ErrorDetail | undefined;
|
|
630
|
+
indexStatistics?: IndexStatistics | undefined;
|
|
629
631
|
}
|
|
630
632
|
export interface ListIndicesRequest {
|
|
631
633
|
applicationId: string | undefined;
|
|
632
|
-
nextToken?: string;
|
|
633
|
-
maxResults?: number;
|
|
634
|
+
nextToken?: string | undefined;
|
|
635
|
+
maxResults?: number | undefined;
|
|
634
636
|
}
|
|
635
637
|
export interface Index {
|
|
636
|
-
displayName?: string;
|
|
637
|
-
indexId?: string;
|
|
638
|
-
createdAt?: Date;
|
|
639
|
-
updatedAt?: Date;
|
|
640
|
-
status?: IndexStatus;
|
|
638
|
+
displayName?: string | undefined;
|
|
639
|
+
indexId?: string | undefined;
|
|
640
|
+
createdAt?: Date | undefined;
|
|
641
|
+
updatedAt?: Date | undefined;
|
|
642
|
+
status?: IndexStatus | undefined;
|
|
641
643
|
}
|
|
642
644
|
export interface ListIndicesResponse {
|
|
643
|
-
nextToken?: string;
|
|
644
|
-
indices?: Index[];
|
|
645
|
+
nextToken?: string | undefined;
|
|
646
|
+
indices?: Index[] | undefined;
|
|
645
647
|
}
|
|
646
648
|
export interface UpdateIndexRequest {
|
|
647
649
|
applicationId: string | undefined;
|
|
648
650
|
indexId: string | undefined;
|
|
649
|
-
displayName?: string;
|
|
650
|
-
description?: string;
|
|
651
|
-
capacityConfiguration?: IndexCapacityConfiguration;
|
|
652
|
-
documentAttributeConfigurations?:
|
|
651
|
+
displayName?: string | undefined;
|
|
652
|
+
description?: string | undefined;
|
|
653
|
+
capacityConfiguration?: IndexCapacityConfiguration | undefined;
|
|
654
|
+
documentAttributeConfigurations?:
|
|
655
|
+
| DocumentAttributeConfiguration[]
|
|
656
|
+
| undefined;
|
|
653
657
|
}
|
|
654
658
|
export interface UpdateIndexResponse {}
|
|
655
659
|
export interface ListApplicationsRequest {
|
|
656
|
-
nextToken?: string;
|
|
657
|
-
maxResults?: number;
|
|
660
|
+
nextToken?: string | undefined;
|
|
661
|
+
maxResults?: number | undefined;
|
|
658
662
|
}
|
|
659
663
|
export interface ListApplicationsResponse {
|
|
660
|
-
nextToken?: string;
|
|
661
|
-
applications?: Application[];
|
|
664
|
+
nextToken?: string | undefined;
|
|
665
|
+
applications?: Application[] | undefined;
|
|
662
666
|
}
|
|
663
667
|
export interface BasicAuthConfiguration {
|
|
664
668
|
secretArn: string | undefined;
|
|
@@ -719,10 +723,10 @@ export interface CreatePluginRequest {
|
|
|
719
723
|
displayName: string | undefined;
|
|
720
724
|
type: PluginType | undefined;
|
|
721
725
|
authConfiguration: PluginAuthConfiguration | undefined;
|
|
722
|
-
serverUrl?: string;
|
|
723
|
-
customPluginConfiguration?: CustomPluginConfiguration;
|
|
724
|
-
tags?: Tag[];
|
|
725
|
-
clientToken?: string;
|
|
726
|
+
serverUrl?: string | undefined;
|
|
727
|
+
customPluginConfiguration?: CustomPluginConfiguration | undefined;
|
|
728
|
+
tags?: Tag[] | undefined;
|
|
729
|
+
clientToken?: string | undefined;
|
|
726
730
|
}
|
|
727
731
|
export declare const PluginBuildStatus: {
|
|
728
732
|
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
@@ -736,9 +740,9 @@ export declare const PluginBuildStatus: {
|
|
|
736
740
|
export type PluginBuildStatus =
|
|
737
741
|
(typeof PluginBuildStatus)[keyof typeof PluginBuildStatus];
|
|
738
742
|
export interface CreatePluginResponse {
|
|
739
|
-
pluginId?: string;
|
|
740
|
-
pluginArn?: string;
|
|
741
|
-
buildStatus?: PluginBuildStatus;
|
|
743
|
+
pluginId?: string | undefined;
|
|
744
|
+
pluginArn?: string | undefined;
|
|
745
|
+
buildStatus?: PluginBuildStatus | undefined;
|
|
742
746
|
}
|
|
743
747
|
export interface DeletePluginRequest {
|
|
744
748
|
applicationId: string | undefined;
|
|
@@ -755,46 +759,46 @@ export declare const PluginState: {
|
|
|
755
759
|
};
|
|
756
760
|
export type PluginState = (typeof PluginState)[keyof typeof PluginState];
|
|
757
761
|
export interface GetPluginResponse {
|
|
758
|
-
applicationId?: string;
|
|
759
|
-
pluginId?: string;
|
|
760
|
-
displayName?: string;
|
|
761
|
-
type?: PluginType;
|
|
762
|
-
serverUrl?: string;
|
|
763
|
-
authConfiguration?: PluginAuthConfiguration;
|
|
764
|
-
customPluginConfiguration?: CustomPluginConfiguration;
|
|
765
|
-
buildStatus?: PluginBuildStatus;
|
|
766
|
-
pluginArn?: string;
|
|
767
|
-
state?: PluginState;
|
|
768
|
-
createdAt?: Date;
|
|
769
|
-
updatedAt?: Date;
|
|
762
|
+
applicationId?: string | undefined;
|
|
763
|
+
pluginId?: string | undefined;
|
|
764
|
+
displayName?: string | undefined;
|
|
765
|
+
type?: PluginType | undefined;
|
|
766
|
+
serverUrl?: string | undefined;
|
|
767
|
+
authConfiguration?: PluginAuthConfiguration | undefined;
|
|
768
|
+
customPluginConfiguration?: CustomPluginConfiguration | undefined;
|
|
769
|
+
buildStatus?: PluginBuildStatus | undefined;
|
|
770
|
+
pluginArn?: string | undefined;
|
|
771
|
+
state?: PluginState | undefined;
|
|
772
|
+
createdAt?: Date | undefined;
|
|
773
|
+
updatedAt?: Date | undefined;
|
|
770
774
|
}
|
|
771
775
|
export interface ListPluginsRequest {
|
|
772
776
|
applicationId: string | undefined;
|
|
773
|
-
nextToken?: string;
|
|
774
|
-
maxResults?: number;
|
|
777
|
+
nextToken?: string | undefined;
|
|
778
|
+
maxResults?: number | undefined;
|
|
775
779
|
}
|
|
776
780
|
export interface Plugin {
|
|
777
|
-
pluginId?: string;
|
|
778
|
-
displayName?: string;
|
|
779
|
-
type?: PluginType;
|
|
780
|
-
serverUrl?: string;
|
|
781
|
-
state?: PluginState;
|
|
782
|
-
buildStatus?: PluginBuildStatus;
|
|
783
|
-
createdAt?: Date;
|
|
784
|
-
updatedAt?: Date;
|
|
781
|
+
pluginId?: string | undefined;
|
|
782
|
+
displayName?: string | undefined;
|
|
783
|
+
type?: PluginType | undefined;
|
|
784
|
+
serverUrl?: string | undefined;
|
|
785
|
+
state?: PluginState | undefined;
|
|
786
|
+
buildStatus?: PluginBuildStatus | undefined;
|
|
787
|
+
createdAt?: Date | undefined;
|
|
788
|
+
updatedAt?: Date | undefined;
|
|
785
789
|
}
|
|
786
790
|
export interface ListPluginsResponse {
|
|
787
|
-
nextToken?: string;
|
|
788
|
-
plugins?: Plugin[];
|
|
791
|
+
nextToken?: string | undefined;
|
|
792
|
+
plugins?: Plugin[] | undefined;
|
|
789
793
|
}
|
|
790
794
|
export interface UpdatePluginRequest {
|
|
791
795
|
applicationId: string | undefined;
|
|
792
796
|
pluginId: string | undefined;
|
|
793
|
-
displayName?: string;
|
|
794
|
-
state?: PluginState;
|
|
795
|
-
serverUrl?: string;
|
|
796
|
-
customPluginConfiguration?: CustomPluginConfiguration;
|
|
797
|
-
authConfiguration?: PluginAuthConfiguration;
|
|
797
|
+
displayName?: string | undefined;
|
|
798
|
+
state?: PluginState | undefined;
|
|
799
|
+
serverUrl?: string | undefined;
|
|
800
|
+
customPluginConfiguration?: CustomPluginConfiguration | undefined;
|
|
801
|
+
authConfiguration?: PluginAuthConfiguration | undefined;
|
|
798
802
|
}
|
|
799
803
|
export interface UpdatePluginResponse {}
|
|
800
804
|
export interface KendraIndexConfiguration {
|
|
@@ -811,7 +815,7 @@ export type DocumentAttributeBoostingLevel =
|
|
|
811
815
|
(typeof DocumentAttributeBoostingLevel)[keyof typeof DocumentAttributeBoostingLevel];
|
|
812
816
|
export interface DateAttributeBoostingConfiguration {
|
|
813
817
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
814
|
-
boostingDurationInSeconds?: number;
|
|
818
|
+
boostingDurationInSeconds?: number | undefined;
|
|
815
819
|
}
|
|
816
820
|
export declare const NumberAttributeBoostingType: {
|
|
817
821
|
readonly PRIORITIZE_LARGER_VALUES: "PRIORITIZE_LARGER_VALUES";
|
|
@@ -821,7 +825,7 @@ export type NumberAttributeBoostingType =
|
|
|
821
825
|
(typeof NumberAttributeBoostingType)[keyof typeof NumberAttributeBoostingType];
|
|
822
826
|
export interface NumberAttributeBoostingConfiguration {
|
|
823
827
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
824
|
-
boostingType?: NumberAttributeBoostingType;
|
|
828
|
+
boostingType?: NumberAttributeBoostingType | undefined;
|
|
825
829
|
}
|
|
826
830
|
export declare const StringAttributeValueBoostingLevel: {
|
|
827
831
|
readonly HIGH: "HIGH";
|
|
@@ -833,7 +837,9 @@ export type StringAttributeValueBoostingLevel =
|
|
|
833
837
|
(typeof StringAttributeValueBoostingLevel)[keyof typeof StringAttributeValueBoostingLevel];
|
|
834
838
|
export interface StringAttributeBoostingConfiguration {
|
|
835
839
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
836
|
-
attributeValueBoosting?:
|
|
840
|
+
attributeValueBoosting?:
|
|
841
|
+
| Record<string, StringAttributeValueBoostingLevel>
|
|
842
|
+
| undefined;
|
|
837
843
|
}
|
|
838
844
|
export interface StringListAttributeBoostingConfiguration {
|
|
839
845
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
@@ -896,7 +902,9 @@ export declare namespace DocumentAttributeBoostingConfiguration {
|
|
|
896
902
|
}
|
|
897
903
|
export interface NativeIndexConfiguration {
|
|
898
904
|
indexId: string | undefined;
|
|
899
|
-
boostingOverride?:
|
|
905
|
+
boostingOverride?:
|
|
906
|
+
| Record<string, DocumentAttributeBoostingConfiguration>
|
|
907
|
+
| undefined;
|
|
900
908
|
}
|
|
901
909
|
export type RetrieverConfiguration =
|
|
902
910
|
| RetrieverConfiguration.KendraIndexConfigurationMember
|
|
@@ -935,13 +943,13 @@ export interface CreateRetrieverRequest {
|
|
|
935
943
|
type: RetrieverType | undefined;
|
|
936
944
|
displayName: string | undefined;
|
|
937
945
|
configuration: RetrieverConfiguration | undefined;
|
|
938
|
-
roleArn?: string;
|
|
939
|
-
clientToken?: string;
|
|
940
|
-
tags?: Tag[];
|
|
946
|
+
roleArn?: string | undefined;
|
|
947
|
+
clientToken?: string | undefined;
|
|
948
|
+
tags?: Tag[] | undefined;
|
|
941
949
|
}
|
|
942
950
|
export interface CreateRetrieverResponse {
|
|
943
|
-
retrieverId?: string;
|
|
944
|
-
retrieverArn?: string;
|
|
951
|
+
retrieverId?: string | undefined;
|
|
952
|
+
retrieverArn?: string | undefined;
|
|
945
953
|
}
|
|
946
954
|
export interface DeleteRetrieverRequest {
|
|
947
955
|
applicationId: string | undefined;
|
|
@@ -960,51 +968,51 @@ export declare const RetrieverStatus: {
|
|
|
960
968
|
export type RetrieverStatus =
|
|
961
969
|
(typeof RetrieverStatus)[keyof typeof RetrieverStatus];
|
|
962
970
|
export interface GetRetrieverResponse {
|
|
963
|
-
applicationId?: string;
|
|
964
|
-
retrieverId?: string;
|
|
965
|
-
retrieverArn?: string;
|
|
966
|
-
type?: RetrieverType;
|
|
967
|
-
status?: RetrieverStatus;
|
|
968
|
-
displayName?: string;
|
|
969
|
-
configuration?: RetrieverConfiguration;
|
|
970
|
-
roleArn?: string;
|
|
971
|
-
createdAt?: Date;
|
|
972
|
-
updatedAt?: Date;
|
|
971
|
+
applicationId?: string | undefined;
|
|
972
|
+
retrieverId?: string | undefined;
|
|
973
|
+
retrieverArn?: string | undefined;
|
|
974
|
+
type?: RetrieverType | undefined;
|
|
975
|
+
status?: RetrieverStatus | undefined;
|
|
976
|
+
displayName?: string | undefined;
|
|
977
|
+
configuration?: RetrieverConfiguration | undefined;
|
|
978
|
+
roleArn?: string | undefined;
|
|
979
|
+
createdAt?: Date | undefined;
|
|
980
|
+
updatedAt?: Date | undefined;
|
|
973
981
|
}
|
|
974
982
|
export interface ListRetrieversRequest {
|
|
975
983
|
applicationId: string | undefined;
|
|
976
|
-
nextToken?: string;
|
|
977
|
-
maxResults?: number;
|
|
984
|
+
nextToken?: string | undefined;
|
|
985
|
+
maxResults?: number | undefined;
|
|
978
986
|
}
|
|
979
987
|
export interface Retriever {
|
|
980
|
-
applicationId?: string;
|
|
981
|
-
retrieverId?: string;
|
|
982
|
-
type?: RetrieverType;
|
|
983
|
-
status?: RetrieverStatus;
|
|
984
|
-
displayName?: string;
|
|
988
|
+
applicationId?: string | undefined;
|
|
989
|
+
retrieverId?: string | undefined;
|
|
990
|
+
type?: RetrieverType | undefined;
|
|
991
|
+
status?: RetrieverStatus | undefined;
|
|
992
|
+
displayName?: string | undefined;
|
|
985
993
|
}
|
|
986
994
|
export interface ListRetrieversResponse {
|
|
987
|
-
retrievers?: Retriever[];
|
|
988
|
-
nextToken?: string;
|
|
995
|
+
retrievers?: Retriever[] | undefined;
|
|
996
|
+
nextToken?: string | undefined;
|
|
989
997
|
}
|
|
990
998
|
export interface UpdateRetrieverRequest {
|
|
991
999
|
applicationId: string | undefined;
|
|
992
1000
|
retrieverId: string | undefined;
|
|
993
|
-
configuration?: RetrieverConfiguration;
|
|
994
|
-
displayName?: string;
|
|
995
|
-
roleArn?: string;
|
|
1001
|
+
configuration?: RetrieverConfiguration | undefined;
|
|
1002
|
+
displayName?: string | undefined;
|
|
1003
|
+
roleArn?: string | undefined;
|
|
996
1004
|
}
|
|
997
1005
|
export interface UpdateRetrieverResponse {}
|
|
998
1006
|
export interface UpdateApplicationRequest {
|
|
999
1007
|
applicationId: string | undefined;
|
|
1000
|
-
identityCenterInstanceArn?: string;
|
|
1001
|
-
displayName?: string;
|
|
1002
|
-
description?: string;
|
|
1003
|
-
roleArn?: string;
|
|
1004
|
-
attachmentsConfiguration?: AttachmentsConfiguration;
|
|
1005
|
-
qAppsConfiguration?: QAppsConfiguration;
|
|
1006
|
-
personalizationConfiguration?: PersonalizationConfiguration;
|
|
1007
|
-
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
|
|
1008
|
+
identityCenterInstanceArn?: string | undefined;
|
|
1009
|
+
displayName?: string | undefined;
|
|
1010
|
+
description?: string | undefined;
|
|
1011
|
+
roleArn?: string | undefined;
|
|
1012
|
+
attachmentsConfiguration?: AttachmentsConfiguration | undefined;
|
|
1013
|
+
qAppsConfiguration?: QAppsConfiguration | undefined;
|
|
1014
|
+
personalizationConfiguration?: PersonalizationConfiguration | undefined;
|
|
1015
|
+
autoSubscriptionConfiguration?: AutoSubscriptionConfiguration | undefined;
|
|
1008
1016
|
}
|
|
1009
1017
|
export interface UpdateApplicationResponse {}
|
|
1010
1018
|
export interface OpenIDConnectProviderConfiguration {
|
|
@@ -1054,19 +1062,19 @@ export type WebExperienceSamplePromptsControlMode =
|
|
|
1054
1062
|
(typeof WebExperienceSamplePromptsControlMode)[keyof typeof WebExperienceSamplePromptsControlMode];
|
|
1055
1063
|
export interface CreateWebExperienceRequest {
|
|
1056
1064
|
applicationId: string | undefined;
|
|
1057
|
-
title?: string;
|
|
1058
|
-
subtitle?: string;
|
|
1059
|
-
welcomeMessage?: string;
|
|
1060
|
-
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
|
1061
|
-
origins?: string[];
|
|
1062
|
-
roleArn?: string;
|
|
1063
|
-
tags?: Tag[];
|
|
1064
|
-
clientToken?: string;
|
|
1065
|
-
identityProviderConfiguration?: IdentityProviderConfiguration;
|
|
1065
|
+
title?: string | undefined;
|
|
1066
|
+
subtitle?: string | undefined;
|
|
1067
|
+
welcomeMessage?: string | undefined;
|
|
1068
|
+
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
1069
|
+
origins?: string[] | undefined;
|
|
1070
|
+
roleArn?: string | undefined;
|
|
1071
|
+
tags?: Tag[] | undefined;
|
|
1072
|
+
clientToken?: string | undefined;
|
|
1073
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
1066
1074
|
}
|
|
1067
1075
|
export interface CreateWebExperienceResponse {
|
|
1068
|
-
webExperienceId?: string;
|
|
1069
|
-
webExperienceArn?: string;
|
|
1076
|
+
webExperienceId?: string | undefined;
|
|
1077
|
+
webExperienceArn?: string | undefined;
|
|
1070
1078
|
}
|
|
1071
1079
|
export interface DeleteWebExperienceRequest {
|
|
1072
1080
|
applicationId: string | undefined;
|
|
@@ -1081,7 +1089,7 @@ export interface SamlConfiguration {
|
|
|
1081
1089
|
metadataXML: string | undefined;
|
|
1082
1090
|
roleArn: string | undefined;
|
|
1083
1091
|
userIdAttribute: string | undefined;
|
|
1084
|
-
userGroupAttribute?: string;
|
|
1092
|
+
userGroupAttribute?: string | undefined;
|
|
1085
1093
|
}
|
|
1086
1094
|
export type WebExperienceAuthConfiguration =
|
|
1087
1095
|
| WebExperienceAuthConfiguration.SamlConfigurationMember
|
|
@@ -1114,50 +1122,50 @@ export declare const WebExperienceStatus: {
|
|
|
1114
1122
|
export type WebExperienceStatus =
|
|
1115
1123
|
(typeof WebExperienceStatus)[keyof typeof WebExperienceStatus];
|
|
1116
1124
|
export interface GetWebExperienceResponse {
|
|
1117
|
-
applicationId?: string;
|
|
1118
|
-
webExperienceId?: string;
|
|
1119
|
-
webExperienceArn?: string;
|
|
1120
|
-
defaultEndpoint?: string;
|
|
1121
|
-
status?: WebExperienceStatus;
|
|
1122
|
-
createdAt?: Date;
|
|
1123
|
-
updatedAt?: Date;
|
|
1124
|
-
title?: string;
|
|
1125
|
-
subtitle?: string;
|
|
1126
|
-
welcomeMessage?: string;
|
|
1127
|
-
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
|
1128
|
-
origins?: string[];
|
|
1129
|
-
roleArn?: string;
|
|
1130
|
-
identityProviderConfiguration?: IdentityProviderConfiguration;
|
|
1131
|
-
authenticationConfiguration?: WebExperienceAuthConfiguration;
|
|
1132
|
-
error?: ErrorDetail;
|
|
1125
|
+
applicationId?: string | undefined;
|
|
1126
|
+
webExperienceId?: string | undefined;
|
|
1127
|
+
webExperienceArn?: string | undefined;
|
|
1128
|
+
defaultEndpoint?: string | undefined;
|
|
1129
|
+
status?: WebExperienceStatus | undefined;
|
|
1130
|
+
createdAt?: Date | undefined;
|
|
1131
|
+
updatedAt?: Date | undefined;
|
|
1132
|
+
title?: string | undefined;
|
|
1133
|
+
subtitle?: string | undefined;
|
|
1134
|
+
welcomeMessage?: string | undefined;
|
|
1135
|
+
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
1136
|
+
origins?: string[] | undefined;
|
|
1137
|
+
roleArn?: string | undefined;
|
|
1138
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
1139
|
+
authenticationConfiguration?: WebExperienceAuthConfiguration | undefined;
|
|
1140
|
+
error?: ErrorDetail | undefined;
|
|
1133
1141
|
}
|
|
1134
1142
|
export interface ListWebExperiencesRequest {
|
|
1135
1143
|
applicationId: string | undefined;
|
|
1136
|
-
nextToken?: string;
|
|
1137
|
-
maxResults?: number;
|
|
1144
|
+
nextToken?: string | undefined;
|
|
1145
|
+
maxResults?: number | undefined;
|
|
1138
1146
|
}
|
|
1139
1147
|
export interface WebExperience {
|
|
1140
|
-
webExperienceId?: string;
|
|
1141
|
-
createdAt?: Date;
|
|
1142
|
-
updatedAt?: Date;
|
|
1143
|
-
defaultEndpoint?: string;
|
|
1144
|
-
status?: WebExperienceStatus;
|
|
1148
|
+
webExperienceId?: string | undefined;
|
|
1149
|
+
createdAt?: Date | undefined;
|
|
1150
|
+
updatedAt?: Date | undefined;
|
|
1151
|
+
defaultEndpoint?: string | undefined;
|
|
1152
|
+
status?: WebExperienceStatus | undefined;
|
|
1145
1153
|
}
|
|
1146
1154
|
export interface ListWebExperiencesResponse {
|
|
1147
|
-
webExperiences?: WebExperience[];
|
|
1148
|
-
nextToken?: string;
|
|
1155
|
+
webExperiences?: WebExperience[] | undefined;
|
|
1156
|
+
nextToken?: string | undefined;
|
|
1149
1157
|
}
|
|
1150
1158
|
export interface UpdateWebExperienceRequest {
|
|
1151
1159
|
applicationId: string | undefined;
|
|
1152
1160
|
webExperienceId: string | undefined;
|
|
1153
|
-
roleArn?: string;
|
|
1154
|
-
authenticationConfiguration?: WebExperienceAuthConfiguration;
|
|
1155
|
-
title?: string;
|
|
1156
|
-
subtitle?: string;
|
|
1157
|
-
welcomeMessage?: string;
|
|
1158
|
-
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
|
1159
|
-
identityProviderConfiguration?: IdentityProviderConfiguration;
|
|
1160
|
-
origins?: string[];
|
|
1161
|
+
roleArn?: string | undefined;
|
|
1162
|
+
authenticationConfiguration?: WebExperienceAuthConfiguration | undefined;
|
|
1163
|
+
title?: string | undefined;
|
|
1164
|
+
subtitle?: string | undefined;
|
|
1165
|
+
welcomeMessage?: string | undefined;
|
|
1166
|
+
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
|
|
1167
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
1168
|
+
origins?: string[] | undefined;
|
|
1161
1169
|
}
|
|
1162
1170
|
export interface UpdateWebExperienceResponse {}
|
|
1163
1171
|
export declare const CreatorModeControl: {
|
|
@@ -1174,7 +1182,7 @@ export interface AttachmentInput {
|
|
|
1174
1182
|
data: Uint8Array | undefined;
|
|
1175
1183
|
}
|
|
1176
1184
|
export interface AttachmentInputEvent {
|
|
1177
|
-
attachment?: AttachmentInput;
|
|
1185
|
+
attachment?: AttachmentInput | undefined;
|
|
1178
1186
|
}
|
|
1179
1187
|
export declare const AttachmentStatus: {
|
|
1180
1188
|
readonly FAILED: "FAILED";
|
|
@@ -1183,9 +1191,9 @@ export declare const AttachmentStatus: {
|
|
|
1183
1191
|
export type AttachmentStatus =
|
|
1184
1192
|
(typeof AttachmentStatus)[keyof typeof AttachmentStatus];
|
|
1185
1193
|
export interface AttachmentOutput {
|
|
1186
|
-
name?: string;
|
|
1187
|
-
status?: AttachmentStatus;
|
|
1188
|
-
error?: ErrorDetail;
|
|
1194
|
+
name?: string | undefined;
|
|
1195
|
+
status?: AttachmentStatus | undefined;
|
|
1196
|
+
error?: ErrorDetail | undefined;
|
|
1189
1197
|
}
|
|
1190
1198
|
export interface DocumentAttribute {
|
|
1191
1199
|
name: string | undefined;
|
|
@@ -1210,15 +1218,15 @@ export interface BatchDeleteDocumentRequest {
|
|
|
1210
1218
|
applicationId: string | undefined;
|
|
1211
1219
|
indexId: string | undefined;
|
|
1212
1220
|
documents: DeleteDocument[] | undefined;
|
|
1213
|
-
dataSourceSyncId?: string;
|
|
1221
|
+
dataSourceSyncId?: string | undefined;
|
|
1214
1222
|
}
|
|
1215
1223
|
export interface FailedDocument {
|
|
1216
|
-
id?: string;
|
|
1217
|
-
error?: ErrorDetail;
|
|
1218
|
-
dataSourceId?: string;
|
|
1224
|
+
id?: string | undefined;
|
|
1225
|
+
error?: ErrorDetail | undefined;
|
|
1226
|
+
dataSourceId?: string | undefined;
|
|
1219
1227
|
}
|
|
1220
1228
|
export interface BatchDeleteDocumentResponse {
|
|
1221
|
-
failedDocuments?: FailedDocument[];
|
|
1229
|
+
failedDocuments?: FailedDocument[] | undefined;
|
|
1222
1230
|
}
|
|
1223
1231
|
export type DocumentContent =
|
|
1224
1232
|
| DocumentContent.BlobMember
|
|
@@ -1264,31 +1272,31 @@ export declare const ContentType: {
|
|
|
1264
1272
|
export type ContentType = (typeof ContentType)[keyof typeof ContentType];
|
|
1265
1273
|
export interface Document {
|
|
1266
1274
|
id: string | undefined;
|
|
1267
|
-
attributes?: DocumentAttribute[];
|
|
1268
|
-
content?: DocumentContent;
|
|
1269
|
-
contentType?: ContentType;
|
|
1270
|
-
title?: string;
|
|
1271
|
-
accessConfiguration?: AccessConfiguration;
|
|
1272
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
|
1275
|
+
attributes?: DocumentAttribute[] | undefined;
|
|
1276
|
+
content?: DocumentContent | undefined;
|
|
1277
|
+
contentType?: ContentType | undefined;
|
|
1278
|
+
title?: string | undefined;
|
|
1279
|
+
accessConfiguration?: AccessConfiguration | undefined;
|
|
1280
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
|
|
1273
1281
|
}
|
|
1274
1282
|
export interface BatchPutDocumentRequest {
|
|
1275
1283
|
applicationId: string | undefined;
|
|
1276
1284
|
indexId: string | undefined;
|
|
1277
1285
|
documents: Document[] | undefined;
|
|
1278
|
-
roleArn?: string;
|
|
1279
|
-
dataSourceSyncId?: string;
|
|
1286
|
+
roleArn?: string | undefined;
|
|
1287
|
+
dataSourceSyncId?: string | undefined;
|
|
1280
1288
|
}
|
|
1281
1289
|
export interface BatchPutDocumentResponse {
|
|
1282
|
-
failedDocuments?: FailedDocument[];
|
|
1290
|
+
failedDocuments?: FailedDocument[] | undefined;
|
|
1283
1291
|
}
|
|
1284
1292
|
export interface BlockedPhrasesConfiguration {
|
|
1285
|
-
blockedPhrases?: string[];
|
|
1286
|
-
systemMessageOverride?: string;
|
|
1293
|
+
blockedPhrases?: string[] | undefined;
|
|
1294
|
+
systemMessageOverride?: string | undefined;
|
|
1287
1295
|
}
|
|
1288
1296
|
export interface BlockedPhrasesConfigurationUpdate {
|
|
1289
|
-
blockedPhrasesToCreateOrUpdate?: string[];
|
|
1290
|
-
blockedPhrasesToDelete?: string[];
|
|
1291
|
-
systemMessageOverride?: string;
|
|
1297
|
+
blockedPhrasesToCreateOrUpdate?: string[] | undefined;
|
|
1298
|
+
blockedPhrasesToDelete?: string[] | undefined;
|
|
1299
|
+
systemMessageOverride?: string | undefined;
|
|
1292
1300
|
}
|
|
1293
1301
|
export declare const ChatMode: {
|
|
1294
1302
|
readonly CREATOR_MODE: "CREATOR_MODE";
|
|
@@ -1322,39 +1330,39 @@ export interface TextInputEvent {
|
|
|
1322
1330
|
userMessage: string | undefined;
|
|
1323
1331
|
}
|
|
1324
1332
|
export interface FailedAttachmentEvent {
|
|
1325
|
-
conversationId?: string;
|
|
1326
|
-
userMessageId?: string;
|
|
1327
|
-
systemMessageId?: string;
|
|
1328
|
-
attachment?: AttachmentOutput;
|
|
1333
|
+
conversationId?: string | undefined;
|
|
1334
|
+
userMessageId?: string | undefined;
|
|
1335
|
+
systemMessageId?: string | undefined;
|
|
1336
|
+
attachment?: AttachmentOutput | undefined;
|
|
1329
1337
|
}
|
|
1330
1338
|
export interface SnippetExcerpt {
|
|
1331
|
-
text?: string;
|
|
1339
|
+
text?: string | undefined;
|
|
1332
1340
|
}
|
|
1333
1341
|
export interface TextSegment {
|
|
1334
|
-
beginOffset?: number;
|
|
1335
|
-
endOffset?: number;
|
|
1336
|
-
snippetExcerpt?: SnippetExcerpt;
|
|
1342
|
+
beginOffset?: number | undefined;
|
|
1343
|
+
endOffset?: number | undefined;
|
|
1344
|
+
snippetExcerpt?: SnippetExcerpt | undefined;
|
|
1337
1345
|
}
|
|
1338
1346
|
export interface SourceAttribution {
|
|
1339
|
-
title?: string;
|
|
1340
|
-
snippet?: string;
|
|
1341
|
-
url?: string;
|
|
1342
|
-
citationNumber?: number;
|
|
1343
|
-
updatedAt?: Date;
|
|
1344
|
-
textMessageSegments?: TextSegment[];
|
|
1347
|
+
title?: string | undefined;
|
|
1348
|
+
snippet?: string | undefined;
|
|
1349
|
+
url?: string | undefined;
|
|
1350
|
+
citationNumber?: number | undefined;
|
|
1351
|
+
updatedAt?: Date | undefined;
|
|
1352
|
+
textMessageSegments?: TextSegment[] | undefined;
|
|
1345
1353
|
}
|
|
1346
1354
|
export interface MetadataEvent {
|
|
1347
|
-
conversationId?: string;
|
|
1348
|
-
userMessageId?: string;
|
|
1349
|
-
systemMessageId?: string;
|
|
1350
|
-
sourceAttributions?: SourceAttribution[];
|
|
1351
|
-
finalTextMessage?: string;
|
|
1355
|
+
conversationId?: string | undefined;
|
|
1356
|
+
userMessageId?: string | undefined;
|
|
1357
|
+
systemMessageId?: string | undefined;
|
|
1358
|
+
sourceAttributions?: SourceAttribution[] | undefined;
|
|
1359
|
+
finalTextMessage?: string | undefined;
|
|
1352
1360
|
}
|
|
1353
1361
|
export interface TextOutputEvent {
|
|
1354
|
-
conversationId?: string;
|
|
1355
|
-
userMessageId?: string;
|
|
1356
|
-
systemMessageId?: string;
|
|
1357
|
-
systemMessage?: string;
|
|
1362
|
+
conversationId?: string | undefined;
|
|
1363
|
+
userMessageId?: string | undefined;
|
|
1364
|
+
systemMessageId?: string | undefined;
|
|
1365
|
+
systemMessage?: string | undefined;
|
|
1358
1366
|
}
|
|
1359
1367
|
export type ChatOutputStream =
|
|
1360
1368
|
| ChatOutputStream.ActionReviewEventMember
|
|
@@ -1423,7 +1431,7 @@ export declare namespace ChatOutputStream {
|
|
|
1423
1431
|
const visit: <T>(value: ChatOutputStream, visitor: Visitor<T>) => T;
|
|
1424
1432
|
}
|
|
1425
1433
|
export interface ChatOutput {
|
|
1426
|
-
outputStream?: AsyncIterable<ChatOutputStream
|
|
1434
|
+
outputStream?: AsyncIterable<ChatOutputStream> | undefined;
|
|
1427
1435
|
}
|
|
1428
1436
|
export declare class LicenseNotFoundException extends __BaseException {
|
|
1429
1437
|
readonly name: "LicenseNotFoundException";
|
|
@@ -1433,51 +1441,51 @@ export declare class LicenseNotFoundException extends __BaseException {
|
|
|
1433
1441
|
);
|
|
1434
1442
|
}
|
|
1435
1443
|
export interface ChatSyncOutput {
|
|
1436
|
-
conversationId?: string;
|
|
1437
|
-
systemMessage?: string;
|
|
1438
|
-
systemMessageId?: string;
|
|
1439
|
-
userMessageId?: string;
|
|
1440
|
-
actionReview?: ActionReview;
|
|
1441
|
-
authChallengeRequest?: AuthChallengeRequest;
|
|
1442
|
-
sourceAttributions?: SourceAttribution[];
|
|
1443
|
-
failedAttachments?: AttachmentOutput[];
|
|
1444
|
+
conversationId?: string | undefined;
|
|
1445
|
+
systemMessage?: string | undefined;
|
|
1446
|
+
systemMessageId?: string | undefined;
|
|
1447
|
+
userMessageId?: string | undefined;
|
|
1448
|
+
actionReview?: ActionReview | undefined;
|
|
1449
|
+
authChallengeRequest?: AuthChallengeRequest | undefined;
|
|
1450
|
+
sourceAttributions?: SourceAttribution[] | undefined;
|
|
1451
|
+
failedAttachments?: AttachmentOutput[] | undefined;
|
|
1444
1452
|
}
|
|
1445
1453
|
export interface ContentBlockerRule {
|
|
1446
|
-
systemMessageOverride?: string;
|
|
1454
|
+
systemMessageOverride?: string | undefined;
|
|
1447
1455
|
}
|
|
1448
1456
|
export interface EligibleDataSource {
|
|
1449
|
-
indexId?: string;
|
|
1450
|
-
dataSourceId?: string;
|
|
1457
|
+
indexId?: string | undefined;
|
|
1458
|
+
dataSourceId?: string | undefined;
|
|
1451
1459
|
}
|
|
1452
1460
|
export interface ContentRetrievalRule {
|
|
1453
|
-
eligibleDataSources?: EligibleDataSource[];
|
|
1461
|
+
eligibleDataSources?: EligibleDataSource[] | undefined;
|
|
1454
1462
|
}
|
|
1455
1463
|
export interface Conversation {
|
|
1456
|
-
conversationId?: string;
|
|
1457
|
-
title?: string;
|
|
1458
|
-
startTime?: Date;
|
|
1464
|
+
conversationId?: string | undefined;
|
|
1465
|
+
title?: string | undefined;
|
|
1466
|
+
startTime?: Date | undefined;
|
|
1459
1467
|
}
|
|
1460
1468
|
export interface UserAlias {
|
|
1461
|
-
indexId?: string;
|
|
1462
|
-
dataSourceId?: string;
|
|
1469
|
+
indexId?: string | undefined;
|
|
1470
|
+
dataSourceId?: string | undefined;
|
|
1463
1471
|
userId: string | undefined;
|
|
1464
1472
|
}
|
|
1465
1473
|
export interface CreateUserRequest {
|
|
1466
1474
|
applicationId: string | undefined;
|
|
1467
1475
|
userId: string | undefined;
|
|
1468
|
-
userAliases?: UserAlias[];
|
|
1469
|
-
clientToken?: string;
|
|
1476
|
+
userAliases?: UserAlias[] | undefined;
|
|
1477
|
+
clientToken?: string | undefined;
|
|
1470
1478
|
}
|
|
1471
1479
|
export interface CreateUserResponse {}
|
|
1472
1480
|
export interface CreatorModeConfiguration {
|
|
1473
1481
|
creatorModeControl: CreatorModeControl | undefined;
|
|
1474
1482
|
}
|
|
1475
1483
|
export interface DataSourceSyncJobMetrics {
|
|
1476
|
-
documentsAdded?: string;
|
|
1477
|
-
documentsModified?: string;
|
|
1478
|
-
documentsDeleted?: string;
|
|
1479
|
-
documentsFailed?: string;
|
|
1480
|
-
documentsScanned?: string;
|
|
1484
|
+
documentsAdded?: string | undefined;
|
|
1485
|
+
documentsModified?: string | undefined;
|
|
1486
|
+
documentsDeleted?: string | undefined;
|
|
1487
|
+
documentsFailed?: string | undefined;
|
|
1488
|
+
documentsScanned?: string | undefined;
|
|
1481
1489
|
}
|
|
1482
1490
|
export declare const DataSourceSyncJobStatus: {
|
|
1483
1491
|
readonly ABORTED: "ABORTED";
|
|
@@ -1491,13 +1499,13 @@ export declare const DataSourceSyncJobStatus: {
|
|
|
1491
1499
|
export type DataSourceSyncJobStatus =
|
|
1492
1500
|
(typeof DataSourceSyncJobStatus)[keyof typeof DataSourceSyncJobStatus];
|
|
1493
1501
|
export interface DataSourceSyncJob {
|
|
1494
|
-
executionId?: string;
|
|
1495
|
-
startTime?: Date;
|
|
1496
|
-
endTime?: Date;
|
|
1497
|
-
status?: DataSourceSyncJobStatus;
|
|
1498
|
-
error?: ErrorDetail;
|
|
1499
|
-
dataSourceErrorCode?: string;
|
|
1500
|
-
metrics?: DataSourceSyncJobMetrics;
|
|
1502
|
+
executionId?: string | undefined;
|
|
1503
|
+
startTime?: Date | undefined;
|
|
1504
|
+
endTime?: Date | undefined;
|
|
1505
|
+
status?: DataSourceSyncJobStatus | undefined;
|
|
1506
|
+
error?: ErrorDetail | undefined;
|
|
1507
|
+
dataSourceErrorCode?: string | undefined;
|
|
1508
|
+
metrics?: DataSourceSyncJobMetrics | undefined;
|
|
1501
1509
|
}
|
|
1502
1510
|
export interface DeleteChatControlsConfigurationRequest {
|
|
1503
1511
|
applicationId: string | undefined;
|
|
@@ -1506,14 +1514,14 @@ export interface DeleteChatControlsConfigurationResponse {}
|
|
|
1506
1514
|
export interface DeleteConversationRequest {
|
|
1507
1515
|
conversationId: string | undefined;
|
|
1508
1516
|
applicationId: string | undefined;
|
|
1509
|
-
userId?: string;
|
|
1517
|
+
userId?: string | undefined;
|
|
1510
1518
|
}
|
|
1511
1519
|
export interface DeleteConversationResponse {}
|
|
1512
1520
|
export interface DeleteGroupRequest {
|
|
1513
1521
|
applicationId: string | undefined;
|
|
1514
1522
|
indexId: string | undefined;
|
|
1515
1523
|
groupName: string | undefined;
|
|
1516
|
-
dataSourceId?: string;
|
|
1524
|
+
dataSourceId?: string | undefined;
|
|
1517
1525
|
}
|
|
1518
1526
|
export interface DeleteGroupResponse {}
|
|
1519
1527
|
export interface DeleteUserRequest {
|
|
@@ -1534,16 +1542,16 @@ export declare const DocumentStatus: {
|
|
|
1534
1542
|
export type DocumentStatus =
|
|
1535
1543
|
(typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
1536
1544
|
export interface DocumentDetails {
|
|
1537
|
-
documentId?: string;
|
|
1538
|
-
status?: DocumentStatus;
|
|
1539
|
-
error?: ErrorDetail;
|
|
1540
|
-
createdAt?: Date;
|
|
1541
|
-
updatedAt?: Date;
|
|
1545
|
+
documentId?: string | undefined;
|
|
1546
|
+
status?: DocumentStatus | undefined;
|
|
1547
|
+
error?: ErrorDetail | undefined;
|
|
1548
|
+
createdAt?: Date | undefined;
|
|
1549
|
+
updatedAt?: Date | undefined;
|
|
1542
1550
|
}
|
|
1543
1551
|
export interface GetChatControlsConfigurationRequest {
|
|
1544
1552
|
applicationId: string | undefined;
|
|
1545
|
-
maxResults?: number;
|
|
1546
|
-
nextToken?: string;
|
|
1553
|
+
maxResults?: number | undefined;
|
|
1554
|
+
nextToken?: string | undefined;
|
|
1547
1555
|
}
|
|
1548
1556
|
export declare const ResponseScope: {
|
|
1549
1557
|
readonly ENTERPRISE_CONTENT_ONLY: "ENTERPRISE_CONTENT_ONLY";
|
|
@@ -1551,8 +1559,8 @@ export declare const ResponseScope: {
|
|
|
1551
1559
|
};
|
|
1552
1560
|
export type ResponseScope = (typeof ResponseScope)[keyof typeof ResponseScope];
|
|
1553
1561
|
export interface UsersAndGroups {
|
|
1554
|
-
userIds?: string[];
|
|
1555
|
-
userGroups?: string[];
|
|
1562
|
+
userIds?: string[] | undefined;
|
|
1563
|
+
userGroups?: string[] | undefined;
|
|
1556
1564
|
}
|
|
1557
1565
|
export type RuleConfiguration =
|
|
1558
1566
|
| RuleConfiguration.ContentBlockerRuleMember
|
|
@@ -1587,29 +1595,29 @@ export declare const RuleType: {
|
|
|
1587
1595
|
};
|
|
1588
1596
|
export type RuleType = (typeof RuleType)[keyof typeof RuleType];
|
|
1589
1597
|
export interface Rule {
|
|
1590
|
-
includedUsersAndGroups?: UsersAndGroups;
|
|
1591
|
-
excludedUsersAndGroups?: UsersAndGroups;
|
|
1598
|
+
includedUsersAndGroups?: UsersAndGroups | undefined;
|
|
1599
|
+
excludedUsersAndGroups?: UsersAndGroups | undefined;
|
|
1592
1600
|
ruleType: RuleType | undefined;
|
|
1593
|
-
ruleConfiguration?: RuleConfiguration;
|
|
1601
|
+
ruleConfiguration?: RuleConfiguration | undefined;
|
|
1594
1602
|
}
|
|
1595
1603
|
export interface TopicConfiguration {
|
|
1596
1604
|
name: string | undefined;
|
|
1597
|
-
description?: string;
|
|
1598
|
-
exampleChatMessages?: string[];
|
|
1605
|
+
description?: string | undefined;
|
|
1606
|
+
exampleChatMessages?: string[] | undefined;
|
|
1599
1607
|
rules: Rule[] | undefined;
|
|
1600
1608
|
}
|
|
1601
1609
|
export interface GetChatControlsConfigurationResponse {
|
|
1602
|
-
responseScope?: ResponseScope;
|
|
1603
|
-
blockedPhrases?: BlockedPhrasesConfiguration;
|
|
1604
|
-
topicConfigurations?: TopicConfiguration[];
|
|
1605
|
-
creatorModeConfiguration?: AppliedCreatorModeConfiguration;
|
|
1606
|
-
nextToken?: string;
|
|
1610
|
+
responseScope?: ResponseScope | undefined;
|
|
1611
|
+
blockedPhrases?: BlockedPhrasesConfiguration | undefined;
|
|
1612
|
+
topicConfigurations?: TopicConfiguration[] | undefined;
|
|
1613
|
+
creatorModeConfiguration?: AppliedCreatorModeConfiguration | undefined;
|
|
1614
|
+
nextToken?: string | undefined;
|
|
1607
1615
|
}
|
|
1608
1616
|
export interface GetGroupRequest {
|
|
1609
1617
|
applicationId: string | undefined;
|
|
1610
1618
|
indexId: string | undefined;
|
|
1611
1619
|
groupName: string | undefined;
|
|
1612
|
-
dataSourceId?: string;
|
|
1620
|
+
dataSourceId?: string | undefined;
|
|
1613
1621
|
}
|
|
1614
1622
|
export declare const GroupStatus: {
|
|
1615
1623
|
readonly DELETED: "DELETED";
|
|
@@ -1620,77 +1628,77 @@ export declare const GroupStatus: {
|
|
|
1620
1628
|
};
|
|
1621
1629
|
export type GroupStatus = (typeof GroupStatus)[keyof typeof GroupStatus];
|
|
1622
1630
|
export interface GroupStatusDetail {
|
|
1623
|
-
status?: GroupStatus;
|
|
1624
|
-
lastUpdatedAt?: Date;
|
|
1625
|
-
errorDetail?: ErrorDetail;
|
|
1631
|
+
status?: GroupStatus | undefined;
|
|
1632
|
+
lastUpdatedAt?: Date | undefined;
|
|
1633
|
+
errorDetail?: ErrorDetail | undefined;
|
|
1626
1634
|
}
|
|
1627
1635
|
export interface GetGroupResponse {
|
|
1628
|
-
status?: GroupStatusDetail;
|
|
1629
|
-
statusHistory?: GroupStatusDetail[];
|
|
1636
|
+
status?: GroupStatusDetail | undefined;
|
|
1637
|
+
statusHistory?: GroupStatusDetail[] | undefined;
|
|
1630
1638
|
}
|
|
1631
1639
|
export interface GetUserRequest {
|
|
1632
1640
|
applicationId: string | undefined;
|
|
1633
1641
|
userId: string | undefined;
|
|
1634
1642
|
}
|
|
1635
1643
|
export interface GetUserResponse {
|
|
1636
|
-
userAliases?: UserAlias[];
|
|
1644
|
+
userAliases?: UserAlias[] | undefined;
|
|
1637
1645
|
}
|
|
1638
1646
|
export interface ListConversationsRequest {
|
|
1639
1647
|
applicationId: string | undefined;
|
|
1640
|
-
userId?: string;
|
|
1641
|
-
nextToken?: string;
|
|
1642
|
-
maxResults?: number;
|
|
1648
|
+
userId?: string | undefined;
|
|
1649
|
+
nextToken?: string | undefined;
|
|
1650
|
+
maxResults?: number | undefined;
|
|
1643
1651
|
}
|
|
1644
1652
|
export interface ListConversationsResponse {
|
|
1645
|
-
nextToken?: string;
|
|
1646
|
-
conversations?: Conversation[];
|
|
1653
|
+
nextToken?: string | undefined;
|
|
1654
|
+
conversations?: Conversation[] | undefined;
|
|
1647
1655
|
}
|
|
1648
1656
|
export interface ListDataSourceSyncJobsRequest {
|
|
1649
1657
|
dataSourceId: string | undefined;
|
|
1650
1658
|
applicationId: string | undefined;
|
|
1651
1659
|
indexId: string | undefined;
|
|
1652
|
-
nextToken?: string;
|
|
1653
|
-
maxResults?: number;
|
|
1654
|
-
startTime?: Date;
|
|
1655
|
-
endTime?: Date;
|
|
1656
|
-
statusFilter?: DataSourceSyncJobStatus;
|
|
1660
|
+
nextToken?: string | undefined;
|
|
1661
|
+
maxResults?: number | undefined;
|
|
1662
|
+
startTime?: Date | undefined;
|
|
1663
|
+
endTime?: Date | undefined;
|
|
1664
|
+
statusFilter?: DataSourceSyncJobStatus | undefined;
|
|
1657
1665
|
}
|
|
1658
1666
|
export interface ListDataSourceSyncJobsResponse {
|
|
1659
|
-
history?: DataSourceSyncJob[];
|
|
1660
|
-
nextToken?: string;
|
|
1667
|
+
history?: DataSourceSyncJob[] | undefined;
|
|
1668
|
+
nextToken?: string | undefined;
|
|
1661
1669
|
}
|
|
1662
1670
|
export interface ListDocumentsRequest {
|
|
1663
1671
|
applicationId: string | undefined;
|
|
1664
1672
|
indexId: string | undefined;
|
|
1665
|
-
dataSourceIds?: string[];
|
|
1666
|
-
nextToken?: string;
|
|
1667
|
-
maxResults?: number;
|
|
1673
|
+
dataSourceIds?: string[] | undefined;
|
|
1674
|
+
nextToken?: string | undefined;
|
|
1675
|
+
maxResults?: number | undefined;
|
|
1668
1676
|
}
|
|
1669
1677
|
export interface ListDocumentsResponse {
|
|
1670
|
-
documentDetailList?: DocumentDetails[];
|
|
1671
|
-
nextToken?: string;
|
|
1678
|
+
documentDetailList?: DocumentDetails[] | undefined;
|
|
1679
|
+
nextToken?: string | undefined;
|
|
1672
1680
|
}
|
|
1673
1681
|
export interface ListGroupsRequest {
|
|
1674
1682
|
applicationId: string | undefined;
|
|
1675
1683
|
indexId: string | undefined;
|
|
1676
1684
|
updatedEarlierThan: Date | undefined;
|
|
1677
|
-
dataSourceId?: string;
|
|
1678
|
-
nextToken?: string;
|
|
1679
|
-
maxResults?: number;
|
|
1685
|
+
dataSourceId?: string | undefined;
|
|
1686
|
+
nextToken?: string | undefined;
|
|
1687
|
+
maxResults?: number | undefined;
|
|
1680
1688
|
}
|
|
1681
1689
|
export interface GroupSummary {
|
|
1682
|
-
groupName?: string;
|
|
1690
|
+
groupName?: string | undefined;
|
|
1683
1691
|
}
|
|
1684
1692
|
export interface ListGroupsResponse {
|
|
1685
|
-
nextToken?: string;
|
|
1686
|
-
items?: GroupSummary[];
|
|
1693
|
+
nextToken?: string | undefined;
|
|
1694
|
+
items?: GroupSummary[] | undefined;
|
|
1687
1695
|
}
|
|
1688
1696
|
export interface ListMessagesRequest {
|
|
1689
1697
|
conversationId: string | undefined;
|
|
1690
1698
|
applicationId: string | undefined;
|
|
1691
|
-
userId?: string;
|
|
1692
|
-
nextToken?: string;
|
|
1693
|
-
maxResults?: number;
|
|
1699
|
+
userId?: string | undefined;
|
|
1700
|
+
nextToken?: string | undefined;
|
|
1701
|
+
maxResults?: number | undefined;
|
|
1694
1702
|
}
|
|
1695
1703
|
export declare const MessageType: {
|
|
1696
1704
|
readonly SYSTEM: "SYSTEM";
|
|
@@ -1698,24 +1706,24 @@ export declare const MessageType: {
|
|
|
1698
1706
|
};
|
|
1699
1707
|
export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
1700
1708
|
export interface Message {
|
|
1701
|
-
messageId?: string;
|
|
1702
|
-
body?: string;
|
|
1703
|
-
time?: Date;
|
|
1704
|
-
type?: MessageType;
|
|
1705
|
-
attachments?: AttachmentOutput[];
|
|
1706
|
-
sourceAttribution?: SourceAttribution[];
|
|
1707
|
-
actionReview?: ActionReview;
|
|
1708
|
-
actionExecution?: ActionExecution;
|
|
1709
|
+
messageId?: string | undefined;
|
|
1710
|
+
body?: string | undefined;
|
|
1711
|
+
time?: Date | undefined;
|
|
1712
|
+
type?: MessageType | undefined;
|
|
1713
|
+
attachments?: AttachmentOutput[] | undefined;
|
|
1714
|
+
sourceAttribution?: SourceAttribution[] | undefined;
|
|
1715
|
+
actionReview?: ActionReview | undefined;
|
|
1716
|
+
actionExecution?: ActionExecution | undefined;
|
|
1709
1717
|
}
|
|
1710
1718
|
export interface ListMessagesResponse {
|
|
1711
|
-
messages?: Message[];
|
|
1712
|
-
nextToken?: string;
|
|
1719
|
+
messages?: Message[] | undefined;
|
|
1720
|
+
nextToken?: string | undefined;
|
|
1713
1721
|
}
|
|
1714
1722
|
export interface ListTagsForResourceRequest {
|
|
1715
1723
|
resourceARN: string | undefined;
|
|
1716
1724
|
}
|
|
1717
1725
|
export interface ListTagsForResourceResponse {
|
|
1718
|
-
tags?: Tag[];
|
|
1726
|
+
tags?: Tag[] | undefined;
|
|
1719
1727
|
}
|
|
1720
1728
|
export declare const MessageUsefulnessReason: {
|
|
1721
1729
|
readonly COMPLETE: "COMPLETE";
|
|
@@ -1741,39 +1749,39 @@ export type MessageUsefulness =
|
|
|
1741
1749
|
(typeof MessageUsefulness)[keyof typeof MessageUsefulness];
|
|
1742
1750
|
export interface MessageUsefulnessFeedback {
|
|
1743
1751
|
usefulness: MessageUsefulness | undefined;
|
|
1744
|
-
reason?: MessageUsefulnessReason;
|
|
1745
|
-
comment?: string;
|
|
1752
|
+
reason?: MessageUsefulnessReason | undefined;
|
|
1753
|
+
comment?: string | undefined;
|
|
1746
1754
|
submittedAt: Date | undefined;
|
|
1747
1755
|
}
|
|
1748
1756
|
export interface PutFeedbackRequest {
|
|
1749
1757
|
applicationId: string | undefined;
|
|
1750
|
-
userId?: string;
|
|
1758
|
+
userId?: string | undefined;
|
|
1751
1759
|
conversationId: string | undefined;
|
|
1752
1760
|
messageId: string | undefined;
|
|
1753
|
-
messageCopiedAt?: Date;
|
|
1754
|
-
messageUsefulness?: MessageUsefulnessFeedback;
|
|
1761
|
+
messageCopiedAt?: Date | undefined;
|
|
1762
|
+
messageUsefulness?: MessageUsefulnessFeedback | undefined;
|
|
1755
1763
|
}
|
|
1756
1764
|
export interface MemberGroup {
|
|
1757
1765
|
groupName: string | undefined;
|
|
1758
|
-
type?: MembershipType;
|
|
1766
|
+
type?: MembershipType | undefined;
|
|
1759
1767
|
}
|
|
1760
1768
|
export interface MemberUser {
|
|
1761
1769
|
userId: string | undefined;
|
|
1762
|
-
type?: MembershipType;
|
|
1770
|
+
type?: MembershipType | undefined;
|
|
1763
1771
|
}
|
|
1764
1772
|
export interface GroupMembers {
|
|
1765
|
-
memberGroups?: MemberGroup[];
|
|
1766
|
-
memberUsers?: MemberUser[];
|
|
1767
|
-
s3PathForGroupMembers?: S3;
|
|
1773
|
+
memberGroups?: MemberGroup[] | undefined;
|
|
1774
|
+
memberUsers?: MemberUser[] | undefined;
|
|
1775
|
+
s3PathForGroupMembers?: S3 | undefined;
|
|
1768
1776
|
}
|
|
1769
1777
|
export interface PutGroupRequest {
|
|
1770
1778
|
applicationId: string | undefined;
|
|
1771
1779
|
indexId: string | undefined;
|
|
1772
1780
|
groupName: string | undefined;
|
|
1773
|
-
dataSourceId?: string;
|
|
1781
|
+
dataSourceId?: string | undefined;
|
|
1774
1782
|
type: MembershipType | undefined;
|
|
1775
1783
|
groupMembers: GroupMembers | undefined;
|
|
1776
|
-
roleArn?: string;
|
|
1784
|
+
roleArn?: string | undefined;
|
|
1777
1785
|
}
|
|
1778
1786
|
export interface PutGroupResponse {}
|
|
1779
1787
|
export interface StartDataSourceSyncJobRequest {
|
|
@@ -1782,7 +1790,7 @@ export interface StartDataSourceSyncJobRequest {
|
|
|
1782
1790
|
indexId: string | undefined;
|
|
1783
1791
|
}
|
|
1784
1792
|
export interface StartDataSourceSyncJobResponse {
|
|
1785
|
-
executionId?: string;
|
|
1793
|
+
executionId?: string | undefined;
|
|
1786
1794
|
}
|
|
1787
1795
|
export interface StopDataSourceSyncJobRequest {
|
|
1788
1796
|
dataSourceId: string | undefined;
|
|
@@ -1802,56 +1810,58 @@ export interface UntagResourceRequest {
|
|
|
1802
1810
|
export interface UntagResourceResponse {}
|
|
1803
1811
|
export interface UpdateChatControlsConfigurationRequest {
|
|
1804
1812
|
applicationId: string | undefined;
|
|
1805
|
-
clientToken?: string;
|
|
1806
|
-
responseScope?: ResponseScope;
|
|
1807
|
-
blockedPhrasesConfigurationUpdate?:
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
|
|
1813
|
+
clientToken?: string | undefined;
|
|
1814
|
+
responseScope?: ResponseScope | undefined;
|
|
1815
|
+
blockedPhrasesConfigurationUpdate?:
|
|
1816
|
+
| BlockedPhrasesConfigurationUpdate
|
|
1817
|
+
| undefined;
|
|
1818
|
+
topicConfigurationsToCreateOrUpdate?: TopicConfiguration[] | undefined;
|
|
1819
|
+
topicConfigurationsToDelete?: TopicConfiguration[] | undefined;
|
|
1820
|
+
creatorModeConfiguration?: CreatorModeConfiguration | undefined;
|
|
1811
1821
|
}
|
|
1812
1822
|
export interface UpdateChatControlsConfigurationResponse {}
|
|
1813
1823
|
export interface UpdateUserRequest {
|
|
1814
1824
|
applicationId: string | undefined;
|
|
1815
1825
|
userId: string | undefined;
|
|
1816
|
-
userAliasesToUpdate?: UserAlias[];
|
|
1817
|
-
userAliasesToDelete?: UserAlias[];
|
|
1826
|
+
userAliasesToUpdate?: UserAlias[] | undefined;
|
|
1827
|
+
userAliasesToDelete?: UserAlias[] | undefined;
|
|
1818
1828
|
}
|
|
1819
1829
|
export interface UpdateUserResponse {
|
|
1820
|
-
userAliasesAdded?: UserAlias[];
|
|
1821
|
-
userAliasesUpdated?: UserAlias[];
|
|
1822
|
-
userAliasesDeleted?: UserAlias[];
|
|
1830
|
+
userAliasesAdded?: UserAlias[] | undefined;
|
|
1831
|
+
userAliasesUpdated?: UserAlias[] | undefined;
|
|
1832
|
+
userAliasesDeleted?: UserAlias[] | undefined;
|
|
1823
1833
|
}
|
|
1824
1834
|
export interface AttributeFilter {
|
|
1825
|
-
andAllFilters?: AttributeFilter[];
|
|
1826
|
-
orAllFilters?: AttributeFilter[];
|
|
1827
|
-
notFilter?: AttributeFilter;
|
|
1828
|
-
equalsTo?: DocumentAttribute;
|
|
1829
|
-
containsAll?: DocumentAttribute;
|
|
1830
|
-
containsAny?: DocumentAttribute;
|
|
1831
|
-
greaterThan?: DocumentAttribute;
|
|
1832
|
-
greaterThanOrEquals?: DocumentAttribute;
|
|
1833
|
-
lessThan?: DocumentAttribute;
|
|
1834
|
-
lessThanOrEquals?: DocumentAttribute;
|
|
1835
|
+
andAllFilters?: AttributeFilter[] | undefined;
|
|
1836
|
+
orAllFilters?: AttributeFilter[] | undefined;
|
|
1837
|
+
notFilter?: AttributeFilter | undefined;
|
|
1838
|
+
equalsTo?: DocumentAttribute | undefined;
|
|
1839
|
+
containsAll?: DocumentAttribute | undefined;
|
|
1840
|
+
containsAny?: DocumentAttribute | undefined;
|
|
1841
|
+
greaterThan?: DocumentAttribute | undefined;
|
|
1842
|
+
greaterThanOrEquals?: DocumentAttribute | undefined;
|
|
1843
|
+
lessThan?: DocumentAttribute | undefined;
|
|
1844
|
+
lessThanOrEquals?: DocumentAttribute | undefined;
|
|
1835
1845
|
}
|
|
1836
1846
|
export interface ChatSyncInput {
|
|
1837
1847
|
applicationId: string | undefined;
|
|
1838
|
-
userId?: string;
|
|
1839
|
-
userGroups?: string[];
|
|
1840
|
-
userMessage?: string;
|
|
1841
|
-
attachments?: AttachmentInput[];
|
|
1842
|
-
actionExecution?: ActionExecution;
|
|
1843
|
-
authChallengeResponse?: AuthChallengeResponse;
|
|
1844
|
-
conversationId?: string;
|
|
1845
|
-
parentMessageId?: string;
|
|
1846
|
-
attributeFilter?: AttributeFilter;
|
|
1847
|
-
chatMode?: ChatMode;
|
|
1848
|
-
chatModeConfiguration?: ChatModeConfiguration;
|
|
1849
|
-
clientToken?: string;
|
|
1848
|
+
userId?: string | undefined;
|
|
1849
|
+
userGroups?: string[] | undefined;
|
|
1850
|
+
userMessage?: string | undefined;
|
|
1851
|
+
attachments?: AttachmentInput[] | undefined;
|
|
1852
|
+
actionExecution?: ActionExecution | undefined;
|
|
1853
|
+
authChallengeResponse?: AuthChallengeResponse | undefined;
|
|
1854
|
+
conversationId?: string | undefined;
|
|
1855
|
+
parentMessageId?: string | undefined;
|
|
1856
|
+
attributeFilter?: AttributeFilter | undefined;
|
|
1857
|
+
chatMode?: ChatMode | undefined;
|
|
1858
|
+
chatModeConfiguration?: ChatModeConfiguration | undefined;
|
|
1859
|
+
clientToken?: string | undefined;
|
|
1850
1860
|
}
|
|
1851
1861
|
export interface ConfigurationEvent {
|
|
1852
|
-
chatMode?: ChatMode;
|
|
1853
|
-
chatModeConfiguration?: ChatModeConfiguration;
|
|
1854
|
-
attributeFilter?: AttributeFilter;
|
|
1862
|
+
chatMode?: ChatMode | undefined;
|
|
1863
|
+
chatModeConfiguration?: ChatModeConfiguration | undefined;
|
|
1864
|
+
attributeFilter?: AttributeFilter | undefined;
|
|
1855
1865
|
}
|
|
1856
1866
|
export type ChatInputStream =
|
|
1857
1867
|
| ChatInputStream.ActionExecutionEventMember
|
|
@@ -1938,12 +1948,12 @@ export declare namespace ChatInputStream {
|
|
|
1938
1948
|
}
|
|
1939
1949
|
export interface ChatInput {
|
|
1940
1950
|
applicationId: string | undefined;
|
|
1941
|
-
userId?: string;
|
|
1942
|
-
userGroups?: string[];
|
|
1943
|
-
conversationId?: string;
|
|
1944
|
-
parentMessageId?: string;
|
|
1945
|
-
clientToken?: string;
|
|
1946
|
-
inputStream?: AsyncIterable<ChatInputStream
|
|
1951
|
+
userId?: string | undefined;
|
|
1952
|
+
userGroups?: string[] | undefined;
|
|
1953
|
+
conversationId?: string | undefined;
|
|
1954
|
+
parentMessageId?: string | undefined;
|
|
1955
|
+
clientToken?: string | undefined;
|
|
1956
|
+
inputStream?: AsyncIterable<ChatInputStream> | undefined;
|
|
1947
1957
|
}
|
|
1948
1958
|
export declare const APISchemaFilterSensitiveLog: (obj: APISchema) => any;
|
|
1949
1959
|
export declare const EncryptionConfigurationFilterSensitiveLog: (
|