@aws-sdk/client-kendra 3.428.0 → 3.429.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.
|
@@ -27,7 +27,7 @@ export interface Highlight {
|
|
|
27
27
|
BeginOffset: number | undefined;
|
|
28
28
|
EndOffset: number | undefined;
|
|
29
29
|
TopAnswer?: boolean;
|
|
30
|
-
Type?: HighlightType
|
|
30
|
+
Type?: HighlightType;
|
|
31
31
|
}
|
|
32
32
|
export interface TextWithHighlights {
|
|
33
33
|
Text?: string;
|
|
@@ -43,7 +43,7 @@ export type AdditionalResultAttributeValueType =
|
|
|
43
43
|
(typeof AdditionalResultAttributeValueType)[keyof typeof AdditionalResultAttributeValueType];
|
|
44
44
|
export interface AdditionalResultAttribute {
|
|
45
45
|
Key: string | undefined;
|
|
46
|
-
ValueType: AdditionalResultAttributeValueType |
|
|
46
|
+
ValueType: AdditionalResultAttributeValueType | undefined;
|
|
47
47
|
Value: AdditionalResultAttributeValue | undefined;
|
|
48
48
|
}
|
|
49
49
|
export interface DataSourceToIndexFieldMapping {
|
|
@@ -73,7 +73,7 @@ export interface AlfrescoConfiguration {
|
|
|
73
73
|
SslCertificateS3Path: S3Path | undefined;
|
|
74
74
|
CrawlSystemFolders?: boolean;
|
|
75
75
|
CrawlComments?: boolean;
|
|
76
|
-
EntityFilter?:
|
|
76
|
+
EntityFilter?: AlfrescoEntity[];
|
|
77
77
|
DocumentLibraryFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
78
78
|
BlogFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
79
79
|
WikiFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
@@ -88,7 +88,7 @@ export declare const EntityType: {
|
|
|
88
88
|
export type EntityType = (typeof EntityType)[keyof typeof EntityType];
|
|
89
89
|
export interface EntityConfiguration {
|
|
90
90
|
EntityId: string | undefined;
|
|
91
|
-
EntityType: EntityType |
|
|
91
|
+
EntityType: EntityType | undefined;
|
|
92
92
|
}
|
|
93
93
|
export interface AssociateEntitiesToExperienceRequest {
|
|
94
94
|
Id: string | undefined;
|
|
@@ -149,7 +149,7 @@ export declare const Persona: {
|
|
|
149
149
|
export type Persona = (typeof Persona)[keyof typeof Persona];
|
|
150
150
|
export interface EntityPersonaConfiguration {
|
|
151
151
|
EntityId: string | undefined;
|
|
152
|
-
Persona: Persona |
|
|
152
|
+
Persona: Persona | undefined;
|
|
153
153
|
}
|
|
154
154
|
export interface AssociatePersonasToEntitiesRequest {
|
|
155
155
|
Id: string | undefined;
|
|
@@ -181,7 +181,7 @@ export interface SuggestableConfig {
|
|
|
181
181
|
}
|
|
182
182
|
export interface AttributeSuggestionsDescribeConfig {
|
|
183
183
|
SuggestableConfigList?: SuggestableConfig[];
|
|
184
|
-
AttributeSuggestionsMode?: AttributeSuggestionsMode
|
|
184
|
+
AttributeSuggestionsMode?: AttributeSuggestionsMode;
|
|
185
185
|
}
|
|
186
186
|
export interface DataSourceGroup {
|
|
187
187
|
GroupId: string | undefined;
|
|
@@ -195,7 +195,7 @@ export interface UserContext {
|
|
|
195
195
|
}
|
|
196
196
|
export interface AttributeSuggestionsUpdateConfig {
|
|
197
197
|
SuggestableConfigList?: SuggestableConfig[];
|
|
198
|
-
AttributeSuggestionsMode?: AttributeSuggestionsMode
|
|
198
|
+
AttributeSuggestionsMode?: AttributeSuggestionsMode;
|
|
199
199
|
}
|
|
200
200
|
export interface BasicAuthenticationConfiguration {
|
|
201
201
|
Host: string | undefined;
|
|
@@ -221,7 +221,7 @@ export declare const ErrorCode: {
|
|
|
221
221
|
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
222
222
|
export interface BatchDeleteDocumentResponseFailedDocument {
|
|
223
223
|
Id?: string;
|
|
224
|
-
ErrorCode?: ErrorCode
|
|
224
|
+
ErrorCode?: ErrorCode;
|
|
225
225
|
ErrorMessage?: string;
|
|
226
226
|
}
|
|
227
227
|
export interface BatchDeleteDocumentResponse {
|
|
@@ -239,7 +239,7 @@ export interface BatchDeleteFeaturedResultsSetRequest {
|
|
|
239
239
|
}
|
|
240
240
|
export interface BatchDeleteFeaturedResultsSetError {
|
|
241
241
|
Id: string | undefined;
|
|
242
|
-
ErrorCode: ErrorCode |
|
|
242
|
+
ErrorCode: ErrorCode | undefined;
|
|
243
243
|
ErrorMessage: string | undefined;
|
|
244
244
|
}
|
|
245
245
|
export interface BatchDeleteFeaturedResultsSetResponse {
|
|
@@ -265,13 +265,13 @@ export type DocumentStatus =
|
|
|
265
265
|
(typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
266
266
|
export interface Status {
|
|
267
267
|
DocumentId?: string;
|
|
268
|
-
DocumentStatus?: DocumentStatus
|
|
268
|
+
DocumentStatus?: DocumentStatus;
|
|
269
269
|
FailureCode?: string;
|
|
270
270
|
FailureReason?: string;
|
|
271
271
|
}
|
|
272
272
|
export interface BatchGetDocumentStatusResponseError {
|
|
273
273
|
DocumentId?: string;
|
|
274
|
-
ErrorCode?: ErrorCode
|
|
274
|
+
ErrorCode?: ErrorCode;
|
|
275
275
|
ErrorMessage?: string;
|
|
276
276
|
}
|
|
277
277
|
export interface BatchGetDocumentStatusResponse {
|
|
@@ -295,7 +295,7 @@ export type ConditionOperator =
|
|
|
295
295
|
(typeof ConditionOperator)[keyof typeof ConditionOperator];
|
|
296
296
|
export interface DocumentAttributeCondition {
|
|
297
297
|
ConditionDocumentAttributeKey: string | undefined;
|
|
298
|
-
Operator: ConditionOperator |
|
|
298
|
+
Operator: ConditionOperator | undefined;
|
|
299
299
|
ConditionOnValue?: DocumentAttributeValue;
|
|
300
300
|
}
|
|
301
301
|
export interface DocumentAttributeTarget {
|
|
@@ -332,8 +332,8 @@ export declare const PrincipalType: {
|
|
|
332
332
|
export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
|
|
333
333
|
export interface Principal {
|
|
334
334
|
Name: string | undefined;
|
|
335
|
-
Type: PrincipalType |
|
|
336
|
-
Access: ReadAccessType |
|
|
335
|
+
Type: PrincipalType | undefined;
|
|
336
|
+
Access: ReadAccessType | undefined;
|
|
337
337
|
DataSourceId?: string;
|
|
338
338
|
}
|
|
339
339
|
export declare const ContentType: {
|
|
@@ -362,7 +362,7 @@ export interface Document {
|
|
|
362
362
|
Attributes?: DocumentAttribute[];
|
|
363
363
|
AccessControlList?: Principal[];
|
|
364
364
|
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
365
|
-
ContentType?: ContentType
|
|
365
|
+
ContentType?: ContentType;
|
|
366
366
|
AccessControlConfigurationId?: string;
|
|
367
367
|
}
|
|
368
368
|
export interface BatchPutDocumentRequest {
|
|
@@ -373,7 +373,7 @@ export interface BatchPutDocumentRequest {
|
|
|
373
373
|
}
|
|
374
374
|
export interface BatchPutDocumentResponseFailedDocument {
|
|
375
375
|
Id?: string;
|
|
376
|
-
ErrorCode?: ErrorCode
|
|
376
|
+
ErrorCode?: ErrorCode;
|
|
377
377
|
ErrorMessage?: string;
|
|
378
378
|
}
|
|
379
379
|
export interface BatchPutDocumentResponse {
|
|
@@ -432,7 +432,7 @@ export declare const ConfluenceAttachmentFieldName: {
|
|
|
432
432
|
export type ConfluenceAttachmentFieldName =
|
|
433
433
|
(typeof ConfluenceAttachmentFieldName)[keyof typeof ConfluenceAttachmentFieldName];
|
|
434
434
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
435
|
-
DataSourceFieldName?: ConfluenceAttachmentFieldName
|
|
435
|
+
DataSourceFieldName?: ConfluenceAttachmentFieldName;
|
|
436
436
|
DateFieldFormat?: string;
|
|
437
437
|
IndexFieldName?: string;
|
|
438
438
|
}
|
|
@@ -460,7 +460,7 @@ export declare const ConfluenceBlogFieldName: {
|
|
|
460
460
|
export type ConfluenceBlogFieldName =
|
|
461
461
|
(typeof ConfluenceBlogFieldName)[keyof typeof ConfluenceBlogFieldName];
|
|
462
462
|
export interface ConfluenceBlogToIndexFieldMapping {
|
|
463
|
-
DataSourceFieldName?: ConfluenceBlogFieldName
|
|
463
|
+
DataSourceFieldName?: ConfluenceBlogFieldName;
|
|
464
464
|
DateFieldFormat?: string;
|
|
465
465
|
IndexFieldName?: string;
|
|
466
466
|
}
|
|
@@ -484,7 +484,7 @@ export declare const ConfluencePageFieldName: {
|
|
|
484
484
|
export type ConfluencePageFieldName =
|
|
485
485
|
(typeof ConfluencePageFieldName)[keyof typeof ConfluencePageFieldName];
|
|
486
486
|
export interface ConfluencePageToIndexFieldMapping {
|
|
487
|
-
DataSourceFieldName?: ConfluencePageFieldName
|
|
487
|
+
DataSourceFieldName?: ConfluencePageFieldName;
|
|
488
488
|
DateFieldFormat?: string;
|
|
489
489
|
IndexFieldName?: string;
|
|
490
490
|
}
|
|
@@ -505,7 +505,7 @@ export declare const ConfluenceSpaceFieldName: {
|
|
|
505
505
|
export type ConfluenceSpaceFieldName =
|
|
506
506
|
(typeof ConfluenceSpaceFieldName)[keyof typeof ConfluenceSpaceFieldName];
|
|
507
507
|
export interface ConfluenceSpaceToIndexFieldMapping {
|
|
508
|
-
DataSourceFieldName?: ConfluenceSpaceFieldName
|
|
508
|
+
DataSourceFieldName?: ConfluenceSpaceFieldName;
|
|
509
509
|
DateFieldFormat?: string;
|
|
510
510
|
IndexFieldName?: string;
|
|
511
511
|
}
|
|
@@ -525,7 +525,7 @@ export type ConfluenceVersion =
|
|
|
525
525
|
export interface ConfluenceConfiguration {
|
|
526
526
|
ServerUrl: string | undefined;
|
|
527
527
|
SecretArn: string | undefined;
|
|
528
|
-
Version: ConfluenceVersion |
|
|
528
|
+
Version: ConfluenceVersion | undefined;
|
|
529
529
|
SpaceConfiguration?: ConfluenceSpaceConfiguration;
|
|
530
530
|
PageConfiguration?: ConfluencePageConfiguration;
|
|
531
531
|
BlogConfiguration?: ConfluenceBlogConfiguration;
|
|
@@ -534,7 +534,7 @@ export interface ConfluenceConfiguration {
|
|
|
534
534
|
InclusionPatterns?: string[];
|
|
535
535
|
ExclusionPatterns?: string[];
|
|
536
536
|
ProxyConfiguration?: ProxyConfiguration;
|
|
537
|
-
AuthenticationType?: ConfluenceAuthenticationType
|
|
537
|
+
AuthenticationType?: ConfluenceAuthenticationType;
|
|
538
538
|
}
|
|
539
539
|
export interface ColumnConfiguration {
|
|
540
540
|
DocumentIdColumnName: string | undefined;
|
|
@@ -565,10 +565,10 @@ export declare const QueryIdentifiersEnclosingOption: {
|
|
|
565
565
|
export type QueryIdentifiersEnclosingOption =
|
|
566
566
|
(typeof QueryIdentifiersEnclosingOption)[keyof typeof QueryIdentifiersEnclosingOption];
|
|
567
567
|
export interface SqlConfiguration {
|
|
568
|
-
QueryIdentifiersEnclosingOption?: QueryIdentifiersEnclosingOption
|
|
568
|
+
QueryIdentifiersEnclosingOption?: QueryIdentifiersEnclosingOption;
|
|
569
569
|
}
|
|
570
570
|
export interface DatabaseConfiguration {
|
|
571
|
-
DatabaseEngineType: DatabaseEngineType |
|
|
571
|
+
DatabaseEngineType: DatabaseEngineType | undefined;
|
|
572
572
|
ConnectionConfiguration: ConnectionConfiguration | undefined;
|
|
573
573
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
574
574
|
ColumnConfiguration: ColumnConfiguration | undefined;
|
|
@@ -582,7 +582,7 @@ export type FsxFileSystemType =
|
|
|
582
582
|
(typeof FsxFileSystemType)[keyof typeof FsxFileSystemType];
|
|
583
583
|
export interface FsxConfiguration {
|
|
584
584
|
FileSystemId: string | undefined;
|
|
585
|
-
FileSystemType: FsxFileSystemType |
|
|
585
|
+
FileSystemType: FsxFileSystemType | undefined;
|
|
586
586
|
VpcConfiguration: DataSourceVpcConfiguration | undefined;
|
|
587
587
|
SecretArn?: string;
|
|
588
588
|
InclusionPatterns?: string[];
|
|
@@ -615,7 +615,7 @@ export type Type = (typeof Type)[keyof typeof Type];
|
|
|
615
615
|
export interface GitHubConfiguration {
|
|
616
616
|
SaaSConfiguration?: SaaSConfiguration;
|
|
617
617
|
OnPremiseConfiguration?: OnPremiseConfiguration;
|
|
618
|
-
Type?: Type
|
|
618
|
+
Type?: Type;
|
|
619
619
|
SecretArn: string | undefined;
|
|
620
620
|
UseChangeLog?: boolean;
|
|
621
621
|
GitHubDocumentCrawlProperties?: GitHubDocumentCrawlProperties;
|
|
@@ -659,7 +659,7 @@ export interface JiraConfiguration {
|
|
|
659
659
|
Project?: string[];
|
|
660
660
|
IssueType?: string[];
|
|
661
661
|
Status?: string[];
|
|
662
|
-
IssueSubEntityFilter?:
|
|
662
|
+
IssueSubEntityFilter?: IssueSubEntity[];
|
|
663
663
|
AttachmentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
664
664
|
CommentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
665
665
|
IssueFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
@@ -717,7 +717,7 @@ export interface SalesforceChatterFeedConfiguration {
|
|
|
717
717
|
DocumentDataFieldName: string | undefined;
|
|
718
718
|
DocumentTitleFieldName?: string;
|
|
719
719
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
720
|
-
IncludeFilterTypes?:
|
|
720
|
+
IncludeFilterTypes?: SalesforceChatterFeedIncludeFilterType[];
|
|
721
721
|
}
|
|
722
722
|
export interface SalesforceCustomKnowledgeArticleTypeConfiguration {
|
|
723
723
|
Name: string | undefined;
|
|
@@ -738,7 +738,7 @@ export interface SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
|
738
738
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
739
739
|
}
|
|
740
740
|
export interface SalesforceKnowledgeArticleConfiguration {
|
|
741
|
-
IncludedStates:
|
|
741
|
+
IncludedStates: SalesforceKnowledgeArticleState[] | undefined;
|
|
742
742
|
StandardKnowledgeArticleTypeConfiguration?: SalesforceStandardKnowledgeArticleTypeConfiguration;
|
|
743
743
|
CustomKnowledgeArticleTypeConfigurations?: SalesforceCustomKnowledgeArticleTypeConfiguration[];
|
|
744
744
|
}
|
|
@@ -768,7 +768,7 @@ export declare const SalesforceStandardObjectName: {
|
|
|
768
768
|
export type SalesforceStandardObjectName =
|
|
769
769
|
(typeof SalesforceStandardObjectName)[keyof typeof SalesforceStandardObjectName];
|
|
770
770
|
export interface SalesforceStandardObjectConfiguration {
|
|
771
|
-
Name: SalesforceStandardObjectName |
|
|
771
|
+
Name: SalesforceStandardObjectName | undefined;
|
|
772
772
|
DocumentDataFieldName: string | undefined;
|
|
773
773
|
DocumentTitleFieldName?: string;
|
|
774
774
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
@@ -816,10 +816,10 @@ export type ServiceNowBuildVersionType =
|
|
|
816
816
|
export interface ServiceNowConfiguration {
|
|
817
817
|
HostUrl: string | undefined;
|
|
818
818
|
SecretArn: string | undefined;
|
|
819
|
-
ServiceNowBuildVersion: ServiceNowBuildVersionType |
|
|
819
|
+
ServiceNowBuildVersion: ServiceNowBuildVersionType | undefined;
|
|
820
820
|
KnowledgeArticleConfiguration?: ServiceNowKnowledgeArticleConfiguration;
|
|
821
821
|
ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration;
|
|
822
|
-
AuthenticationType?: ServiceNowAuthenticationType
|
|
822
|
+
AuthenticationType?: ServiceNowAuthenticationType;
|
|
823
823
|
}
|
|
824
824
|
export declare const SharePointOnlineAuthenticationType: {
|
|
825
825
|
readonly HTTP_BASIC: "HTTP_BASIC";
|
|
@@ -836,7 +836,7 @@ export declare const SharePointVersion: {
|
|
|
836
836
|
export type SharePointVersion =
|
|
837
837
|
(typeof SharePointVersion)[keyof typeof SharePointVersion];
|
|
838
838
|
export interface SharePointConfiguration {
|
|
839
|
-
SharePointVersion: SharePointVersion |
|
|
839
|
+
SharePointVersion: SharePointVersion | undefined;
|
|
840
840
|
Urls: string[] | undefined;
|
|
841
841
|
SecretArn: string | undefined;
|
|
842
842
|
CrawlAttachments?: boolean;
|
|
@@ -848,7 +848,7 @@ export interface SharePointConfiguration {
|
|
|
848
848
|
DocumentTitleFieldName?: string;
|
|
849
849
|
DisableLocalGroups?: boolean;
|
|
850
850
|
SslCertificateS3Path?: S3Path;
|
|
851
|
-
AuthenticationType?: SharePointOnlineAuthenticationType
|
|
851
|
+
AuthenticationType?: SharePointOnlineAuthenticationType;
|
|
852
852
|
ProxyConfiguration?: ProxyConfiguration;
|
|
853
853
|
}
|
|
854
854
|
export declare const SlackEntity: {
|
|
@@ -862,7 +862,7 @@ export interface SlackConfiguration {
|
|
|
862
862
|
TeamId: string | undefined;
|
|
863
863
|
SecretArn: string | undefined;
|
|
864
864
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
865
|
-
SlackEntityList:
|
|
865
|
+
SlackEntityList: SlackEntity[] | undefined;
|
|
866
866
|
UseChangeLog?: boolean;
|
|
867
867
|
CrawlBotMessage?: boolean;
|
|
868
868
|
ExcludeArchived?: boolean;
|
|
@@ -886,7 +886,7 @@ export type WebCrawlerMode =
|
|
|
886
886
|
(typeof WebCrawlerMode)[keyof typeof WebCrawlerMode];
|
|
887
887
|
export interface SeedUrlConfiguration {
|
|
888
888
|
SeedUrls: string[] | undefined;
|
|
889
|
-
WebCrawlerMode?: WebCrawlerMode
|
|
889
|
+
WebCrawlerMode?: WebCrawlerMode;
|
|
890
890
|
}
|
|
891
891
|
export interface SiteMapsConfiguration {
|
|
892
892
|
SiteMaps: string[] | undefined;
|
|
@@ -964,7 +964,7 @@ export type DataSourceType =
|
|
|
964
964
|
export interface CreateDataSourceRequest {
|
|
965
965
|
Name: string | undefined;
|
|
966
966
|
IndexId: string | undefined;
|
|
967
|
-
Type: DataSourceType |
|
|
967
|
+
Type: DataSourceType | undefined;
|
|
968
968
|
Configuration?: DataSourceConfiguration;
|
|
969
969
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
970
970
|
Description?: string;
|
|
@@ -1014,7 +1014,7 @@ export interface CreateFaqRequest {
|
|
|
1014
1014
|
S3Path: S3Path | undefined;
|
|
1015
1015
|
RoleArn: string | undefined;
|
|
1016
1016
|
Tags?: Tag[];
|
|
1017
|
-
FileFormat?: FaqFileFormat
|
|
1017
|
+
FileFormat?: FaqFileFormat;
|
|
1018
1018
|
ClientToken?: string;
|
|
1019
1019
|
LanguageCode?: string;
|
|
1020
1020
|
}
|
|
@@ -1035,7 +1035,7 @@ export interface CreateFeaturedResultsSetRequest {
|
|
|
1035
1035
|
FeaturedResultsSetName: string | undefined;
|
|
1036
1036
|
Description?: string;
|
|
1037
1037
|
ClientToken?: string;
|
|
1038
|
-
Status?: FeaturedResultsSetStatus
|
|
1038
|
+
Status?: FeaturedResultsSetStatus;
|
|
1039
1039
|
QueryTexts?: string[];
|
|
1040
1040
|
FeaturedDocuments?: FeaturedDocument[];
|
|
1041
1041
|
Tags?: Tag[];
|
|
@@ -1044,7 +1044,7 @@ export interface FeaturedResultsSet {
|
|
|
1044
1044
|
FeaturedResultsSetId?: string;
|
|
1045
1045
|
FeaturedResultsSetName?: string;
|
|
1046
1046
|
Description?: string;
|
|
1047
|
-
Status?: FeaturedResultsSetStatus
|
|
1047
|
+
Status?: FeaturedResultsSetStatus;
|
|
1048
1048
|
QueryTexts?: string[];
|
|
1049
1049
|
FeaturedDocuments?: FeaturedDocument[];
|
|
1050
1050
|
LastUpdatedTimestamp?: number;
|
|
@@ -1091,7 +1091,7 @@ export declare const UserGroupResolutionMode: {
|
|
|
1091
1091
|
export type UserGroupResolutionMode =
|
|
1092
1092
|
(typeof UserGroupResolutionMode)[keyof typeof UserGroupResolutionMode];
|
|
1093
1093
|
export interface UserGroupResolutionConfiguration {
|
|
1094
|
-
UserGroupResolutionMode: UserGroupResolutionMode |
|
|
1094
|
+
UserGroupResolutionMode: UserGroupResolutionMode | undefined;
|
|
1095
1095
|
}
|
|
1096
1096
|
export interface JsonTokenTypeConfiguration {
|
|
1097
1097
|
UserNameAttributeField: string | undefined;
|
|
@@ -1103,7 +1103,7 @@ export declare const KeyLocation: {
|
|
|
1103
1103
|
};
|
|
1104
1104
|
export type KeyLocation = (typeof KeyLocation)[keyof typeof KeyLocation];
|
|
1105
1105
|
export interface JwtTokenTypeConfiguration {
|
|
1106
|
-
KeyLocation: KeyLocation |
|
|
1106
|
+
KeyLocation: KeyLocation | undefined;
|
|
1107
1107
|
URL?: string;
|
|
1108
1108
|
SecretManagerArn?: string;
|
|
1109
1109
|
UserNameAttributeField?: string;
|
|
@@ -1117,14 +1117,14 @@ export interface UserTokenConfiguration {
|
|
|
1117
1117
|
}
|
|
1118
1118
|
export interface CreateIndexRequest {
|
|
1119
1119
|
Name: string | undefined;
|
|
1120
|
-
Edition?: IndexEdition
|
|
1120
|
+
Edition?: IndexEdition;
|
|
1121
1121
|
RoleArn: string | undefined;
|
|
1122
1122
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1123
1123
|
Description?: string;
|
|
1124
1124
|
ClientToken?: string;
|
|
1125
1125
|
Tags?: Tag[];
|
|
1126
1126
|
UserTokenConfigurations?: UserTokenConfiguration[];
|
|
1127
|
-
UserContextPolicy?: UserContextPolicy
|
|
1127
|
+
UserContextPolicy?: UserContextPolicy;
|
|
1128
1128
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
|
|
1129
1129
|
}
|
|
1130
1130
|
export interface CreateIndexResponse {
|
|
@@ -1217,13 +1217,13 @@ export interface DescribeDataSourceResponse {
|
|
|
1217
1217
|
Id?: string;
|
|
1218
1218
|
IndexId?: string;
|
|
1219
1219
|
Name?: string;
|
|
1220
|
-
Type?: DataSourceType
|
|
1220
|
+
Type?: DataSourceType;
|
|
1221
1221
|
Configuration?: DataSourceConfiguration;
|
|
1222
1222
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1223
1223
|
CreatedAt?: Date;
|
|
1224
1224
|
UpdatedAt?: Date;
|
|
1225
1225
|
Description?: string;
|
|
1226
|
-
Status?: DataSourceStatus
|
|
1226
|
+
Status?: DataSourceStatus;
|
|
1227
1227
|
Schedule?: string;
|
|
1228
1228
|
RoleArn?: string;
|
|
1229
1229
|
ErrorMessage?: string;
|
|
@@ -1239,7 +1239,7 @@ export declare const EndpointType: {
|
|
|
1239
1239
|
};
|
|
1240
1240
|
export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
|
|
1241
1241
|
export interface ExperienceEndpoint {
|
|
1242
|
-
EndpointType?: EndpointType
|
|
1242
|
+
EndpointType?: EndpointType;
|
|
1243
1243
|
Endpoint?: string;
|
|
1244
1244
|
}
|
|
1245
1245
|
export declare const ExperienceStatus: {
|
|
@@ -1259,7 +1259,7 @@ export interface DescribeExperienceResponse {
|
|
|
1259
1259
|
CreatedAt?: Date;
|
|
1260
1260
|
UpdatedAt?: Date;
|
|
1261
1261
|
Description?: string;
|
|
1262
|
-
Status?: ExperienceStatus
|
|
1262
|
+
Status?: ExperienceStatus;
|
|
1263
1263
|
RoleArn?: string;
|
|
1264
1264
|
ErrorMessage?: string;
|
|
1265
1265
|
}
|
|
@@ -1283,10 +1283,10 @@ export interface DescribeFaqResponse {
|
|
|
1283
1283
|
CreatedAt?: Date;
|
|
1284
1284
|
UpdatedAt?: Date;
|
|
1285
1285
|
S3Path?: S3Path;
|
|
1286
|
-
Status?: FaqStatus
|
|
1286
|
+
Status?: FaqStatus;
|
|
1287
1287
|
RoleArn?: string;
|
|
1288
1288
|
ErrorMessage?: string;
|
|
1289
|
-
FileFormat?: FaqFileFormat
|
|
1289
|
+
FileFormat?: FaqFileFormat;
|
|
1290
1290
|
LanguageCode?: string;
|
|
1291
1291
|
}
|
|
1292
1292
|
export interface DescribeFeaturedResultsSetRequest {
|
|
@@ -1305,7 +1305,7 @@ export interface DescribeFeaturedResultsSetResponse {
|
|
|
1305
1305
|
FeaturedResultsSetId?: string;
|
|
1306
1306
|
FeaturedResultsSetName?: string;
|
|
1307
1307
|
Description?: string;
|
|
1308
|
-
Status?: FeaturedResultsSetStatus
|
|
1308
|
+
Status?: FeaturedResultsSetStatus;
|
|
1309
1309
|
QueryTexts?: string[];
|
|
1310
1310
|
FeaturedDocumentsWithMetadata?: FeaturedDocumentWithMetadata[];
|
|
1311
1311
|
FeaturedDocumentsMissing?: FeaturedDocumentMissing[];
|
|
@@ -1328,7 +1328,7 @@ export interface Relevance {
|
|
|
1328
1328
|
Freshness?: boolean;
|
|
1329
1329
|
Importance?: number;
|
|
1330
1330
|
Duration?: string;
|
|
1331
|
-
RankOrder?: Order
|
|
1331
|
+
RankOrder?: Order;
|
|
1332
1332
|
ValueImportanceMap?: Record<string, number>;
|
|
1333
1333
|
}
|
|
1334
1334
|
export interface Search {
|
|
@@ -1347,7 +1347,7 @@ export type DocumentAttributeValueType =
|
|
|
1347
1347
|
(typeof DocumentAttributeValueType)[keyof typeof DocumentAttributeValueType];
|
|
1348
1348
|
export interface DocumentMetadataConfiguration {
|
|
1349
1349
|
Name: string | undefined;
|
|
1350
|
-
Type: DocumentAttributeValueType |
|
|
1350
|
+
Type: DocumentAttributeValueType | undefined;
|
|
1351
1351
|
Relevance?: Relevance;
|
|
1352
1352
|
Search?: Search;
|
|
1353
1353
|
}
|
|
@@ -1374,10 +1374,10 @@ export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
|
1374
1374
|
export interface DescribeIndexResponse {
|
|
1375
1375
|
Name?: string;
|
|
1376
1376
|
Id?: string;
|
|
1377
|
-
Edition?: IndexEdition
|
|
1377
|
+
Edition?: IndexEdition;
|
|
1378
1378
|
RoleArn?: string;
|
|
1379
1379
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1380
|
-
Status?: IndexStatus
|
|
1380
|
+
Status?: IndexStatus;
|
|
1381
1381
|
Description?: string;
|
|
1382
1382
|
CreatedAt?: Date;
|
|
1383
1383
|
UpdatedAt?: Date;
|
|
@@ -1386,7 +1386,7 @@ export interface DescribeIndexResponse {
|
|
|
1386
1386
|
ErrorMessage?: string;
|
|
1387
1387
|
CapacityUnits?: CapacityUnitsConfiguration;
|
|
1388
1388
|
UserTokenConfigurations?: UserTokenConfiguration[];
|
|
1389
|
-
UserContextPolicy?: UserContextPolicy
|
|
1389
|
+
UserContextPolicy?: UserContextPolicy;
|
|
1390
1390
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
|
|
1391
1391
|
}
|
|
1392
1392
|
export interface DescribePrincipalMappingRequest {
|
|
@@ -1404,7 +1404,7 @@ export declare const PrincipalMappingStatus: {
|
|
|
1404
1404
|
export type PrincipalMappingStatus =
|
|
1405
1405
|
(typeof PrincipalMappingStatus)[keyof typeof PrincipalMappingStatus];
|
|
1406
1406
|
export interface GroupOrderingIdSummary {
|
|
1407
|
-
Status?: PrincipalMappingStatus
|
|
1407
|
+
Status?: PrincipalMappingStatus;
|
|
1408
1408
|
LastUpdatedAt?: Date;
|
|
1409
1409
|
ReceivedAt?: Date;
|
|
1410
1410
|
OrderingId?: number;
|
|
@@ -1435,7 +1435,7 @@ export interface DescribeQuerySuggestionsBlockListResponse {
|
|
|
1435
1435
|
Id?: string;
|
|
1436
1436
|
Name?: string;
|
|
1437
1437
|
Description?: string;
|
|
1438
|
-
Status?: QuerySuggestionsBlockListStatus
|
|
1438
|
+
Status?: QuerySuggestionsBlockListStatus;
|
|
1439
1439
|
ErrorMessage?: string;
|
|
1440
1440
|
CreatedAt?: Date;
|
|
1441
1441
|
UpdatedAt?: Date;
|
|
@@ -1459,8 +1459,8 @@ export declare const QuerySuggestionsStatus: {
|
|
|
1459
1459
|
export type QuerySuggestionsStatus =
|
|
1460
1460
|
(typeof QuerySuggestionsStatus)[keyof typeof QuerySuggestionsStatus];
|
|
1461
1461
|
export interface DescribeQuerySuggestionsConfigResponse {
|
|
1462
|
-
Mode?: Mode
|
|
1463
|
-
Status?: QuerySuggestionsStatus
|
|
1462
|
+
Mode?: Mode;
|
|
1463
|
+
Status?: QuerySuggestionsStatus;
|
|
1464
1464
|
QueryLogLookBackWindowInDays?: number;
|
|
1465
1465
|
IncludeQueriesWithoutUserInformation?: boolean;
|
|
1466
1466
|
MinimumNumberOfQueryingUsers?: number;
|
|
@@ -1489,7 +1489,7 @@ export interface DescribeThesaurusResponse {
|
|
|
1489
1489
|
IndexId?: string;
|
|
1490
1490
|
Name?: string;
|
|
1491
1491
|
Description?: string;
|
|
1492
|
-
Status?: ThesaurusStatus
|
|
1492
|
+
Status?: ThesaurusStatus;
|
|
1493
1493
|
ErrorMessage?: string;
|
|
1494
1494
|
CreatedAt?: Date;
|
|
1495
1495
|
UpdatedAt?: Date;
|
|
@@ -1566,8 +1566,8 @@ export declare const MetricType: {
|
|
|
1566
1566
|
export type MetricType = (typeof MetricType)[keyof typeof MetricType];
|
|
1567
1567
|
export interface GetSnapshotsRequest {
|
|
1568
1568
|
IndexId: string | undefined;
|
|
1569
|
-
Interval: Interval |
|
|
1570
|
-
MetricType: MetricType |
|
|
1569
|
+
Interval: Interval | undefined;
|
|
1570
|
+
MetricType: MetricType | undefined;
|
|
1571
1571
|
NextToken?: string;
|
|
1572
1572
|
MaxResults?: number;
|
|
1573
1573
|
}
|
|
@@ -1606,10 +1606,10 @@ export interface ListDataSourcesRequest {
|
|
|
1606
1606
|
export interface DataSourceSummary {
|
|
1607
1607
|
Name?: string;
|
|
1608
1608
|
Id?: string;
|
|
1609
|
-
Type?: DataSourceType
|
|
1609
|
+
Type?: DataSourceType;
|
|
1610
1610
|
CreatedAt?: Date;
|
|
1611
1611
|
UpdatedAt?: Date;
|
|
1612
|
-
Status?: DataSourceStatus
|
|
1612
|
+
Status?: DataSourceStatus;
|
|
1613
1613
|
LanguageCode?: string;
|
|
1614
1614
|
}
|
|
1615
1615
|
export interface ListDataSourcesResponse {
|
|
@@ -1633,7 +1633,7 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
1633
1633
|
NextToken?: string;
|
|
1634
1634
|
MaxResults?: number;
|
|
1635
1635
|
StartTimeFilter?: TimeRange;
|
|
1636
|
-
StatusFilter?: DataSourceSyncJobStatus
|
|
1636
|
+
StatusFilter?: DataSourceSyncJobStatus;
|
|
1637
1637
|
}
|
|
1638
1638
|
export interface DataSourceSyncJobMetrics {
|
|
1639
1639
|
DocumentsAdded?: string;
|
|
@@ -1646,9 +1646,9 @@ export interface DataSourceSyncJob {
|
|
|
1646
1646
|
ExecutionId?: string;
|
|
1647
1647
|
StartTime?: Date;
|
|
1648
1648
|
EndTime?: Date;
|
|
1649
|
-
Status?: DataSourceSyncJobStatus
|
|
1649
|
+
Status?: DataSourceSyncJobStatus;
|
|
1650
1650
|
ErrorMessage?: string;
|
|
1651
|
-
ErrorCode?: ErrorCode
|
|
1651
|
+
ErrorCode?: ErrorCode;
|
|
1652
1652
|
DataSourceErrorCode?: string;
|
|
1653
1653
|
Metrics?: DataSourceSyncJobMetrics;
|
|
1654
1654
|
}
|
|
@@ -1664,7 +1664,7 @@ export interface ListEntityPersonasRequest {
|
|
|
1664
1664
|
}
|
|
1665
1665
|
export interface PersonasSummary {
|
|
1666
1666
|
EntityId?: string;
|
|
1667
|
-
Persona?: Persona
|
|
1667
|
+
Persona?: Persona;
|
|
1668
1668
|
CreatedAt?: Date;
|
|
1669
1669
|
UpdatedAt?: Date;
|
|
1670
1670
|
}
|
|
@@ -1686,7 +1686,7 @@ export interface EntityDisplayData {
|
|
|
1686
1686
|
}
|
|
1687
1687
|
export interface ExperienceEntitiesSummary {
|
|
1688
1688
|
EntityId?: string;
|
|
1689
|
-
EntityType?: EntityType
|
|
1689
|
+
EntityType?: EntityType;
|
|
1690
1690
|
DisplayData?: EntityDisplayData;
|
|
1691
1691
|
}
|
|
1692
1692
|
export interface ListExperienceEntitiesResponse {
|
|
@@ -1702,7 +1702,7 @@ export interface ExperiencesSummary {
|
|
|
1702
1702
|
Name?: string;
|
|
1703
1703
|
Id?: string;
|
|
1704
1704
|
CreatedAt?: Date;
|
|
1705
|
-
Status?: ExperienceStatus
|
|
1705
|
+
Status?: ExperienceStatus;
|
|
1706
1706
|
Endpoints?: ExperienceEndpoint[];
|
|
1707
1707
|
}
|
|
1708
1708
|
export interface ListExperiencesResponse {
|
|
@@ -1717,10 +1717,10 @@ export interface ListFaqsRequest {
|
|
|
1717
1717
|
export interface FaqSummary {
|
|
1718
1718
|
Id?: string;
|
|
1719
1719
|
Name?: string;
|
|
1720
|
-
Status?: FaqStatus
|
|
1720
|
+
Status?: FaqStatus;
|
|
1721
1721
|
CreatedAt?: Date;
|
|
1722
1722
|
UpdatedAt?: Date;
|
|
1723
|
-
FileFormat?: FaqFileFormat
|
|
1723
|
+
FileFormat?: FaqFileFormat;
|
|
1724
1724
|
LanguageCode?: string;
|
|
1725
1725
|
}
|
|
1726
1726
|
export interface ListFaqsResponse {
|
|
@@ -1735,7 +1735,7 @@ export interface ListFeaturedResultsSetsRequest {
|
|
|
1735
1735
|
export interface FeaturedResultsSetSummary {
|
|
1736
1736
|
FeaturedResultsSetId?: string;
|
|
1737
1737
|
FeaturedResultsSetName?: string;
|
|
1738
|
-
Status?: FeaturedResultsSetStatus
|
|
1738
|
+
Status?: FeaturedResultsSetStatus;
|
|
1739
1739
|
LastUpdatedTimestamp?: number;
|
|
1740
1740
|
CreationTimestamp?: number;
|
|
1741
1741
|
}
|
|
@@ -1765,10 +1765,10 @@ export interface ListIndicesRequest {
|
|
|
1765
1765
|
export interface IndexConfigurationSummary {
|
|
1766
1766
|
Name?: string;
|
|
1767
1767
|
Id?: string;
|
|
1768
|
-
Edition?: IndexEdition
|
|
1768
|
+
Edition?: IndexEdition;
|
|
1769
1769
|
CreatedAt: Date | undefined;
|
|
1770
1770
|
UpdatedAt: Date | undefined;
|
|
1771
|
-
Status: IndexStatus |
|
|
1771
|
+
Status: IndexStatus | undefined;
|
|
1772
1772
|
}
|
|
1773
1773
|
export interface ListIndicesResponse {
|
|
1774
1774
|
IndexConfigurationSummaryItems?: IndexConfigurationSummary[];
|
|
@@ -1782,7 +1782,7 @@ export interface ListQuerySuggestionsBlockListsRequest {
|
|
|
1782
1782
|
export interface QuerySuggestionsBlockListSummary {
|
|
1783
1783
|
Id?: string;
|
|
1784
1784
|
Name?: string;
|
|
1785
|
-
Status?: QuerySuggestionsBlockListStatus
|
|
1785
|
+
Status?: QuerySuggestionsBlockListStatus;
|
|
1786
1786
|
CreatedAt?: Date;
|
|
1787
1787
|
UpdatedAt?: Date;
|
|
1788
1788
|
ItemCount?: number;
|
|
@@ -1813,7 +1813,7 @@ export interface ListThesauriRequest {
|
|
|
1813
1813
|
export interface ThesaurusSummary {
|
|
1814
1814
|
Id?: string;
|
|
1815
1815
|
Name?: string;
|
|
1816
|
-
Status?: ThesaurusStatus
|
|
1816
|
+
Status?: ThesaurusStatus;
|
|
1817
1817
|
CreatedAt?: Date;
|
|
1818
1818
|
UpdatedAt?: Date;
|
|
1819
1819
|
}
|
|
@@ -1859,14 +1859,14 @@ export declare const SortOrder: {
|
|
|
1859
1859
|
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
1860
1860
|
export interface SortingConfiguration {
|
|
1861
1861
|
DocumentAttributeKey: string | undefined;
|
|
1862
|
-
SortOrder: SortOrder |
|
|
1862
|
+
SortOrder: SortOrder | undefined;
|
|
1863
1863
|
}
|
|
1864
1864
|
export interface SpellCorrectionConfiguration {
|
|
1865
1865
|
IncludeQuerySpellCheckSuggestions: boolean | undefined;
|
|
1866
1866
|
}
|
|
1867
1867
|
export interface FeaturedResultsItem {
|
|
1868
1868
|
Id?: string;
|
|
1869
|
-
Type?: QueryResultType
|
|
1869
|
+
Type?: QueryResultType;
|
|
1870
1870
|
AdditionalAttributes?: AdditionalResultAttribute[];
|
|
1871
1871
|
DocumentId?: string;
|
|
1872
1872
|
DocumentTitle?: TextWithHighlights;
|
|
@@ -1891,7 +1891,7 @@ export declare const ScoreConfidence: {
|
|
|
1891
1891
|
export type ScoreConfidence =
|
|
1892
1892
|
(typeof ScoreConfidence)[keyof typeof ScoreConfidence];
|
|
1893
1893
|
export interface ScoreAttributes {
|
|
1894
|
-
ScoreConfidence?: ScoreConfidence
|
|
1894
|
+
ScoreConfidence?: ScoreConfidence;
|
|
1895
1895
|
}
|
|
1896
1896
|
export interface TableCell {
|
|
1897
1897
|
Value?: string;
|