@aws-sdk/client-kendra 3.43.0 → 3.44.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.
Files changed (100) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +7 -7
  3. package/dist-cjs/Kendra.js +180 -0
  4. package/dist-cjs/commands/AssociateEntitiesToExperienceCommand.js +36 -0
  5. package/dist-cjs/commands/AssociatePersonasToEntitiesCommand.js +36 -0
  6. package/dist-cjs/commands/CreateExperienceCommand.js +36 -0
  7. package/dist-cjs/commands/DeleteExperienceCommand.js +36 -0
  8. package/dist-cjs/commands/DescribeExperienceCommand.js +36 -0
  9. package/dist-cjs/commands/DisassociateEntitiesFromExperienceCommand.js +36 -0
  10. package/dist-cjs/commands/DisassociatePersonasFromEntitiesCommand.js +36 -0
  11. package/dist-cjs/commands/GetSnapshotsCommand.js +36 -0
  12. package/dist-cjs/commands/ListEntityPersonasCommand.js +36 -0
  13. package/dist-cjs/commands/ListExperienceEntitiesCommand.js +36 -0
  14. package/dist-cjs/commands/ListExperiencesCommand.js +36 -0
  15. package/dist-cjs/commands/UpdateExperienceCommand.js +36 -0
  16. package/dist-cjs/commands/index.js +12 -0
  17. package/dist-cjs/models/models_0.js +342 -39
  18. package/dist-cjs/pagination/ListEntityPersonasPaginator.js +35 -0
  19. package/dist-cjs/pagination/ListExperienceEntitiesPaginator.js +34 -0
  20. package/dist-cjs/pagination/ListExperiencesPaginator.js +35 -0
  21. package/dist-cjs/pagination/index.js +3 -0
  22. package/dist-cjs/protocols/Aws_json1_1.js +2043 -261
  23. package/dist-es/Kendra.js +180 -0
  24. package/dist-es/commands/AssociateEntitiesToExperienceCommand.js +39 -0
  25. package/dist-es/commands/AssociatePersonasToEntitiesCommand.js +39 -0
  26. package/dist-es/commands/CreateExperienceCommand.js +39 -0
  27. package/dist-es/commands/DeleteExperienceCommand.js +39 -0
  28. package/dist-es/commands/DescribeExperienceCommand.js +39 -0
  29. package/dist-es/commands/DisassociateEntitiesFromExperienceCommand.js +39 -0
  30. package/dist-es/commands/DisassociatePersonasFromEntitiesCommand.js +39 -0
  31. package/dist-es/commands/GetSnapshotsCommand.js +39 -0
  32. package/dist-es/commands/ListEntityPersonasCommand.js +39 -0
  33. package/dist-es/commands/ListExperienceEntitiesCommand.js +39 -0
  34. package/dist-es/commands/ListExperiencesCommand.js +39 -0
  35. package/dist-es/commands/UpdateExperienceCommand.js +39 -0
  36. package/dist-es/commands/index.js +12 -0
  37. package/dist-es/models/models_0.js +239 -24
  38. package/dist-es/pagination/ListEntityPersonasPaginator.js +74 -0
  39. package/dist-es/pagination/ListExperienceEntitiesPaginator.js +73 -0
  40. package/dist-es/pagination/ListExperiencesPaginator.js +74 -0
  41. package/dist-es/pagination/index.js +3 -0
  42. package/dist-es/protocols/Aws_json1_1.js +2042 -234
  43. package/dist-types/Kendra.d.ts +164 -1
  44. package/dist-types/KendraClient.d.ts +14 -2
  45. package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +39 -0
  46. package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +39 -0
  47. package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +3 -0
  48. package/dist-types/commands/CreateDataSourceCommand.d.ts +2 -0
  49. package/dist-types/commands/CreateExperienceCommand.d.ts +37 -0
  50. package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +3 -0
  51. package/dist-types/commands/DeleteExperienceCommand.d.ts +37 -0
  52. package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +3 -0
  53. package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +3 -0
  54. package/dist-types/commands/DescribeExperienceCommand.d.ts +38 -0
  55. package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +3 -0
  56. package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +3 -0
  57. package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +3 -0
  58. package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +39 -0
  59. package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +39 -0
  60. package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +3 -0
  61. package/dist-types/commands/GetSnapshotsCommand.d.ts +37 -0
  62. package/dist-types/commands/ListEntityPersonasCommand.d.ts +36 -0
  63. package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +39 -0
  64. package/dist-types/commands/ListExperiencesCommand.d.ts +38 -0
  65. package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +3 -0
  66. package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +3 -0
  67. package/dist-types/commands/PutPrincipalMappingCommand.d.ts +3 -0
  68. package/dist-types/commands/SubmitFeedbackCommand.d.ts +4 -1
  69. package/dist-types/commands/UpdateExperienceCommand.d.ts +37 -0
  70. package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +3 -0
  71. package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +3 -0
  72. package/dist-types/commands/index.d.ts +12 -0
  73. package/dist-types/models/models_0.d.ts +1316 -180
  74. package/dist-types/pagination/ListEntityPersonasPaginator.d.ts +4 -0
  75. package/dist-types/pagination/ListExperienceEntitiesPaginator.d.ts +4 -0
  76. package/dist-types/pagination/ListExperiencesPaginator.d.ts +4 -0
  77. package/dist-types/pagination/index.d.ts +3 -0
  78. package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
  79. package/dist-types/ts3.4/Kendra.d.ts +60 -0
  80. package/dist-types/ts3.4/KendraClient.d.ts +14 -2
  81. package/dist-types/ts3.4/commands/AssociateEntitiesToExperienceCommand.d.ts +17 -0
  82. package/dist-types/ts3.4/commands/AssociatePersonasToEntitiesCommand.d.ts +17 -0
  83. package/dist-types/ts3.4/commands/CreateExperienceCommand.d.ts +17 -0
  84. package/dist-types/ts3.4/commands/DeleteExperienceCommand.d.ts +17 -0
  85. package/dist-types/ts3.4/commands/DescribeExperienceCommand.d.ts +17 -0
  86. package/dist-types/ts3.4/commands/DisassociateEntitiesFromExperienceCommand.d.ts +17 -0
  87. package/dist-types/ts3.4/commands/DisassociatePersonasFromEntitiesCommand.d.ts +17 -0
  88. package/dist-types/ts3.4/commands/GetSnapshotsCommand.d.ts +17 -0
  89. package/dist-types/ts3.4/commands/ListEntityPersonasCommand.d.ts +17 -0
  90. package/dist-types/ts3.4/commands/ListExperienceEntitiesCommand.d.ts +17 -0
  91. package/dist-types/ts3.4/commands/ListExperiencesCommand.d.ts +17 -0
  92. package/dist-types/ts3.4/commands/UpdateExperienceCommand.d.ts +17 -0
  93. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  94. package/dist-types/ts3.4/models/models_0.d.ts +603 -57
  95. package/dist-types/ts3.4/pagination/ListEntityPersonasPaginator.d.ts +4 -0
  96. package/dist-types/ts3.4/pagination/ListExperienceEntitiesPaginator.d.ts +4 -0
  97. package/dist-types/ts3.4/pagination/ListExperiencesPaginator.d.ts +4 -0
  98. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  99. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  100. package/package.json +1 -1
@@ -149,6 +149,226 @@ export declare namespace AdditionalResultAttribute {
149
149
  */
150
150
  const filterSensitiveLog: (obj: AdditionalResultAttribute) => any;
151
151
  }
