@aws-sdk/client-kendra 3.178.0 → 3.180.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/CHANGELOG.md +19 -0
- package/dist-types/Kendra.d.ts +26 -29
- package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +1 -1
- package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/CreateDataSourceCommand.d.ts +12 -13
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +3 -4
- package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +1 -2
- package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +3 -3
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +635 -782
- package/package.json +7 -7
|
@@ -13,9 +13,9 @@ export interface AccessControlConfigurationSummary {
|
|
|
13
13
|
Id: string | undefined;
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* <p>Access Control List files for the documents in a data source. For
|
|
17
|
-
*
|
|
18
|
-
* sources</a>.</p>
|
|
16
|
+
* <p>Access Control List files for the documents in a data source. For the format of the
|
|
17
|
+
* file, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html">Access control
|
|
18
|
+
* for S3 data sources</a>.</p>
|
|
19
19
|
*/
|
|
20
20
|
export interface AccessControlListConfiguration {
|
|
21
21
|
/**
|
|
@@ -36,16 +36,14 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
36
36
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* <p>Provides information about the column that should be used for
|
|
40
|
-
*
|
|
39
|
+
* <p>Provides information about the column that should be used for filtering the query
|
|
40
|
+
* response by groups.</p>
|
|
41
41
|
*/
|
|
42
42
|
export interface AclConfiguration {
|
|
43
43
|
/**
|
|
44
|
-
* <p>A list of groups, separated by semi-colons, that filters a query
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
* <code>UserContext</code> field of the <code>Query</code>
|
|
48
|
-
* API.</p>
|
|
44
|
+
* <p>A list of groups, separated by semi-colons, that filters a query response based on
|
|
45
|
+
* user context. The document is only returned to users that are in one of the groups
|
|
46
|
+
* specified in the <code>UserContext</code> field of the <code>Query</code> API.</p>
|
|
49
47
|
*/
|
|
50
48
|
AllowedGroupsColumnName: string | undefined;
|
|
51
49
|
}
|
|
@@ -54,24 +52,21 @@ export declare enum HighlightType {
|
|
|
54
52
|
THESAURUS_SYNONYM = "THESAURUS_SYNONYM"
|
|
55
53
|
}
|
|
56
54
|
/**
|
|
57
|
-
* <p>Provides information that you can use to highlight a search result
|
|
58
|
-
*
|
|
59
|
-
* response.</p>
|
|
55
|
+
* <p>Provides information that you can use to highlight a search result so that your users
|
|
56
|
+
* can quickly identify terms in the response.</p>
|
|
60
57
|
*/
|
|
61
58
|
export interface Highlight {
|
|
62
59
|
/**
|
|
63
|
-
* <p>The zero-based location in the response string where the highlight
|
|
64
|
-
* starts.</p>
|
|
60
|
+
* <p>The zero-based location in the response string where the highlight starts.</p>
|
|
65
61
|
*/
|
|
66
62
|
BeginOffset: number | undefined;
|
|
67
63
|
/**
|
|
68
|
-
* <p>The zero-based location in the response string where the highlight
|
|
69
|
-
* ends.</p>
|
|
64
|
+
* <p>The zero-based location in the response string where the highlight ends.</p>
|
|
70
65
|
*/
|
|
71
66
|
EndOffset: number | undefined;
|
|
72
67
|
/**
|
|
73
|
-
* <p>Indicates whether the response is the best response. True if this
|
|
74
|
-
*
|
|
68
|
+
* <p>Indicates whether the response is the best response. True if this is the best
|
|
69
|
+
* response; otherwise, false.</p>
|
|
75
70
|
*/
|
|
76
71
|
TopAnswer?: boolean;
|
|
77
72
|
/**
|
|
@@ -80,8 +75,7 @@ export interface Highlight {
|
|
|
80
75
|
Type?: HighlightType | string;
|
|
81
76
|
}
|
|
82
77
|
/**
|
|
83
|
-
* <p>Provides text and information about where to highlight the
|
|
84
|
-
* text.</p>
|
|
78
|
+
* <p>Provides text and information about where to highlight the text.</p>
|
|
85
79
|
*/
|
|
86
80
|
export interface TextWithHighlights {
|
|
87
81
|
/**
|
|
@@ -89,8 +83,7 @@ export interface TextWithHighlights {
|
|
|
89
83
|
*/
|
|
90
84
|
Text?: string;
|
|
91
85
|
/**
|
|
92
|
-
* <p>The beginning and end of the text that should be
|
|
93
|
-
* highlighted.</p>
|
|
86
|
+
* <p>The beginning and end of the text that should be highlighted.</p>
|
|
94
87
|
*/
|
|
95
88
|
Highlights?: Highlight[];
|
|
96
89
|
}
|
|
@@ -99,8 +92,8 @@ export interface TextWithHighlights {
|
|
|
99
92
|
*/
|
|
100
93
|
export interface AdditionalResultAttributeValue {
|
|
101
94
|
/**
|
|
102
|
-
* <p>The text associated with the attribute and information about the
|
|
103
|
-
*
|
|
95
|
+
* <p>The text associated with the attribute and information about the highlight to apply to
|
|
96
|
+
* the text.</p>
|
|
104
97
|
*/
|
|
105
98
|
TextWithHighlightsValue?: TextWithHighlights;
|
|
106
99
|
}
|
|
@@ -125,9 +118,8 @@ export interface AdditionalResultAttribute {
|
|
|
125
118
|
Value: AdditionalResultAttributeValue | undefined;
|
|
126
119
|
}
|
|
127
120
|
/**
|
|
128
|
-
* <p>Maps a column or attribute in the data source to an index field.
|
|
129
|
-
*
|
|
130
|
-
* <code>UpdateIndex</code> API.</p>
|
|
121
|
+
* <p>Maps a column or attribute in the data source to an index field. You must first create
|
|
122
|
+
* the fields in the index using the <code>UpdateIndex</code> API.</p>
|
|
131
123
|
*/
|
|
132
124
|
export interface DataSourceToIndexFieldMapping {
|
|
133
125
|
/**
|
|
@@ -149,8 +141,7 @@ export declare enum AlfrescoEntity {
|
|
|
149
141
|
wiki = "wiki"
|
|
150
142
|
}
|
|
151
143
|
/**
|
|
152
|
-
* <p>Information required to find a specific file in an Amazon S3
|
|
153
|
-
* bucket.</p>
|
|
144
|
+
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
154
145
|
*/
|
|
155
146
|
export interface S3Path {
|
|
156
147
|
/**
|
|
@@ -167,16 +158,14 @@ export interface S3Path {
|
|
|
167
158
|
*/
|
|
168
159
|
export interface DataSourceVpcConfiguration {
|
|
169
160
|
/**
|
|
170
|
-
* <p>A list of identifiers for subnets within your Amazon VPC. The
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
* device.</p>
|
|
161
|
+
* <p>A list of identifiers for subnets within your Amazon VPC. The subnets should be able
|
|
162
|
+
* to connect to each other in the VPC, and they should have outgoing access to the
|
|
163
|
+
* Internet through a NAT device.</p>
|
|
174
164
|
*/
|
|
175
165
|
SubnetIds: string[] | undefined;
|
|
176
166
|
/**
|
|
177
|
-
* <p>A list of identifiers of security groups within your Amazon VPC.
|
|
178
|
-
*
|
|
179
|
-
* source.</p>
|
|
167
|
+
* <p>A list of identifiers of security groups within your Amazon VPC. The security groups
|
|
168
|
+
* should enable Amazon Kendra to connect to the data source.</p>
|
|
180
169
|
*/
|
|
181
170
|
SecurityGroupIds: string[] | undefined;
|
|
182
171
|
}
|
|
@@ -296,12 +285,12 @@ export declare enum EntityType {
|
|
|
296
285
|
}
|
|
297
286
|
/**
|
|
298
287
|
* <p>Provides the configuration information for users or groups in
|
|
299
|
-
* your
|
|
288
|
+
* your IAM Identity Center identity source to grant access your Amazon Kendra
|
|
300
289
|
* experience.</p>
|
|
301
290
|
*/
|
|
302
291
|
export interface EntityConfiguration {
|
|
303
292
|
/**
|
|
304
|
-
* <p>The identifier of a user or group in your
|
|
293
|
+
* <p>The identifier of a user or group in your IAM Identity Center identity
|
|
305
294
|
* source. For example, a user ID could be an email.</p>
|
|
306
295
|
*/
|
|
307
296
|
EntityId: string | undefined;
|
|
@@ -321,29 +310,29 @@ export interface AssociateEntitiesToExperienceRequest {
|
|
|
321
310
|
*/
|
|
322
311
|
IndexId: string | undefined;
|
|
323
312
|
/**
|
|
324
|
-
* <p>Lists users or groups in your
|
|
313
|
+
* <p>Lists users or groups in your IAM Identity Center identity source.</p>
|
|
325
314
|
*/
|
|
326
315
|
EntityList: EntityConfiguration[] | undefined;
|
|
327
316
|
}
|
|
328
317
|
/**
|
|
329
|
-
* <p>Information on the users or groups in your
|
|
318
|
+
* <p>Information on the users or groups in your IAM Identity Center identity
|
|
330
319
|
* source that failed to properly configure with your Amazon Kendra experience.</p>
|
|
331
320
|
*/
|
|
332
321
|
export interface FailedEntity {
|
|
333
322
|
/**
|
|
334
|
-
* <p>The identifier of the user or group in your
|
|
323
|
+
* <p>The identifier of the user or group in your IAM Identity Center identity
|
|
335
324
|
* source. For example, a user ID could be an email.</p>
|
|
336
325
|
*/
|
|
337
326
|
EntityId?: string;
|
|
338
327
|
/**
|
|
339
|
-
* <p>The reason the user or group in your
|
|
328
|
+
* <p>The reason the user or group in your IAM Identity Center identity source
|
|
340
329
|
* failed to properly configure with your Amazon Kendra experience.</p>
|
|
341
330
|
*/
|
|
342
331
|
ErrorMessage?: string;
|
|
343
332
|
}
|
|
344
333
|
export interface AssociateEntitiesToExperienceResponse {
|
|
345
334
|
/**
|
|
346
|
-
* <p>Lists the users or groups in your
|
|
335
|
+
* <p>Lists the users or groups in your IAM Identity Center identity source that
|
|
347
336
|
* failed to properly configure with your Amazon Kendra experience.</p>
|
|
348
337
|
*/
|
|
349
338
|
FailedEntityList?: FailedEntity[];
|
|
@@ -414,19 +403,19 @@ export declare enum Persona {
|
|
|
414
403
|
}
|
|
415
404
|
/**
|
|
416
405
|
* <p>Provides the configuration information for users or groups in your
|
|
417
|
-
*
|
|
406
|
+
* IAM Identity Center identity source for access to your Amazon Kendra experience.
|
|
418
407
|
* Specific permissions are defined for each user or group once they are
|
|
419
408
|
* granted access to your Amazon Kendra experience.</p>
|
|
420
409
|
*/
|
|
421
410
|
export interface EntityPersonaConfiguration {
|
|
422
411
|
/**
|
|
423
|
-
* <p>The identifier of a user or group in your
|
|
412
|
+
* <p>The identifier of a user or group in your IAM Identity Center identity
|
|
424
413
|
* source. For example, a user ID could be an email.</p>
|
|
425
414
|
*/
|
|
426
415
|
EntityId: string | undefined;
|
|
427
416
|
/**
|
|
428
417
|
* <p>The persona that defines the specific permissions of the user or group
|
|
429
|
-
* in your
|
|
418
|
+
* in your IAM Identity Center identity source. The available personas or
|
|
430
419
|
* access roles are <code>Owner</code> and <code>Viewer</code>. For more
|
|
431
420
|
* information on these personas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience">Providing
|
|
432
421
|
* access to your search page</a>.</p>
|
|
@@ -444,7 +433,7 @@ export interface AssociatePersonasToEntitiesRequest {
|
|
|
444
433
|
IndexId: string | undefined;
|
|
445
434
|
/**
|
|
446
435
|
* <p>The personas that define the specific permissions of users or groups in
|
|
447
|
-
* your
|
|
436
|
+
* your IAM Identity Center identity source. The available personas or access
|
|
448
437
|
* roles are <code>Owner</code> and <code>Viewer</code>. For more information
|
|
449
438
|
* on these personas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience">Providing
|
|
450
439
|
* access to your search page</a>.</p>
|
|
@@ -453,14 +442,14 @@ export interface AssociatePersonasToEntitiesRequest {
|
|
|
453
442
|
}
|
|
454
443
|
export interface AssociatePersonasToEntitiesResponse {
|
|
455
444
|
/**
|
|
456
|
-
* <p>Lists the users or groups in your
|
|
445
|
+
* <p>Lists the users or groups in your IAM Identity Center identity source that
|
|
457
446
|
* failed to properly configure with your Amazon Kendra experience.</p>
|
|
458
447
|
*/
|
|
459
448
|
FailedEntityList?: FailedEntity[];
|
|
460
449
|
}
|
|
461
450
|
/**
|
|
462
|
-
* <p>The value of a document attribute. You can only provide one
|
|
463
|
-
*
|
|
451
|
+
* <p>The value of a document attribute. You can only provide one value for a document
|
|
452
|
+
* attribute.</p>
|
|
464
453
|
*/
|
|
465
454
|
export interface DocumentAttributeValue {
|
|
466
455
|
/**
|
|
@@ -477,17 +466,16 @@ export interface DocumentAttributeValue {
|
|
|
477
466
|
LongValue?: number;
|
|
478
467
|
/**
|
|
479
468
|
* <p>A date expressed as an ISO 8601 string.</p>
|
|
480
|
-
* <p>It is important for the time zone to be included
|
|
481
|
-
*
|
|
482
|
-
*
|
|
483
|
-
* for March 25th 2012 at 12:30PM (plus 10 seconds) in
|
|
484
|
-
* Central European Time.</p>
|
|
469
|
+
* <p>It is important for the time zone to be included in the ISO 8601 date-time format. For
|
|
470
|
+
* example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012
|
|
471
|
+
* at 12:30PM (plus 10 seconds) in Central European Time.</p>
|
|
485
472
|
*/
|
|
486
473
|
DateValue?: Date;
|
|
487
474
|
}
|
|
488
475
|
/**
|
|
489
|
-
* <p>A document attribute or metadata field. To create custom document
|
|
490
|
-
*
|
|
476
|
+
* <p>A document attribute or metadata field. To create custom document attributes, see
|
|
477
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html">Custom
|
|
478
|
+
* attributes</a>.</p>
|
|
491
479
|
*/
|
|
492
480
|
export interface DocumentAttribute {
|
|
493
481
|
/**
|
|
@@ -539,8 +527,7 @@ export interface AuthenticationConfiguration {
|
|
|
539
527
|
BasicAuthentication?: BasicAuthenticationConfiguration[];
|
|
540
528
|
}
|
|
541
529
|
/**
|
|
542
|
-
* <p>Maps a particular data source sync job to a particular data
|
|
543
|
-
* source.</p>
|
|
530
|
+
* <p>Maps a particular data source sync job to a particular data source.</p>
|
|
544
531
|
*/
|
|
545
532
|
export interface DataSourceSyncJobMetricTarget {
|
|
546
533
|
/**
|
|
@@ -549,12 +536,11 @@ export interface DataSourceSyncJobMetricTarget {
|
|
|
549
536
|
DataSourceId: string | undefined;
|
|
550
537
|
/**
|
|
551
538
|
* <p>The ID of the sync job that is running on the data source.</p>
|
|
552
|
-
* <p>If the ID of a sync job is not provided and there is a sync job
|
|
553
|
-
*
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
* indexed/deleted at the index level without sync job metrics included.</p>
|
|
539
|
+
* <p>If the ID of a sync job is not provided and there is a sync job running, then the ID
|
|
540
|
+
* of this sync job is used and metrics are generated for this sync job.</p>
|
|
541
|
+
* <p>If the ID of a sync job is not provided and there is no sync job running, then no
|
|
542
|
+
* metrics are generated and documents are indexed/deleted at the index level without sync
|
|
543
|
+
* job metrics included.</p>
|
|
558
544
|
*/
|
|
559
545
|
DataSourceSyncJobId?: string;
|
|
560
546
|
}
|
|
@@ -569,8 +555,7 @@ export interface BatchDeleteDocumentRequest {
|
|
|
569
555
|
*/
|
|
570
556
|
DocumentIdList: string[] | undefined;
|
|
571
557
|
/**
|
|
572
|
-
* <p>Maps a particular data source sync job to a particular data
|
|
573
|
-
* source.</p>
|
|
558
|
+
* <p>Maps a particular data source sync job to a particular data source.</p>
|
|
574
559
|
*/
|
|
575
560
|
DataSourceSyncJobMetricTarget?: DataSourceSyncJobMetricTarget;
|
|
576
561
|
}
|
|
@@ -579,24 +564,20 @@ export declare enum ErrorCode {
|
|
|
579
564
|
INVALID_REQUEST = "InvalidRequest"
|
|
580
565
|
}
|
|
581
566
|
/**
|
|
582
|
-
* <p>Provides information about documents that could not be removed
|
|
583
|
-
*
|
|
584
|
-
* API.</p>
|
|
567
|
+
* <p>Provides information about documents that could not be removed from an index by the
|
|
568
|
+
* <code>BatchDeleteDocument</code> API.</p>
|
|
585
569
|
*/
|
|
586
570
|
export interface BatchDeleteDocumentResponseFailedDocument {
|
|
587
571
|
/**
|
|
588
|
-
* <p>The identifier of the document that couldn't be removed from the
|
|
589
|
-
* index.</p>
|
|
572
|
+
* <p>The identifier of the document that couldn't be removed from the index.</p>
|
|
590
573
|
*/
|
|
591
574
|
Id?: string;
|
|
592
575
|
/**
|
|
593
|
-
* <p>The error code for why the document couldn't be removed from the
|
|
594
|
-
* index.</p>
|
|
576
|
+
* <p>The error code for why the document couldn't be removed from the index.</p>
|
|
595
577
|
*/
|
|
596
578
|
ErrorCode?: ErrorCode | string;
|
|
597
579
|
/**
|
|
598
|
-
* <p>An explanation for why the document couldn't be removed from the
|
|
599
|
-
* index.</p>
|
|
580
|
+
* <p>An explanation for why the document couldn't be removed from the index.</p>
|
|
600
581
|
*/
|
|
601
582
|
ErrorMessage?: string;
|
|
602
583
|
}
|
|
@@ -936,7 +917,8 @@ export declare enum PrincipalType {
|
|
|
936
917
|
USER = "USER"
|
|
937
918
|
}
|
|
938
919
|
/**
|
|
939
|
-
* <p>Provides user and group information for <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">user context
|
|
920
|
+
* <p>Provides user and group information for <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">user context
|
|
921
|
+
* filtering</a>.</p>
|
|
940
922
|
*/
|
|
941
923
|
export interface Principal {
|
|
942
924
|
/**
|
|
@@ -952,8 +934,7 @@ export interface Principal {
|
|
|
952
934
|
*/
|
|
953
935
|
Access: ReadAccessType | string | undefined;
|
|
954
936
|
/**
|
|
955
|
-
* <p>The identifier of the data source the principal should
|
|
956
|
-
* access documents from.</p>
|
|
937
|
+
* <p>The identifier of the data source the principal should access documents from.</p>
|
|
957
938
|
*/
|
|
958
939
|
DataSourceId?: string;
|
|
959
940
|
}
|
|
@@ -965,16 +946,14 @@ export declare enum ContentType {
|
|
|
965
946
|
PPT = "PPT"
|
|
966
947
|
}
|
|
967
948
|
/**
|
|
968
|
-
* <p>
|
|
969
|
-
* Information to define the hierarchy for which documents users should have access to.
|
|
949
|
+
* <p> Information to define the hierarchy for which documents users should have access to.
|
|
970
950
|
* </p>
|
|
971
951
|
*/
|
|
972
952
|
export interface HierarchicalPrincipal {
|
|
973
953
|
/**
|
|
974
|
-
* <p>A list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
* access for each document.</p>
|
|
954
|
+
* <p>A list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should
|
|
955
|
+
* have access to. Each hierarchical list specifies which user or group has allow or deny
|
|
956
|
+
* access for each document.</p>
|
|
978
957
|
*/
|
|
979
958
|
PrincipalList: Principal[] | undefined;
|
|
980
959
|
}
|
|
@@ -984,11 +963,11 @@ export interface HierarchicalPrincipal {
|
|
|
984
963
|
export interface Document {
|
|
985
964
|
/**
|
|
986
965
|
* <p>A unique identifier of the document in the index.</p>
|
|
987
|
-
* <p>Note, each document ID must be unique per index. You cannot create a data source
|
|
988
|
-
*
|
|
989
|
-
*
|
|
990
|
-
* can delete a data source and then use the <code>BatchPutDocument</code> API to index
|
|
991
|
-
*
|
|
966
|
+
* <p>Note, each document ID must be unique per index. You cannot create a data source to
|
|
967
|
+
* index your documents with their unique IDs and then use the
|
|
968
|
+
* <code>BatchPutDocument</code> API to index the same documents, or vice versa. You
|
|
969
|
+
* can delete a data source and then use the <code>BatchPutDocument</code> API to index the
|
|
970
|
+
* same documents, or vice versa.</p>
|
|
992
971
|
*/
|
|
993
972
|
Id: string | undefined;
|
|
994
973
|
/**
|
|
@@ -997,50 +976,44 @@ export interface Document {
|
|
|
997
976
|
Title?: string;
|
|
998
977
|
/**
|
|
999
978
|
* <p>The contents of the document. </p>
|
|
1000
|
-
* <p>Documents passed to the <code>Blob</code> parameter must be base64
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
1003
|
-
*
|
|
1004
|
-
* encode the contents before sending.</p>
|
|
979
|
+
* <p>Documents passed to the <code>Blob</code> parameter must be base64 encoded. Your code
|
|
980
|
+
* might not need to encode the document file bytes if you're using an Amazon Web Services
|
|
981
|
+
* SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint
|
|
982
|
+
* directly using REST, you must base64 encode the contents before sending.</p>
|
|
1005
983
|
*/
|
|
1006
984
|
Blob?: Uint8Array;
|
|
1007
985
|
/**
|
|
1008
|
-
* <p>Information required to find a specific file in an Amazon S3
|
|
1009
|
-
* bucket.</p>
|
|
986
|
+
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
1010
987
|
*/
|
|
1011
988
|
S3Path?: S3Path;
|
|
1012
989
|
/**
|
|
1013
|
-
* <p>Custom attributes to apply to the document. Use the custom
|
|
1014
|
-
*
|
|
1015
|
-
* provide
|
|
1016
|
-
*
|
|
1017
|
-
*
|
|
1018
|
-
*
|
|
1019
|
-
*
|
|
1020
|
-
* 'DataSourceSyncJobId' could be an optional custom attribute
|
|
1021
|
-
* as Amazon Kendra will use the ID of a running sync job.</p>
|
|
990
|
+
* <p>Custom attributes to apply to the document. Use the custom attributes to provide
|
|
991
|
+
* additional information for searching, to provide facets for refining searches, and to
|
|
992
|
+
* provide additional information in the query response.</p>
|
|
993
|
+
* <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that
|
|
994
|
+
* provide information on the synchronization of documents running on a data source. Note,
|
|
995
|
+
* 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of
|
|
996
|
+
* a running sync job.</p>
|
|
1022
997
|
*/
|
|
1023
998
|
Attributes?: DocumentAttribute[];
|
|
1024
999
|
/**
|
|
1025
|
-
* <p>Information on principals (users and/or groups) and which documents
|
|
1026
|
-
*
|
|
1027
|
-
*
|
|
1028
|
-
* access to documents.</p>
|
|
1000
|
+
* <p>Information on principals (users and/or groups) and which documents they should have
|
|
1001
|
+
* access to. This is useful for user context filtering, where search results are filtered
|
|
1002
|
+
* based on the user or their group access to documents.</p>
|
|
1029
1003
|
*/
|
|
1030
1004
|
AccessControlList?: Principal[];
|
|
1031
1005
|
/**
|
|
1032
|
-
* <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists
|
|
1033
|
-
*
|
|
1006
|
+
* <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should
|
|
1007
|
+
* have access to.</p>
|
|
1034
1008
|
*/
|
|
1035
1009
|
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
1036
1010
|
/**
|
|
1037
|
-
* <p>The file type of the document in the <code>Blob</code>
|
|
1038
|
-
* field.</p>
|
|
1011
|
+
* <p>The file type of the document in the <code>Blob</code> field.</p>
|
|
1039
1012
|
*/
|
|
1040
1013
|
ContentType?: ContentType | string;
|
|
1041
1014
|
/**
|
|
1042
|
-
* <p>The identifier of the access control configuration that you want
|
|
1043
|
-
*
|
|
1015
|
+
* <p>The identifier of the access control configuration that you want to apply to the
|
|
1016
|
+
* document.</p>
|
|
1044
1017
|
*/
|
|
1045
1018
|
AccessControlConfigurationId?: string;
|
|
1046
1019
|
}
|
|
@@ -1088,8 +1061,7 @@ export interface BatchPutDocumentRequest {
|
|
|
1088
1061
|
CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
|
|
1089
1062
|
}
|
|
1090
1063
|
/**
|
|
1091
|
-
* <p>Provides information about a document that could not be
|
|
1092
|
-
* indexed.</p>
|
|
1064
|
+
* <p>Provides information about a document that could not be indexed.</p>
|
|
1093
1065
|
*/
|
|
1094
1066
|
export interface BatchPutDocumentResponseFailedDocument {
|
|
1095
1067
|
/**
|
|
@@ -1097,13 +1069,11 @@ export interface BatchPutDocumentResponseFailedDocument {
|
|
|
1097
1069
|
*/
|
|
1098
1070
|
Id?: string;
|
|
1099
1071
|
/**
|
|
1100
|
-
* <p>The type of error that caused the document to fail to be
|
|
1101
|
-
* indexed.</p>
|
|
1072
|
+
* <p>The type of error that caused the document to fail to be indexed.</p>
|
|
1102
1073
|
*/
|
|
1103
1074
|
ErrorCode?: ErrorCode | string;
|
|
1104
1075
|
/**
|
|
1105
|
-
* <p>A description of the reason why the document could not be
|
|
1106
|
-
* indexed.</p>
|
|
1076
|
+
* <p>A description of the reason why the document could not be indexed.</p>
|
|
1107
1077
|
*/
|
|
1108
1078
|
ErrorMessage?: string;
|
|
1109
1079
|
}
|
|
@@ -1675,8 +1645,8 @@ export interface ConfluenceConfiguration {
|
|
|
1675
1645
|
AuthenticationType?: ConfluenceAuthenticationType | string;
|
|
1676
1646
|
}
|
|
1677
1647
|
/**
|
|
1678
|
-
* <p>Provides information about how Amazon Kendra should use the columns of
|
|
1679
|
-
*
|
|
1648
|
+
* <p>Provides information about how Amazon Kendra should use the columns of a database
|
|
1649
|
+
* in an index.</p>
|
|
1680
1650
|
*/
|
|
1681
1651
|
export interface ColumnConfiguration {
|
|
1682
1652
|
/**
|
|
@@ -1692,14 +1662,13 @@ export interface ColumnConfiguration {
|
|
|
1692
1662
|
*/
|
|
1693
1663
|
DocumentTitleColumnName?: string;
|
|
1694
1664
|
/**
|
|
1695
|
-
* <p>An array of objects that map database column names to the
|
|
1696
|
-
*
|
|
1697
|
-
*
|
|
1665
|
+
* <p>An array of objects that map database column names to the corresponding fields in an
|
|
1666
|
+
* index. You must first create the fields in the index using the <code>UpdateIndex</code>
|
|
1667
|
+
* API.</p>
|
|
1698
1668
|
*/
|
|
1699
1669
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1700
1670
|
/**
|
|
1701
|
-
* <p>One to five columns that indicate when a document in the database
|
|
1702
|
-
* has changed.</p>
|
|
1671
|
+
* <p>One to five columns that indicate when a document in the database has changed.</p>
|
|
1703
1672
|
*/
|
|
1704
1673
|
ChangeDetectingColumns: string[] | undefined;
|
|
1705
1674
|
}
|
|
@@ -1726,13 +1695,13 @@ export interface ConnectionConfiguration {
|
|
|
1726
1695
|
*/
|
|
1727
1696
|
TableName: string | undefined;
|
|
1728
1697
|
/**
|
|
1729
|
-
* <p>The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
|
|
1730
|
-
*
|
|
1731
|
-
*
|
|
1732
|
-
*
|
|
1733
|
-
*
|
|
1734
|
-
* Secrets Manager
|
|
1735
|
-
*
|
|
1698
|
+
* <p>The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The
|
|
1699
|
+
* credentials should be a user/password pair. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html">Using a
|
|
1700
|
+
* Database Data Source</a>. For more information about Secrets Manager, see
|
|
1701
|
+
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html"> What
|
|
1702
|
+
* Is Secrets Manager</a> in the <i>
|
|
1703
|
+
* Secrets Manager
|
|
1704
|
+
* </i> user guide.</p>
|
|
1736
1705
|
*/
|
|
1737
1706
|
SecretArn: string | undefined;
|
|
1738
1707
|
}
|
|
@@ -1747,29 +1716,25 @@ export declare enum QueryIdentifiersEnclosingOption {
|
|
|
1747
1716
|
NONE = "NONE"
|
|
1748
1717
|
}
|
|
1749
1718
|
/**
|
|
1750
|
-
* <p>Provides the configuration information to use a SQL
|
|
1751
|
-
* database.</p>
|
|
1719
|
+
* <p>Provides the configuration information to use a SQL database.</p>
|
|
1752
1720
|
*/
|
|
1753
1721
|
export interface SqlConfiguration {
|
|
1754
1722
|
/**
|
|
1755
|
-
* <p>Determines whether Amazon Kendra encloses SQL identifiers for tables and
|
|
1756
|
-
*
|
|
1757
|
-
*
|
|
1758
|
-
*
|
|
1759
|
-
*
|
|
1760
|
-
*
|
|
1761
|
-
*
|
|
1762
|
-
*
|
|
1763
|
-
*
|
|
1764
|
-
*
|
|
1765
|
-
* <p>For MySQL databases, you must enable the <code>ansi_quotes</code>
|
|
1766
|
-
* option when you set this field to <code>DOUBLE_QUOTES</code>.</p>
|
|
1723
|
+
* <p>Determines whether Amazon Kendra encloses SQL identifiers for tables and column
|
|
1724
|
+
* names in double quotes (") when making a database query.</p>
|
|
1725
|
+
* <p>By default, Amazon Kendra passes SQL identifiers the way that they are entered
|
|
1726
|
+
* into the data source configuration. It does not change the case of identifiers or
|
|
1727
|
+
* enclose them in quotes.</p>
|
|
1728
|
+
* <p>PostgreSQL internally converts uppercase characters to lower case characters in
|
|
1729
|
+
* identifiers unless they are quoted. Choosing this option encloses identifiers in quotes
|
|
1730
|
+
* so that PostgreSQL does not convert the character's case.</p>
|
|
1731
|
+
* <p>For MySQL databases, you must enable the <code>ansi_quotes</code> option when you set
|
|
1732
|
+
* this field to <code>DOUBLE_QUOTES</code>.</p>
|
|
1767
1733
|
*/
|
|
1768
1734
|
QueryIdentifiersEnclosingOption?: QueryIdentifiersEnclosingOption | string;
|
|
1769
1735
|
}
|
|
1770
1736
|
/**
|
|
1771
|
-
* <p>Provides the configuration information to connect to a
|
|
1772
|
-
* index. </p>
|
|
1737
|
+
* <p>Provides the configuration information to connect to a index. </p>
|
|
1773
1738
|
*/
|
|
1774
1739
|
export interface DatabaseConfiguration {
|
|
1775
1740
|
/**
|
|
@@ -1785,13 +1750,13 @@ export interface DatabaseConfiguration {
|
|
|
1785
1750
|
*/
|
|
1786
1751
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1787
1752
|
/**
|
|
1788
|
-
* <p>Information about where the index should get the document
|
|
1789
|
-
*
|
|
1753
|
+
* <p>Information about where the index should get the document information from the
|
|
1754
|
+
* database.</p>
|
|
1790
1755
|
*/
|
|
1791
1756
|
ColumnConfiguration: ColumnConfiguration | undefined;
|
|
1792
1757
|
/**
|
|
1793
|
-
* <p>Information about the database column that provides information
|
|
1794
|
-
*
|
|
1758
|
+
* <p>Information about the database column that provides information for user context
|
|
1759
|
+
* filtering.</p>
|
|
1795
1760
|
*/
|
|
1796
1761
|
AclConfiguration?: AclConfiguration;
|
|
1797
1762
|
/**
|
|
@@ -2330,23 +2295,21 @@ export interface JiraConfiguration {
|
|
|
2330
2295
|
*/
|
|
2331
2296
|
export interface OneDriveUsers {
|
|
2332
2297
|
/**
|
|
2333
|
-
* <p>A list of users whose documents should be indexed. Specify the
|
|
2334
|
-
*
|
|
2335
|
-
*
|
|
2336
|
-
*
|
|
2337
|
-
* <code>OneDriveUserS3Path</code> field to specify the location of
|
|
2338
|
-
* a file containing a list of users.</p>
|
|
2298
|
+
* <p>A list of users whose documents should be indexed. Specify the user names in email
|
|
2299
|
+
* format, for example, <code>username@tenantdomain</code>. If you need to index the
|
|
2300
|
+
* documents of more than 100 users, use the <code>OneDriveUserS3Path</code> field to
|
|
2301
|
+
* specify the location of a file containing a list of users.</p>
|
|
2339
2302
|
*/
|
|
2340
2303
|
OneDriveUserList?: string[];
|
|
2341
2304
|
/**
|
|
2342
|
-
* <p>The S3 bucket location of a file containing a list of users whose
|
|
2343
|
-
*
|
|
2305
|
+
* <p>The S3 bucket location of a file containing a list of users whose documents should be
|
|
2306
|
+
* indexed.</p>
|
|
2344
2307
|
*/
|
|
2345
2308
|
OneDriveUserS3Path?: S3Path;
|
|
2346
2309
|
}
|
|
2347
2310
|
/**
|
|
2348
|
-
* <p>Provides the configuration information to connect
|
|
2349
|
-
*
|
|
2311
|
+
* <p>Provides the configuration information to connect to OneDrive as your data
|
|
2312
|
+
* source.</p>
|
|
2350
2313
|
*/
|
|
2351
2314
|
export interface OneDriveConfiguration {
|
|
2352
2315
|
/**
|
|
@@ -2354,11 +2317,10 @@ export interface OneDriveConfiguration {
|
|
|
2354
2317
|
*/
|
|
2355
2318
|
TenantDomain: string | undefined;
|
|
2356
2319
|
/**
|
|
2357
|
-
* <p>The Amazon Resource Name (ARN) of an Secrets Managersecret
|
|
2358
|
-
*
|
|
2359
|
-
*
|
|
2360
|
-
*
|
|
2361
|
-
* application.</p>
|
|
2320
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the
|
|
2321
|
+
* user name and password to connect to OneDrive. The user namd should be the application
|
|
2322
|
+
* ID for the OneDrive application, and the password is the application key for the
|
|
2323
|
+
* OneDrive application.</p>
|
|
2362
2324
|
*/
|
|
2363
2325
|
SecretArn: string | undefined;
|
|
2364
2326
|
/**
|
|
@@ -2366,22 +2328,20 @@ export interface OneDriveConfiguration {
|
|
|
2366
2328
|
*/
|
|
2367
2329
|
OneDriveUsers: OneDriveUsers | undefined;
|
|
2368
2330
|
/**
|
|
2369
|
-
* <p>A list of regular expression patterns to include certain documents
|
|
2370
|
-
* in
|
|
2371
|
-
* patterns are
|
|
2372
|
-
*
|
|
2373
|
-
*
|
|
2374
|
-
* precedence and the document isn't included in the index.</p>
|
|
2331
|
+
* <p>A list of regular expression patterns to include certain documents in your OneDrive.
|
|
2332
|
+
* Documents that match the patterns are included in the index. Documents that don't match
|
|
2333
|
+
* the patterns are excluded from the index. If a document matches both an inclusion and
|
|
2334
|
+
* exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
2335
|
+
* included in the index.</p>
|
|
2375
2336
|
* <p>The pattern is applied to the file name.</p>
|
|
2376
2337
|
*/
|
|
2377
2338
|
InclusionPatterns?: string[];
|
|
2378
2339
|
/**
|
|
2379
|
-
* <p>A list of regular expression patterns to exclude certain documents
|
|
2380
|
-
*
|
|
2381
|
-
* patterns are
|
|
2382
|
-
*
|
|
2383
|
-
*
|
|
2384
|
-
* precedence and the document isn't included in the index.</p>
|
|
2340
|
+
* <p>A list of regular expression patterns to exclude certain documents in your OneDrive.
|
|
2341
|
+
* Documents that match the patterns are excluded from the index. Documents that don't
|
|
2342
|
+
* match the patterns are included in the index. If a document matches both an inclusion
|
|
2343
|
+
* and exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
2344
|
+
* included in the index.</p>
|
|
2385
2345
|
* <p>The pattern is applied to the file name.</p>
|
|
2386
2346
|
*/
|
|
2387
2347
|
ExclusionPatterns?: string[];
|
|
@@ -2389,8 +2349,8 @@ export interface OneDriveConfiguration {
|
|
|
2389
2349
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map OneDrive data
|
|
2390
2350
|
* source attributes or field names to Amazon Kendra index field names. To create
|
|
2391
2351
|
* custom fields, use the <code>UpdateIndex</code> API before you map to OneDrive fields.
|
|
2392
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2393
|
-
*
|
|
2352
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2353
|
+
* OneDrive data source field names must exist in your OneDrive custom metadata.</p>
|
|
2394
2354
|
*/
|
|
2395
2355
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2396
2356
|
/**
|
|
@@ -2499,23 +2459,21 @@ export interface QuipConfiguration {
|
|
|
2499
2459
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2500
2460
|
}
|
|
2501
2461
|
/**
|
|
2502
|
-
* <p>Document metadata files that contain information such as the
|
|
2503
|
-
*
|
|
2504
|
-
*
|
|
2505
|
-
* single document.</p>
|
|
2462
|
+
* <p>Document metadata files that contain information such as the document access control
|
|
2463
|
+
* information, source URI, document author, and custom attributes. Each metadata file
|
|
2464
|
+
* contains metadata about a single document.</p>
|
|
2506
2465
|
*/
|
|
2507
2466
|
export interface DocumentsMetadataConfiguration {
|
|
2508
2467
|
/**
|
|
2509
2468
|
* <p>A prefix used to filter metadata configuration files in the Amazon Web Services S3
|
|
2510
|
-
* bucket. The S3 bucket might contain multiple metadata files. Use
|
|
2511
|
-
*
|
|
2512
|
-
* files.</p>
|
|
2469
|
+
* bucket. The S3 bucket might contain multiple metadata files. Use <code>S3Prefix</code>
|
|
2470
|
+
* to include only the desired metadata files.</p>
|
|
2513
2471
|
*/
|
|
2514
2472
|
S3Prefix?: string;
|
|
2515
2473
|
}
|
|
2516
2474
|
/**
|
|
2517
|
-
* <p>Provides the configuration information to connect to
|
|
2518
|
-
*
|
|
2475
|
+
* <p>Provides the configuration information to connect to an Amazon S3
|
|
2476
|
+
* bucket.</p>
|
|
2519
2477
|
*/
|
|
2520
2478
|
export interface S3DataSourceConfiguration {
|
|
2521
2479
|
/**
|
|
@@ -2523,75 +2481,70 @@ export interface S3DataSourceConfiguration {
|
|
|
2523
2481
|
*/
|
|
2524
2482
|
BucketName: string | undefined;
|
|
2525
2483
|
/**
|
|
2526
|
-
* <p>A list of S3 prefixes for the documents that should be included in
|
|
2527
|
-
* the index.</p>
|
|
2484
|
+
* <p>A list of S3 prefixes for the documents that should be included in the index.</p>
|
|
2528
2485
|
*/
|
|
2529
2486
|
InclusionPrefixes?: string[];
|
|
2530
2487
|
/**
|
|
2531
|
-
* <p>A list of glob patterns for documents that should be indexed. If a
|
|
2532
|
-
*
|
|
2533
|
-
*
|
|
2488
|
+
* <p>A list of glob patterns for documents that should be indexed. If a document that
|
|
2489
|
+
* matches an inclusion pattern also matches an exclusion pattern, the document is not
|
|
2490
|
+
* indexed.</p>
|
|
2534
2491
|
* <p>Some <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">examples</a>
|
|
2535
2492
|
* are:</p>
|
|
2536
2493
|
* <ul>
|
|
2537
2494
|
* <li>
|
|
2538
2495
|
* <p>
|
|
2539
|
-
* <i>*.txt</i> will include all text files
|
|
2540
|
-
*
|
|
2496
|
+
* <i>*.txt</i> will include all text files in a directory (files
|
|
2497
|
+
* with the extension .txt).</p>
|
|
2541
2498
|
* </li>
|
|
2542
2499
|
* <li>
|
|
2543
2500
|
* <p>
|
|
2544
|
-
* <i>**\/*.txt</i> will include all text
|
|
2545
|
-
*
|
|
2501
|
+
* <i>**\/*.txt</i> will include all text files in a directory and
|
|
2502
|
+
* its subdirectories.</p>
|
|
2546
2503
|
* </li>
|
|
2547
2504
|
* <li>
|
|
2548
2505
|
* <p>
|
|
2549
|
-
* <i>*tax*</i> will include all files in
|
|
2550
|
-
*
|
|
2551
|
-
* 'taxes', 'income_tax'.</p>
|
|
2506
|
+
* <i>*tax*</i> will include all files in a directory that contain
|
|
2507
|
+
* 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.</p>
|
|
2552
2508
|
* </li>
|
|
2553
2509
|
* </ul>
|
|
2554
2510
|
*/
|
|
2555
2511
|
InclusionPatterns?: string[];
|
|
2556
2512
|
/**
|
|
2557
|
-
* <p>A list of glob patterns for documents that should not be indexed.
|
|
2558
|
-
*
|
|
2559
|
-
*
|
|
2560
|
-
* indexed.</p>
|
|
2513
|
+
* <p>A list of glob patterns for documents that should not be indexed. If a document that
|
|
2514
|
+
* matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the
|
|
2515
|
+
* document is not indexed.</p>
|
|
2561
2516
|
* <p>Some <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">examples</a>
|
|
2562
2517
|
* are:</p>
|
|
2563
2518
|
* <ul>
|
|
2564
2519
|
* <li>
|
|
2565
2520
|
* <p>
|
|
2566
|
-
* <i>*.png , *.jpg</i> will exclude
|
|
2567
|
-
*
|
|
2568
|
-
* (files with the extensions .png and .jpg).</p>
|
|
2521
|
+
* <i>*.png , *.jpg</i> will exclude all PNG and JPEG image files
|
|
2522
|
+
* in a directory (files with the extensions .png and .jpg).</p>
|
|
2569
2523
|
* </li>
|
|
2570
2524
|
* <li>
|
|
2571
2525
|
* <p>
|
|
2572
|
-
* <i>*internal*</i> will exclude all
|
|
2573
|
-
*
|
|
2574
|
-
*
|
|
2526
|
+
* <i>*internal*</i> will exclude all files in a directory that
|
|
2527
|
+
* contain 'internal' in the file name, such as 'internal', 'internal_only',
|
|
2528
|
+
* 'company_internal'.</p>
|
|
2575
2529
|
* </li>
|
|
2576
2530
|
* <li>
|
|
2577
2531
|
* <p>
|
|
2578
|
-
* <i>**\/*internal*</i> will exclude
|
|
2579
|
-
*
|
|
2532
|
+
* <i>**\/*internal*</i> will exclude all internal-related files in
|
|
2533
|
+
* a directory and its subdirectories.</p>
|
|
2580
2534
|
* </li>
|
|
2581
2535
|
* </ul>
|
|
2582
2536
|
*/
|
|
2583
2537
|
ExclusionPatterns?: string[];
|
|
2584
2538
|
/**
|
|
2585
|
-
* <p>Document metadata files that contain information such as the
|
|
2586
|
-
*
|
|
2587
|
-
*
|
|
2588
|
-
* single document.</p>
|
|
2539
|
+
* <p>Document metadata files that contain information such as the document access control
|
|
2540
|
+
* information, source URI, document author, and custom attributes. Each metadata file
|
|
2541
|
+
* contains metadata about a single document.</p>
|
|
2589
2542
|
*/
|
|
2590
2543
|
DocumentsMetadataConfiguration?: DocumentsMetadataConfiguration;
|
|
2591
2544
|
/**
|
|
2592
|
-
* <p>Provides the path to the S3 bucket that contains the user context
|
|
2593
|
-
*
|
|
2594
|
-
*
|
|
2545
|
+
* <p>Provides the path to the S3 bucket that contains the user context filtering files for
|
|
2546
|
+
* the data source. For the format of the file, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html">Access control for S3 data
|
|
2547
|
+
* sources</a>.</p>
|
|
2595
2548
|
*/
|
|
2596
2549
|
AccessControlListConfiguration?: AccessControlListConfiguration;
|
|
2597
2550
|
}
|
|
@@ -2600,21 +2553,18 @@ export declare enum SalesforceChatterFeedIncludeFilterType {
|
|
|
2600
2553
|
STANDARD_USER = "STANDARD_USER"
|
|
2601
2554
|
}
|
|
2602
2555
|
/**
|
|
2603
|
-
* <p>The configuration information for syncing a Salesforce chatter feed. The
|
|
2604
|
-
*
|
|
2605
|
-
* table.</p>
|
|
2556
|
+
* <p>The configuration information for syncing a Salesforce chatter feed. The contents of
|
|
2557
|
+
* the object comes from the Salesforce FeedItem table.</p>
|
|
2606
2558
|
*/
|
|
2607
2559
|
export interface SalesforceChatterFeedConfiguration {
|
|
2608
2560
|
/**
|
|
2609
|
-
* <p>The name of the column in the Salesforce FeedItem table that
|
|
2610
|
-
*
|
|
2611
|
-
* <code>Body</code> column.</p>
|
|
2561
|
+
* <p>The name of the column in the Salesforce FeedItem table that contains the content to
|
|
2562
|
+
* index. Typically this is the <code>Body</code> column.</p>
|
|
2612
2563
|
*/
|
|
2613
2564
|
DocumentDataFieldName: string | undefined;
|
|
2614
2565
|
/**
|
|
2615
|
-
* <p>The name of the column in the Salesforce FeedItem table that
|
|
2616
|
-
*
|
|
2617
|
-
* <code>Title</code> column.</p>
|
|
2566
|
+
* <p>The name of the column in the Salesforce FeedItem table that contains the title of the
|
|
2567
|
+
* document. This is typically the <code>Title</code> column.</p>
|
|
2618
2568
|
*/
|
|
2619
2569
|
DocumentTitleFieldName?: string;
|
|
2620
2570
|
/**
|
|
@@ -2623,17 +2573,15 @@ export interface SalesforceChatterFeedConfiguration {
|
|
|
2623
2573
|
*/
|
|
2624
2574
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2625
2575
|
/**
|
|
2626
|
-
* <p>Filters the documents in the feed based on status of the user.
|
|
2627
|
-
*
|
|
2628
|
-
*
|
|
2629
|
-
* <code>STANDARD_USER</code> only documents for Salesforce
|
|
2576
|
+
* <p>Filters the documents in the feed based on status of the user. When you specify
|
|
2577
|
+
* <code>ACTIVE_USERS</code> only documents from users who have an active account are
|
|
2578
|
+
* indexed. When you specify <code>STANDARD_USER</code> only documents for Salesforce
|
|
2630
2579
|
* standard users are documented. You can specify both.</p>
|
|
2631
2580
|
*/
|
|
2632
2581
|
IncludeFilterTypes?: (SalesforceChatterFeedIncludeFilterType | string)[];
|
|
2633
2582
|
}
|
|
2634
2583
|
/**
|
|
2635
|
-
* <p>Provides the configuration information for indexing Salesforce custom
|
|
2636
|
-
* articles.</p>
|
|
2584
|
+
* <p>Provides the configuration information for indexing Salesforce custom articles.</p>
|
|
2637
2585
|
*/
|
|
2638
2586
|
export interface SalesforceCustomKnowledgeArticleTypeConfiguration {
|
|
2639
2587
|
/**
|
|
@@ -2641,21 +2589,20 @@ export interface SalesforceCustomKnowledgeArticleTypeConfiguration {
|
|
|
2641
2589
|
*/
|
|
2642
2590
|
Name: string | undefined;
|
|
2643
2591
|
/**
|
|
2644
|
-
* <p>The name of the field in the custom knowledge article that
|
|
2645
|
-
*
|
|
2592
|
+
* <p>The name of the field in the custom knowledge article that contains the document data
|
|
2593
|
+
* to index.</p>
|
|
2646
2594
|
*/
|
|
2647
2595
|
DocumentDataFieldName: string | undefined;
|
|
2648
2596
|
/**
|
|
2649
|
-
* <p>The name of the field in the custom knowledge article that
|
|
2650
|
-
*
|
|
2597
|
+
* <p>The name of the field in the custom knowledge article that contains the document
|
|
2598
|
+
* title.</p>
|
|
2651
2599
|
*/
|
|
2652
2600
|
DocumentTitleFieldName?: string;
|
|
2653
2601
|
/**
|
|
2654
2602
|
* <p>Maps attributes or field names of the custom knowledge article to Amazon Kendra
|
|
2655
|
-
* index field names. To create custom fields, use the <code>UpdateIndex</code> API
|
|
2656
|
-
*
|
|
2657
|
-
*
|
|
2658
|
-
* The Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2603
|
+
* index field names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
2604
|
+
* you map to Salesforce fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2605
|
+
* Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2659
2606
|
*/
|
|
2660
2607
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2661
2608
|
}
|
|
@@ -2665,13 +2612,12 @@ export declare enum SalesforceKnowledgeArticleState {
|
|
|
2665
2612
|
PUBLISHED = "PUBLISHED"
|
|
2666
2613
|
}
|
|
2667
2614
|
/**
|
|
2668
|
-
* <p>Provides the configuration information for standard Salesforce
|
|
2669
|
-
*
|
|
2615
|
+
* <p>Provides the configuration information for standard Salesforce knowledge
|
|
2616
|
+
* articles.</p>
|
|
2670
2617
|
*/
|
|
2671
2618
|
export interface SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
2672
2619
|
/**
|
|
2673
|
-
* <p>The name of the field that contains the document data to
|
|
2674
|
-
* index.</p>
|
|
2620
|
+
* <p>The name of the field that contains the document data to index.</p>
|
|
2675
2621
|
*/
|
|
2676
2622
|
DocumentDataFieldName: string | undefined;
|
|
2677
2623
|
/**
|
|
@@ -2679,41 +2625,36 @@ export interface SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
|
2679
2625
|
*/
|
|
2680
2626
|
DocumentTitleFieldName?: string;
|
|
2681
2627
|
/**
|
|
2682
|
-
* <p>Maps attributes or field names of the knowledge article to Amazon Kendra
|
|
2683
|
-
*
|
|
2684
|
-
*
|
|
2685
|
-
*
|
|
2686
|
-
* The Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2628
|
+
* <p>Maps attributes or field names of the knowledge article to Amazon Kendra index
|
|
2629
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code> API before you
|
|
2630
|
+
* map to Salesforce fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2631
|
+
* Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2687
2632
|
*/
|
|
2688
2633
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2689
2634
|
}
|
|
2690
2635
|
/**
|
|
2691
|
-
* <p>Provides the configuration information for the knowledge article
|
|
2692
|
-
*
|
|
2693
|
-
* articles
|
|
2694
|
-
* custom fields of custom knowledge articles, but not both </p>
|
|
2636
|
+
* <p>Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the
|
|
2637
|
+
* standard fields of knowledge articles, or the custom fields of custom knowledge
|
|
2638
|
+
* articles, but not both </p>
|
|
2695
2639
|
*/
|
|
2696
2640
|
export interface SalesforceKnowledgeArticleConfiguration {
|
|
2697
2641
|
/**
|
|
2698
|
-
* <p>Specifies the document states that should be included when
|
|
2699
|
-
*
|
|
2700
|
-
* state.</p>
|
|
2642
|
+
* <p>Specifies the document states that should be included when Amazon Kendra indexes
|
|
2643
|
+
* knowledge articles. You must specify at least one state.</p>
|
|
2701
2644
|
*/
|
|
2702
2645
|
IncludedStates: (SalesforceKnowledgeArticleState | string)[] | undefined;
|
|
2703
2646
|
/**
|
|
2704
|
-
* <p>Configuration information for standard Salesforce
|
|
2705
|
-
* knowledge articles.</p>
|
|
2647
|
+
* <p>Configuration information for standard Salesforce knowledge articles.</p>
|
|
2706
2648
|
*/
|
|
2707
2649
|
StandardKnowledgeArticleTypeConfiguration?: SalesforceStandardKnowledgeArticleTypeConfiguration;
|
|
2708
2650
|
/**
|
|
2709
|
-
* <p>Configuration information for custom Salesforce knowledge
|
|
2710
|
-
* articles.</p>
|
|
2651
|
+
* <p>Configuration information for custom Salesforce knowledge articles.</p>
|
|
2711
2652
|
*/
|
|
2712
2653
|
CustomKnowledgeArticleTypeConfigurations?: SalesforceCustomKnowledgeArticleTypeConfiguration[];
|
|
2713
2654
|
}
|
|
2714
2655
|
/**
|
|
2715
|
-
* <p>Provides the configuration information for processing attachments to
|
|
2716
|
-
*
|
|
2656
|
+
* <p>Provides the configuration information for processing attachments to Salesforce
|
|
2657
|
+
* standard objects.</p>
|
|
2717
2658
|
*/
|
|
2718
2659
|
export interface SalesforceStandardObjectAttachmentConfiguration {
|
|
2719
2660
|
/**
|
|
@@ -2721,8 +2662,8 @@ export interface SalesforceStandardObjectAttachmentConfiguration {
|
|
|
2721
2662
|
*/
|
|
2722
2663
|
DocumentTitleFieldName?: string;
|
|
2723
2664
|
/**
|
|
2724
|
-
* <p>One or more objects that map fields in attachments to Amazon Kendra
|
|
2725
|
-
*
|
|
2665
|
+
* <p>One or more objects that map fields in attachments to Amazon Kendra index
|
|
2666
|
+
* fields.</p>
|
|
2726
2667
|
*/
|
|
2727
2668
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2728
2669
|
}
|
|
@@ -2746,8 +2687,7 @@ export declare enum SalesforceStandardObjectName {
|
|
|
2746
2687
|
USER = "USER"
|
|
2747
2688
|
}
|
|
2748
2689
|
/**
|
|
2749
|
-
* <p>Provides the configuration information for indexing a single standard
|
|
2750
|
-
* object.</p>
|
|
2690
|
+
* <p>Provides the configuration information for indexing a single standard object.</p>
|
|
2751
2691
|
*/
|
|
2752
2692
|
export interface SalesforceStandardObjectConfiguration {
|
|
2753
2693
|
/**
|
|
@@ -2755,63 +2695,60 @@ export interface SalesforceStandardObjectConfiguration {
|
|
|
2755
2695
|
*/
|
|
2756
2696
|
Name: SalesforceStandardObjectName | string | undefined;
|
|
2757
2697
|
/**
|
|
2758
|
-
* <p>The name of the field in the standard object table that contains
|
|
2759
|
-
*
|
|
2698
|
+
* <p>The name of the field in the standard object table that contains the document
|
|
2699
|
+
* contents.</p>
|
|
2760
2700
|
*/
|
|
2761
2701
|
DocumentDataFieldName: string | undefined;
|
|
2762
2702
|
/**
|
|
2763
|
-
* <p>The name of the field in the standard object table that contains
|
|
2764
|
-
*
|
|
2703
|
+
* <p>The name of the field in the standard object table that contains the document
|
|
2704
|
+
* title.</p>
|
|
2765
2705
|
*/
|
|
2766
2706
|
DocumentTitleFieldName?: string;
|
|
2767
2707
|
/**
|
|
2768
|
-
* <p>Maps attributes or field names of the standard object to Amazon Kendra
|
|
2769
|
-
*
|
|
2770
|
-
*
|
|
2771
|
-
*
|
|
2772
|
-
* The Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2708
|
+
* <p>Maps attributes or field names of the standard object to Amazon Kendra index
|
|
2709
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code> API before you
|
|
2710
|
+
* map to Salesforce fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2711
|
+
* Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2773
2712
|
*/
|
|
2774
2713
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2775
2714
|
}
|
|
2776
2715
|
/**
|
|
2777
|
-
* <p>Provides the configuration information to connect to Salesforce
|
|
2778
|
-
*
|
|
2716
|
+
* <p>Provides the configuration information to connect to Salesforce as your data
|
|
2717
|
+
* source.</p>
|
|
2779
2718
|
*/
|
|
2780
2719
|
export interface SalesforceConfiguration {
|
|
2781
2720
|
/**
|
|
2782
|
-
* <p>The instance URL for the Salesforce site that you want to
|
|
2783
|
-
* index.</p>
|
|
2721
|
+
* <p>The instance URL for the Salesforce site that you want to index.</p>
|
|
2784
2722
|
*/
|
|
2785
2723
|
ServerUrl: string | undefined;
|
|
2786
2724
|
/**
|
|
2787
|
-
* <p>The Amazon Resource Name (ARN) of an Secrets Managersecret
|
|
2788
|
-
*
|
|
2789
|
-
*
|
|
2790
|
-
* the following keys:</p>
|
|
2725
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the
|
|
2726
|
+
* key/value pairs required to connect to your Salesforce instance. The secret must contain
|
|
2727
|
+
* a JSON structure with the following keys:</p>
|
|
2791
2728
|
* <ul>
|
|
2792
2729
|
* <li>
|
|
2793
|
-
* <p>authenticationUrl - The OAUTH endpoint that Amazon Kendra
|
|
2794
|
-
*
|
|
2730
|
+
* <p>authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get
|
|
2731
|
+
* an OAUTH token. </p>
|
|
2795
2732
|
* </li>
|
|
2796
2733
|
* <li>
|
|
2797
|
-
* <p>consumerKey - The application public key generated when
|
|
2798
|
-
*
|
|
2734
|
+
* <p>consumerKey - The application public key generated when you created your
|
|
2735
|
+
* Salesforce application.</p>
|
|
2799
2736
|
* </li>
|
|
2800
2737
|
* <li>
|
|
2801
|
-
* <p>consumerSecret - The application private key generated
|
|
2802
|
-
*
|
|
2738
|
+
* <p>consumerSecret - The application private key generated when you created your
|
|
2739
|
+
* Salesforce application.</p>
|
|
2803
2740
|
* </li>
|
|
2804
2741
|
* <li>
|
|
2805
|
-
* <p>password - The password associated with the user logging
|
|
2806
|
-
*
|
|
2742
|
+
* <p>password - The password associated with the user logging in to the Salesforce
|
|
2743
|
+
* instance.</p>
|
|
2807
2744
|
* </li>
|
|
2808
2745
|
* <li>
|
|
2809
|
-
* <p>securityToken - The token associated with the user account
|
|
2810
|
-
*
|
|
2746
|
+
* <p>securityToken - The token associated with the user account logging in to the
|
|
2747
|
+
* Salesforce instance.</p>
|
|
2811
2748
|
* </li>
|
|
2812
2749
|
* <li>
|
|
2813
|
-
* <p>username - The user name of the user logging in to the
|
|
2814
|
-
*
|
|
2750
|
+
* <p>username - The user name of the user logging in to the Salesforce
|
|
2751
|
+
* instance.</p>
|
|
2815
2752
|
* </li>
|
|
2816
2753
|
* </ul>
|
|
2817
2754
|
*/
|
|
@@ -2822,10 +2759,10 @@ export interface SalesforceConfiguration {
|
|
|
2822
2759
|
*/
|
|
2823
2760
|
StandardObjectConfigurations?: SalesforceStandardObjectConfiguration[];
|
|
2824
2761
|
/**
|
|
2825
|
-
* <p>Configuration information for the knowledge article
|
|
2826
|
-
*
|
|
2827
|
-
* articles
|
|
2828
|
-
*
|
|
2762
|
+
* <p>Configuration information for the knowledge article types that Amazon Kendra
|
|
2763
|
+
* indexes. Amazon Kendra indexes standard knowledge articles and the standard fields
|
|
2764
|
+
* of knowledge articles, or the custom fields of custom knowledge articles, but not
|
|
2765
|
+
* both.</p>
|
|
2829
2766
|
*/
|
|
2830
2767
|
KnowledgeArticleConfiguration?: SalesforceKnowledgeArticleConfiguration;
|
|
2831
2768
|
/**
|
|
@@ -2838,25 +2775,25 @@ export interface SalesforceConfiguration {
|
|
|
2838
2775
|
*/
|
|
2839
2776
|
CrawlAttachments?: boolean;
|
|
2840
2777
|
/**
|
|
2841
|
-
* <p>Configuration information for processing attachments to
|
|
2842
|
-
*
|
|
2778
|
+
* <p>Configuration information for processing attachments to Salesforce standard objects.
|
|
2779
|
+
* </p>
|
|
2843
2780
|
*/
|
|
2844
2781
|
StandardObjectAttachmentConfiguration?: SalesforceStandardObjectAttachmentConfiguration;
|
|
2845
2782
|
/**
|
|
2846
2783
|
* <p>A list of regular expression patterns to include certain documents in your Salesforce.
|
|
2847
|
-
* Documents that match the patterns are included in the index. Documents that
|
|
2848
|
-
*
|
|
2849
|
-
*
|
|
2850
|
-
*
|
|
2784
|
+
* Documents that match the patterns are included in the index. Documents that don't match
|
|
2785
|
+
* the patterns are excluded from the index. If a document matches both an inclusion and
|
|
2786
|
+
* exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
2787
|
+
* included in the index.</p>
|
|
2851
2788
|
* <p>The pattern is applied to the name of the attached file.</p>
|
|
2852
2789
|
*/
|
|
2853
2790
|
IncludeAttachmentFilePatterns?: string[];
|
|
2854
2791
|
/**
|
|
2855
2792
|
* <p>A list of regular expression patterns to exclude certain documents in your Salesforce.
|
|
2856
|
-
* Documents that match the patterns are excluded from the index. Documents that
|
|
2857
|
-
*
|
|
2858
|
-
*
|
|
2859
|
-
*
|
|
2793
|
+
* Documents that match the patterns are excluded from the index. Documents that don't
|
|
2794
|
+
* match the patterns are included in the index. If a document matches both an inclusion
|
|
2795
|
+
* and exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
2796
|
+
* included in the index.</p>
|
|
2860
2797
|
* <p>The pattern is applied to the name of the attached file.</p>
|
|
2861
2798
|
*/
|
|
2862
2799
|
ExcludeAttachmentFilePatterns?: string[];
|
|
@@ -2866,8 +2803,8 @@ export declare enum ServiceNowAuthenticationType {
|
|
|
2866
2803
|
OAUTH2 = "OAUTH2"
|
|
2867
2804
|
}
|
|
2868
2805
|
/**
|
|
2869
|
-
* <p>Provides the configuration information for crawling knowledge articles
|
|
2870
|
-
*
|
|
2806
|
+
* <p>Provides the configuration information for crawling knowledge articles in the
|
|
2807
|
+
* ServiceNow site.</p>
|
|
2871
2808
|
*/
|
|
2872
2809
|
export interface ServiceNowKnowledgeArticleConfiguration {
|
|
2873
2810
|
/**
|
|
@@ -2876,56 +2813,54 @@ export interface ServiceNowKnowledgeArticleConfiguration {
|
|
|
2876
2813
|
*/
|
|
2877
2814
|
CrawlAttachments?: boolean;
|
|
2878
2815
|
/**
|
|
2879
|
-
* <p>A list of regular expression patterns to include certain attachments of knowledge
|
|
2880
|
-
* your ServiceNow. Item that match the patterns are included in the index.
|
|
2881
|
-
* don't match the patterns are excluded from the index. If an item matches both
|
|
2882
|
-
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2883
|
-
*
|
|
2884
|
-
* <p>The regex is
|
|
2885
|
-
*
|
|
2816
|
+
* <p>A list of regular expression patterns to include certain attachments of knowledge
|
|
2817
|
+
* articles in your ServiceNow. Item that match the patterns are included in the index.
|
|
2818
|
+
* Items that don't match the patterns are excluded from the index. If an item matches both
|
|
2819
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
|
|
2820
|
+
* isn't included in the index.</p>
|
|
2821
|
+
* <p>The regex is applied to the field specified in the
|
|
2822
|
+
* <code>PatternTargetField</code>.</p>
|
|
2886
2823
|
*/
|
|
2887
2824
|
IncludeAttachmentFilePatterns?: string[];
|
|
2888
2825
|
/**
|
|
2889
|
-
* <p>A list of regular expression patterns to exclude certain attachments of knowledge
|
|
2890
|
-
* your ServiceNow. Item that match the patterns are excluded from the index.
|
|
2891
|
-
* don't match the patterns are included in the index. If an item matches both
|
|
2892
|
-
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2893
|
-
*
|
|
2894
|
-
* <p>The regex is
|
|
2895
|
-
*
|
|
2826
|
+
* <p>A list of regular expression patterns to exclude certain attachments of knowledge
|
|
2827
|
+
* articles in your ServiceNow. Item that match the patterns are excluded from the index.
|
|
2828
|
+
* Items that don't match the patterns are included in the index. If an item matches both
|
|
2829
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
|
|
2830
|
+
* isn't included in the index.</p>
|
|
2831
|
+
* <p>The regex is applied to the field specified in the
|
|
2832
|
+
* <code>PatternTargetField</code>.</p>
|
|
2896
2833
|
*/
|
|
2897
2834
|
ExcludeAttachmentFilePatterns?: string[];
|
|
2898
2835
|
/**
|
|
2899
|
-
* <p>The name of the ServiceNow field that is mapped to the index
|
|
2900
|
-
*
|
|
2836
|
+
* <p>The name of the ServiceNow field that is mapped to the index document contents field
|
|
2837
|
+
* in the Amazon Kendra index.</p>
|
|
2901
2838
|
*/
|
|
2902
2839
|
DocumentDataFieldName: string | undefined;
|
|
2903
2840
|
/**
|
|
2904
|
-
* <p>The name of the ServiceNow field that is mapped to the index
|
|
2905
|
-
*
|
|
2841
|
+
* <p>The name of the ServiceNow field that is mapped to the index document title
|
|
2842
|
+
* field.</p>
|
|
2906
2843
|
*/
|
|
2907
2844
|
DocumentTitleFieldName?: string;
|
|
2908
2845
|
/**
|
|
2909
|
-
* <p>Maps attributes or field names of knoweldge articles to Amazon Kendra index
|
|
2910
|
-
*
|
|
2911
|
-
*
|
|
2912
|
-
*
|
|
2913
|
-
* The ServiceNow data source field names must exist in your ServiceNow custom metadata.</p>
|
|
2846
|
+
* <p>Maps attributes or field names of knoweldge articles to Amazon Kendra index field
|
|
2847
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
2848
|
+
* ServiceNow fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2849
|
+
* ServiceNow data source field names must exist in your ServiceNow custom metadata.</p>
|
|
2914
2850
|
*/
|
|
2915
2851
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2916
2852
|
/**
|
|
2917
|
-
* <p>A query that selects the knowledge articles to index. The query
|
|
2918
|
-
*
|
|
2919
|
-
*
|
|
2920
|
-
*
|
|
2921
|
-
*
|
|
2922
|
-
* documents to index with a query</a>. </p>
|
|
2853
|
+
* <p>A query that selects the knowledge articles to index. The query can return articles
|
|
2854
|
+
* from multiple knowledge bases, and the knowledge bases can be public or private.</p>
|
|
2855
|
+
* <p>The query string must be one generated by the ServiceNow console. For more
|
|
2856
|
+
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html">Specifying documents to index with a
|
|
2857
|
+
* query</a>. </p>
|
|
2923
2858
|
*/
|
|
2924
2859
|
FilterQuery?: string;
|
|
2925
2860
|
}
|
|
2926
2861
|
/**
|
|
2927
|
-
* <p>Provides the configuration information for crawling service catalog
|
|
2928
|
-
*
|
|
2862
|
+
* <p>Provides the configuration information for crawling service catalog items in the
|
|
2863
|
+
* ServiceNow site</p>
|
|
2929
2864
|
*/
|
|
2930
2865
|
export interface ServiceNowServiceCatalogConfiguration {
|
|
2931
2866
|
/**
|
|
@@ -2936,37 +2871,36 @@ export interface ServiceNowServiceCatalogConfiguration {
|
|
|
2936
2871
|
/**
|
|
2937
2872
|
* <p>A list of regular expression patterns to include certain attachments of catalogs in
|
|
2938
2873
|
* your ServiceNow. Item that match the patterns are included in the index. Items that
|
|
2939
|
-
* don't match the patterns are excluded from the index. If an item matches both
|
|
2940
|
-
*
|
|
2941
|
-
*
|
|
2874
|
+
* don't match the patterns are excluded from the index. If an item matches both an
|
|
2875
|
+
* inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
|
|
2876
|
+
* isn't included in the index.</p>
|
|
2942
2877
|
* <p>The regex is applied to the file name of the attachment.</p>
|
|
2943
2878
|
*/
|
|
2944
2879
|
IncludeAttachmentFilePatterns?: string[];
|
|
2945
2880
|
/**
|
|
2946
2881
|
* <p>A list of regular expression patterns to exclude certain attachments of catalogs in
|
|
2947
2882
|
* your ServiceNow. Item that match the patterns are excluded from the index. Items that
|
|
2948
|
-
* don't match the patterns are included in the index. If an item matches both
|
|
2949
|
-
*
|
|
2950
|
-
*
|
|
2883
|
+
* don't match the patterns are included in the index. If an item matches both an inclusion
|
|
2884
|
+
* and exclusion pattern, the exclusion pattern takes precedence and the item isn't
|
|
2885
|
+
* included in the index.</p>
|
|
2951
2886
|
* <p>The regex is applied to the file name of the attachment.</p>
|
|
2952
2887
|
*/
|
|
2953
2888
|
ExcludeAttachmentFilePatterns?: string[];
|
|
2954
2889
|
/**
|
|
2955
|
-
* <p>The name of the ServiceNow field that is mapped to the index
|
|
2956
|
-
*
|
|
2890
|
+
* <p>The name of the ServiceNow field that is mapped to the index document contents field
|
|
2891
|
+
* in the Amazon Kendra index.</p>
|
|
2957
2892
|
*/
|
|
2958
2893
|
DocumentDataFieldName: string | undefined;
|
|
2959
2894
|
/**
|
|
2960
|
-
* <p>The name of the ServiceNow field that is mapped to the index
|
|
2961
|
-
*
|
|
2895
|
+
* <p>The name of the ServiceNow field that is mapped to the index document title
|
|
2896
|
+
* field.</p>
|
|
2962
2897
|
*/
|
|
2963
2898
|
DocumentTitleFieldName?: string;
|
|
2964
2899
|
/**
|
|
2965
|
-
* <p>Maps attributes or field names of catalogs to Amazon Kendra index
|
|
2966
|
-
*
|
|
2967
|
-
*
|
|
2968
|
-
*
|
|
2969
|
-
* The ServiceNow data source field names must exist in your ServiceNow custom metadata.</p>
|
|
2900
|
+
* <p>Maps attributes or field names of catalogs to Amazon Kendra index field names. To
|
|
2901
|
+
* create custom fields, use the <code>UpdateIndex</code> API before you map to ServiceNow
|
|
2902
|
+
* fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2903
|
+
* ServiceNow data source field names must exist in your ServiceNow custom metadata.</p>
|
|
2970
2904
|
*/
|
|
2971
2905
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2972
2906
|
}
|
|
@@ -2975,52 +2909,45 @@ export declare enum ServiceNowBuildVersionType {
|
|
|
2975
2909
|
OTHERS = "OTHERS"
|
|
2976
2910
|
}
|
|
2977
2911
|
/**
|
|
2978
|
-
* <p>Provides the configuration information to connect to
|
|
2979
|
-
*
|
|
2912
|
+
* <p>Provides the configuration information to connect to ServiceNow as your data
|
|
2913
|
+
* source.</p>
|
|
2980
2914
|
*/
|
|
2981
2915
|
export interface ServiceNowConfiguration {
|
|
2982
2916
|
/**
|
|
2983
|
-
* <p>The ServiceNow instance that the data source connects to. The host
|
|
2984
|
-
*
|
|
2985
|
-
* <i>{instance}.service-now.com.</i>
|
|
2917
|
+
* <p>The ServiceNow instance that the data source connects to. The host endpoint should
|
|
2918
|
+
* look like the following: <i>{instance}.service-now.com.</i>
|
|
2986
2919
|
* </p>
|
|
2987
2920
|
*/
|
|
2988
2921
|
HostUrl: string | undefined;
|
|
2989
2922
|
/**
|
|
2990
|
-
* <p>The Amazon Resource Name (ARN) of the Secrets Manager secret
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
2993
|
-
*
|
|
2994
|
-
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html#servicenow-authentication">Authentication
|
|
2995
|
-
* for a ServiceNow data source</a>.</p>
|
|
2923
|
+
* <p>The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the
|
|
2924
|
+
* user name and password required to connect to the ServiceNow instance. You can also
|
|
2925
|
+
* provide OAuth authentication credentials of user name, password, client ID, and client
|
|
2926
|
+
* secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html#servicenow-authentication">Authentication for a ServiceNow data source</a>.</p>
|
|
2996
2927
|
*/
|
|
2997
2928
|
SecretArn: string | undefined;
|
|
2998
2929
|
/**
|
|
2999
|
-
* <p>The identifier of the release that the ServiceNow host is running.
|
|
3000
|
-
*
|
|
3001
|
-
* <code>OTHERS</code>.</p>
|
|
2930
|
+
* <p>The identifier of the release that the ServiceNow host is running. If the host is not
|
|
2931
|
+
* running the <code>LONDON</code> release, use <code>OTHERS</code>.</p>
|
|
3002
2932
|
*/
|
|
3003
2933
|
ServiceNowBuildVersion: ServiceNowBuildVersionType | string | undefined;
|
|
3004
2934
|
/**
|
|
3005
|
-
* <p>Configuration information for crawling knowledge articles
|
|
3006
|
-
*
|
|
2935
|
+
* <p>Configuration information for crawling knowledge articles in the ServiceNow
|
|
2936
|
+
* site.</p>
|
|
3007
2937
|
*/
|
|
3008
2938
|
KnowledgeArticleConfiguration?: ServiceNowKnowledgeArticleConfiguration;
|
|
3009
2939
|
/**
|
|
3010
|
-
* <p>Configuration information for crawling service catalogs
|
|
3011
|
-
* in the ServiceNow site.</p>
|
|
2940
|
+
* <p>Configuration information for crawling service catalogs in the ServiceNow site.</p>
|
|
3012
2941
|
*/
|
|
3013
2942
|
ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration;
|
|
3014
2943
|
/**
|
|
3015
|
-
* <p>The type of authentication used to connect to the
|
|
3016
|
-
*
|
|
3017
|
-
*
|
|
3018
|
-
*
|
|
3019
|
-
* choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the
|
|
2944
|
+
* <p>The type of authentication used to connect to the ServiceNow instance. If you choose
|
|
2945
|
+
* <code>HTTP_BASIC</code>, Amazon Kendra is authenticated using the user name and
|
|
2946
|
+
* password provided in the Secrets Manager secret in the <code>SecretArn</code>
|
|
2947
|
+
* field. If you choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the
|
|
3020
2948
|
* credentials of client ID, client secret, user name and password.</p>
|
|
3021
|
-
* <p>When you use <code>OAUTH2</code> authentication, you must generate
|
|
3022
|
-
*
|
|
3023
|
-
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html">Using a
|
|
2949
|
+
* <p>When you use <code>OAUTH2</code> authentication, you must generate a token and a
|
|
2950
|
+
* client secret using the ServiceNow console. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html">Using a
|
|
3024
2951
|
* ServiceNow data source</a>.</p>
|
|
3025
2952
|
*/
|
|
3026
2953
|
AuthenticationType?: ServiceNowAuthenticationType | string;
|
|
@@ -3036,8 +2963,8 @@ export declare enum SharePointVersion {
|
|
|
3036
2963
|
SHAREPOINT_ONLINE = "SHAREPOINT_ONLINE"
|
|
3037
2964
|
}
|
|
3038
2965
|
/**
|
|
3039
|
-
* <p>Provides the configuration information to connect to Microsoft
|
|
3040
|
-
*
|
|
2966
|
+
* <p>Provides the configuration information to connect to Microsoft SharePoint as your data
|
|
2967
|
+
* source.</p>
|
|
3041
2968
|
*/
|
|
3042
2969
|
export interface SharePointConfiguration {
|
|
3043
2970
|
/**
|
|
@@ -3049,17 +2976,13 @@ export interface SharePointConfiguration {
|
|
|
3049
2976
|
*/
|
|
3050
2977
|
Urls: string[] | undefined;
|
|
3051
2978
|
/**
|
|
3052
|
-
* <p>The Amazon Resource Name (ARN) of an Secrets Manager
|
|
3053
|
-
*
|
|
3054
|
-
*
|
|
3055
|
-
*
|
|
3056
|
-
*
|
|
3057
|
-
*
|
|
3058
|
-
*
|
|
3059
|
-
* <p>You can also provide OAuth authentication credentials of user name,
|
|
3060
|
-
* password, client ID, and client secret. For more information, see
|
|
3061
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html#sharepoint-authentication">Authentication
|
|
3062
|
-
* for a SharePoint data source</a>.</p>
|
|
2979
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the
|
|
2980
|
+
* user name and password required to connect to the SharePoint instance. If you use
|
|
2981
|
+
* SharePoint Server, you also need to provide the sever domain name as part of the
|
|
2982
|
+
* credentials. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html">Using a Microsoft SharePoint Data
|
|
2983
|
+
* Source</a>.</p>
|
|
2984
|
+
* <p>You can also provide OAuth authentication credentials of user name, password, client
|
|
2985
|
+
* ID, and client secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html#sharepoint-authentication">Authentication for a SharePoint data source</a>.</p>
|
|
3063
2986
|
*/
|
|
3064
2987
|
SecretArn: string | undefined;
|
|
3065
2988
|
/**
|
|
@@ -3070,49 +2993,45 @@ export interface SharePointConfiguration {
|
|
|
3070
2993
|
/**
|
|
3071
2994
|
* <p>
|
|
3072
2995
|
* <code>TRUE</code> to use the SharePoint change log to determine which documents
|
|
3073
|
-
* require updating in the index. Depending on the change log's
|
|
3074
|
-
*
|
|
3075
|
-
*
|
|
2996
|
+
* require updating in the index. Depending on the change log's size, it may take longer
|
|
2997
|
+
* for Amazon Kendra to use the change log than to scan all of your documents in
|
|
2998
|
+
* SharePoint.</p>
|
|
3076
2999
|
*/
|
|
3077
3000
|
UseChangeLog?: boolean;
|
|
3078
3001
|
/**
|
|
3079
3002
|
* <p>A list of regular expression patterns to include certain documents in your SharePoint.
|
|
3080
|
-
* Documents that match the patterns are included in the index. Documents that
|
|
3081
|
-
*
|
|
3082
|
-
*
|
|
3083
|
-
*
|
|
3084
|
-
* <p>The regex applies to the display URL of the SharePoint
|
|
3085
|
-
* document.</p>
|
|
3003
|
+
* Documents that match the patterns are included in the index. Documents that don't match
|
|
3004
|
+
* the patterns are excluded from the index. If a document matches both an inclusion and
|
|
3005
|
+
* exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
3006
|
+
* included in the index.</p>
|
|
3007
|
+
* <p>The regex applies to the display URL of the SharePoint document.</p>
|
|
3086
3008
|
*/
|
|
3087
3009
|
InclusionPatterns?: string[];
|
|
3088
3010
|
/**
|
|
3089
3011
|
* <p>A list of regular expression patterns to exclude certain documents in your SharePoint.
|
|
3090
|
-
* Documents that match the patterns are excluded from the index. Documents that
|
|
3091
|
-
*
|
|
3092
|
-
*
|
|
3093
|
-
*
|
|
3094
|
-
* <p>The regex applies to the display URL of the SharePoint
|
|
3095
|
-
* document.</p>
|
|
3012
|
+
* Documents that match the patterns are excluded from the index. Documents that don't
|
|
3013
|
+
* match the patterns are included in the index. If a document matches both an inclusion
|
|
3014
|
+
* and exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
3015
|
+
* included in the index.</p>
|
|
3016
|
+
* <p>The regex applies to the display URL of the SharePoint document.</p>
|
|
3096
3017
|
*/
|
|
3097
3018
|
ExclusionPatterns?: string[];
|
|
3098
3019
|
/**
|
|
3099
|
-
* <p>Configuration information for an Amazon Virtual Private Cloud to connect
|
|
3100
|
-
*
|
|
3101
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring
|
|
3102
|
-
* a VPC</a>.</p>
|
|
3020
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft
|
|
3021
|
+
* SharePoint. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
3103
3022
|
*/
|
|
3104
3023
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
3105
3024
|
/**
|
|
3106
3025
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map SharePoint data
|
|
3107
3026
|
* source attributes or field names to Amazon Kendra index field names. To create
|
|
3108
3027
|
* custom fields, use the <code>UpdateIndex</code> API before you map to SharePoint fields.
|
|
3109
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
3110
|
-
*
|
|
3028
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
3029
|
+
* SharePoint data source field names must exist in your SharePoint custom metadata.</p>
|
|
3111
3030
|
*/
|
|
3112
3031
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
3113
3032
|
/**
|
|
3114
|
-
* <p>The Microsoft SharePoint attribute field that contains the title
|
|
3115
|
-
*
|
|
3033
|
+
* <p>The Microsoft SharePoint attribute field that contains the title of the
|
|
3034
|
+
* document.</p>
|
|
3116
3035
|
*/
|
|
3117
3036
|
DocumentTitleFieldName?: string;
|
|
3118
3037
|
/**
|
|
@@ -3121,37 +3040,33 @@ export interface SharePointConfiguration {
|
|
|
3121
3040
|
*/
|
|
3122
3041
|
DisableLocalGroups?: boolean;
|
|
3123
3042
|
/**
|
|
3124
|
-
* <p>The path to the SSL certificate stored in an Amazon S3 bucket. You
|
|
3125
|
-
*
|
|
3126
|
-
*
|
|
3127
|
-
*
|
|
3128
|
-
* OpenSSL. For an example of using OpenSSL to create an X509 certificate, see
|
|
3129
|
-
* <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign
|
|
3130
|
-
* an X509 certificate</a>.</p>
|
|
3043
|
+
* <p>The path to the SSL certificate stored in an Amazon S3 bucket. You use this to
|
|
3044
|
+
* connect to SharePoint Server if you require a secure SSL connection.</p>
|
|
3045
|
+
* <p>You can simply generate a self-signed X509 certificate on any computer using OpenSSL.
|
|
3046
|
+
* For an example of using OpenSSL to create an X509 certificate, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign an X509 certificate</a>.</p>
|
|
3131
3047
|
*/
|
|
3132
3048
|
SslCertificateS3Path?: S3Path;
|
|
3133
3049
|
/**
|
|
3134
|
-
* <p>Whether you want to connect to SharePoint using basic authentication of
|
|
3135
|
-
*
|
|
3136
|
-
*
|
|
3137
|
-
* SharePoint Online.</p>
|
|
3050
|
+
* <p>Whether you want to connect to SharePoint using basic authentication of user name and
|
|
3051
|
+
* password, or OAuth authentication of user name, password, client ID, and client secret.
|
|
3052
|
+
* You can use OAuth authentication for SharePoint Online.</p>
|
|
3138
3053
|
*/
|
|
3139
3054
|
AuthenticationType?: SharePointOnlineAuthenticationType | string;
|
|
3140
3055
|
/**
|
|
3141
|
-
* <p>Configuration information to connect to your Microsoft SharePoint site URLs
|
|
3142
|
-
*
|
|
3056
|
+
* <p>Configuration information to connect to your Microsoft SharePoint site URLs via
|
|
3057
|
+
* instance via a web proxy. You can use this option for SharePoint Server.</p>
|
|
3143
3058
|
* <p>You must provide the website host name and port number. For example, the host name of
|
|
3144
|
-
*
|
|
3145
|
-
* is 443, the standard port for HTTPS.</p>
|
|
3059
|
+
* <i>https://a.example.com/page1.html</i> is "a.example.com" and the
|
|
3060
|
+
* port is 443, the standard port for HTTPS.</p>
|
|
3146
3061
|
* <p>Web proxy credentials are optional and you can use them to connect to a web proxy
|
|
3147
|
-
* server that requires basic authentication of user name and password. To store web
|
|
3148
|
-
*
|
|
3149
|
-
* <p>It is recommended that you follow best security practices when configuring your
|
|
3150
|
-
*
|
|
3151
|
-
*
|
|
3152
|
-
*
|
|
3153
|
-
*
|
|
3154
|
-
*
|
|
3062
|
+
* server that requires basic authentication of user name and password. To store web proxy
|
|
3063
|
+
* credentials, you use a secret in Secrets Manager.</p>
|
|
3064
|
+
* <p>It is recommended that you follow best security practices when configuring your web
|
|
3065
|
+
* proxy. This includes setting up throttling, setting up logging and monitoring, and
|
|
3066
|
+
* applying security patches on a regular basis. If you use your web proxy with multiple
|
|
3067
|
+
* data sources, sync jobs that occur at the same time could strain the load on your proxy.
|
|
3068
|
+
* It is recommended you prepare your proxy beforehand for any security and load
|
|
3069
|
+
* requirements.</p>
|
|
3155
3070
|
*/
|
|
3156
3071
|
ProxyConfiguration?: ProxyConfiguration;
|
|
3157
3072
|
}
|
|
@@ -3269,22 +3184,13 @@ export interface SlackConfiguration {
|
|
|
3269
3184
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
3270
3185
|
}
|
|
3271
3186
|
/**
|
|
3272
|
-
* <p>Provides a template for the configuration information to connect
|
|
3273
|
-
*
|
|
3187
|
+
* <p>Provides a template for the configuration information to connect to your data
|
|
3188
|
+
* source.</p>
|
|
3274
3189
|
*/
|
|
3275
3190
|
export interface TemplateConfiguration {
|
|
3276
3191
|
/**
|
|
3277
|
-
* <p>The template schema used for the data source.</p>
|
|
3278
|
-
* <p>
|
|
3279
|
-
* where templates are supported:</p>
|
|
3280
|
-
* <ul>
|
|
3281
|
-
* <li>
|
|
3282
|
-
* <p>
|
|
3283
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-zendesk.html#zendesk-template-schema">Zendesk
|
|
3284
|
-
* template schema</a>
|
|
3285
|
-
* </p>
|
|
3286
|
-
* </li>
|
|
3287
|
-
* </ul>
|
|
3192
|
+
* <p>The template schema used for the data source, where templates schemas are supported.</p>
|
|
3193
|
+
* <p>See <a href="https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html">Data source template schemas</a>.</p>
|
|
3288
3194
|
*/
|
|
3289
3195
|
Template?: __DocumentType;
|
|
3290
3196
|
}
|
|
@@ -3543,43 +3449,43 @@ export interface WorkDocsConfiguration {
|
|
|
3543
3449
|
*/
|
|
3544
3450
|
export interface DataSourceConfiguration {
|
|
3545
3451
|
/**
|
|
3546
|
-
* <p>Provides the configuration information to connect to an Amazon S3
|
|
3547
|
-
*
|
|
3452
|
+
* <p>Provides the configuration information to connect to an Amazon S3 bucket as
|
|
3453
|
+
* your data source.</p>
|
|
3548
3454
|
*/
|
|
3549
3455
|
S3Configuration?: S3DataSourceConfiguration;
|
|
3550
3456
|
/**
|
|
3551
|
-
* <p>Provides the configuration information to connect to Microsoft SharePoint
|
|
3552
|
-
*
|
|
3457
|
+
* <p>Provides the configuration information to connect to Microsoft SharePoint as your data
|
|
3458
|
+
* source.</p>
|
|
3553
3459
|
*/
|
|
3554
3460
|
SharePointConfiguration?: SharePointConfiguration;
|
|
3555
3461
|
/**
|
|
3556
|
-
* <p>Provides the configuration information to connect to a database as
|
|
3557
|
-
*
|
|
3462
|
+
* <p>Provides the configuration information to connect to a database as your data
|
|
3463
|
+
* source.</p>
|
|
3558
3464
|
*/
|
|
3559
3465
|
DatabaseConfiguration?: DatabaseConfiguration;
|
|
3560
3466
|
/**
|
|
3561
|
-
* <p>Provides the configuration information to connect to
|
|
3562
|
-
*
|
|
3467
|
+
* <p>Provides the configuration information to connect to Salesforce as your data
|
|
3468
|
+
* source.</p>
|
|
3563
3469
|
*/
|
|
3564
3470
|
SalesforceConfiguration?: SalesforceConfiguration;
|
|
3565
3471
|
/**
|
|
3566
|
-
* <p>Provides the configuration information to connect to Microsoft
|
|
3567
|
-
*
|
|
3472
|
+
* <p>Provides the configuration information to connect to Microsoft OneDrive as your data
|
|
3473
|
+
* source.</p>
|
|
3568
3474
|
*/
|
|
3569
3475
|
OneDriveConfiguration?: OneDriveConfiguration;
|
|
3570
3476
|
/**
|
|
3571
|
-
* <p>Provides the configuration information to connect to ServiceNow
|
|
3572
|
-
*
|
|
3477
|
+
* <p>Provides the configuration information to connect to ServiceNow as your data
|
|
3478
|
+
* source.</p>
|
|
3573
3479
|
*/
|
|
3574
3480
|
ServiceNowConfiguration?: ServiceNowConfiguration;
|
|
3575
3481
|
/**
|
|
3576
|
-
* <p>Provides the configuration information to connect to Confluence
|
|
3577
|
-
*
|
|
3482
|
+
* <p>Provides the configuration information to connect to Confluence as your data
|
|
3483
|
+
* source.</p>
|
|
3578
3484
|
*/
|
|
3579
3485
|
ConfluenceConfiguration?: ConfluenceConfiguration;
|
|
3580
3486
|
/**
|
|
3581
|
-
* <p>Provides the configuration information to connect to Google
|
|
3582
|
-
*
|
|
3487
|
+
* <p>Provides the configuration information to connect to Google Drive as your data
|
|
3488
|
+
* source.</p>
|
|
3583
3489
|
*/
|
|
3584
3490
|
GoogleDriveConfiguration?: GoogleDriveConfiguration;
|
|
3585
3491
|
/**
|
|
@@ -3588,18 +3494,17 @@ export interface DataSourceConfiguration {
|
|
|
3588
3494
|
*/
|
|
3589
3495
|
WebCrawlerConfiguration?: WebCrawlerConfiguration;
|
|
3590
3496
|
/**
|
|
3591
|
-
* <p>Provides the configuration information to connect to Amazon WorkDocs
|
|
3592
|
-
*
|
|
3497
|
+
* <p>Provides the configuration information to connect to Amazon WorkDocs as your data
|
|
3498
|
+
* source.</p>
|
|
3593
3499
|
*/
|
|
3594
3500
|
WorkDocsConfiguration?: WorkDocsConfiguration;
|
|
3595
3501
|
/**
|
|
3596
|
-
* <p>Provides the configuration information to connect to Amazon FSx as
|
|
3597
|
-
*
|
|
3502
|
+
* <p>Provides the configuration information to connect to Amazon FSx as your data
|
|
3503
|
+
* source.</p>
|
|
3598
3504
|
*/
|
|
3599
3505
|
FsxConfiguration?: FsxConfiguration;
|
|
3600
3506
|
/**
|
|
3601
|
-
* <p>Provides the configuration information to connect to Slack as your
|
|
3602
|
-
* data source.</p>
|
|
3507
|
+
* <p>Provides the configuration information to connect to Slack as your data source.</p>
|
|
3603
3508
|
*/
|
|
3604
3509
|
SlackConfiguration?: SlackConfiguration;
|
|
3605
3510
|
/**
|
|
@@ -3607,28 +3512,26 @@ export interface DataSourceConfiguration {
|
|
|
3607
3512
|
*/
|
|
3608
3513
|
BoxConfiguration?: BoxConfiguration;
|
|
3609
3514
|
/**
|
|
3610
|
-
* <p>Provides the configuration information to connect to Quip as your
|
|
3611
|
-
* data source.</p>
|
|
3515
|
+
* <p>Provides the configuration information to connect to Quip as your data source.</p>
|
|
3612
3516
|
*/
|
|
3613
3517
|
QuipConfiguration?: QuipConfiguration;
|
|
3614
3518
|
/**
|
|
3615
|
-
* <p>Provides the configuration information to connect to Jira as your
|
|
3616
|
-
* data source.</p>
|
|
3519
|
+
* <p>Provides the configuration information to connect to Jira as your data source.</p>
|
|
3617
3520
|
*/
|
|
3618
3521
|
JiraConfiguration?: JiraConfiguration;
|
|
3619
3522
|
/**
|
|
3620
|
-
* <p>Provides the configuration information to connect to GitHub as
|
|
3621
|
-
*
|
|
3523
|
+
* <p>Provides the configuration information to connect to GitHub as your data
|
|
3524
|
+
* source.</p>
|
|
3622
3525
|
*/
|
|
3623
3526
|
GitHubConfiguration?: GitHubConfiguration;
|
|
3624
3527
|
/**
|
|
3625
|
-
* <p>Provides the configuration information to connect to Alfresco as your
|
|
3626
|
-
*
|
|
3528
|
+
* <p>Provides the configuration information to connect to Alfresco as your data
|
|
3529
|
+
* source.</p>
|
|
3627
3530
|
*/
|
|
3628
3531
|
AlfrescoConfiguration?: AlfrescoConfiguration;
|
|
3629
3532
|
/**
|
|
3630
|
-
* <p>Provides a template for the configuration information to connect
|
|
3631
|
-
*
|
|
3533
|
+
* <p>Provides a template for the configuration information to connect to your data
|
|
3534
|
+
* source.</p>
|
|
3632
3535
|
*/
|
|
3633
3536
|
TemplateConfiguration?: TemplateConfiguration;
|
|
3634
3537
|
}
|
|
@@ -3685,16 +3588,15 @@ export interface CreateDataSourceRequest {
|
|
|
3685
3588
|
Type: DataSourceType | string | undefined;
|
|
3686
3589
|
/**
|
|
3687
3590
|
* <p>Configuration information to connect to your data source repository.</p>
|
|
3688
|
-
* <p>You can't specify the <code>Configuration</code> parameter when the
|
|
3689
|
-
*
|
|
3690
|
-
*
|
|
3691
|
-
* <p>The <code>Configuration</code> parameter is required for all other
|
|
3692
|
-
* data sources.</p>
|
|
3591
|
+
* <p>You can't specify the <code>Configuration</code> parameter when the <code>Type</code>
|
|
3592
|
+
* parameter is set to <code>CUSTOM</code>. If you do, you receive a
|
|
3593
|
+
* <code>ValidationException</code> exception.</p>
|
|
3594
|
+
* <p>The <code>Configuration</code> parameter is required for all other data sources.</p>
|
|
3693
3595
|
*/
|
|
3694
3596
|
Configuration?: DataSourceConfiguration;
|
|
3695
3597
|
/**
|
|
3696
|
-
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your
|
|
3697
|
-
*
|
|
3598
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
|
|
3599
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
3698
3600
|
*/
|
|
3699
3601
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
3700
3602
|
/**
|
|
@@ -3702,38 +3604,33 @@ export interface CreateDataSourceRequest {
|
|
|
3702
3604
|
*/
|
|
3703
3605
|
Description?: string;
|
|
3704
3606
|
/**
|
|
3705
|
-
* <p>Sets the frequency for Amazon Kendra to check the documents in your
|
|
3706
|
-
*
|
|
3707
|
-
*
|
|
3708
|
-
*
|
|
3709
|
-
*
|
|
3710
|
-
*
|
|
3711
|
-
*
|
|
3712
|
-
* you receive a <code>ValidationException</code> exception.</p>
|
|
3607
|
+
* <p>Sets the frequency for Amazon Kendra to check the documents in your data source
|
|
3608
|
+
* repository and update the index. If you don't set a schedule Amazon Kendra will not
|
|
3609
|
+
* periodically update the index. You can call the <code>StartDataSourceSyncJob</code> API to
|
|
3610
|
+
* update the index.</p>
|
|
3611
|
+
* <p>You can't specify the <code>Schedule</code> parameter when the <code>Type</code> parameter
|
|
3612
|
+
* is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code>
|
|
3613
|
+
* exception.</p>
|
|
3713
3614
|
*/
|
|
3714
3615
|
Schedule?: string;
|
|
3715
3616
|
/**
|
|
3716
|
-
* <p>The Amazon Resource Name (ARN) of a role with permission to access the
|
|
3717
|
-
*
|
|
3718
|
-
*
|
|
3719
|
-
*
|
|
3720
|
-
*
|
|
3721
|
-
*
|
|
3722
|
-
* you receive a <code>ValidationException</code> exception.</p>
|
|
3723
|
-
* <p>The <code>RoleArn</code> parameter is required for all other data
|
|
3724
|
-
* sources.</p>
|
|
3617
|
+
* <p>The Amazon Resource Name (ARN) of a role with permission to access the data source and
|
|
3618
|
+
* required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
3619
|
+
* <p>You can't specify the <code>RoleArn</code> parameter when the <code>Type</code> parameter
|
|
3620
|
+
* is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code>
|
|
3621
|
+
* exception.</p>
|
|
3622
|
+
* <p>The <code>RoleArn</code> parameter is required for all other data sources.</p>
|
|
3725
3623
|
*/
|
|
3726
3624
|
RoleArn?: string;
|
|
3727
3625
|
/**
|
|
3728
|
-
* <p>A list of key-value pairs that identify the data source connector. You can use
|
|
3729
|
-
*
|
|
3730
|
-
* resources.</p>
|
|
3626
|
+
* <p>A list of key-value pairs that identify the data source connector. You can use the tags to
|
|
3627
|
+
* identify and organize your resources and to control access to resources.</p>
|
|
3731
3628
|
*/
|
|
3732
3629
|
Tags?: Tag[];
|
|
3733
3630
|
/**
|
|
3734
|
-
* <p>A token that you provide to identify the request to create a data
|
|
3735
|
-
*
|
|
3736
|
-
*
|
|
3631
|
+
* <p>A token that you provide to identify the request to create a data source connector.
|
|
3632
|
+
* Multiple calls to the <code>CreateDataSource</code> API with the same client token will create
|
|
3633
|
+
* only one data source connector.</p>
|
|
3737
3634
|
*/
|
|
3738
3635
|
ClientToken?: string;
|
|
3739
3636
|
/**
|
|
@@ -3785,13 +3682,13 @@ export interface ContentSourceConfiguration {
|
|
|
3785
3682
|
*/
|
|
3786
3683
|
export interface UserIdentityConfiguration {
|
|
3787
3684
|
/**
|
|
3788
|
-
* <p>The
|
|
3685
|
+
* <p>The IAM Identity Center field name that contains the identifiers of your users,
|
|
3789
3686
|
* such as their emails. This is used for <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">user context filtering</a>
|
|
3790
|
-
* and for granting access to your Amazon Kendra experience. You must set up
|
|
3687
|
+
* and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center
|
|
3791
3688
|
* with Amazon Kendra. You must include your users and groups in your Access Control List when
|
|
3792
3689
|
* you ingest documents into your index. For more information, see
|
|
3793
3690
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting
|
|
3794
|
-
* started with an
|
|
3691
|
+
* started with an IAM Identity Center identity source</a>.</p>
|
|
3795
3692
|
*/
|
|
3796
3693
|
IdentityAttributeName?: string;
|
|
3797
3694
|
}
|
|
@@ -3808,7 +3705,7 @@ export interface ExperienceConfiguration {
|
|
|
3808
3705
|
*/
|
|
3809
3706
|
ContentSourceConfiguration?: ContentSourceConfiguration;
|
|
3810
3707
|
/**
|
|
3811
|
-
* <p>The
|
|
3708
|
+
* <p>The IAM Identity Center field name that contains the identifiers of your users,
|
|
3812
3709
|
* such as their emails.</p>
|
|
3813
3710
|
*/
|
|
3814
3711
|
UserIdentityConfiguration?: UserIdentityConfiguration;
|
|
@@ -3825,7 +3722,7 @@ export interface CreateExperienceRequest {
|
|
|
3825
3722
|
/**
|
|
3826
3723
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
|
|
3827
3724
|
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
3828
|
-
* API, and
|
|
3725
|
+
* API, and IAM Identity Center that stores your user and group information.
|
|
3829
3726
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
3830
3727
|
*/
|
|
3831
3728
|
RoleArn?: string;
|
|
@@ -3921,14 +3818,14 @@ export declare enum IndexEdition {
|
|
|
3921
3818
|
ENTERPRISE_EDITION = "ENTERPRISE_EDITION"
|
|
3922
3819
|
}
|
|
3923
3820
|
/**
|
|
3924
|
-
* <p>Provides the identifier of the KMS key used to
|
|
3925
|
-
*
|
|
3926
|
-
*
|
|
3821
|
+
* <p>Provides the identifier of the KMS key used to encrypt data
|
|
3822
|
+
* indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric
|
|
3823
|
+
* keys.</p>
|
|
3927
3824
|
*/
|
|
3928
3825
|
export interface ServerSideEncryptionConfiguration {
|
|
3929
3826
|
/**
|
|
3930
|
-
* <p>The identifier of the KMS key. Amazon Kendra
|
|
3931
|
-
*
|
|
3827
|
+
* <p>The identifier of the KMS key. Amazon Kendra doesn't support
|
|
3828
|
+
* asymmetric keys.</p>
|
|
3932
3829
|
*/
|
|
3933
3830
|
KmsKeyId?: string;
|
|
3934
3831
|
}
|
|
@@ -3942,29 +3839,29 @@ export declare enum UserGroupResolutionMode {
|
|
|
3942
3839
|
}
|
|
3943
3840
|
/**
|
|
3944
3841
|
* <p>Provides the configuration information to fetch access levels
|
|
3945
|
-
* of groups and users from an
|
|
3842
|
+
* of groups and users from an IAM Identity Center (successor to Single Sign-On) identity
|
|
3946
3843
|
* source. This is useful for user context filtering, where search
|
|
3947
3844
|
* results are filtered based on the user or their group access to
|
|
3948
3845
|
* documents. You can also use the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping</a>
|
|
3949
3846
|
* API to map users to their groups so that you only need to provide
|
|
3950
3847
|
* the user ID when you issue the query.</p>
|
|
3951
|
-
* <p>To set up an
|
|
3848
|
+
* <p>To set up an IAM Identity Center identity source in the console to use with
|
|
3952
3849
|
* Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started
|
|
3953
|
-
* with an
|
|
3954
|
-
* permissions to use
|
|
3850
|
+
* with an IAM Identity Center identity source</a>. You must also grant the required
|
|
3851
|
+
* permissions to use IAM Identity Center with Amazon Kendra. For more information, see
|
|
3955
3852
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso">IAM roles for
|
|
3956
|
-
*
|
|
3853
|
+
* IAM Identity Center</a>.</p>
|
|
3957
3854
|
* <p>Amazon Kendra currently does not support using <code>UserGroupResolutionConfiguration</code>
|
|
3958
|
-
* with an Amazon Web Services organization member account for your
|
|
3855
|
+
* with an Amazon Web Services organization member account for your IAM Identity Center
|
|
3959
3856
|
* identify source. You must create your index in the management account for the organization
|
|
3960
3857
|
* in order to use <code>UserGroupResolutionConfiguration</code>.</p>
|
|
3961
3858
|
*/
|
|
3962
3859
|
export interface UserGroupResolutionConfiguration {
|
|
3963
3860
|
/**
|
|
3964
3861
|
* <p>The identity store provider (mode) you want to use to fetch access levels of groups and
|
|
3965
|
-
* users.
|
|
3862
|
+
* users. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups
|
|
3966
3863
|
* must
|
|
3967
|
-
* exist in an
|
|
3864
|
+
* exist in an IAM Identity Center identity source in order to use this mode.</p>
|
|
3968
3865
|
*/
|
|
3969
3866
|
UserGroupResolutionMode: UserGroupResolutionMode | string | undefined;
|
|
3970
3867
|
}
|
|
@@ -4106,7 +4003,7 @@ export interface CreateIndexRequest {
|
|
|
4106
4003
|
*/
|
|
4107
4004
|
UserContextPolicy?: UserContextPolicy | string;
|
|
4108
4005
|
/**
|
|
4109
|
-
* <p>Enables fetching access levels of groups and users from an
|
|
4006
|
+
* <p>Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On)
|
|
4110
4007
|
* identity source. To configure this, see
|
|
4111
4008
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>.</p>
|
|
4112
4009
|
*/
|
|
@@ -4397,14 +4294,14 @@ export interface DescribeDataSourceResponse {
|
|
|
4397
4294
|
*/
|
|
4398
4295
|
Type?: DataSourceType | string;
|
|
4399
4296
|
/**
|
|
4400
|
-
* <p>Configuration details for the data source connector. This shows how the
|
|
4401
|
-
*
|
|
4402
|
-
*
|
|
4297
|
+
* <p>Configuration details for the data source connector. This shows how the data source is
|
|
4298
|
+
* configured. The configuration options for a data source depend on the data source
|
|
4299
|
+
* provider.</p>
|
|
4403
4300
|
*/
|
|
4404
4301
|
Configuration?: DataSourceConfiguration;
|
|
4405
4302
|
/**
|
|
4406
|
-
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your
|
|
4407
|
-
*
|
|
4303
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
|
|
4304
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
4408
4305
|
*/
|
|
4409
4306
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
4410
4307
|
/**
|
|
@@ -4420,10 +4317,9 @@ export interface DescribeDataSourceResponse {
|
|
|
4420
4317
|
*/
|
|
4421
4318
|
Description?: string;
|
|
4422
4319
|
/**
|
|
4423
|
-
* <p>The current status of the data source connector. When the status is
|
|
4424
|
-
*
|
|
4425
|
-
* <code>
|
|
4426
|
-
* reason that the data source failed.</p>
|
|
4320
|
+
* <p>The current status of the data source connector. When the status is <code>ACTIVE</code>
|
|
4321
|
+
* the data source is ready to use. When the status is <code>FAILED</code>, the
|
|
4322
|
+
* <code>ErrorMessage</code> field contains the reason that the data source failed.</p>
|
|
4427
4323
|
*/
|
|
4428
4324
|
Status?: DataSourceStatus | string;
|
|
4429
4325
|
/**
|
|
@@ -4431,14 +4327,14 @@ export interface DescribeDataSourceResponse {
|
|
|
4431
4327
|
*/
|
|
4432
4328
|
Schedule?: string;
|
|
4433
4329
|
/**
|
|
4434
|
-
* <p>The Amazon Resource Name (ARN) of the role with permission to access
|
|
4435
|
-
*
|
|
4330
|
+
* <p>The Amazon Resource Name (ARN) of the role with permission to access the data source and
|
|
4331
|
+
* required resources.</p>
|
|
4436
4332
|
*/
|
|
4437
4333
|
RoleArn?: string;
|
|
4438
4334
|
/**
|
|
4439
4335
|
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
4440
|
-
* <code>ErrorMessage</code> field contains a description of the error that
|
|
4441
|
-
*
|
|
4336
|
+
* <code>ErrorMessage</code> field contains a description of the error that caused the data
|
|
4337
|
+
* source to fail.</p>
|
|
4442
4338
|
*/
|
|
4443
4339
|
ErrorMessage?: string;
|
|
4444
4340
|
/**
|
|
@@ -4541,7 +4437,7 @@ export interface DescribeExperienceResponse {
|
|
|
4541
4437
|
/**
|
|
4542
4438
|
* <p>Shows the Amazon Resource Name (ARN) of a role with permission to access
|
|
4543
4439
|
* <code>Query</code> API, <code>QuerySuggestions</code> API,
|
|
4544
|
-
* <code>SubmitFeedback</code> API, and
|
|
4440
|
+
* <code>SubmitFeedback</code> API, and IAM Identity Center that stores
|
|
4545
4441
|
* your user and group information.</p>
|
|
4546
4442
|
*/
|
|
4547
4443
|
RoleArn?: string;
|
|
@@ -4593,8 +4489,7 @@ export interface DescribeFaqResponse {
|
|
|
4593
4489
|
*/
|
|
4594
4490
|
UpdatedAt?: Date;
|
|
4595
4491
|
/**
|
|
4596
|
-
* <p>Information required to find a specific file in an Amazon S3
|
|
4597
|
-
* bucket.</p>
|
|
4492
|
+
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
4598
4493
|
*/
|
|
4599
4494
|
S3Path?: S3Path;
|
|
4600
4495
|
/**
|
|
@@ -4632,31 +4527,29 @@ export interface DescribeIndexRequest {
|
|
|
4632
4527
|
Id: string | undefined;
|
|
4633
4528
|
}
|
|
4634
4529
|
/**
|
|
4635
|
-
* <p>Specifies additional capacity units configured for your
|
|
4636
|
-
*
|
|
4637
|
-
* to fit your usage requirements.</p>
|
|
4530
|
+
* <p>Specifies additional capacity units configured for your Enterprise Edition index. You
|
|
4531
|
+
* can add and remove capacity units to fit your usage requirements.</p>
|
|
4638
4532
|
*/
|
|
4639
4533
|
export interface CapacityUnitsConfiguration {
|
|
4640
4534
|
/**
|
|
4641
|
-
* <p>The amount of extra storage capacity for an index.
|
|
4642
|
-
*
|
|
4643
|
-
*
|
|
4535
|
+
* <p>The amount of extra storage capacity for an index. A single capacity unit provides 30
|
|
4536
|
+
* GB of storage space or 100,000 documents, whichever is reached first. You can add up to
|
|
4537
|
+
* 100 extra capacity units.</p>
|
|
4644
4538
|
*/
|
|
4645
4539
|
StorageCapacityUnits: number | undefined;
|
|
4646
4540
|
/**
|
|
4647
|
-
* <p>The amount of extra query capacity for an index and
|
|
4648
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html">GetQuerySuggestions</a>
|
|
4541
|
+
* <p>The amount of extra query capacity for an index and <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html">GetQuerySuggestions</a>
|
|
4649
4542
|
* capacity.</p>
|
|
4650
|
-
* <p>A single extra capacity unit for an index provides 0.1 queries per second or
|
|
4651
|
-
* 8,000 queries per day. You can add up to 100 extra capacity units.</p>
|
|
4543
|
+
* <p>A single extra capacity unit for an index provides 0.1 queries per second or
|
|
4544
|
+
* approximately 8,000 queries per day. You can add up to 100 extra capacity units.</p>
|
|
4652
4545
|
* <p>
|
|
4653
|
-
* <code>GetQuerySuggestions</code> capacity is five times the
|
|
4654
|
-
*
|
|
4655
|
-
*
|
|
4656
|
-
*
|
|
4657
|
-
*
|
|
4658
|
-
*
|
|
4659
|
-
*
|
|
4546
|
+
* <code>GetQuerySuggestions</code> capacity is five times the provisioned query capacity
|
|
4547
|
+
* for an index, or the base capacity of 2.5 calls per second, whichever is higher. For
|
|
4548
|
+
* example, the base capacity for an index is 0.1 queries per second, and
|
|
4549
|
+
* <code>GetQuerySuggestions</code> capacity has a base of 2.5 calls per second. If you
|
|
4550
|
+
* add another 0.1 queries per second to total 0.2 queries per second for an index, the
|
|
4551
|
+
* <code>GetQuerySuggestions</code> capacity is 2.5 calls per second (higher than five
|
|
4552
|
+
* times 0.2 queries per second).</p>
|
|
4660
4553
|
*/
|
|
4661
4554
|
QueryCapacityUnits: number | undefined;
|
|
4662
4555
|
}
|
|
@@ -4665,95 +4558,81 @@ export declare enum Order {
|
|
|
4665
4558
|
DESCENDING = "DESCENDING"
|
|
4666
4559
|
}
|
|
4667
4560
|
/**
|
|
4668
|
-
* <p>Provides information for tuning the relevance of a field
|
|
4669
|
-
*
|
|
4670
|
-
*
|
|
4671
|
-
* parameters.</p>
|
|
4561
|
+
* <p>Provides information for tuning the relevance of a field in a search. When a query
|
|
4562
|
+
* includes terms that match the field, the results are given a boost in the response based
|
|
4563
|
+
* on these tuning parameters.</p>
|
|
4672
4564
|
*/
|
|
4673
4565
|
export interface Relevance {
|
|
4674
4566
|
/**
|
|
4675
|
-
* <p>Indicates that this field determines how "fresh" a document is.
|
|
4676
|
-
*
|
|
4677
|
-
*
|
|
4678
|
-
*
|
|
4679
|
-
* <code>DATE</code> type field. Only applies to <code>DATE</code>
|
|
4680
|
-
* fields.</p>
|
|
4567
|
+
* <p>Indicates that this field determines how "fresh" a document is. For example, if
|
|
4568
|
+
* document 1 was created on November 5, and document 2 was created on October 31, document
|
|
4569
|
+
* 1 is "fresher" than document 2. You can only set the <code>Freshness</code> field on one
|
|
4570
|
+
* <code>DATE</code> type field. Only applies to <code>DATE</code> fields.</p>
|
|
4681
4571
|
*/
|
|
4682
4572
|
Freshness?: boolean;
|
|
4683
4573
|
/**
|
|
4684
|
-
* <p>The relative importance of the field in the search. Larger numbers
|
|
4685
|
-
*
|
|
4574
|
+
* <p>The relative importance of the field in the search. Larger numbers provide more of a
|
|
4575
|
+
* boost than smaller numbers.</p>
|
|
4686
4576
|
*/
|
|
4687
4577
|
Importance?: number;
|
|
4688
4578
|
/**
|
|
4689
|
-
* <p>Specifies the time period that the boost applies to. For example,
|
|
4690
|
-
*
|
|
4691
|
-
*
|
|
4692
|
-
* the
|
|
4693
|
-
*
|
|
4694
|
-
*
|
|
4695
|
-
* a numeric string followed by the character "s", for example "86400s"
|
|
4696
|
-
* for one day, or "604800s" for one week. </p>
|
|
4579
|
+
* <p>Specifies the time period that the boost applies to. For example, to make the boost
|
|
4580
|
+
* apply to documents with the field value within the last month, you would use "2628000s".
|
|
4581
|
+
* Once the field value is beyond the specified range, the effect of the boost drops off.
|
|
4582
|
+
* The higher the importance, the faster the effect drops off. If you don't specify a
|
|
4583
|
+
* value, the default is 3 months. The value of the field is a numeric string followed by
|
|
4584
|
+
* the character "s", for example "86400s" for one day, or "604800s" for one week. </p>
|
|
4697
4585
|
* <p>Only applies to <code>DATE</code> fields.</p>
|
|
4698
4586
|
*/
|
|
4699
4587
|
Duration?: string;
|
|
4700
4588
|
/**
|
|
4701
4589
|
* <p>Determines how values should be interpreted.</p>
|
|
4702
|
-
* <p>When the <code>RankOrder</code> field is <code>ASCENDING</code>,
|
|
4703
|
-
*
|
|
4704
|
-
*
|
|
4705
|
-
*
|
|
4706
|
-
*
|
|
4707
|
-
*
|
|
4708
|
-
*
|
|
4709
|
-
* task.</p>
|
|
4710
|
-
* <p>Only applies to <code>LONG</code> and <code>DOUBLE</code>
|
|
4711
|
-
* fields.</p>
|
|
4590
|
+
* <p>When the <code>RankOrder</code> field is <code>ASCENDING</code>, higher numbers are
|
|
4591
|
+
* better. For example, a document with a rating score of 10 is higher ranking than a
|
|
4592
|
+
* document with a rating score of 1.</p>
|
|
4593
|
+
* <p>When the <code>RankOrder</code> field is <code>DESCENDING</code>, lower numbers are
|
|
4594
|
+
* better. For example, in a task tracking application, a priority 1 task is more important
|
|
4595
|
+
* than a priority 5 task.</p>
|
|
4596
|
+
* <p>Only applies to <code>LONG</code> and <code>DOUBLE</code> fields.</p>
|
|
4712
4597
|
*/
|
|
4713
4598
|
RankOrder?: Order | string;
|
|
4714
4599
|
/**
|
|
4715
|
-
* <p>A list of values that should be given a different boost when they
|
|
4716
|
-
*
|
|
4717
|
-
*
|
|
4718
|
-
*
|
|
4719
|
-
*
|
|
4720
|
-
*
|
|
4721
|
-
*
|
|
4722
|
-
* given special attention when they appear in the metadata of a
|
|
4723
|
-
* document. When those terms appear they are given the specified
|
|
4600
|
+
* <p>A list of values that should be given a different boost when they appear in the result
|
|
4601
|
+
* list. For example, if you are boosting a field called "department," query terms that
|
|
4602
|
+
* match the department field are boosted in the result. However, you can add entries from
|
|
4603
|
+
* the department field to boost documents with those values higher. </p>
|
|
4604
|
+
* <p>For example, you can add entries to the map with names of departments. If you add
|
|
4605
|
+
* "HR",5 and "Legal",3 those departments are given special attention when they appear in
|
|
4606
|
+
* the metadata of a document. When those terms appear they are given the specified
|
|
4724
4607
|
* importance instead of the regular importance for the boost.</p>
|
|
4725
4608
|
*/
|
|
4726
4609
|
ValueImportanceMap?: Record<string, number>;
|
|
4727
4610
|
}
|
|
4728
4611
|
/**
|
|
4729
|
-
* <p>Provides information about how a custom index field is used during
|
|
4730
|
-
* a search.</p>
|
|
4612
|
+
* <p>Provides information about how a custom index field is used during a search.</p>
|
|
4731
4613
|
*/
|
|
4732
4614
|
export interface Search {
|
|
4733
4615
|
/**
|
|
4734
|
-
* <p>Indicates that the field can be used to create search facets, a
|
|
4735
|
-
*
|
|
4736
|
-
* <code>false</code> .</p>
|
|
4616
|
+
* <p>Indicates that the field can be used to create search facets, a count of results for
|
|
4617
|
+
* each value in the field. The default is <code>false</code> .</p>
|
|
4737
4618
|
*/
|
|
4738
4619
|
Facetable?: boolean;
|
|
4739
4620
|
/**
|
|
4740
|
-
* <p>Determines whether the field is used in the search. If the
|
|
4741
|
-
*
|
|
4742
|
-
*
|
|
4743
|
-
* the search. The default is <code>true</code> for string fields and
|
|
4744
|
-
* <code>false</code> for number and date fields.</p>
|
|
4621
|
+
* <p>Determines whether the field is used in the search. If the <code>Searchable</code>
|
|
4622
|
+
* field is <code>true</code>, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is <code>true</code> for
|
|
4623
|
+
* string fields and <code>false</code> for number and date fields.</p>
|
|
4745
4624
|
*/
|
|
4746
4625
|
Searchable?: boolean;
|
|
4747
4626
|
/**
|
|
4748
|
-
* <p>Determines whether the field is returned in the query response.
|
|
4749
|
-
*
|
|
4627
|
+
* <p>Determines whether the field is returned in the query response. The default is
|
|
4628
|
+
* <code>true</code>.</p>
|
|
4750
4629
|
*/
|
|
4751
4630
|
Displayable?: boolean;
|
|
4752
4631
|
/**
|
|
4753
|
-
* <p>Determines whether the field can be used to sort the results of a
|
|
4754
|
-
*
|
|
4755
|
-
* <code>
|
|
4756
|
-
*
|
|
4632
|
+
* <p>Determines whether the field can be used to sort the results of a query. If you
|
|
4633
|
+
* specify sorting on a field that does not have <code>Sortable</code> set to
|
|
4634
|
+
* <code>true</code>, Amazon Kendra returns an exception. The default is
|
|
4635
|
+
* <code>false</code>.</p>
|
|
4757
4636
|
*/
|
|
4758
4637
|
Sortable?: boolean;
|
|
4759
4638
|
}
|
|
@@ -4764,8 +4643,8 @@ export declare enum DocumentAttributeValueType {
|
|
|
4764
4643
|
STRING_VALUE = "STRING_VALUE"
|
|
4765
4644
|
}
|
|
4766
4645
|
/**
|
|
4767
|
-
* <p>Specifies the properties, such as relevance tuning
|
|
4768
|
-
*
|
|
4646
|
+
* <p>Specifies the properties, such as relevance tuning and searchability, of an index
|
|
4647
|
+
* field.</p>
|
|
4769
4648
|
*/
|
|
4770
4649
|
export interface DocumentMetadataConfiguration {
|
|
4771
4650
|
/**
|
|
@@ -4777,30 +4656,27 @@ export interface DocumentMetadataConfiguration {
|
|
|
4777
4656
|
*/
|
|
4778
4657
|
Type: DocumentAttributeValueType | string | undefined;
|
|
4779
4658
|
/**
|
|
4780
|
-
* <p>Provides tuning parameters to determine how the field
|
|
4781
|
-
*
|
|
4659
|
+
* <p>Provides tuning parameters to determine how the field affects the search
|
|
4660
|
+
* results.</p>
|
|
4782
4661
|
*/
|
|
4783
4662
|
Relevance?: Relevance;
|
|
4784
4663
|
/**
|
|
4785
|
-
* <p>Provides information about how the field is used during a
|
|
4786
|
-
* search.</p>
|
|
4664
|
+
* <p>Provides information about how the field is used during a search.</p>
|
|
4787
4665
|
*/
|
|
4788
4666
|
Search?: Search;
|
|
4789
4667
|
}
|
|
4790
4668
|
/**
|
|
4791
|
-
* <p>Provides statistical information about the FAQ questions and
|
|
4792
|
-
*
|
|
4669
|
+
* <p>Provides statistical information about the FAQ questions and answers contained in an
|
|
4670
|
+
* index.</p>
|
|
4793
4671
|
*/
|
|
4794
4672
|
export interface FaqStatistics {
|
|
4795
4673
|
/**
|
|
4796
|
-
* <p>The total number of FAQ questions and answers contained in the
|
|
4797
|
-
* index.</p>
|
|
4674
|
+
* <p>The total number of FAQ questions and answers contained in the index.</p>
|
|
4798
4675
|
*/
|
|
4799
4676
|
IndexedQuestionAnswersCount: number | undefined;
|
|
4800
4677
|
}
|
|
4801
4678
|
/**
|
|
4802
|
-
* <p>Provides information about text documents indexed in an
|
|
4803
|
-
* index.</p>
|
|
4679
|
+
* <p>Provides information about text documents indexed in an index.</p>
|
|
4804
4680
|
*/
|
|
4805
4681
|
export interface TextDocumentStatistics {
|
|
4806
4682
|
/**
|
|
@@ -4813,8 +4689,8 @@ export interface TextDocumentStatistics {
|
|
|
4813
4689
|
IndexedTextBytes: number | undefined;
|
|
4814
4690
|
}
|
|
4815
4691
|
/**
|
|
4816
|
-
* <p>Provides information about the number of documents and the number
|
|
4817
|
-
*
|
|
4692
|
+
* <p>Provides information about the number of documents and the number of questions and
|
|
4693
|
+
* answers in an index.</p>
|
|
4818
4694
|
*/
|
|
4819
4695
|
export interface IndexStatistics {
|
|
4820
4696
|
/**
|
|
@@ -4916,7 +4792,7 @@ export interface DescribeIndexResponse {
|
|
|
4916
4792
|
UserContextPolicy?: UserContextPolicy | string;
|
|
4917
4793
|
/**
|
|
4918
4794
|
* <p>Whether you have enabled the configuration for fetching access
|
|
4919
|
-
* levels of groups and users from an
|
|
4795
|
+
* levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source.</p>
|
|
4920
4796
|
*/
|
|
4921
4797
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
|
|
4922
4798
|
}
|
|
@@ -5248,8 +5124,7 @@ export interface DescribeThesaurusResponse {
|
|
|
5248
5124
|
*/
|
|
5249
5125
|
RoleArn?: string;
|
|
5250
5126
|
/**
|
|
5251
|
-
* <p>Information required to find a specific file in an Amazon S3
|
|
5252
|
-
* bucket.</p>
|
|
5127
|
+
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
5253
5128
|
*/
|
|
5254
5129
|
SourceS3Path?: S3Path;
|
|
5255
5130
|
/**
|
|
@@ -5278,13 +5153,13 @@ export interface DisassociateEntitiesFromExperienceRequest {
|
|
|
5278
5153
|
*/
|
|
5279
5154
|
IndexId: string | undefined;
|
|
5280
5155
|
/**
|
|
5281
|
-
* <p>Lists users or groups in your
|
|
5156
|
+
* <p>Lists users or groups in your IAM Identity Center identity source.</p>
|
|
5282
5157
|
*/
|
|
5283
5158
|
EntityList: EntityConfiguration[] | undefined;
|
|
5284
5159
|
}
|
|
5285
5160
|
export interface DisassociateEntitiesFromExperienceResponse {
|
|
5286
5161
|
/**
|
|
5287
|
-
* <p>Lists the users or groups in your
|
|
5162
|
+
* <p>Lists the users or groups in your IAM Identity Center identity source that
|
|
5288
5163
|
* failed to properly remove access to your Amazon Kendra experience.</p>
|
|
5289
5164
|
*/
|
|
5290
5165
|
FailedEntityList?: FailedEntity[];
|
|
@@ -5299,14 +5174,14 @@ export interface DisassociatePersonasFromEntitiesRequest {
|
|
|
5299
5174
|
*/
|
|
5300
5175
|
IndexId: string | undefined;
|
|
5301
5176
|
/**
|
|
5302
|
-
* <p>The identifiers of users or groups in your
|
|
5177
|
+
* <p>The identifiers of users or groups in your IAM Identity Center identity
|
|
5303
5178
|
* source. For example, user IDs could be user emails.</p>
|
|
5304
5179
|
*/
|
|
5305
5180
|
EntityIds: string[] | undefined;
|
|
5306
5181
|
}
|
|
5307
5182
|
export interface DisassociatePersonasFromEntitiesResponse {
|
|
5308
5183
|
/**
|
|
5309
|
-
* <p>Lists the users or groups in your
|
|
5184
|
+
* <p>Lists the users or groups in your IAM Identity Center identity source that
|
|
5310
5185
|
* failed to properly remove access to your Amazon Kendra experience.</p>
|
|
5311
5186
|
*/
|
|
5312
5187
|
FailedEntityList?: FailedEntity[];
|
|
@@ -5555,10 +5430,8 @@ export interface ListDataSourcesRequest {
|
|
|
5555
5430
|
*/
|
|
5556
5431
|
IndexId: string | undefined;
|
|
5557
5432
|
/**
|
|
5558
|
-
* <p>If the previous response was incomplete (because there is more data to
|
|
5559
|
-
* retrieve
|
|
5560
|
-
* can use this pagination token to retrieve the next set of data source connectors
|
|
5561
|
-
* (<code>DataSourceSummaryItems</code>). </p>
|
|
5433
|
+
* <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to
|
|
5434
|
+
* retrieve the next set of data source connectors (<code>DataSourceSummaryItems</code>). </p>
|
|
5562
5435
|
*/
|
|
5563
5436
|
NextToken?: string;
|
|
5564
5437
|
/**
|
|
@@ -5567,8 +5440,8 @@ export interface ListDataSourcesRequest {
|
|
|
5567
5440
|
MaxResults?: number;
|
|
5568
5441
|
}
|
|
5569
5442
|
/**
|
|
5570
|
-
* <p>Summary information for an Amazon Kendra data source. Returned in a call
|
|
5571
|
-
*
|
|
5443
|
+
* <p>Summary information for an Amazon Kendra data source. Returned in a call to the
|
|
5444
|
+
* <code>DescribeDataSource</code> API.</p>
|
|
5572
5445
|
*/
|
|
5573
5446
|
export interface DataSourceSummary {
|
|
5574
5447
|
/**
|
|
@@ -5592,8 +5465,8 @@ export interface DataSourceSummary {
|
|
|
5592
5465
|
*/
|
|
5593
5466
|
UpdatedAt?: Date;
|
|
5594
5467
|
/**
|
|
5595
|
-
* <p>The status of the data source. When the status is
|
|
5596
|
-
*
|
|
5468
|
+
* <p>The status of the data source. When the status is <code>ACTIVE</code> the data source
|
|
5469
|
+
* is ready to use.</p>
|
|
5597
5470
|
*/
|
|
5598
5471
|
Status?: DataSourceStatus | string;
|
|
5599
5472
|
/**
|
|
@@ -5611,9 +5484,8 @@ export interface ListDataSourcesResponse {
|
|
|
5611
5484
|
*/
|
|
5612
5485
|
SummaryItems?: DataSourceSummary[];
|
|
5613
5486
|
/**
|
|
5614
|
-
* <p>If the response is truncated, Amazon Kendra returns this token that you
|
|
5615
|
-
*
|
|
5616
|
-
* source connectors.</p>
|
|
5487
|
+
* <p>If the response is truncated, Amazon Kendra returns this token that you can use in
|
|
5488
|
+
* the subsequent request to retrieve the next set of data source connectors.</p>
|
|
5617
5489
|
*/
|
|
5618
5490
|
NextToken?: string;
|
|
5619
5491
|
}
|
|
@@ -5636,57 +5508,55 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
5636
5508
|
*/
|
|
5637
5509
|
IndexId: string | undefined;
|
|
5638
5510
|
/**
|
|
5639
|
-
* <p>If the previous response was incomplete (because there is more data to retrieve),
|
|
5640
|
-
*
|
|
5641
|
-
* to retrieve the next set of jobs.</p>
|
|
5511
|
+
* <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to
|
|
5512
|
+
* retrieve the next set of jobs.</p>
|
|
5642
5513
|
*/
|
|
5643
5514
|
NextToken?: string;
|
|
5644
5515
|
/**
|
|
5645
|
-
* <p>The maximum number of synchronization jobs to return in the response.
|
|
5646
|
-
*
|
|
5647
|
-
* actual results.</p>
|
|
5516
|
+
* <p>The maximum number of synchronization jobs to return in the response. If there are fewer
|
|
5517
|
+
* results in the list, this response contains only the actual results.</p>
|
|
5648
5518
|
*/
|
|
5649
5519
|
MaxResults?: number;
|
|
5650
5520
|
/**
|
|
5651
|
-
* <p>When specified, the synchronization jobs returned in the list are
|
|
5652
|
-
*
|
|
5521
|
+
* <p>When specified, the synchronization jobs returned in the list are limited to jobs between
|
|
5522
|
+
* the specified dates.</p>
|
|
5653
5523
|
*/
|
|
5654
5524
|
StartTimeFilter?: TimeRange;
|
|
5655
5525
|
/**
|
|
5656
|
-
* <p>Only returns synchronization jobs with the
|
|
5657
|
-
*
|
|
5526
|
+
* <p>Only returns synchronization jobs with the <code>Status</code> field equal to the
|
|
5527
|
+
* specified status.</p>
|
|
5658
5528
|
*/
|
|
5659
5529
|
StatusFilter?: DataSourceSyncJobStatus | string;
|
|
5660
5530
|
}
|
|
5661
5531
|
/**
|
|
5662
|
-
* <p>Maps a batch delete document request to a specific data source
|
|
5663
|
-
*
|
|
5664
|
-
*
|
|
5532
|
+
* <p>Maps a batch delete document request to a specific data source sync job. This is
|
|
5533
|
+
* optional and should only be supplied when documents are deleted by a data source
|
|
5534
|
+
* connector.</p>
|
|
5665
5535
|
*/
|
|
5666
5536
|
export interface DataSourceSyncJobMetrics {
|
|
5667
5537
|
/**
|
|
5668
|
-
* <p>The number of documents added from the data source up to now in
|
|
5669
|
-
*
|
|
5538
|
+
* <p>The number of documents added from the data source up to now in the data source
|
|
5539
|
+
* sync.</p>
|
|
5670
5540
|
*/
|
|
5671
5541
|
DocumentsAdded?: string;
|
|
5672
5542
|
/**
|
|
5673
|
-
* <p>The number of documents modified in the data source up to now in
|
|
5674
|
-
*
|
|
5543
|
+
* <p>The number of documents modified in the data source up to now in the data source sync
|
|
5544
|
+
* run.</p>
|
|
5675
5545
|
*/
|
|
5676
5546
|
DocumentsModified?: string;
|
|
5677
5547
|
/**
|
|
5678
|
-
* <p>The number of documents deleted from the data source up to now in
|
|
5679
|
-
*
|
|
5548
|
+
* <p>The number of documents deleted from the data source up to now in the data source sync
|
|
5549
|
+
* run.</p>
|
|
5680
5550
|
*/
|
|
5681
5551
|
DocumentsDeleted?: string;
|
|
5682
5552
|
/**
|
|
5683
|
-
* <p>The number of documents that failed to sync from the data source
|
|
5684
|
-
*
|
|
5553
|
+
* <p>The number of documents that failed to sync from the data source up to now in the data
|
|
5554
|
+
* source sync run.</p>
|
|
5685
5555
|
*/
|
|
5686
5556
|
DocumentsFailed?: string;
|
|
5687
5557
|
/**
|
|
5688
|
-
* <p>The current number of documents crawled by the current sync job in
|
|
5689
|
-
*
|
|
5558
|
+
* <p>The current number of documents crawled by the current sync job in the data
|
|
5559
|
+
* source.</p>
|
|
5690
5560
|
*/
|
|
5691
5561
|
DocumentsScanned?: string;
|
|
5692
5562
|
}
|
|
@@ -5703,41 +5573,36 @@ export interface DataSourceSyncJob {
|
|
|
5703
5573
|
*/
|
|
5704
5574
|
StartTime?: Date;
|
|
5705
5575
|
/**
|
|
5706
|
-
* <p>The UNIX datetime that the synchronization job
|
|
5707
|
-
* completed.</p>
|
|
5576
|
+
* <p>The UNIX datetime that the synchronization job completed.</p>
|
|
5708
5577
|
*/
|
|
5709
5578
|
EndTime?: Date;
|
|
5710
5579
|
/**
|
|
5711
|
-
* <p>The execution status of the synchronization job. When the
|
|
5712
|
-
*
|
|
5713
|
-
*
|
|
5714
|
-
*
|
|
5715
|
-
* <code>ErrorMessage</code> fields give you the reason for the
|
|
5716
|
-
* failure.</p>
|
|
5580
|
+
* <p>The execution status of the synchronization job. When the <code>Status</code> field is
|
|
5581
|
+
* set to <code>SUCCEEDED</code>, the synchronization job is done. If the status code is
|
|
5582
|
+
* set to <code>FAILED</code>, the <code>ErrorCode</code> and <code>ErrorMessage</code>
|
|
5583
|
+
* fields give you the reason for the failure.</p>
|
|
5717
5584
|
*/
|
|
5718
5585
|
Status?: DataSourceSyncJobStatus | string;
|
|
5719
5586
|
/**
|
|
5720
5587
|
* <p>If the <code>Status</code> field is set to <code>ERROR</code>, the
|
|
5721
|
-
* <code>ErrorMessage</code> field contains a description of the
|
|
5722
|
-
*
|
|
5588
|
+
* <code>ErrorMessage</code> field contains a description of the error that caused the
|
|
5589
|
+
* synchronization to fail.</p>
|
|
5723
5590
|
*/
|
|
5724
5591
|
ErrorMessage?: string;
|
|
5725
5592
|
/**
|
|
5726
|
-
* <p>If the <code>Status</code> field is set to <code>FAILED</code>,
|
|
5727
|
-
*
|
|
5728
|
-
* synchronization failed.</p>
|
|
5593
|
+
* <p>If the <code>Status</code> field is set to <code>FAILED</code>, the
|
|
5594
|
+
* <code>ErrorCode</code> field indicates the reason the synchronization failed.</p>
|
|
5729
5595
|
*/
|
|
5730
5596
|
ErrorCode?: ErrorCode | string;
|
|
5731
5597
|
/**
|
|
5732
|
-
* <p>If the reason that the synchronization failed is due to an error
|
|
5733
|
-
*
|
|
5734
|
-
* identifies the error.</p>
|
|
5598
|
+
* <p>If the reason that the synchronization failed is due to an error with the underlying
|
|
5599
|
+
* data source, this field contains a code that identifies the error.</p>
|
|
5735
5600
|
*/
|
|
5736
5601
|
DataSourceErrorCode?: string;
|
|
5737
5602
|
/**
|
|
5738
|
-
* <p>Maps a batch delete document request to a specific data source
|
|
5739
|
-
*
|
|
5740
|
-
*
|
|
5603
|
+
* <p>Maps a batch delete document request to a specific data source sync job. This is
|
|
5604
|
+
* optional and should only be supplied when documents are deleted by a data source
|
|
5605
|
+
* connector.</p>
|
|
5741
5606
|
*/
|
|
5742
5607
|
Metrics?: DataSourceSyncJobMetrics;
|
|
5743
5608
|
}
|
|
@@ -5747,8 +5612,8 @@ export interface ListDataSourceSyncJobsResponse {
|
|
|
5747
5612
|
*/
|
|
5748
5613
|
History?: DataSourceSyncJob[];
|
|
5749
5614
|
/**
|
|
5750
|
-
* <p>If the response is truncated, Amazon Kendra returns this token that you
|
|
5751
|
-
*
|
|
5615
|
+
* <p>If the response is truncated, Amazon Kendra returns this token that you can use in
|
|
5616
|
+
* the subsequent request to retrieve the next set of jobs.</p>
|
|
5752
5617
|
*/
|
|
5753
5618
|
NextToken?: string;
|
|
5754
5619
|
}
|
|
@@ -5773,7 +5638,7 @@ export interface ListEntityPersonasRequest {
|
|
|
5773
5638
|
MaxResults?: number;
|
|
5774
5639
|
}
|
|
5775
5640
|
/**
|
|
5776
|
-
* <p>Summary information for users or groups in your
|
|
5641
|
+
* <p>Summary information for users or groups in your IAM Identity Center identity
|
|
5777
5642
|
* source. This applies to users and groups with specific permissions that define
|
|
5778
5643
|
* their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience
|
|
5779
5644
|
* such as a search application. For more information on creating a search application
|
|
@@ -5782,13 +5647,13 @@ export interface ListEntityPersonasRequest {
|
|
|
5782
5647
|
*/
|
|
5783
5648
|
export interface PersonasSummary {
|
|
5784
5649
|
/**
|
|
5785
|
-
* <p>The identifier of a user or group in your
|
|
5650
|
+
* <p>The identifier of a user or group in your IAM Identity Center identity source.
|
|
5786
5651
|
* For example, a user ID could be an email.</p>
|
|
5787
5652
|
*/
|
|
5788
5653
|
EntityId?: string;
|
|
5789
5654
|
/**
|
|
5790
5655
|
* <p>The persona that defines the specific permissions of the user or group in
|
|
5791
|
-
* your
|
|
5656
|
+
* your IAM Identity Center identity source. The available personas or access
|
|
5792
5657
|
* roles are <code>Owner</code> and <code>Viewer</code>. For more information on
|
|
5793
5658
|
* these personas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience">Providing
|
|
5794
5659
|
* access to your search page</a>.</p>
|
|
@@ -5856,7 +5721,7 @@ export interface EntityDisplayData {
|
|
|
5856
5721
|
LastName?: string;
|
|
5857
5722
|
}
|
|
5858
5723
|
/**
|
|
5859
|
-
* <p>Summary information for users or groups in your
|
|
5724
|
+
* <p>Summary information for users or groups in your IAM Identity Center identity
|
|
5860
5725
|
* source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra
|
|
5861
5726
|
* experience such as a search application. For more information on creating a
|
|
5862
5727
|
* search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
|
|
@@ -5864,7 +5729,7 @@ export interface EntityDisplayData {
|
|
|
5864
5729
|
*/
|
|
5865
5730
|
export interface ExperienceEntitiesSummary {
|
|
5866
5731
|
/**
|
|
5867
|
-
* <p>The identifier of a user or group in your
|
|
5732
|
+
* <p>The identifier of a user or group in your IAM Identity Center identity source.
|
|
5868
5733
|
* For example, a user ID could be an email.</p>
|
|
5869
5734
|
*/
|
|
5870
5735
|
EntityId?: string;
|
|
@@ -5962,8 +5827,8 @@ export interface ListFaqsRequest {
|
|
|
5962
5827
|
MaxResults?: number;
|
|
5963
5828
|
}
|
|
5964
5829
|
/**
|
|
5965
|
-
* <p>Summary information for frequently asked questions and answers
|
|
5966
|
-
*
|
|
5830
|
+
* <p>Summary information for frequently asked questions and answers included in an
|
|
5831
|
+
* index.</p>
|
|
5967
5832
|
*/
|
|
5968
5833
|
export interface FaqSummary {
|
|
5969
5834
|
/**
|
|
@@ -5971,13 +5836,12 @@ export interface FaqSummary {
|
|
|
5971
5836
|
*/
|
|
5972
5837
|
Id?: string;
|
|
5973
5838
|
/**
|
|
5974
|
-
* <p>The name that you assigned the FAQ when you created or updated the
|
|
5975
|
-
* FAQ.</p>
|
|
5839
|
+
* <p>The name that you assigned the FAQ when you created or updated the FAQ.</p>
|
|
5976
5840
|
*/
|
|
5977
5841
|
Name?: string;
|
|
5978
5842
|
/**
|
|
5979
|
-
* <p>The current status of the FAQ. When the status is
|
|
5980
|
-
*
|
|
5843
|
+
* <p>The current status of the FAQ. When the status is <code>ACTIVE</code> the FAQ is ready
|
|
5844
|
+
* for use.</p>
|
|
5981
5845
|
*/
|
|
5982
5846
|
Status?: FaqStatus | string;
|
|
5983
5847
|
/**
|
|
@@ -6098,15 +5962,14 @@ export interface IndexConfigurationSummary {
|
|
|
6098
5962
|
*/
|
|
6099
5963
|
Name?: string;
|
|
6100
5964
|
/**
|
|
6101
|
-
* <p>A unique identifier for the index. Use this to identify the index
|
|
6102
|
-
*
|
|
6103
|
-
*
|
|
6104
|
-
* <code>DeleteIndex</code>.</p>
|
|
5965
|
+
* <p>A unique identifier for the index. Use this to identify the index when you are using
|
|
5966
|
+
* APIs such as <code>Query</code>, <code>DescribeIndex</code>, <code>UpdateIndex</code>,
|
|
5967
|
+
* and <code>DeleteIndex</code>.</p>
|
|
6105
5968
|
*/
|
|
6106
5969
|
Id?: string;
|
|
6107
5970
|
/**
|
|
6108
|
-
* <p>Indicates whether the index is a enterprise edition index or a
|
|
6109
|
-
*
|
|
5971
|
+
* <p>Indicates whether the index is a enterprise edition index or a developer edition
|
|
5972
|
+
* index. </p>
|
|
6110
5973
|
*/
|
|
6111
5974
|
Edition?: IndexEdition | string;
|
|
6112
5975
|
/**
|
|
@@ -6114,13 +5977,13 @@ export interface IndexConfigurationSummary {
|
|
|
6114
5977
|
*/
|
|
6115
5978
|
CreatedAt: Date | undefined;
|
|
6116
5979
|
/**
|
|
6117
|
-
* <p>The Unix timestamp when the index was last updated by the
|
|
6118
|
-
*
|
|
5980
|
+
* <p>The Unix timestamp when the index was last updated by the <code>UpdateIndex</code>
|
|
5981
|
+
* API.</p>
|
|
6119
5982
|
*/
|
|
6120
5983
|
UpdatedAt: Date | undefined;
|
|
6121
5984
|
/**
|
|
6122
|
-
* <p>The current status of the index. When the status is
|
|
6123
|
-
*
|
|
5985
|
+
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the index is
|
|
5986
|
+
* ready to search.</p>
|
|
6124
5987
|
*/
|
|
6125
5988
|
Status: IndexStatus | string | undefined;
|
|
6126
5989
|
}
|
|
@@ -6424,10 +6287,10 @@ export declare enum SortOrder {
|
|
|
6424
6287
|
DESC = "DESC"
|
|
6425
6288
|
}
|
|
6426
6289
|
/**
|
|
6427
|
-
* <p>Specifies the document attribute to use to sort the response to a
|
|
6428
|
-
*
|
|
6429
|
-
*
|
|
6430
|
-
*
|
|
6290
|
+
* <p>Specifies the document attribute to use to sort the response to a Amazon Kendra
|
|
6291
|
+
* query. You can specify a single attribute for sorting. The attribute must have the
|
|
6292
|
+
* <code>Sortable</code> flag set to <code>true</code>, otherwise Amazon Kendra
|
|
6293
|
+
* returns an exception.</p>
|
|
6431
6294
|
* <p>You can sort attributes of the following types.</p>
|
|
6432
6295
|
* <ul>
|
|
6433
6296
|
* <li>
|
|
@@ -6449,11 +6312,9 @@ export declare enum SortOrder {
|
|
|
6449
6312
|
*/
|
|
6450
6313
|
export interface SortingConfiguration {
|
|
6451
6314
|
/**
|
|
6452
|
-
* <p>The name of the document attribute used to sort the response. You
|
|
6453
|
-
*
|
|
6454
|
-
*
|
|
6455
|
-
* <p>You can also sort by any of the following built-in
|
|
6456
|
-
* attributes:</p>
|
|
6315
|
+
* <p>The name of the document attribute used to sort the response. You can use any field
|
|
6316
|
+
* that has the <code>Sortable</code> flag set to true.</p>
|
|
6317
|
+
* <p>You can also sort by any of the following built-in attributes:</p>
|
|
6457
6318
|
* <ul>
|
|
6458
6319
|
* <li>
|
|
6459
6320
|
* <p>_category</p>
|
|
@@ -6474,9 +6335,8 @@ export interface SortingConfiguration {
|
|
|
6474
6335
|
*/
|
|
6475
6336
|
DocumentAttributeKey: string | undefined;
|
|
6476
6337
|
/**
|
|
6477
|
-
* <p>The order that the results should be returned in. In case of ties,
|
|
6478
|
-
*
|
|
6479
|
-
* tie-breaker.</p>
|
|
6338
|
+
* <p>The order that the results should be returned in. In case of ties, the relevance
|
|
6339
|
+
* assigned to the result by Amazon Kendra is used as the tie-breaker.</p>
|
|
6480
6340
|
*/
|
|
6481
6341
|
SortOrder: SortOrder | string | undefined;
|
|
6482
6342
|
}
|
|
@@ -6723,8 +6583,8 @@ export interface StartDataSourceSyncJobResponse {
|
|
|
6723
6583
|
}
|
|
6724
6584
|
export interface StopDataSourceSyncJobRequest {
|
|
6725
6585
|
/**
|
|
6726
|
-
* <p>The identifier of the data source connector for which to stop the
|
|
6727
|
-
*
|
|
6586
|
+
* <p>The identifier of the data source connector for which to stop the synchronization
|
|
6587
|
+
* jobs.</p>
|
|
6728
6588
|
*/
|
|
6729
6589
|
Id: string | undefined;
|
|
6730
6590
|
/**
|
|
@@ -6733,19 +6593,17 @@ export interface StopDataSourceSyncJobRequest {
|
|
|
6733
6593
|
IndexId: string | undefined;
|
|
6734
6594
|
}
|
|
6735
6595
|
/**
|
|
6736
|
-
* <p>Gathers information about when a particular result was clicked by
|
|
6737
|
-
*
|
|
6738
|
-
*
|
|
6596
|
+
* <p>Gathers information about when a particular result was clicked by a user. Your
|
|
6597
|
+
* application uses the <code>SubmitFeedback</code> API to provide click
|
|
6598
|
+
* information.</p>
|
|
6739
6599
|
*/
|
|
6740
6600
|
export interface ClickFeedback {
|
|
6741
6601
|
/**
|
|
6742
|
-
* <p>The unique identifier of the search result that was
|
|
6743
|
-
* clicked.</p>
|
|
6602
|
+
* <p>The unique identifier of the search result that was clicked.</p>
|
|
6744
6603
|
*/
|
|
6745
6604
|
ResultId: string | undefined;
|
|
6746
6605
|
/**
|
|
6747
|
-
* <p>The Unix timestamp of the date and time that the result was
|
|
6748
|
-
* clicked.</p>
|
|
6606
|
+
* <p>The Unix timestamp of the date and time that the result was clicked.</p>
|
|
6749
6607
|
*/
|
|
6750
6608
|
ClickTime: Date | undefined;
|
|
6751
6609
|
}
|
|
@@ -6754,19 +6612,17 @@ export declare enum RelevanceType {
|
|
|
6754
6612
|
RELEVANT = "RELEVANT"
|
|
6755
6613
|
}
|
|
6756
6614
|
/**
|
|
6757
|
-
* <p>Provides feedback on how relevant a document is to a search. Your
|
|
6758
|
-
*
|
|
6759
|
-
* provide relevance information.</p>
|
|
6615
|
+
* <p>Provides feedback on how relevant a document is to a search. Your application uses the
|
|
6616
|
+
* <code>SubmitFeedback</code> API to provide relevance information.</p>
|
|
6760
6617
|
*/
|
|
6761
6618
|
export interface RelevanceFeedback {
|
|
6762
6619
|
/**
|
|
6763
|
-
* <p>The unique identifier of the search result that the user provided
|
|
6764
|
-
*
|
|
6620
|
+
* <p>The unique identifier of the search result that the user provided relevance feedback
|
|
6621
|
+
* for.</p>
|
|
6765
6622
|
*/
|
|
6766
6623
|
ResultId: string | undefined;
|
|
6767
6624
|
/**
|
|
6768
|
-
* <p>Whether to document was relevant or not relevant to the
|
|
6769
|
-
* search.</p>
|
|
6625
|
+
* <p>Whether to document was relevant or not relevant to the search.</p>
|
|
6770
6626
|
*/
|
|
6771
6627
|
RelevanceValue: RelevanceType | string | undefined;
|
|
6772
6628
|
}
|
|
@@ -6870,8 +6726,8 @@ export interface UpdateDataSourceRequest {
|
|
|
6870
6726
|
*/
|
|
6871
6727
|
Configuration?: DataSourceConfiguration;
|
|
6872
6728
|
/**
|
|
6873
|
-
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your
|
|
6874
|
-
*
|
|
6729
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
|
|
6730
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
6875
6731
|
*/
|
|
6876
6732
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
6877
6733
|
/**
|
|
@@ -6883,9 +6739,8 @@ export interface UpdateDataSourceRequest {
|
|
|
6883
6739
|
*/
|
|
6884
6740
|
Schedule?: string;
|
|
6885
6741
|
/**
|
|
6886
|
-
* <p>The Amazon Resource Name (ARN) of a role with permission to access
|
|
6887
|
-
*
|
|
6888
|
-
* Amazon Kendra</a>.</p>
|
|
6742
|
+
* <p>The Amazon Resource Name (ARN) of a role with permission to access the data source and
|
|
6743
|
+
* required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
6889
6744
|
*/
|
|
6890
6745
|
RoleArn?: string;
|
|
6891
6746
|
/**
|
|
@@ -6923,7 +6778,7 @@ export interface UpdateExperienceRequest {
|
|
|
6923
6778
|
/**
|
|
6924
6779
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
|
|
6925
6780
|
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
6926
|
-
* API, and
|
|
6781
|
+
* API, and IAM Identity Center that stores your user and group information.
|
|
6927
6782
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
6928
6783
|
*/
|
|
6929
6784
|
RoleArn?: string;
|
|
@@ -6979,7 +6834,7 @@ export interface UpdateIndexRequest {
|
|
|
6979
6834
|
*/
|
|
6980
6835
|
UserContextPolicy?: UserContextPolicy | string;
|
|
6981
6836
|
/**
|
|
6982
|
-
* <p>Enables fetching access levels of groups and users from an
|
|
6837
|
+
* <p>Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On)
|
|
6983
6838
|
* identity source. To configure this, see
|
|
6984
6839
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>.</p>
|
|
6985
6840
|
*/
|
|
@@ -7097,8 +6952,7 @@ export interface UpdateThesaurusRequest {
|
|
|
7097
6952
|
*/
|
|
7098
6953
|
RoleArn?: string;
|
|
7099
6954
|
/**
|
|
7100
|
-
* <p>Information required to find a specific file in an Amazon S3
|
|
7101
|
-
* bucket.</p>
|
|
6955
|
+
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
7102
6956
|
*/
|
|
7103
6957
|
SourceS3Path?: S3Path;
|
|
7104
6958
|
}
|
|
@@ -7137,8 +6991,8 @@ export interface Facet {
|
|
|
7137
6991
|
MaxResults?: number;
|
|
7138
6992
|
}
|
|
7139
6993
|
/**
|
|
7140
|
-
* <p>Provides the count of documents that match a particular attribute
|
|
7141
|
-
*
|
|
6994
|
+
* <p>Provides the count of documents that match a particular attribute when doing a faceted
|
|
6995
|
+
* search.</p>
|
|
7142
6996
|
*/
|
|
7143
6997
|
export interface DocumentAttributeValueCountPair {
|
|
7144
6998
|
/**
|
|
@@ -7146,22 +7000,21 @@ export interface DocumentAttributeValueCountPair {
|
|
|
7146
7000
|
*/
|
|
7147
7001
|
DocumentAttributeValue?: DocumentAttributeValue;
|
|
7148
7002
|
/**
|
|
7149
|
-
* <p>The number of documents in the response that have the attribute
|
|
7150
|
-
*
|
|
7003
|
+
* <p>The number of documents in the response that have the attribute value for the
|
|
7004
|
+
* key.</p>
|
|
7151
7005
|
*/
|
|
7152
7006
|
Count?: number;
|
|
7153
7007
|
/**
|
|
7154
|
-
* <p>Contains the results of a document attribute that is a nested facet.
|
|
7155
|
-
*
|
|
7156
|
-
*
|
|
7157
|
-
* <p>For example, the document attribute or facet "Department" includes a
|
|
7158
|
-
*
|
|
7159
|
-
*
|
|
7160
|
-
*
|
|
7161
|
-
*
|
|
7162
|
-
*
|
|
7163
|
-
*
|
|
7164
|
-
* are returned for a query.</p>
|
|
7008
|
+
* <p>Contains the results of a document attribute that is a nested facet. A
|
|
7009
|
+
* <code>FacetResult</code> contains the counts for each facet nested within a
|
|
7010
|
+
* facet.</p>
|
|
7011
|
+
* <p>For example, the document attribute or facet "Department" includes a value called
|
|
7012
|
+
* "Engineering". In addition, the document attribute or facet "SubDepartment" includes the
|
|
7013
|
+
* values "Frontend" and "Backend" for documents assigned to "Engineering". You can display
|
|
7014
|
+
* nested facets in the search results so that documents can be searched not only by
|
|
7015
|
+
* department but also by a sub department within a department. The counts for documents
|
|
7016
|
+
* that belong to "Frontend" and "Backend" within "Engineering" are returned for a
|
|
7017
|
+
* query.</p>
|
|
7165
7018
|
*/
|
|
7166
7019
|
FacetResults?: FacetResult[];
|
|
7167
7020
|
}
|