152
+ export declare enum EntityType {
153
+ GROUP = "GROUP",
154
+ USER = "USER"
155
+ }
156
+ /**
157
+ * <p>Provides the configuration information of users or groups in
158
+ * your Amazon Web Services SSO identity source to grant access your Amazon Kendra
159
+ * experience.</p>
160
+ */
161
+ export interface EntityConfiguration {
162
+ /**
163
+ * <p>The identifier of a user or group in your Amazon Web Services SSO identity
164
+ * source. For example, a user ID could be an email.</p>
165
+ */
166
+ EntityId: string | undefined;
167
+ /**
168
+ * <p>Specifies whether you are configuring a <code>User</code> or a
169
+ * <code>Group</code>.</p>
170
+ */
171
+ EntityType: EntityType | string | undefined;
172
+ }
173
+ export declare namespace EntityConfiguration {
174
+ /**
175
+ * @internal
176
+ */
177
+ const filterSensitiveLog: (obj: EntityConfiguration) => any;
178
+ }
179
+ export interface AssociateEntitiesToExperienceRequest {
180
+ /**
181
+ * <p>The identifier of your Amazon Kendra experience.</p>
182
+ */
183
+ Id: string | undefined;
184
+ /**
185
+ * <p>The identifier of the index for your Amazon Kendra experience.</p>
186
+ */
187
+ IndexId: string | undefined;
188
+ /**
189
+ * <p>Lists users or groups in your Amazon Web Services SSO identity source.</p>
190
+ */
191
+ EntityList: EntityConfiguration[] | undefined;
192
+ }
193
+ export declare namespace AssociateEntitiesToExperienceRequest {
194
+ /**
195
+ * @internal
196
+ */
197
+ const filterSensitiveLog: (obj: AssociateEntitiesToExperienceRequest) => any;
198
+ }
199
+ /**
200
+ * <p>Information on the users or groups in your Amazon Web Services SSO identity
201
+ * source that failed to properly configure with your Amazon Kendra experience.</p>
202
+ */
203
+ export interface FailedEntity {
204
+ /**
205
+ * <p>The identifier of the user or group in your Amazon Web Services SSO identity
206
+ * source. For example, a user ID could be an email.</p>
207
+ */
208
+ EntityId?: string;
209
+ /**
210
+ * <p>The reason the user or group in your Amazon Web Services SSO identity source
211
+ * failed to properly configure with your Amazon Kendra experience.</p>
212
+ */
213
+ ErrorMessage?: string;
214
+ }
215
+ export declare namespace FailedEntity {
216
+ /**
217
+ * @internal
218
+ */
219
+ const filterSensitiveLog: (obj: FailedEntity) => any;
220
+ }
221
+ export interface AssociateEntitiesToExperienceResponse {
222
+ /**
223
+ * <p>Lists the users or groups in your Amazon Web Services SSO identity source that
224
+ * failed to properly configure with your Amazon Kendra experience.</p>
225
+ */
226
+ FailedEntityList?: FailedEntity[];
227
+ }
228
+ export declare namespace AssociateEntitiesToExperienceResponse {
229
+ /**
230
+ * @internal
231
+ */
232
+ const filterSensitiveLog: (obj: AssociateEntitiesToExperienceResponse) => any;
233
+ }
234
+ /**
235
+ * <p></p>
236
+ */
237
+ export interface InternalServerException extends __SmithyException, $MetadataBearer {
238
+ name: "InternalServerException";
239
+ $fault: "server";
240
+ Message?: string;
241
+ }
242
+ export declare namespace InternalServerException {
243
+ /**
244
+ * @internal
245
+ */
246
+ const filterSensitiveLog: (obj: InternalServerException) => any;
247
+ }
248
+ /**
249
+ * <p></p>
250
+ */
251
+ export interface ResourceAlreadyExistException extends __SmithyException, $MetadataBearer {
252
+ name: "ResourceAlreadyExistException";
253
+ $fault: "client";
254
+ Message?: string;
255
+ }
256
+ export declare namespace ResourceAlreadyExistException {
257
+ /**
258
+ * @internal
259
+ */
260
+ const filterSensitiveLog: (obj: ResourceAlreadyExistException) => any;
261
+ }
262
+ /**
263
+ * <p></p>
264
+ */
265
+ export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
266
+ name: "ResourceNotFoundException";
267
+ $fault: "client";
268
+ Message?: string;
269
+ }
270
+ export declare namespace ResourceNotFoundException {
271
+ /**
272
+ * @internal
273
+ */
274
+ const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
275
+ }
276
+ /**
277
+ * <p></p>
278
+ */
279
+ export interface ThrottlingException extends __SmithyException, $MetadataBearer {
280
+ name: "ThrottlingException";
281
+ $fault: "client";
282
+ Message?: string;
283
+ }
284
+ export declare namespace ThrottlingException {
285
+ /**
286
+ * @internal
287
+ */
288
+ const filterSensitiveLog: (obj: ThrottlingException) => any;
289
+ }
290
+ /**
291
+ * <p></p>
292
+ */
293
+ export interface ValidationException extends __SmithyException, $MetadataBearer {
294
+ name: "ValidationException";
295
+ $fault: "client";
296
+ Message?: string;
297
+ }
298
+ export declare namespace ValidationException {
299
+ /**
300
+ * @internal
301
+ */
302
+ const filterSensitiveLog: (obj: ValidationException) => any;
303
+ }
304
+ export declare enum Persona {
305
+ OWNER = "OWNER",
306
+ VIEWER = "VIEWER"
307
+ }
308
+ /**
309
+ * <p>Provides the configuration information of users or groups in your
310
+ * Amazon Web Services SSO identity source for access to your Amazon Kendra experience.
311
+ * Specific permissions are defined for each user or group once they are
312
+ * granted access to your Amazon Kendra experience.</p>
313
+ */
314
+ export interface EntityPersonaConfiguration {
315
+ /**
316
+ * <p>The identifier of a user or group in your Amazon Web Services SSO identity
317
+ * source. For example, a user ID could be an email.</p>
318
+ */
319
+ EntityId: string | undefined;
320
+ /**
321
+ * <p>The persona that defines the specific permissions of the user or group
322
+ * in your Amazon Web Services SSO identity source. The available personas or
323
+ * access roles are <code>Owner</code> and <code>Viewer</code>. For more
324
+ * 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
325
+ * access to your search page</a>.</p>
326
+ */
327
+ Persona: Persona | string | undefined;
328
+ }
329
+ export declare namespace EntityPersonaConfiguration {
330
+ /**
331
+ * @internal
332
+ */
333
+ const filterSensitiveLog: (obj: EntityPersonaConfiguration) => any;
334
+ }
335
+ export interface AssociatePersonasToEntitiesRequest {
336
+ /**
337
+ * <p>The identifier of your Amazon Kendra experience.</p>
338
+ */
339
+ Id: string | undefined;
340
+ /**
341
+ * <p>The identifier of the index for your Amazon Kendra experience.</p>
342
+ */
343
+ IndexId: string | undefined;
344
+ /**
345
+ * <p>The personas that define the specific permissions of users or groups in
346
+ * your Amazon Web Services SSO identity source. The available personas or access
347
+ * roles are <code>Owner</code> and <code>Viewer</code>. For more information
348
+ * on these personas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience">Providing
349
+ * access to your search page</a>.</p>
350
+ */
351
+ Personas: EntityPersonaConfiguration[] | undefined;
352
+ }
353
+ export declare namespace AssociatePersonasToEntitiesRequest {
354
+ /**
355
+ * @internal
356
+ */
357
+ const filterSensitiveLog: (obj: AssociatePersonasToEntitiesRequest) => any;
358
+ }
359
+ export interface AssociatePersonasToEntitiesResponse {
360
+ /**
361
+ * <p>Lists the users or groups in your Amazon Web Services SSO identity source that
362
+ * failed to properly configure with your Amazon Kendra experience.</p>
363
+ */
364
+ FailedEntityList?: FailedEntity[];
365
+ }
366
+ export declare namespace AssociatePersonasToEntitiesResponse {
367
+ /**
368
+ * @internal
369
+ */
370
+ const filterSensitiveLog: (obj: AssociatePersonasToEntitiesResponse) => any;
371
+ }
152
372
  /**
153
373
  * <p>The value of a custom document attribute. You can only provide one
154
374
  * value for a custom attribute.</p>
@@ -221,7 +441,7 @@ export interface BasicAuthenticationConfiguration {
221
441
  */
222
442
  Port: number | undefined;
223
443
  /**
224
- * <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">AWS Secrets Manager</a>
444
+ * <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
225
445
  * </p>
226
446
  * <p>You use a secret if basic authentication credentials are required to connect
227
447
  * to a website. The secret stores your credentials of user name and password.</p>
@@ -360,62 +580,6 @@ export declare namespace ConflictException {
360
580
  */
361
581
  const filterSensitiveLog: (obj: ConflictException) => any;
362
582
  }
363
- /**
364
- * <p></p>
365
- */
366
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
367
- name: "InternalServerException";
368
- $fault: "server";
369
- Message?: string;
370
- }
371
- export declare namespace InternalServerException {
372
- /**
373
- * @internal
374
- */
375
- const filterSensitiveLog: (obj: InternalServerException) => any;
376
- }
377
- /**
378
- * <p></p>
379
- */
380
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
381
- name: "ResourceNotFoundException";
382
- $fault: "client";
383
- Message?: string;
384
- }
385
- export declare namespace ResourceNotFoundException {
386
- /**
387
- * @internal
388
- */
389
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
390
- }
391
- /**
392
- * <p></p>
393
- */
394
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
395
- name: "ThrottlingException";
396
- $fault: "client";
397
- Message?: string;
398
- }
399
- export declare namespace ThrottlingException {
400
- /**
401
- * @internal
402
- */
403
- const filterSensitiveLog: (obj: ThrottlingException) => any;
404
- }
405
- /**
406
- * <p></p>
407
- */
408
- export interface ValidationException extends __SmithyException, $MetadataBearer {
409
- name: "ValidationException";
410
- $fault: "client";
411
- Message?: string;
412
- }
413
- export declare namespace ValidationException {
414
- /**
415
- * @internal
416
- */
417
- const filterSensitiveLog: (obj: ValidationException) => any;
418
- }
419
583
  /**
420
584
  * <p>Identifies a document for which to retrieve status
421
585
  * information</p>
@@ -573,6 +737,216 @@ export declare namespace BatchGetDocumentStatusResponse {
573
737
  */
574
738
  const filterSensitiveLog: (obj: BatchGetDocumentStatusResponse) => any;
575
739
  }
740
+ export declare enum ConditionOperator {
741
+ BeginsWith = "BeginsWith",
742
+ Contains = "Contains",
743
+ Equals = "Equals",
744
+ Exists = "Exists",
745
+ GreaterThan = "GreaterThan",
746
+ GreaterThanOrEquals = "GreaterThanOrEquals",
747
+ LessThan = "LessThan",
748
+ LessThanOrEquals = "LessThanOrEquals",
749
+ NotContains = "NotContains",
750
+ NotEquals = "NotEquals",
751
+ NotExists = "NotExists"
752
+ }
753
+ /**
754
+ * <p>The condition used for the target document attribute or metadata field when
755
+ * ingesting documents into Amazon Kendra. You use this with <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html">DocumentAttributeTarget
756
+ * to apply the condition</a>.</p>
757
+ * <p>For example, you can create the 'Department' target field and have it prefill
758
+ * department names associated with the documents based on information in the
759
+ * 'Source_URI' field. Set the condition that if the 'Source_URI' field contains
760
+ * 'financial' in its URI value, then prefill the target field 'Department' with
761
+ * the target value 'Finance' for the document.</p>
762
+ * <p>Amazon Kendra cannot create a target field if it has not already been created as an
763
+ * index field. After you create your index field, you can create a document metadata
764
+ * field using <code>DocumentAttributeTarget</code>. Amazon Kendra then will map your newly
765
+ * created metadata field to your index field.</p>
766
+ */
767
+ export interface DocumentAttributeCondition {
768
+ /**
769
+ * <p>The identifier of the document attribute used for the condition.</p>
770
+ * <p>For example, 'Source_URI' could be an identifier for the attribute or metadata
771
+ * field that contains source URIs associated with the documents.</p>
772
+ * <p>Amazon Kendra currently does not support <code>_document_body</code> as an attribute
773
+ * key used for the condition.</p>
774
+ */
775
+ ConditionDocumentAttributeKey: string | undefined;
776
+ /**
777
+ * <p>The condition operator.</p>
778
+ * <p>For example, you can use 'Contains' to partially match a string.</p>
779
+ */
780
+ Operator: ConditionOperator | string | undefined;
781
+ /**
782
+ * <p>The value used by the operator.</p>
783
+ * <p>For example, you can specify the value 'financial' for strings in the 'Source_URI'
784
+ * field that partially match or contain this value.</p>
785
+ */
786
+ ConditionOnValue?: DocumentAttributeValue;
787
+ }
788
+ export declare namespace DocumentAttributeCondition {
789
+ /**
790
+ * @internal
791
+ */
792
+ const filterSensitiveLog: (obj: DocumentAttributeCondition) => any;
793
+ }
794
+ /**
795
+ * <p>The target document attribute or metadata field you want to alter when ingesting
796
+ * documents into Amazon Kendra.</p>
797
+ * <p>For example, you can delete customer identification numbers associated with the
798
+ * documents, stored in the document metadata field called 'Customer_ID'. You set the
799
+ * target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This
800
+ * removes all customer ID values in the field 'Customer_ID'. This would scrub
801
+ * personally identifiable information from each document's metadata.</p>
802
+ * <p>Amazon Kendra cannot create a target field if it has not already been created as an
803
+ * index field. After you create your index field, you can create a document metadata
804
+ * field using <code>DocumentAttributeTarget</code>. Amazon Kendra then will map your newly
805
+ * created metadata field to your index field.</p>
806
+ * <p>You can also use this with <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html">DocumentAttributeCondition</a>.</p>
807
+ */
808
+ export interface DocumentAttributeTarget {
809
+ /**
810
+ * <p>The identifier of the target document attribute or metadata field.</p>
811
+ * <p>For example, 'Department' could be an identifier for the target attribute or
812
+ * metadata field that includes the department names associated with the documents.</p>
813
+ */
814
+ TargetDocumentAttributeKey?: string;
815
+ /**
816
+ * <p>
817
+ * <code>TRUE</code> to delete the existing target value for your specified target
818
+ * attribute key. You cannot create a target value and set this to <code>TRUE</code>.
819
+ * To create a target value (<code>TargetDocumentAttributeValue</code>), set this to
820
+ * <code>FALSE</code>.</p>
821
+ */
822
+ TargetDocumentAttributeValueDeletion?: boolean;
823
+ /**
824
+ * <p>The target value you want to create for the target attribute.</p>
825
+ * <p>For example, 'Finance' could be the target value for the target attribute key
826
+ * 'Department'.</p>
827
+ */
828
+ TargetDocumentAttributeValue?: DocumentAttributeValue;
829
+ }
830
+ export declare namespace DocumentAttributeTarget {
831
+ /**
832
+ * @internal
833
+ */
834
+ const filterSensitiveLog: (obj: DocumentAttributeTarget) => any;
835
+ }
836
+ /**
837
+ * <p>Provides the configuration information for applying basic logic to alter document
838
+ * metadata and content when ingesting documents into Amazon Kendra. To apply advanced
839
+ * logic, to go beyond what you can do with basic logic, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html">HookConfiguration</a>.</p>
840
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata
841
+ * during the ingestion process</a>.</p>
842
+ */
843
+ export interface InlineCustomDocumentEnrichmentConfiguration {
844
+ /**
845
+ * <p>Configuration of the condition used for the target document attribute or metadata
846
+ * field when ingesting documents into Amazon Kendra.</p>
847
+ */
848
+ Condition?: DocumentAttributeCondition;
849
+ /**
850
+ * <p>Configuration of the target document attribute or metadata field when ingesting
851
+ * documents into Amazon Kendra. You can also include a value.</p>
852
+ */
853
+ Target?: DocumentAttributeTarget;
854
+ /**
855
+ * <p>
856
+ * <code>TRUE</code> to delete content if the condition used for the target
857
+ * attribute is met.</p>
858
+ */
859
+ DocumentContentDeletion?: boolean;
860
+ }
861
+ export declare namespace InlineCustomDocumentEnrichmentConfiguration {
862
+ /**
863
+ * @internal
864
+ */
865
+ const filterSensitiveLog: (obj: InlineCustomDocumentEnrichmentConfiguration) => any;
866
+ }
867
+ /**
868
+ * <p>Provides the configuration information for invoking a Lambda function in
869
+ * Lambda to alter document metadata and content when ingesting
870
+ * documents into Amazon Kendra. You can configure your Lambda function using
871
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PreExtractionHookConfiguration.html">PreExtractionHookConfiguration</a>
872
+ * if you want to apply advanced alterations on the original or raw documents.
873
+ * If you want to apply advanced alterations on the Amazon Kendra structured documents,
874
+ * you must configure your Lambda function using <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PostExtractionHookConfiguration.html">PostExtractionHookConfiguration</a>.
875
+ * You can only invoke one Lambda function. However, this function can invoke other
876
+ * functions it requires.</p>
877
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata
878
+ * during the ingestion process</a>.</p>
879
+ */
880
+ export interface HookConfiguration {
881
+ /**
882
+ * <p>The condition used for when a Lambda function should be invoked.</p>
883
+ * <p>For example, you can specify a condition that if there are empty date-time
884
+ * values, then Amazon Kendra should invoke a function that inserts the current date-time.</p>
885
+ */
886
+ InvocationCondition?: DocumentAttributeCondition;
887
+ /**
888
+ * <p>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function
889
+ * during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
890
+ */
891
+ LambdaArn: string | undefined;
892
+ /**
893
+ * <p>Stores the original, raw documents or the structured, parsed
894
+ * documents before and after altering them. For more information,
895
+ * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda">Data
896
+ * contracts for Lambda functions</a>.</p>
897
+ */
898
+ S3Bucket: string | undefined;
899
+ }
900
+ export declare namespace HookConfiguration {
901
+ /**
902
+ * @internal
903
+ */
904
+ const filterSensitiveLog: (obj: HookConfiguration) => any;
905
+ }
906
+ /**
907
+ * <p>Provides the configuration information for altering document metadata and content
908
+ * during the document ingestion process.</p>
909
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata
910
+ * during the ingestion process</a>.</p>
911
+ */
912
+ export interface CustomDocumentEnrichmentConfiguration {
913
+ /**
914
+ * <p>Configuration information to alter document attributes or metadata fields and
915
+ * content when ingesting documents into Amazon Kendra.</p>
916
+ */
917
+ InlineConfigurations?: InlineCustomDocumentEnrichmentConfiguration[];
918
+ /**
919
+ * <p>Configuration information for invoking a Lambda function in Lambda
920
+ * on the original or raw documents before extracting their metadata and text. You can
921
+ * use a Lambda function to apply advanced logic for creating, modifying, or deleting
922
+ * document metadata and content. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation">Advanced
923
+ * data manipulation</a>.</p>
924
+ */
925
+ PreExtractionHookConfiguration?: HookConfiguration;
926
+ /**
927
+ * <p>Configuration information for invoking a Lambda function in Lambda
928
+ * on the structured documents with their metadata and text extracted. You can use a
929
+ * Lambda function to apply advanced logic for creating, modifying, or deleting document
930
+ * metadata and content. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation">Advanced
931
+ * data manipulation</a>.</p>
932
+ */
933
+ PostExtractionHookConfiguration?: HookConfiguration;
934
+ /**
935
+ * <p>The Amazon Resource Name (ARN) of a role with permission to run
936
+ * <code>PreExtractionHookConfiguration</code> and
937
+ * <code>PostExtractionHookConfiguration</code> for altering document metadata
938
+ * and content during the document ingestion process. For more information,
939
+ * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for
940
+ * Amazon Kendra</a>.</p>
941
+ */
942
+ RoleArn?: string;
943
+ }
944
+ export declare namespace CustomDocumentEnrichmentConfiguration {
945
+ /**
946
+ * @internal
947
+ */
948
+ const filterSensitiveLog: (obj: CustomDocumentEnrichmentConfiguration) => any;
949
+ }
576
950
  export declare enum ReadAccessType {
577
951
  ALLOW = "ALLOW",
578
952
  DENY = "DENY"
@@ -750,6 +1124,16 @@ export interface BatchPutDocumentRequest {
750
1124
  * quotas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</p>
751
1125
  */
752
1126
  Documents: Document[] | undefined;
1127
+ /**
1128
+ * <p>Configuration information for altering your document metadata and content during
1129
+ * the document ingestion process when you use the <code>BatchPutDocument</code>
1130
+ * operation.</p>
1131
+ * <p>For more information on how to create, modify and delete document metadata,
1132
+ * or make other content alterations when you ingest documents into Amazon Kendra, see
1133
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
1134
+ * document metadata during the ingestion process</a>.</p>
1135
+ */
1136
+ CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
753
1137
  }
754
1138
  export declare namespace BatchPutDocumentRequest {
755
1139
  /**
@@ -1159,7 +1543,7 @@ export interface ConfluenceConfiguration {
1159
1543
  */
1160
1544
  ServerUrl: string | undefined;
1161
1545
  /**
1162
- * <p>The Amazon Resource Name (ARN) of an Secrets Managersecret
1546
+ * <p>The Amazon Resource Name (ARN) of an Secrets Manager secret
1163
1547
  * that contains the key/value pairs required to connect to your
1164
1548
  * Confluence server. The secret must contain a JSON structure with the
1165
1549
  * following keys:</p>
@@ -2116,7 +2500,7 @@ export interface ServiceNowConfiguration {
2116
2500
  /**
2117
2501
  * <p>Determines the type of authentication used to connect to the
2118
2502
  * ServiceNow instance. If you choose <code>HTTP_BASIC</code>, Amazon Kendra is
2119
- * authenticated using the user name and password provided in the AWS
2503
+ * authenticated using the user name and password provided in the
2120
2504
  * Secrets Manager secret in the <code>SecretArn</code> field. When you
2121
2505
  * choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the OAuth
2122
2506
  * token and secret provided in the Secrets Manager secret, and the
@@ -2162,7 +2546,7 @@ export interface SharePointConfiguration {
2162
2546
  * domain name as part of the credentials. For
2163
2547
  * more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html">Using a
2164
2548
  * Microsoft SharePoint Data Source</a>. For more information
2165
- * about Secrets Manager, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html"> What Is
2549
+ * about Secrets Manager see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html"> What Is
2166
2550
  * Secrets Manager</a> in the <i>Secrets Manager
2167
2551
  * </i> user guide.</p>
2168
2552
  */
@@ -2259,7 +2643,7 @@ export interface ProxyConfiguration {
2259
2643
  */
2260
2644
  Port: number | undefined;
2261
2645
  /**
2262
- * <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">AWS Secrets Manager</a>
2646
+ * <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
2263
2647
  * </p>
2264
2648
  * <p>The credentials are optional. You use a secret if web proxy credentials
2265
2649
  * are required to connect to a website host. Amazon Kendra currently support basic
@@ -2284,8 +2668,8 @@ export declare enum WebCrawlerMode {
2284
2668
  * <p>
2285
2669
  * <i>When selecting websites to index, you must adhere to
2286
2670
  * the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
2287
- * and all other Amazon terms. Remember that you must only use the Amazon Kendra web
2288
- * crawler to index your own webpages, or webpages that you have authorization
2671
+ * and all other Amazon terms. Remember that you must only use Amazon Kendra Web
2672
+ * Crawler to index your own webpages, or webpages that you have authorization
2289
2673
  * to index.</i>
2290
2674
  * </p>
2291
2675
  */
@@ -2332,8 +2716,8 @@ export declare namespace SeedUrlConfiguration {
2332
2716
  * <p>
2333
2717
  * <i>When selecting websites to index, you must adhere to
2334
2718
  * the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
2335
- * and all other Amazon terms. Remember that you must only use the Amazon Kendra web
2336
- * crawler to index your own webpages, or webpages that you have authorization
2719
+ * and all other Amazon terms. Remember that you must only use Amazon Kendra Web
2720
+ * Crawler to index your own webpages, or webpages that you have authorization
2337
2721
  * to index.</i>
2338
2722
  * </p>
2339
2723
  */
@@ -2359,8 +2743,8 @@ export declare namespace SiteMapsConfiguration {
2359
2743
  * <p>
2360
2744
  * <i>When selecting websites to index, you must adhere to
2361
2745
  * the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
2362
- * and all other Amazon terms. Remember that you must only use the Amazon Kendra web
2363
- * crawler to index your own webpages, or webpages that you have authorization to
2746
+ * and all other Amazon terms. Remember that you must only use Amazon Kendra Web
2747
+ * Crawler to index your own webpages, or webpages that you have authorization to
2364
2748
  * index.</i>
2365
2749
  * </p>
2366
2750
  */
@@ -2389,7 +2773,7 @@ export declare namespace Urls {
2389
2773
  }
2390
2774
  /**
2391
2775
  * <p>Provides the configuration information required for Amazon Kendra
2392
- * web crawler.</p>
2776
+ * Web Crawler.</p>
2393
2777
  */
2394
2778
  export interface WebCrawlerConfiguration {
2395
2779
  /**
@@ -2403,8 +2787,8 @@ export interface WebCrawlerConfiguration {
2403
2787
  * <p>
2404
2788
  * <i>When selecting websites to index, you must adhere to
2405
2789
  * the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
2406
- * and all other Amazon terms. Remember that you must only use the Amazon Kendra
2407
- * web crawler to index your own webpages, or webpages that you have
2790
+ * and all other Amazon terms. Remember that you must only use Amazon Kendra
2791
+ * Web Crawler to index your own webpages, or webpages that you have
2408
2792
  * authorization to index.</i>
2409
2793
  * </p>
2410
2794
  */
@@ -2459,7 +2843,7 @@ export interface WebCrawlerConfiguration {
2459
2843
  * port is 443, the standard port for HTTPS.</p>
2460
2844
  * <p>Web proxy credentials are optional and you can use them to connect to a
2461
2845
  * web proxy server that requires basic authentication. To store web proxy
2462
- * credentials, you use a secret in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">AWS Secrets Manager</a>.</p>
2846
+ * credentials, you use a secret in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>.</p>
2463
2847
  */
2464
2848
  ProxyConfiguration?: ProxyConfiguration;
2465
2849
  /**
@@ -2468,7 +2852,7 @@ export interface WebCrawlerConfiguration {
2468
2852
  * <p>You can connect to websites using basic authentication of user name and password.</p>
2469
2853
  * <p>You must provide the website host name and port number. For example, the host name
2470
2854
  * of https://a.example.com/page1.html is "a.example.com" and the port is 443, the
2471
- * standard port for HTTPS. You use a secret in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">AWS Secrets Manager</a> to store
2855
+ * standard port for HTTPS. You use a secret in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a> to store
2472
2856
  * your authentication credentials.</p>
2473
2857
  */
2474
2858
  AuthenticationConfiguration?: AuthenticationConfiguration;
@@ -2490,11 +2874,11 @@ export interface WorkDocsConfiguration {
2490
2874
  * <p>The identifier of the directory corresponding to your
2491
2875
  * Amazon WorkDocs site repository.</p>
2492
2876
  * <p>You can find the organization ID in the
2493
- * <a href="https://console.aws.amazon.com/directoryservicev2/">AWS Directory Service</a> by going to
2877
+ * <a href="https://console.aws.amazon.com/directoryservicev2/">Directory Service</a> by going to
2494
2878
  * <b>Active Directory</b>, then
2495
2879
  * <b>Directories</b>. Your Amazon WorkDocs site directory has an
2496
2880
  * ID, which is the organization ID. You can also set up a new Amazon WorkDocs
2497
- * directory in the AWS Directory Service console and enable a Amazon WorkDocs site
2881
+ * directory in the Directory Service console and enable a Amazon WorkDocs site
2498
2882
  * for the directory in the Amazon WorkDocs console.</p>
2499
2883
  */
2500
2884
  OrganizationId: string | undefined;
@@ -2553,7 +2937,7 @@ export declare namespace WorkDocsConfiguration {
2553
2937
  const filterSensitiveLog: (obj: WorkDocsConfiguration) => any;
2554
2938
  }
2555
2939
  /**
2556
- * <p>Configuration information for a Amazon Kendra data source.</p>
2940
+ * <p>Configuration information for an Amazon Kendra data source.</p>
2557
2941
  */
2558
2942
  export interface DataSourceConfiguration {
2559
2943
  /**
@@ -2598,7 +2982,7 @@ export interface DataSourceConfiguration {
2598
2982
  GoogleDriveConfiguration?: GoogleDriveConfiguration;
2599
2983
  /**
2600
2984
  * <p>Provides the configuration information required for Amazon Kendra
2601
- * web crawler.</p>
2985
+ * Web Crawler.</p>
2602
2986
  */
2603
2987
  WebCrawlerConfiguration?: WebCrawlerConfiguration;
2604
2988
  /**
@@ -2720,38 +3104,156 @@ export interface CreateDataSourceRequest {
2720
3104
  * documents in languages other than English</a>.</p>
2721
3105
  */
2722
3106
  LanguageCode?: string;
3107
+ /**
3108
+ * <p>Configuration information for altering document metadata and content during the
3109
+ * document ingestion process when you create a data source.</p>
3110
+ * <p>For more information on how to create, modify and delete document metadata, or make
3111
+ * other content alterations when you ingest documents into Amazon Kendra, see
3112
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
3113
+ * document metadata during the ingestion process</a>.</p>
3114
+ */
3115
+ CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
3116
+ }
3117
+ export declare namespace CreateDataSourceRequest {
3118
+ /**
3119
+ * @internal
3120
+ */
3121
+ const filterSensitiveLog: (obj: CreateDataSourceRequest) => any;
3122
+ }
3123
+ export interface CreateDataSourceResponse {
3124
+ /**
3125
+ * <p>A unique identifier for the data source.</p>
3126
+ */
3127
+ Id: string | undefined;
3128
+ }
3129
+ export declare namespace CreateDataSourceResponse {
3130
+ /**
3131
+ * @internal
3132
+ */
3133
+ const filterSensitiveLog: (obj: CreateDataSourceResponse) => any;
3134
+ }
3135
+ /**
3136
+ * <p>Configuration information for your content sources, such as data sources,
3137
+ * FAQs, and content indexed directly via <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>.</p>
3138
+ */
3139
+ export interface ContentSourceConfiguration {
3140
+ /**
3141
+ * <p>The identifier of the data sources you want to use for your Amazon Kendra experience.</p>
3142
+ */
3143
+ DataSourceIds?: string[];
3144
+ /**
3145
+ * <p>The identifier of the FAQs that you want to use for your Amazon Kendra experience.</p>
3146
+ */
3147
+ FaqIds?: string[];
3148
+ /**
3149
+ * <p>
3150
+ * <code>TRUE</code> to use documents you indexed directly using the
3151
+ * <code>BatchPutDocument</code> operation.</p>
3152
+ */
3153
+ DirectPutContent?: boolean;
3154
+ }
3155
+ export declare namespace ContentSourceConfiguration {
3156
+ /**
3157
+ * @internal
3158
+ */
3159
+ const filterSensitiveLog: (obj: ContentSourceConfiguration) => any;
3160
+ }
3161
+ /**
3162
+ * <p>Configuration information for the identifiers of your users.</p>
3163
+ */
3164
+ export interface UserIdentityConfiguration {
3165
+ /**
3166
+ * <p>The Amazon Web Services SSO field name that contains the identifiers of your users,
3167
+ * 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>
3168
+ * and for granting access to your Amazon Kendra experience. You must set up Amazon Web Services SSO
3169
+ * with Amazon Kendra. You must include your users and groups in your Access Control List when
3170
+ * you ingest documents into your index. For more information, see
3171
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting
3172
+ * started with an Amazon Web Services SSO identity source</a>.</p>
3173
+ */
3174
+ IdentityAttributeName?: string;
3175
+ }
3176
+ export declare namespace UserIdentityConfiguration {
3177
+ /**
3178
+ * @internal
3179
+ */
3180
+ const filterSensitiveLog: (obj: UserIdentityConfiguration) => any;
3181
+ }
3182
+ /**
3183
+ * <p>Specifies the configuration information for your Amazon Kendra experience. This includes
3184
+ * the data source IDs and/or FAQ IDs, and user or group information to grant access
3185
+ * to your Amazon Kendra experience.</p>
3186
+ */
3187
+ export interface ExperienceConfiguration {
3188
+ /**
3189
+ * <p>The identifiers of your data sources and FAQs. Or, you can specify
3190
+ * that you want to use documents indexed via the <code>BatchPutDocument</code>
3191
+ * operation. This is the content you want to use for your Amazon Kendra experience.</p>
3192
+ */
3193
+ ContentSourceConfiguration?: ContentSourceConfiguration;
3194
+ /**
3195
+ * <p>The Amazon Web Services SSO field name that contains the identifiers of your users,
3196
+ * such as their emails.</p>
3197
+ */
3198
+ UserIdentityConfiguration?: UserIdentityConfiguration;
3199
+ }
3200
+ export declare namespace ExperienceConfiguration {
3201
+ /**
3202
+ * @internal
3203
+ */
3204
+ const filterSensitiveLog: (obj: ExperienceConfiguration) => any;
3205
+ }
3206
+ export interface CreateExperienceRequest {
3207
+ /**
3208
+ * <p>A name for your Amazon Kendra experience.</p>
3209
+ */
3210
+ Name: string | undefined;
3211
+ /**
3212
+ * <p>The identifier of the index for your Amazon Kendra experience.</p>
3213
+ */
3214
+ IndexId: string | undefined;
3215
+ /**
3216
+ * <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
3217
+ * operations, <code>QuerySuggestions</code> operations, <code>SubmitFeedback</code>
3218
+ * operations, and Amazon Web Services SSO that stores your user and group information.
3219
+ * For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
3220
+ */
3221
+ RoleArn?: string;
3222
+ /**
3223
+ * <p>Provides the configuration information for your Amazon Kendra experience. This includes
3224
+ * <code>ContentSourceConfiguration</code>, which specifies the data source IDs
3225
+ * and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the
3226
+ * user or group information to grant access to your Amazon Kendra experience.</p>
3227
+ */
3228
+ Configuration?: ExperienceConfiguration;
3229
+ /**
3230
+ * <p>A description for your Amazon Kendra experience.</p>
3231
+ */
3232
+ Description?: string;
3233
+ /**
3234
+ * <p>A token that you provide to identify the request to create your Amazon Kendra experience.
3235
+ * Multiple calls to the <code>CreateExperience</code> operation with the same client
3236
+ * token creates only one Amazon Kendra experience.</p>
3237
+ */
3238
+ ClientToken?: string;
2723
3239
  }
2724
- export declare namespace CreateDataSourceRequest {
3240
+ export declare namespace CreateExperienceRequest {
2725
3241
  /**
2726
3242
  * @internal
2727
3243
  */
2728
- const filterSensitiveLog: (obj: CreateDataSourceRequest) => any;
3244
+ const filterSensitiveLog: (obj: CreateExperienceRequest) => any;
2729
3245
  }
2730
- export interface CreateDataSourceResponse {
3246
+ export interface CreateExperienceResponse {
2731
3247
  /**
2732
- * <p>A unique identifier for the data source.</p>
3248
+ * <p>The identifier for your created Amazon Kendra experience.</p>
2733
3249
  */
2734
3250
  Id: string | undefined;
2735
3251
  }
2736
- export declare namespace CreateDataSourceResponse {
2737
- /**
2738
- * @internal
2739
- */
2740
- const filterSensitiveLog: (obj: CreateDataSourceResponse) => any;
2741
- }
2742
- /**
2743
- * <p></p>
2744
- */
2745
- export interface ResourceAlreadyExistException extends __SmithyException, $MetadataBearer {
2746
- name: "ResourceAlreadyExistException";
2747
- $fault: "client";
2748
- Message?: string;
2749
- }
2750
- export declare namespace ResourceAlreadyExistException {
3252
+ export declare namespace CreateExperienceResponse {
2751
3253
  /**
2752
3254
  * @internal
2753
3255
  */
2754
- const filterSensitiveLog: (obj: ResourceAlreadyExistException) => any;
3256
+ const filterSensitiveLog: (obj: CreateExperienceResponse) => any;
2755
3257
  }
2756
3258
  export declare enum FaqFileFormat {
2757
3259
  CSV = "CSV",
@@ -2860,26 +3362,26 @@ export declare enum UserGroupResolutionMode {
2860
3362
  }
2861
3363
  /**
2862
3364
  * <p>Provides the configuration information to fetch access levels
2863
- * of groups and users from an AWS Single Sign-On identity
3365
+ * of groups and users from an Amazon Web Services Single Sign On identity
2864
3366
  * source. This is useful for setting up user context filtering, where
2865
3367
  * Amazon Kendra filters search results for different users based on their
2866
3368
  * group's access to documents. You can also map your users to their
2867
3369
  * groups for user context filtering using the
2868
- * <a href="https://docs.aws.amazon.com/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping
3370
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping
2869
3371
  * operation</a>.</p>
2870
- * <p>To set up an AWS SSO identity source in the console to use with
3372
+ * <p>To set up an Amazon Web Services SSO identity source in the console to use with
2871
3373
  * Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started
2872
- * with an AWS SSO identity source</a>. You must also grant the required
2873
- * permissions to use AWS SSO with Amazon Kendra. For more information, see
3374
+ * with an Amazon Web Services SSO identity source</a>. You must also grant the required
3375
+ * permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see
2874
3376
  * <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso">IAM roles for
2875
- * AWS Single Sign-On</a>.</p>
3377
+ * Amazon Web Services SSO</a>.</p>
2876
3378
  */
2877
3379
  export interface UserGroupResolutionConfiguration {
2878
3380
  /**
2879
3381
  * <p>The identity store provider (mode) you want to use to fetch access levels of groups and
2880
- * users. AWS Single Sign-On is currently the only available mode. Your users and groups
3382
+ * users. Amazon Web Services Single Sign On is currently the only available mode. Your users and groups
2881
3383
  * must
2882
- * exist in an AWS SSO identity source in order to use this mode.</p>
3384
+ * exist in an Amazon Web Services SSO identity source in order to use this mode.</p>
2883
3385
  */
2884
3386
  UserGroupResolutionMode: UserGroupResolutionMode | string | undefined;
2885
3387
  }
@@ -3045,7 +3547,7 @@ export interface CreateIndexRequest {
3045
3547
  */
3046
3548
  UserContextPolicy?: UserContextPolicy | string;
3047
3549
  /**
3048
- * <p>Enables fetching access levels of groups and users from an AWS Single Sign-On
3550
+ * <p>Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On
3049
3551
  * identity source. To configure this, see
3050
3552
  * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>.</p>
3051
3553
  */
@@ -3149,7 +3651,7 @@ export interface CreateThesaurusRequest {
3149
3651
  */
3150
3652
  Description?: string;
3151
3653
  /**
3152
- * <p>An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions
3654
+ * <p>An IAM role that gives Amazon Kendra permissions
3153
3655
  * to access thesaurus file specified in <code>SourceS3Path</code>.
3154
3656
  * </p>
3155
3657
  */
@@ -3210,6 +3712,30 @@ export declare namespace DeleteDataSourceRequest {
3210
3712
  */
3211
3713
  const filterSensitiveLog: (obj: DeleteDataSourceRequest) => any;
3212
3714
  }
3715
+ export interface DeleteExperienceRequest {
3716
+ /**
3717
+ * <p>The identifier of your Amazon Kendra experience you want to delete.</p>
3718
+ */
3719
+ Id: string | undefined;
3720
+ /**
3721
+ * <p>The identifier of the index for your Amazon Kendra experience you want to delete.</p>
3722
+ */
3723
+ IndexId: string | undefined;
3724
+ }
3725
+ export declare namespace DeleteExperienceRequest {
3726
+ /**
3727
+ * @internal
3728
+ */
3729
+ const filterSensitiveLog: (obj: DeleteExperienceRequest) => any;
3730
+ }
3731
+ export interface DeleteExperienceResponse {
3732
+ }
3733
+ export declare namespace DeleteExperienceResponse {
3734
+ /**
3735
+ * @internal
3736
+ */
3737
+ const filterSensitiveLog: (obj: DeleteExperienceResponse) => any;
3738
+ }
3213
3739
  export interface DeleteFaqRequest {
3214
3740
  /**
3215
3741
  * <p>The identifier of the FAQ to remove.</p>
@@ -3403,6 +3929,15 @@ export interface DescribeDataSourceResponse {
3403
3929
  * documents in languages other than English</a>.</p>
3404
3930
  */
3405
3931
  LanguageCode?: string;
3932
+ /**
3933
+ * <p>Configuration information for altering document metadata and content during the
3934
+ * document ingestion process when you describe a data source.</p>
3935
+ * <p>For more information on how to create, modify and delete document metadata, or make
3936
+ * other content alterations when you ingest documents into Amazon Kendra, see
3937
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
3938
+ * document metadata during the ingestion process</a>.</p>
3939
+ */
3940
+ CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
3406
3941
  }
3407
3942
  export declare namespace DescribeDataSourceResponse {
3408
3943
  /**
@@ -3410,6 +3945,116 @@ export declare namespace DescribeDataSourceResponse {
3410
3945
  */
3411
3946
  const filterSensitiveLog: (obj: DescribeDataSourceResponse) => any;
3412
3947
  }
3948
+ export interface DescribeExperienceRequest {
3949
+ /**
3950
+ * <p>The identifier of your Amazon Kendra experience you want to get information on.</p>
3951
+ */
3952
+ Id: string | undefined;
3953
+ /**
3954
+ * <p>The identifier of the index for your Amazon Kendra experience you want to get
3955
+ * information on.</p>
3956
+ */
3957
+ IndexId: string | undefined;
3958
+ }
3959
+ export declare namespace DescribeExperienceRequest {
3960
+ /**
3961
+ * @internal
3962
+ */
3963
+ const filterSensitiveLog: (obj: DescribeExperienceRequest) => any;
3964
+ }
3965
+ export declare enum EndpointType {
3966
+ HOME = "HOME"
3967
+ }
3968
+ /**
3969
+ * <p>Provides the configuration information of the endpoint for your Amazon Kendra
3970
+ * experience.</p>
3971
+ */
3972
+ export interface ExperienceEndpoint {
3973
+ /**
3974
+ * <p>The type of endpoint for your Amazon Kendra experience. The type currently available
3975
+ * is <code>HOME</code>, which is a unique and fully hosted URL to the home page
3976
+ * of your Amazon Kendra experience.</p>
3977
+ */
3978
+ EndpointType?: EndpointType | string;
3979
+ /**
3980
+ * <p>The endpoint of your Amazon Kendra experience.</p>
3981
+ */
3982
+ Endpoint?: string;
3983
+ }
3984
+ export declare namespace ExperienceEndpoint {
3985
+ /**
3986
+ * @internal
3987
+ */
3988
+ const filterSensitiveLog: (obj: ExperienceEndpoint) => any;
3989
+ }
3990
+ export declare enum ExperienceStatus {
3991
+ ACTIVE = "ACTIVE",
3992
+ CREATING = "CREATING",
3993
+ DELETING = "DELETING",
3994
+ FAILED = "FAILED"
3995
+ }
3996
+ export interface DescribeExperienceResponse {
3997
+ /**
3998
+ * <p>Shows the identifier of your Amazon Kendra experience.</p>
3999
+ */
4000
+ Id?: string;
4001
+ /**
4002
+ * <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
4003
+ */
4004
+ IndexId?: string;
4005
+ /**
4006
+ * <p>Shows the name of your Amazon Kendra experience.</p>
4007
+ */
4008
+ Name?: string;
4009
+ /**
4010
+ * <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully
4011
+ * hosted by Amazon Web Services.</p>
4012
+ */
4013
+ Endpoints?: ExperienceEndpoint[];
4014
+ /**
4015
+ * <p>Shows the configuration information for your Amazon Kendra experience. This includes
4016
+ * <code>ContentSourceConfiguration</code>, which specifies the data source IDs
4017
+ * and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the
4018
+ * user or group information to grant access to your Amazon Kendra experience.</p>
4019
+ */
4020
+ Configuration?: ExperienceConfiguration;
4021
+ /**
4022
+ * <p>Shows the date-time your Amazon Kendra experience was created.</p>
4023
+ */
4024
+ CreatedAt?: Date;
4025
+ /**
4026
+ * <p>Shows the date-time your Amazon Kendra experience was last updated.</p>
4027
+ */
4028
+ UpdatedAt?: Date;
4029
+ /**
4030
+ * <p>Shows the description for your Amazon Kendra experience.</p>
4031
+ */
4032
+ Description?: string;
4033
+ /**
4034
+ * <p>The current processing status of your Amazon Kendra experience. When the status
4035
+ * is <code>ACTIVE</code>, your Amazon Kendra experience is ready to use. When the
4036
+ * status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains
4037
+ * the reason that this failed.</p>
4038
+ */
4039
+ Status?: ExperienceStatus | string;
4040
+ /**
4041
+ * <p>Shows the Amazon Resource Name (ARN) of a role with permission to access
4042
+ * <code>Query</code> operations, <code>QuerySuggestions</code> operations,
4043
+ * <code>SubmitFeedback</code> operations, and Amazon Web Services SSO that stores
4044
+ * your user and group information.</p>
4045
+ */
4046
+ RoleArn?: string;
4047
+ /**
4048
+ * <p>The reason your Amazon Kendra experience could not properly process.</p>
4049
+ */
4050
+ ErrorMessage?: string;
4051
+ }
4052
+ export declare namespace DescribeExperienceResponse {
4053
+ /**
4054
+ * @internal
4055
+ */
4056
+ const filterSensitiveLog: (obj: DescribeExperienceResponse) => any;
4057
+ }
3413
4058
  export interface DescribeFaqRequest {
3414
4059
  /**
3415
4060
  * <p>The unique identifier of the FAQ.</p>
@@ -3833,7 +4478,7 @@ export interface DescribeIndexResponse {
3833
4478
  UserContextPolicy?: UserContextPolicy | string;
3834
4479
  /**
3835
4480
  * <p>Shows whether you have enabled the configuration for fetching access
3836
- * levels of groups and users from an AWS Single Sign-On identity source.</p>
4481
+ * levels of groups and users from an Amazon Web Services Single Sign On identity source.</p>
3837
4482
  */
3838
4483
  UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
3839
4484
  }
@@ -4212,7 +4857,7 @@ export interface DescribeThesaurusResponse {
4212
4857
  */
4213
4858
  UpdatedAt?: Date;
4214
4859
  /**
4215
- * <p>An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions
4860
+ * <p>An IAM role that gives Amazon Kendra permissions
4216
4861
  * to access thesaurus file specified in <code>SourceS3Path</code>.
4217
4862
  * </p>
4218
4863
  */
@@ -4244,6 +4889,73 @@ export declare namespace DescribeThesaurusResponse {
4244
4889
  */
4245
4890
  const filterSensitiveLog: (obj: DescribeThesaurusResponse) => any;
4246
4891
  }
4892
+ export interface DisassociateEntitiesFromExperienceRequest {
4893
+ /**
4894
+ * <p>The identifier of your Amazon Kendra experience.</p>
4895
+ */
4896
+ Id: string | undefined;
4897
+ /**
4898
+ * <p>The identifier of the index for your Amazon Kendra experience.</p>
4899
+ */
4900
+ IndexId: string | undefined;
4901
+ /**
4902
+ * <p>Lists users or groups in your Amazon Web Services SSO identity source.</p>
4903
+ */
4904
+ EntityList: EntityConfiguration[] | undefined;
4905
+ }
4906
+ export declare namespace DisassociateEntitiesFromExperienceRequest {
4907
+ /**
4908
+ * @internal
4909
+ */
4910
+ const filterSensitiveLog: (obj: DisassociateEntitiesFromExperienceRequest) => any;
4911
+ }
4912
+ export interface DisassociateEntitiesFromExperienceResponse {
4913
+ /**
4914
+ * <p>Lists the users or groups in your Amazon Web Services SSO identity source that
4915
+ * failed to properly remove access to your Amazon Kendra experience.</p>
4916
+ */
4917
+ FailedEntityList?: FailedEntity[];
4918
+ }
4919
+ export declare namespace DisassociateEntitiesFromExperienceResponse {
4920
+ /**
4921
+ * @internal
4922
+ */
4923
+ const filterSensitiveLog: (obj: DisassociateEntitiesFromExperienceResponse) => any;
4924
+ }
4925
+ export interface DisassociatePersonasFromEntitiesRequest {
4926
+ /**
4927
+ * <p>The identifier of your Amazon Kendra experience.</p>
4928
+ */
4929
+ Id: string | undefined;
4930
+ /**
4931
+ * <p>The identifier of the index for your Amazon Kendra experience.</p>
4932
+ */
4933
+ IndexId: string | undefined;
4934
+ /**
4935
+ * <p>The identifiers of users or groups in your Amazon Web Services SSO identity
4936
+ * source. For example, user IDs could be user emails.</p>
4937
+ */
4938
+ EntityIds: string[] | undefined;
4939
+ }
4940
+ export declare namespace DisassociatePersonasFromEntitiesRequest {
4941
+ /**
4942
+ * @internal
4943
+ */
4944
+ const filterSensitiveLog: (obj: DisassociatePersonasFromEntitiesRequest) => any;
4945
+ }
4946
+ export interface DisassociatePersonasFromEntitiesResponse {
4947
+ /**
4948
+ * <p>Lists the users or groups in your Amazon Web Services SSO identity source that
4949
+ * failed to properly remove access to your Amazon Kendra experience.</p>
4950
+ */
4951
+ FailedEntityList?: FailedEntity[];
4952
+ }
4953
+ export declare namespace DisassociatePersonasFromEntitiesResponse {
4954
+ /**
4955
+ * @internal
4956
+ */
4957
+ const filterSensitiveLog: (obj: DisassociatePersonasFromEntitiesResponse) => any;
4958
+ }
4247
4959
  export interface GetQuerySuggestionsRequest {
4248
4960
  /**
4249
4961
  * <p>The identifier of the index you want to get query suggestions from.</p>
@@ -4276,92 +4988,238 @@ export declare namespace GetQuerySuggestionsRequest {
4276
4988
  */
4277
4989
  export interface SuggestionHighlight {
4278
4990
  /**
4279
- * <p>The zero-based location in the response string where the highlight starts.</p>
4991
+ * <p>The zero-based location in the response string where the highlight starts.</p>
4992
+ */
4993
+ BeginOffset?: number;
4994
+ /**
4995
+ * <p>The zero-based location in the response string where the highlight ends.</p>
4996
+ */
4997
+ EndOffset?: number;
4998
+ }
4999
+ export declare namespace SuggestionHighlight {
5000
+ /**
5001
+ * @internal
5002
+ */
5003
+ const filterSensitiveLog: (obj: SuggestionHighlight) => any;
5004
+ }
5005
+ /**
5006
+ * <p>Provides text and information about where to highlight the query suggestion text.</p>
5007
+ */
5008
+ export interface SuggestionTextWithHighlights {
5009
+ /**
5010
+ * <p>The query suggestion text to display to the user.</p>
5011
+ */
5012
+ Text?: string;
5013
+ /**
5014
+ * <p>The beginning and end of the query suggestion text that should be highlighted.</p>
5015
+ */
5016
+ Highlights?: SuggestionHighlight[];
5017
+ }
5018
+ export declare namespace SuggestionTextWithHighlights {
5019
+ /**
5020
+ * @internal
5021
+ */
5022
+ const filterSensitiveLog: (obj: SuggestionTextWithHighlights) => any;
5023
+ }
5024
+ /**
5025
+ * <p>The <code>SuggestionTextWithHighlights</code> structure information.</p>
5026
+ */
5027
+ export interface SuggestionValue {
5028
+ /**
5029
+ * <p>The <code>SuggestionTextWithHighlights</code> structure that contains
5030
+ * the query suggestion text and highlights.</p>
5031
+ */
5032
+ Text?: SuggestionTextWithHighlights;
5033
+ }
5034
+ export declare namespace SuggestionValue {
5035
+ /**
5036
+ * @internal
5037
+ */
5038
+ const filterSensitiveLog: (obj: SuggestionValue) => any;
5039
+ }
5040
+ /**
5041
+ * <p>A single query suggestion.</p>
5042
+ */
5043
+ export interface Suggestion {
5044
+ /**
5045
+ * <p>The unique UUID (universally unique identifier) of a single
5046
+ * query suggestion.</p>
5047
+ */
5048
+ Id?: string;
5049
+ /**
5050
+ * <p>The value for the unique UUID (universally unique identifier)
5051
+ * of a single query suggestion.</p>
5052
+ * <p>The value is the text string of a suggestion.</p>
5053
+ */
5054
+ Value?: SuggestionValue;
5055
+ }
5056
+ export declare namespace Suggestion {
5057
+ /**
5058
+ * @internal
5059
+ */
5060
+ const filterSensitiveLog: (obj: Suggestion) => any;
5061
+ }
5062
+ export interface GetQuerySuggestionsResponse {
5063
+ /**
5064
+ * <p>The unique identifier for a list of query suggestions for an index.</p>
5065
+ */
5066
+ QuerySuggestionsId?: string;
5067
+ /**
5068
+ * <p>A list of query suggestions for an index.</p>
5069
+ */
5070
+ Suggestions?: Suggestion[];
5071
+ }
5072
+ export declare namespace GetQuerySuggestionsResponse {
5073
+ /**
5074
+ * @internal
5075
+ */
5076
+ const filterSensitiveLog: (obj: GetQuerySuggestionsResponse) => any;
5077
+ }
5078
+ export declare enum Interval {
5079
+ ONE_MONTH_AGO = "ONE_MONTH_AGO",
5080
+ ONE_WEEK_AGO = "ONE_WEEK_AGO",
5081
+ THIS_MONTH = "THIS_MONTH",
5082
+ THIS_WEEK = "THIS_WEEK",
5083
+ TWO_MONTHS_AGO = "TWO_MONTHS_AGO",
5084
+ TWO_WEEKS_AGO = "TWO_WEEKS_AGO"
5085
+ }
5086
+ export declare enum MetricType {
5087
+ AGG_QUERY_DOC_METRICS = "AGG_QUERY_DOC_METRICS",
5088
+ DOCS_BY_CLICK_COUNT = "DOCS_BY_CLICK_COUNT",
5089
+ QUERIES_BY_COUNT = "QUERIES_BY_COUNT",
5090
+ QUERIES_BY_ZERO_CLICK_RATE = "QUERIES_BY_ZERO_CLICK_RATE",
5091
+ QUERIES_BY_ZERO_RESULT_RATE = "QUERIES_BY_ZERO_RESULT_RATE",
5092
+ TREND_QUERY_DOC_METRICS = "TREND_QUERY_DOC_METRICS"
5093
+ }
5094
+ export interface GetSnapshotsRequest {
5095
+ /**
5096
+ * <p>The identifier of the index to get search metrics data.</p>
5097
+ */
5098
+ IndexId: string | undefined;
5099
+ /**
5100
+ * <p>The time interval or time window to get search metrics data.
5101
+ * The time interval uses the time zone of your index.
5102
+ * You can view data in the following time windows:</p>
5103
+ * <ul>
5104
+ * <li>
5105
+ * <p>
5106
+ * <code>THIS_WEEK</code>: The current week, starting on
5107
+ * the Sunday and ending on the day before the current date.</p>
5108
+ * </li>
5109
+ * <li>
5110
+ * <p>
5111
+ * <code>ONE_WEEK_AGO</code>: The previous week, starting on
5112
+ * the Sunday and ending on the following Saturday.</p>
5113
+ * </li>
5114
+ * <li>
5115
+ * <p>
5116
+ * <code>TWO_WEEKS_AGO</code>: The week before the previous week,
5117
+ * starting on the Sunday and ending on the following Saturday.</p>
5118
+ * </li>
5119
+ * <li>
5120
+ * <p>
5121
+ * <code>THIS_MONTH</code>: The current month, starting on the
5122
+ * first day of the month and ending on the day before the current date.</p>
5123
+ * </li>
5124
+ * <li>
5125
+ * <p>
5126
+ * <code>ONE_MONTH_AGO</code>: The previous month, starting on the
5127
+ * first day of the month and ending on the last day of the month.</p>
5128
+ * </li>
5129
+ * <li>
5130
+ * <p>
5131
+ * <code>TWO_MONTHS_AGO</code>: The month before the previous month,
5132
+ * starting on the first day of the month and ending on last day of the month.</p>
5133
+ * </li>
5134
+ * </ul>
5135
+ */
5136
+ Interval: Interval | string | undefined;
5137
+ /**
5138
+ * <p>The metric you want to retrieve. You
5139
+ * can specify only one metric per call.</p>
5140
+ * <p>For more information about the metrics you can view, see
5141
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining
5142
+ * insights with search analytics</a>.</p>
5143
+ */
5144
+ MetricType: MetricType | string | undefined;
5145
+ /**
5146
+ * <p>If the previous response was incomplete (because there
5147
+ * is more data to retrieve), Amazon Kendra returns a pagination token in
5148
+ * the response. You can use this pagination token to
5149
+ * retrieve the next set of search metrics data.</p>
4280
5150
  */
4281
- BeginOffset?: number;
5151
+ NextToken?: string;
4282
5152
  /**
4283
- * <p>The zero-based location in the response string where the highlight ends.</p>
5153
+ * <p>The maximum number of returned data for the metric.</p>
4284
5154
  */
4285
- EndOffset?: number;
5155
+ MaxResults?: number;
4286
5156
  }
4287
- export declare namespace SuggestionHighlight {
5157
+ export declare namespace GetSnapshotsRequest {
4288
5158
  /**
4289
5159
  * @internal
4290
5160
  */
4291
- const filterSensitiveLog: (obj: SuggestionHighlight) => any;
5161
+ const filterSensitiveLog: (obj: GetSnapshotsRequest) => any;
4292
5162
  }
4293
5163
  /**
4294
- * <p>Provides text and information about where to highlight the query suggestion text.</p>
5164
+ * <p>Provides a range of time.</p>
4295
5165
  */
4296
- export interface SuggestionTextWithHighlights {
5166
+ export interface TimeRange {
4297
5167
  /**
4298
- * <p>The query suggestion text to display to the user.</p>
5168
+ * <p>The UNIX datetime of the beginning of the time range.</p>
4299
5169
  */
4300
- Text?: string;
5170
+ StartTime?: Date;
4301
5171
  /**
4302
- * <p>The beginning and end of the query suggestion text that should be highlighted.</p>
5172
+ * <p>The UNIX datetime of the end of the time range.</p>
4303
5173
  */
4304
- Highlights?: SuggestionHighlight[];
5174
+ EndTime?: Date;
4305
5175
  }
4306
- export declare namespace SuggestionTextWithHighlights {
5176
+ export declare namespace TimeRange {
4307
5177
  /**
4308
5178
  * @internal
4309
5179
  */
4310
- const filterSensitiveLog: (obj: SuggestionTextWithHighlights) => any;
5180
+ const filterSensitiveLog: (obj: TimeRange) => any;
4311
5181
  }
4312
- /**
4313
- * <p>The <code>SuggestionTextWithHighlights</code> structure information.</p>
4314
- */
4315
- export interface SuggestionValue {
5182
+ export interface GetSnapshotsResponse {
4316
5183
  /**
4317
- * <p>The <code>SuggestionTextWithHighlights</code> structure that contains
4318
- * the query suggestion text and highlights.</p>
5184
+ * <p>The date-time for the beginning and end of the time window
5185
+ * for the search metrics data.</p>
4319
5186
  */
4320
- Text?: SuggestionTextWithHighlights;
4321
- }
4322
- export declare namespace SuggestionValue {
5187
+ SnapShotTimeFilter?: TimeRange;
4323
5188
  /**
4324
- * @internal
5189
+ * <p>The column headers for the search metrics data.</p>
4325
5190
  */
4326
- const filterSensitiveLog: (obj: SuggestionValue) => any;
4327
- }
4328
- /**
4329
- * <p>A single query suggestion.</p>
4330
- */
4331
- export interface Suggestion {
5191
+ SnapshotsDataHeader?: string[];
4332
5192
  /**
4333
- * <p>The unique UUID (universally unique identifier) of a single
4334
- * query suggestion.</p>
5193
+ * <p>The search metrics data. The data returned depends on the
5194
+ * metric type you requested.</p>
4335
5195
  */
4336
- Id?: string;
5196
+ SnapshotsData?: string[][];
4337
5197
  /**
4338
- * <p>The value for the unique UUID (universally unique identifier)
4339
- * of a single query suggestion.</p>
4340
- * <p>The value is the text string of a suggestion.</p>
5198
+ * <p>If the response is truncated, Amazon Kendra returns this
5199
+ * token, which you can use in a later request to retrieve the
5200
+ * next set of search metrics data.</p>
4341
5201
  */
4342
- Value?: SuggestionValue;
5202
+ NextToken?: string;
4343
5203
  }
4344
- export declare namespace Suggestion {
5204
+ export declare namespace GetSnapshotsResponse {
4345
5205
  /**
4346
5206
  * @internal
4347
5207
  */
4348
- const filterSensitiveLog: (obj: Suggestion) => any;
5208
+ const filterSensitiveLog: (obj: GetSnapshotsResponse) => any;
4349
5209
  }
4350
- export interface GetQuerySuggestionsResponse {
4351
- /**
4352
- * <p>The unique identifier for a list of query suggestions for an index.</p>
4353
- */
4354
- QuerySuggestionsId?: string;
4355
- /**
4356
- * <p>A list of query suggestions for an index.</p>
4357
- */
4358
- Suggestions?: Suggestion[];
5210
+ /**
5211
+ * <p>The input to the request is not valid.</p>
5212
+ */
5213
+ export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
5214
+ name: "InvalidRequestException";
5215
+ $fault: "client";
5216
+ Message?: string;
4359
5217
  }
4360
- export declare namespace GetQuerySuggestionsResponse {
5218
+ export declare namespace InvalidRequestException {
4361
5219
  /**
4362
5220
  * @internal
4363
5221
  */
4364
- const filterSensitiveLog: (obj: GetQuerySuggestionsResponse) => any;
5222
+ const filterSensitiveLog: (obj: InvalidRequestException) => any;
4365
5223
  }
4366
5224
  export interface ListDataSourcesRequest {
4367
5225
  /**
@@ -4449,25 +5307,6 @@ export declare namespace ListDataSourcesResponse {
4449
5307
  */
4450
5308
  const filterSensitiveLog: (obj: ListDataSourcesResponse) => any;
4451
5309
  }
4452
- /**
4453
- * <p>Provides a range of time.</p>
4454
- */
4455
- export interface TimeRange {
4456
- /**
4457
- * <p>The UNIX datetime of the beginning of the time range.</p>
4458
- */
4459
- StartTime?: Date;
4460
- /**
4461
- * <p>The UNIX datetime of the end of the time range.</p>
4462
- */
4463
- EndTime?: Date;
4464
- }
4465
- export declare namespace TimeRange {
4466
- /**
4467
- * @internal
4468
- */
4469
- const filterSensitiveLog: (obj: TimeRange) => any;
4470
- }
4471
5310
  export declare enum DataSourceSyncJobStatus {
4472
5311
  ABORTED = "ABORTED",
4473
5312
  FAILED = "FAILED",
@@ -4627,6 +5466,258 @@ export declare namespace ListDataSourceSyncJobsResponse {
4627
5466
  */
4628
5467
  const filterSensitiveLog: (obj: ListDataSourceSyncJobsResponse) => any;
4629
5468
  }
5469
+ export interface ListEntityPersonasRequest {
5470
+ /**
5471
+ * <p>The identifier of your Amazon Kendra experience.</p>
5472
+ */
5473
+ Id: string | undefined;
5474
+ /**
5475
+ * <p>The identifier of the index for your Amazon Kendra experience.</p>
5476
+ */
5477
+ IndexId: string | undefined;
5478
+ /**
5479
+ * <p>If the previous response was incomplete (because there is more data to retrieve),
5480
+ * Amazon Kendra returns a pagination token in the response. You can use this pagination
5481
+ * token to retrieve the next set of users or groups.</p>
5482
+ */
5483
+ NextToken?: string;
5484
+ /**
5485
+ * <p>The maximum number of returned users or groups.</p>
5486
+ */
5487
+ MaxResults?: number;
5488
+ }
5489
+ export declare namespace ListEntityPersonasRequest {
5490
+ /**
5491
+ * @internal
5492
+ */
5493
+ const filterSensitiveLog: (obj: ListEntityPersonasRequest) => any;
5494
+ }
5495
+ /**
5496
+ * <p>Summary information for users or groups in your Amazon Web Services SSO identity
5497
+ * source. This applies to users and groups with specific permissions that define
5498
+ * their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience
5499
+ * such as a search application. For more information on creating a search application
5500
+ * experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
5501
+ * search experience with no code</a>.</p>
5502
+ */
5503
+ export interface PersonasSummary {
5504
+ /**
5505
+ * <p>The identifier of a user or group in your Amazon Web Services SSO identity source.
5506
+ * For example, a user ID could be an email.</p>
5507
+ */
5508
+ EntityId?: string;
5509
+ /**
5510
+ * <p>The persona that defines the specific permissions of the user or group in
5511
+ * your Amazon Web Services SSO identity source. The available personas or access
5512
+ * roles are <code>Owner</code> and <code>Viewer</code>. For more information on
5513
+ * these personas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience">Providing
5514
+ * access to your search page</a>.</p>
5515
+ */
5516
+ Persona?: Persona | string;
5517
+ /**
5518
+ * <p>The date-time the summary information was created.</p>
5519
+ */
5520
+ CreatedAt?: Date;
5521
+ /**
5522
+ * <p>The date-time the summary information was last updated.</p>
5523
+ */
5524
+ UpdatedAt?: Date;
5525
+ }
5526
+ export declare namespace PersonasSummary {
5527
+ /**
5528
+ * @internal
5529
+ */
5530
+ const filterSensitiveLog: (obj: PersonasSummary) => any;
5531
+ }
5532
+ export interface ListEntityPersonasResponse {
5533
+ /**
5534
+ * <p>An array of summary information for one or more users or groups.</p>
5535
+ */
5536
+ SummaryItems?: PersonasSummary[];
5537
+ /**
5538
+ * <p>If the response is truncated, Amazon Kendra returns this token, which you can use in
5539
+ * a later request to retrieve the next set of users or groups.</p>
5540
+ */
5541
+ NextToken?: string;
5542
+ }
5543
+ export declare namespace ListEntityPersonasResponse {
5544
+ /**
5545
+ * @internal
5546
+ */
5547
+ const filterSensitiveLog: (obj: ListEntityPersonasResponse) => any;
5548
+ }
5549
+ export interface ListExperienceEntitiesRequest {
5550
+ /**
5551
+ * <p>The identifier of your Amazon Kendra experience.</p>
5552
+ */
5553
+ Id: string | undefined;
5554
+ /**
5555
+ * <p>The identifier of the index for your Amazon Kendra experience.</p>
5556
+ */
5557
+ IndexId: string | undefined;
5558
+ /**
5559
+ * <p>If the previous response was incomplete (because there is more data to retrieve),
5560
+ * Amazon Kendra returns a pagination token in the response. You can use this pagination
5561
+ * token to retrieve the next set of users or groups.</p>
5562
+ */
5563
+ NextToken?: string;
5564
+ }
5565
+ export declare namespace ListExperienceEntitiesRequest {
5566
+ /**
5567
+ * @internal
5568
+ */
5569
+ const filterSensitiveLog: (obj: ListExperienceEntitiesRequest) => any;
5570
+ }
5571
+ /**
5572
+ * <p>Information about the user entity.</p>
5573
+ */
5574
+ export interface EntityDisplayData {
5575
+ /**
5576
+ * <p>The name of the user.</p>
5577
+ */
5578
+ UserName?: string;
5579
+ /**
5580
+ * <p>The name of the group.</p>
5581
+ */
5582
+ GroupName?: string;
5583
+ /**
5584
+ * <p>The user name of the user.</p>
5585
+ */
5586
+ IdentifiedUserName?: string;
5587
+ /**
5588
+ * <p>The first name of the user.</p>
5589
+ */
5590
+ FirstName?: string;
5591
+ /**
5592
+ * <p>The last name of the user.</p>
5593
+ */
5594
+ LastName?: string;
5595
+ }
5596
+ export declare namespace EntityDisplayData {
5597
+ /**
5598
+ * @internal
5599
+ */
5600
+ const filterSensitiveLog: (obj: EntityDisplayData) => any;
5601
+ }
5602
+ /**
5603
+ * <p>Summary information for users or groups in your Amazon Web Services SSO identity
5604
+ * source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra
5605
+ * experience such as a search application. For more information on creating a
5606
+ * search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
5607
+ * a search experience with no code</a>.</p>
5608
+ */
5609
+ export interface ExperienceEntitiesSummary {
5610
+ /**
5611
+ * <p>The identifier of a user or group in your Amazon Web Services SSO identity source.
5612
+ * For example, a user ID could be an email.</p>
5613
+ */
5614
+ EntityId?: string;
5615
+ /**
5616
+ * <p>Shows the type as <code>User</code> or <code>Group</code>.</p>
5617
+ */
5618
+ EntityType?: EntityType | string;
5619
+ /**
5620
+ * <p>Information about the user entity.</p>
5621
+ */
5622
+ DisplayData?: EntityDisplayData;
5623
+ }
5624
+ export declare namespace ExperienceEntitiesSummary {
5625
+ /**
5626
+ * @internal
5627
+ */
5628
+ const filterSensitiveLog: (obj: ExperienceEntitiesSummary) => any;
5629
+ }
5630
+ export interface ListExperienceEntitiesResponse {
5631
+ /**
5632
+ * <p>An array of summary information for one or more users or groups.</p>
5633
+ */
5634
+ SummaryItems?: ExperienceEntitiesSummary[];
5635
+ /**
5636
+ * <p>If the response is truncated, Amazon Kendra returns this token, which you can use in
5637
+ * a later request to retrieve the next set of users or groups.</p>
5638
+ */
5639
+ NextToken?: string;
5640
+ }
5641
+ export declare namespace ListExperienceEntitiesResponse {
5642
+ /**
5643
+ * @internal
5644
+ */
5645
+ const filterSensitiveLog: (obj: ListExperienceEntitiesResponse) => any;
5646
+ }
5647
+ export interface ListExperiencesRequest {
5648
+ /**
5649
+ * <p>The identifier of the index for your Amazon Kendra experience.</p>
5650
+ */
5651
+ IndexId: string | undefined;
5652
+ /**
5653
+ * <p>If the previous response was incomplete (because there is more data
5654
+ * to retrieve), Amazon Kendra returns a pagination token in the response. You can use this
5655
+ * pagination token to retrieve the next set of Amazon Kendra experiences.</p>
5656
+ */
5657
+ NextToken?: string;
5658
+ /**
5659
+ * <p>The maximum number of returned Amazon Kendra experiences.</p>
5660
+ */
5661
+ MaxResults?: number;
5662
+ }
5663
+ export declare namespace ListExperiencesRequest {
5664
+ /**
5665
+ * @internal
5666
+ */
5667
+ const filterSensitiveLog: (obj: ListExperiencesRequest) => any;
5668
+ }
5669
+ /**
5670
+ * <p>Summary information for your Amazon Kendra experience. You can create an Amazon Kendra
5671
+ * experience such as a search application. For more information on creating
5672
+ * a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
5673
+ * a search experience with no code</a>.</p>
5674
+ */
5675
+ export interface ExperiencesSummary {
5676
+ /**
5677
+ * <p>The name of your Amazon Kendra experience.</p>
5678
+ */
5679
+ Name?: string;
5680
+ /**
5681
+ * <p>The identifier of your Amazon Kendra experience.</p>
5682
+ */
5683
+ Id?: string;
5684
+ /**
5685
+ * <p>The date-time your Amazon Kendra experience was created.</p>
5686
+ */
5687
+ CreatedAt?: Date;
5688
+ /**
5689
+ * <p>The processing status of your Amazon Kendra experience.</p>
5690
+ */
5691
+ Status?: ExperienceStatus | string;
5692
+ /**
5693
+ * <p>The endpoint URLs for your Amazon Kendra experiences. The URLs are unique
5694
+ * and fully hosted by Amazon Web Services.</p>
5695
+ */
5696
+ Endpoints?: ExperienceEndpoint[];
5697
+ }
5698
+ export declare namespace ExperiencesSummary {
5699
+ /**
5700
+ * @internal
5701
+ */
5702
+ const filterSensitiveLog: (obj: ExperiencesSummary) => any;
5703
+ }
5704
+ export interface ListExperiencesResponse {
5705
+ /**
5706
+ * <p>An array of summary information for one or more Amazon Kendra experiences.</p>
5707
+ */
5708
+ SummaryItems?: ExperiencesSummary[];
5709
+ /**
5710
+ * <p>If the response is truncated, Amazon Kendra returns this token, which you can use
5711
+ * in a later request to retrieve the next set of Amazon Kendra experiences.</p>
5712
+ */
5713
+ NextToken?: string;
5714
+ }
5715
+ export declare namespace ListExperiencesResponse {
5716
+ /**
5717
+ * @internal
5718
+ */
5719
+ const filterSensitiveLog: (obj: ListExperiencesResponse) => any;
5720
+ }
4630
5721
  export interface ListFaqsRequest {
4631
5722
  /**
4632
5723
  * <p>The index that contains the FAQ lists.</p>
@@ -5775,7 +6866,7 @@ export interface UpdateDataSourceRequest {
5775
6866
  */
5776
6867
  IndexId: string | undefined;
5777
6868
  /**
5778
- * <p>Configuration information for a Amazon Kendra data source.</p>
6869
+ * <p>Configuration information for an Amazon Kendra data source.</p>
5779
6870
  */
5780
6871
  Configuration?: DataSourceConfiguration;
5781
6872
  /**
@@ -5799,6 +6890,15 @@ export interface UpdateDataSourceRequest {
5799
6890
  * documents in languages other than English</a>.</p>
5800
6891
  */
5801
6892
  LanguageCode?: string;
6893
+ /**
6894
+ * <p>Configuration information for altering document metadata and content during the
6895
+ * document ingestion process when you update a data source.</p>
6896
+ * <p>For more information on how to create, modify and delete document metadata, or make
6897
+ * other content alterations when you ingest documents into Amazon Kendra, see
6898
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
6899
+ * document metadata during the ingestion process</a>.</p>
6900
+ */
6901
+ CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
5802
6902
  }
5803
6903
  export declare namespace UpdateDataSourceRequest {
5804
6904
  /**
@@ -5806,6 +6906,42 @@ export declare namespace UpdateDataSourceRequest {
5806
6906
  */
5807
6907
  const filterSensitiveLog: (obj: UpdateDataSourceRequest) => any;
5808
6908
  }
6909
+ export interface UpdateExperienceRequest {
6910
+ /**
6911
+ * <p>The identifier of your Amazon Kendra experience you want to update.</p>
6912
+ */
6913
+ Id: string | undefined;
6914
+ /**
6915
+ * <p>The name of your Amazon Kendra experience you want to update.</p>
6916
+ */
6917
+ Name?: string;
6918
+ /**
6919
+ * <p>The identifier of the index for your Amazon Kendra experience you want to update.</p>
6920
+ */
6921
+ IndexId: string | undefined;
6922
+ /**
6923
+ * <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
6924
+ * operations, <code>QuerySuggestions</code> operations, <code>SubmitFeedback</code>
6925
+ * operations, and Amazon Web Services SSO that stores your user and group information.
6926
+ * For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
6927
+ */
6928
+ RoleArn?: string;
6929
+ /**
6930
+ * <p>Provides the user configuration information. This includes the Amazon Web Services SSO
6931
+ * field name that contains the identifiers of your users, such as their emails.</p>
6932
+ */
6933
+ Configuration?: ExperienceConfiguration;
6934
+ /**
6935
+ * <p>The description of your Amazon Kendra experience you want to update.</p>
6936
+ */
6937
+ Description?: string;
6938
+ }
6939
+ export declare namespace UpdateExperienceRequest {
6940
+ /**
6941
+ * @internal
6942
+ */
6943
+ const filterSensitiveLog: (obj: UpdateExperienceRequest) => any;
6944
+ }
5809
6945
  export interface UpdateIndexRequest {
5810
6946
  /**
5811
6947
  * <p>The identifier of the index to update.</p>
@@ -5846,7 +6982,7 @@ export interface UpdateIndexRequest {
5846
6982
  */
5847
6983
  UserContextPolicy?: UserContextPolicy | string;
5848
6984
  /**
5849
- * <p>Enables fetching access levels of groups and users from an AWS Single Sign-On
6985
+ * <p>Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On
5850
6986
  * identity source. To configure this, see
5851
6987
  * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>.</p>
5852
6988
  */
@@ -6009,7 +7145,7 @@ export declare namespace UpdateThesaurusRequest {
6009
7145
  * </li>
6010
7146
  * <li>
6011
7147
  * <p>
6012
- * <code> <EqualTo></code>
7148
+ * <code> <EqualsTo></code>
6013
7149
  * </p>
6014
7150
  * </li>
6015
7151
  * </ol>