@aws-sdk/client-kendra 3.321.1 → 3.326.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 (77) hide show
  1. package/dist-cjs/models/models_0.js +10 -5
  2. package/dist-cjs/models/models_1.js +4 -1
  3. package/dist-cjs/protocols/Aws_json1_1.js +56 -2
  4. package/dist-es/models/models_0.js +8 -3
  5. package/dist-es/models/models_1.js +3 -0
  6. package/dist-es/protocols/Aws_json1_1.js +56 -2
  7. package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +11 -0
  8. package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +11 -0
  9. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +12 -0
  10. package/dist-types/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +12 -0
  11. package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +20 -0
  12. package/dist-types/commands/BatchPutDocumentCommand.d.ts +12 -0
  13. package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +4 -0
  14. package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +6 -0
  15. package/dist-types/commands/CreateDataSourceCommand.d.ts +6 -0
  16. package/dist-types/commands/CreateExperienceCommand.d.ts +6 -0
  17. package/dist-types/commands/CreateFaqCommand.d.ts +6 -0
  18. package/dist-types/commands/CreateFeaturedResultsSetCommand.d.ts +21 -0
  19. package/dist-types/commands/CreateIndexCommand.d.ts +6 -0
  20. package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +7 -1
  21. package/dist-types/commands/CreateThesaurusCommand.d.ts +6 -0
  22. package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteDataSourceCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteExperienceCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteFaqCommand.d.ts +4 -0
  26. package/dist-types/commands/DeleteIndexCommand.d.ts +4 -0
  27. package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +4 -0
  28. package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +4 -0
  29. package/dist-types/commands/DeleteThesaurusCommand.d.ts +4 -0
  30. package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +28 -0
  31. package/dist-types/commands/DescribeDataSourceCommand.d.ts +570 -0
  32. package/dist-types/commands/DescribeExperienceCommand.d.ts +34 -0
  33. package/dist-types/commands/DescribeFaqCommand.d.ts +20 -0
  34. package/dist-types/commands/DescribeFeaturedResultsSetCommand.d.ts +26 -0
  35. package/dist-types/commands/DescribeIndexCommand.d.ts +72 -0
  36. package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +17 -0
  37. package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +20 -0
  38. package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +14 -0
  39. package/dist-types/commands/DescribeThesaurusCommand.d.ts +21 -0
  40. package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +11 -0
  41. package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +11 -0
  42. package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +129 -1
  43. package/dist-types/commands/GetSnapshotsCommand.d.ts +18 -0
  44. package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +11 -0
  45. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +24 -0
  46. package/dist-types/commands/ListDataSourcesCommand.d.ts +17 -0
  47. package/dist-types/commands/ListEntityPersonasCommand.d.ts +14 -0
  48. package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +19 -0
  49. package/dist-types/commands/ListExperiencesCommand.d.ts +20 -0
  50. package/dist-types/commands/ListFaqsCommand.d.ts +17 -0
  51. package/dist-types/commands/ListFeaturedResultsSetsCommand.d.ts +15 -0
  52. package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +12 -0
  53. package/dist-types/commands/ListIndicesCommand.d.ts +16 -0
  54. package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  56. package/dist-types/commands/ListThesauriCommand.d.ts +15 -0
  57. package/dist-types/commands/PutPrincipalMappingCommand.d.ts +4 -0
  58. package/dist-types/commands/QueryCommand.d.ts +200 -0
  59. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +6 -0
  60. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +4 -0
  61. package/dist-types/commands/SubmitFeedbackCommand.d.ts +4 -0
  62. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  63. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  64. package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +4 -0
  65. package/dist-types/commands/UpdateDataSourceCommand.d.ts +4 -0
  66. package/dist-types/commands/UpdateExperienceCommand.d.ts +4 -0
  67. package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +21 -0
  68. package/dist-types/commands/UpdateIndexCommand.d.ts +4 -0
  69. package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +4 -0
  70. package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +14 -1
  71. package/dist-types/commands/UpdateThesaurusCommand.d.ts +4 -0
  72. package/dist-types/models/models_0.d.ts +173 -210
  73. package/dist-types/models/models_1.d.ts +213 -2
  74. package/dist-types/ts3.4/commands/GetQuerySuggestionsCommand.d.ts +2 -4
  75. package/dist-types/ts3.4/models/models_0.d.ts +40 -46
  76. package/dist-types/ts3.4/models/models_1.d.ts +53 -3
  77. package/package.json +16 -16
@@ -32,6 +32,574 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
32
32
  * };
33
33
  * const command = new DescribeDataSourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeDataSourceResponse
36
+ * // Id: "STRING_VALUE",
37
+ * // IndexId: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // Type: "S3" || "SHAREPOINT" || "DATABASE" || "SALESFORCE" || "ONEDRIVE" || "SERVICENOW" || "CUSTOM" || "CONFLUENCE" || "GOOGLEDRIVE" || "WEBCRAWLER" || "WORKDOCS" || "FSX" || "SLACK" || "BOX" || "QUIP" || "JIRA" || "GITHUB" || "ALFRESCO" || "TEMPLATE",
40
+ * // Configuration: { // DataSourceConfiguration
41
+ * // S3Configuration: { // S3DataSourceConfiguration
42
+ * // BucketName: "STRING_VALUE", // required
43
+ * // InclusionPrefixes: [ // DataSourceInclusionsExclusionsStrings
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // InclusionPatterns: [
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // ExclusionPatterns: [
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // DocumentsMetadataConfiguration: { // DocumentsMetadataConfiguration
53
+ * // S3Prefix: "STRING_VALUE",
54
+ * // },
55
+ * // AccessControlListConfiguration: { // AccessControlListConfiguration
56
+ * // KeyPath: "STRING_VALUE",
57
+ * // },
58
+ * // },
59
+ * // SharePointConfiguration: { // SharePointConfiguration
60
+ * // SharePointVersion: "SHAREPOINT_2013" || "SHAREPOINT_2016" || "SHAREPOINT_ONLINE" || "SHAREPOINT_2019", // required
61
+ * // Urls: [ // SharePointUrlList // required
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // SecretArn: "STRING_VALUE", // required
65
+ * // CrawlAttachments: true || false,
66
+ * // UseChangeLog: true || false,
67
+ * // InclusionPatterns: [
68
+ * // "STRING_VALUE",
69
+ * // ],
70
+ * // ExclusionPatterns: [
71
+ * // "STRING_VALUE",
72
+ * // ],
73
+ * // VpcConfiguration: { // DataSourceVpcConfiguration
74
+ * // SubnetIds: [ // SubnetIdList // required
75
+ * // "STRING_VALUE",
76
+ * // ],
77
+ * // SecurityGroupIds: [ // SecurityGroupIdList // required
78
+ * // "STRING_VALUE",
79
+ * // ],
80
+ * // },
81
+ * // FieldMappings: [ // DataSourceToIndexFieldMappingList
82
+ * // { // DataSourceToIndexFieldMapping
83
+ * // DataSourceFieldName: "STRING_VALUE", // required
84
+ * // DateFieldFormat: "STRING_VALUE",
85
+ * // IndexFieldName: "STRING_VALUE", // required
86
+ * // },
87
+ * // ],
88
+ * // DocumentTitleFieldName: "STRING_VALUE",
89
+ * // DisableLocalGroups: true || false,
90
+ * // SslCertificateS3Path: { // S3Path
91
+ * // Bucket: "STRING_VALUE", // required
92
+ * // Key: "STRING_VALUE", // required
93
+ * // },
94
+ * // AuthenticationType: "HTTP_BASIC" || "OAUTH2",
95
+ * // ProxyConfiguration: { // ProxyConfiguration
96
+ * // Host: "STRING_VALUE", // required
97
+ * // Port: Number("int"), // required
98
+ * // Credentials: "STRING_VALUE",
99
+ * // },
100
+ * // },
101
+ * // DatabaseConfiguration: { // DatabaseConfiguration
102
+ * // DatabaseEngineType: "RDS_AURORA_MYSQL" || "RDS_AURORA_POSTGRESQL" || "RDS_MYSQL" || "RDS_POSTGRESQL", // required
103
+ * // ConnectionConfiguration: { // ConnectionConfiguration
104
+ * // DatabaseHost: "STRING_VALUE", // required
105
+ * // DatabasePort: Number("int"), // required
106
+ * // DatabaseName: "STRING_VALUE", // required
107
+ * // TableName: "STRING_VALUE", // required
108
+ * // SecretArn: "STRING_VALUE", // required
109
+ * // },
110
+ * // VpcConfiguration: {
111
+ * // SubnetIds: [ // required
112
+ * // "STRING_VALUE",
113
+ * // ],
114
+ * // SecurityGroupIds: [ // required
115
+ * // "STRING_VALUE",
116
+ * // ],
117
+ * // },
118
+ * // ColumnConfiguration: { // ColumnConfiguration
119
+ * // DocumentIdColumnName: "STRING_VALUE", // required
120
+ * // DocumentDataColumnName: "STRING_VALUE", // required
121
+ * // DocumentTitleColumnName: "STRING_VALUE",
122
+ * // FieldMappings: [
123
+ * // {
124
+ * // DataSourceFieldName: "STRING_VALUE", // required
125
+ * // DateFieldFormat: "STRING_VALUE",
126
+ * // IndexFieldName: "STRING_VALUE", // required
127
+ * // },
128
+ * // ],
129
+ * // ChangeDetectingColumns: [ // ChangeDetectingColumns // required
130
+ * // "STRING_VALUE",
131
+ * // ],
132
+ * // },
133
+ * // AclConfiguration: { // AclConfiguration
134
+ * // AllowedGroupsColumnName: "STRING_VALUE", // required
135
+ * // },
136
+ * // SqlConfiguration: { // SqlConfiguration
137
+ * // QueryIdentifiersEnclosingOption: "DOUBLE_QUOTES" || "NONE",
138
+ * // },
139
+ * // },
140
+ * // SalesforceConfiguration: { // SalesforceConfiguration
141
+ * // ServerUrl: "STRING_VALUE", // required
142
+ * // SecretArn: "STRING_VALUE", // required
143
+ * // StandardObjectConfigurations: [ // SalesforceStandardObjectConfigurationList
144
+ * // { // SalesforceStandardObjectConfiguration
145
+ * // Name: "ACCOUNT" || "CAMPAIGN" || "CASE" || "CONTACT" || "CONTRACT" || "DOCUMENT" || "GROUP" || "IDEA" || "LEAD" || "OPPORTUNITY" || "PARTNER" || "PRICEBOOK" || "PRODUCT" || "PROFILE" || "SOLUTION" || "TASK" || "USER", // required
146
+ * // DocumentDataFieldName: "STRING_VALUE", // required
147
+ * // DocumentTitleFieldName: "STRING_VALUE",
148
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
149
+ * // },
150
+ * // ],
151
+ * // KnowledgeArticleConfiguration: { // SalesforceKnowledgeArticleConfiguration
152
+ * // IncludedStates: [ // SalesforceKnowledgeArticleStateList // required
153
+ * // "DRAFT" || "PUBLISHED" || "ARCHIVED",
154
+ * // ],
155
+ * // StandardKnowledgeArticleTypeConfiguration: { // SalesforceStandardKnowledgeArticleTypeConfiguration
156
+ * // DocumentDataFieldName: "STRING_VALUE", // required
157
+ * // DocumentTitleFieldName: "STRING_VALUE",
158
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
159
+ * // },
160
+ * // CustomKnowledgeArticleTypeConfigurations: [ // SalesforceCustomKnowledgeArticleTypeConfigurationList
161
+ * // { // SalesforceCustomKnowledgeArticleTypeConfiguration
162
+ * // Name: "STRING_VALUE", // required
163
+ * // DocumentDataFieldName: "STRING_VALUE", // required
164
+ * // DocumentTitleFieldName: "STRING_VALUE",
165
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
166
+ * // },
167
+ * // ],
168
+ * // },
169
+ * // ChatterFeedConfiguration: { // SalesforceChatterFeedConfiguration
170
+ * // DocumentDataFieldName: "STRING_VALUE", // required
171
+ * // DocumentTitleFieldName: "STRING_VALUE",
172
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
173
+ * // IncludeFilterTypes: [ // SalesforceChatterFeedIncludeFilterTypes
174
+ * // "ACTIVE_USER" || "STANDARD_USER",
175
+ * // ],
176
+ * // },
177
+ * // CrawlAttachments: true || false,
178
+ * // StandardObjectAttachmentConfiguration: { // SalesforceStandardObjectAttachmentConfiguration
179
+ * // DocumentTitleFieldName: "STRING_VALUE",
180
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
181
+ * // },
182
+ * // IncludeAttachmentFilePatterns: "<DataSourceInclusionsExclusionsStrings>",
183
+ * // ExcludeAttachmentFilePatterns: "<DataSourceInclusionsExclusionsStrings>",
184
+ * // },
185
+ * // OneDriveConfiguration: { // OneDriveConfiguration
186
+ * // TenantDomain: "STRING_VALUE", // required
187
+ * // SecretArn: "STRING_VALUE", // required
188
+ * // OneDriveUsers: { // OneDriveUsers
189
+ * // OneDriveUserList: [ // OneDriveUserList
190
+ * // "STRING_VALUE",
191
+ * // ],
192
+ * // OneDriveUserS3Path: {
193
+ * // Bucket: "STRING_VALUE", // required
194
+ * // Key: "STRING_VALUE", // required
195
+ * // },
196
+ * // },
197
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
198
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
199
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
200
+ * // DisableLocalGroups: true || false,
201
+ * // },
202
+ * // ServiceNowConfiguration: { // ServiceNowConfiguration
203
+ * // HostUrl: "STRING_VALUE", // required
204
+ * // SecretArn: "STRING_VALUE", // required
205
+ * // ServiceNowBuildVersion: "LONDON" || "OTHERS", // required
206
+ * // KnowledgeArticleConfiguration: { // ServiceNowKnowledgeArticleConfiguration
207
+ * // CrawlAttachments: true || false,
208
+ * // IncludeAttachmentFilePatterns: "<DataSourceInclusionsExclusionsStrings>",
209
+ * // ExcludeAttachmentFilePatterns: "<DataSourceInclusionsExclusionsStrings>",
210
+ * // DocumentDataFieldName: "STRING_VALUE", // required
211
+ * // DocumentTitleFieldName: "STRING_VALUE",
212
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
213
+ * // FilterQuery: "STRING_VALUE",
214
+ * // },
215
+ * // ServiceCatalogConfiguration: { // ServiceNowServiceCatalogConfiguration
216
+ * // CrawlAttachments: true || false,
217
+ * // IncludeAttachmentFilePatterns: "<DataSourceInclusionsExclusionsStrings>",
218
+ * // ExcludeAttachmentFilePatterns: "<DataSourceInclusionsExclusionsStrings>",
219
+ * // DocumentDataFieldName: "STRING_VALUE", // required
220
+ * // DocumentTitleFieldName: "STRING_VALUE",
221
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
222
+ * // },
223
+ * // AuthenticationType: "HTTP_BASIC" || "OAUTH2",
224
+ * // },
225
+ * // ConfluenceConfiguration: { // ConfluenceConfiguration
226
+ * // ServerUrl: "STRING_VALUE", // required
227
+ * // SecretArn: "STRING_VALUE", // required
228
+ * // Version: "CLOUD" || "SERVER", // required
229
+ * // SpaceConfiguration: { // ConfluenceSpaceConfiguration
230
+ * // CrawlPersonalSpaces: true || false,
231
+ * // CrawlArchivedSpaces: true || false,
232
+ * // IncludeSpaces: [ // ConfluenceSpaceList
233
+ * // "STRING_VALUE",
234
+ * // ],
235
+ * // ExcludeSpaces: [
236
+ * // "STRING_VALUE",
237
+ * // ],
238
+ * // SpaceFieldMappings: [ // ConfluenceSpaceFieldMappingsList
239
+ * // { // ConfluenceSpaceToIndexFieldMapping
240
+ * // DataSourceFieldName: "DISPLAY_URL" || "ITEM_TYPE" || "SPACE_KEY" || "URL",
241
+ * // DateFieldFormat: "STRING_VALUE",
242
+ * // IndexFieldName: "STRING_VALUE",
243
+ * // },
244
+ * // ],
245
+ * // },
246
+ * // PageConfiguration: { // ConfluencePageConfiguration
247
+ * // PageFieldMappings: [ // ConfluencePageFieldMappingsList
248
+ * // { // ConfluencePageToIndexFieldMapping
249
+ * // DataSourceFieldName: "AUTHOR" || "CONTENT_STATUS" || "CREATED_DATE" || "DISPLAY_URL" || "ITEM_TYPE" || "LABELS" || "MODIFIED_DATE" || "PARENT_ID" || "SPACE_KEY" || "SPACE_NAME" || "URL" || "VERSION",
250
+ * // DateFieldFormat: "STRING_VALUE",
251
+ * // IndexFieldName: "STRING_VALUE",
252
+ * // },
253
+ * // ],
254
+ * // },
255
+ * // BlogConfiguration: { // ConfluenceBlogConfiguration
256
+ * // BlogFieldMappings: [ // ConfluenceBlogFieldMappingsList
257
+ * // { // ConfluenceBlogToIndexFieldMapping
258
+ * // DataSourceFieldName: "AUTHOR" || "DISPLAY_URL" || "ITEM_TYPE" || "LABELS" || "PUBLISH_DATE" || "SPACE_KEY" || "SPACE_NAME" || "URL" || "VERSION",
259
+ * // DateFieldFormat: "STRING_VALUE",
260
+ * // IndexFieldName: "STRING_VALUE",
261
+ * // },
262
+ * // ],
263
+ * // },
264
+ * // AttachmentConfiguration: { // ConfluenceAttachmentConfiguration
265
+ * // CrawlAttachments: true || false,
266
+ * // AttachmentFieldMappings: [ // ConfluenceAttachmentFieldMappingsList
267
+ * // { // ConfluenceAttachmentToIndexFieldMapping
268
+ * // DataSourceFieldName: "AUTHOR" || "CONTENT_TYPE" || "CREATED_DATE" || "DISPLAY_URL" || "FILE_SIZE" || "ITEM_TYPE" || "PARENT_ID" || "SPACE_KEY" || "SPACE_NAME" || "URL" || "VERSION",
269
+ * // DateFieldFormat: "STRING_VALUE",
270
+ * // IndexFieldName: "STRING_VALUE",
271
+ * // },
272
+ * // ],
273
+ * // },
274
+ * // VpcConfiguration: {
275
+ * // SubnetIds: [ // required
276
+ * // "STRING_VALUE",
277
+ * // ],
278
+ * // SecurityGroupIds: [ // required
279
+ * // "STRING_VALUE",
280
+ * // ],
281
+ * // },
282
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
283
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
284
+ * // ProxyConfiguration: {
285
+ * // Host: "STRING_VALUE", // required
286
+ * // Port: Number("int"), // required
287
+ * // Credentials: "STRING_VALUE",
288
+ * // },
289
+ * // AuthenticationType: "HTTP_BASIC" || "PAT",
290
+ * // },
291
+ * // GoogleDriveConfiguration: { // GoogleDriveConfiguration
292
+ * // SecretArn: "STRING_VALUE", // required
293
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
294
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
295
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
296
+ * // ExcludeMimeTypes: [ // ExcludeMimeTypesList
297
+ * // "STRING_VALUE",
298
+ * // ],
299
+ * // ExcludeUserAccounts: [ // ExcludeUserAccountsList
300
+ * // "STRING_VALUE",
301
+ * // ],
302
+ * // ExcludeSharedDrives: [ // ExcludeSharedDrivesList
303
+ * // "STRING_VALUE",
304
+ * // ],
305
+ * // },
306
+ * // WebCrawlerConfiguration: { // WebCrawlerConfiguration
307
+ * // Urls: { // Urls
308
+ * // SeedUrlConfiguration: { // SeedUrlConfiguration
309
+ * // SeedUrls: [ // SeedUrlList // required
310
+ * // "STRING_VALUE",
311
+ * // ],
312
+ * // WebCrawlerMode: "HOST_ONLY" || "SUBDOMAINS" || "EVERYTHING",
313
+ * // },
314
+ * // SiteMapsConfiguration: { // SiteMapsConfiguration
315
+ * // SiteMaps: [ // SiteMapsList // required
316
+ * // "STRING_VALUE",
317
+ * // ],
318
+ * // },
319
+ * // },
320
+ * // CrawlDepth: Number("int"),
321
+ * // MaxLinksPerPage: Number("int"),
322
+ * // MaxContentSizePerPageInMegaBytes: Number("float"),
323
+ * // MaxUrlsPerMinuteCrawlRate: Number("int"),
324
+ * // UrlInclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
325
+ * // UrlExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
326
+ * // ProxyConfiguration: {
327
+ * // Host: "STRING_VALUE", // required
328
+ * // Port: Number("int"), // required
329
+ * // Credentials: "STRING_VALUE",
330
+ * // },
331
+ * // AuthenticationConfiguration: { // AuthenticationConfiguration
332
+ * // BasicAuthentication: [ // BasicAuthenticationConfigurationList
333
+ * // { // BasicAuthenticationConfiguration
334
+ * // Host: "STRING_VALUE", // required
335
+ * // Port: Number("int"), // required
336
+ * // Credentials: "STRING_VALUE", // required
337
+ * // },
338
+ * // ],
339
+ * // },
340
+ * // },
341
+ * // WorkDocsConfiguration: { // WorkDocsConfiguration
342
+ * // OrganizationId: "STRING_VALUE", // required
343
+ * // CrawlComments: true || false,
344
+ * // UseChangeLog: true || false,
345
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
346
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
347
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
348
+ * // },
349
+ * // FsxConfiguration: { // FsxConfiguration
350
+ * // FileSystemId: "STRING_VALUE", // required
351
+ * // FileSystemType: "WINDOWS", // required
352
+ * // VpcConfiguration: {
353
+ * // SubnetIds: [ // required
354
+ * // "STRING_VALUE",
355
+ * // ],
356
+ * // SecurityGroupIds: [ // required
357
+ * // "STRING_VALUE",
358
+ * // ],
359
+ * // },
360
+ * // SecretArn: "STRING_VALUE",
361
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
362
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
363
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
364
+ * // },
365
+ * // SlackConfiguration: { // SlackConfiguration
366
+ * // TeamId: "STRING_VALUE", // required
367
+ * // SecretArn: "STRING_VALUE", // required
368
+ * // VpcConfiguration: {
369
+ * // SubnetIds: [ // required
370
+ * // "STRING_VALUE",
371
+ * // ],
372
+ * // SecurityGroupIds: [ // required
373
+ * // "STRING_VALUE",
374
+ * // ],
375
+ * // },
376
+ * // SlackEntityList: [ // SlackEntityList // required
377
+ * // "PUBLIC_CHANNEL" || "PRIVATE_CHANNEL" || "GROUP_MESSAGE" || "DIRECT_MESSAGE",
378
+ * // ],
379
+ * // UseChangeLog: true || false,
380
+ * // CrawlBotMessage: true || false,
381
+ * // ExcludeArchived: true || false,
382
+ * // SinceCrawlDate: "STRING_VALUE", // required
383
+ * // LookBackPeriod: Number("int"),
384
+ * // PrivateChannelFilter: [ // PrivateChannelFilter
385
+ * // "STRING_VALUE",
386
+ * // ],
387
+ * // PublicChannelFilter: [ // PublicChannelFilter
388
+ * // "STRING_VALUE",
389
+ * // ],
390
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
391
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
392
+ * // FieldMappings: "<DataSourceToIndexFieldMappingList>",
393
+ * // },
394
+ * // BoxConfiguration: { // BoxConfiguration
395
+ * // EnterpriseId: "STRING_VALUE", // required
396
+ * // SecretArn: "STRING_VALUE", // required
397
+ * // UseChangeLog: true || false,
398
+ * // CrawlComments: true || false,
399
+ * // CrawlTasks: true || false,
400
+ * // CrawlWebLinks: true || false,
401
+ * // FileFieldMappings: "<DataSourceToIndexFieldMappingList>",
402
+ * // TaskFieldMappings: "<DataSourceToIndexFieldMappingList>",
403
+ * // CommentFieldMappings: "<DataSourceToIndexFieldMappingList>",
404
+ * // WebLinkFieldMappings: "<DataSourceToIndexFieldMappingList>",
405
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
406
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
407
+ * // VpcConfiguration: "<DataSourceVpcConfiguration>",
408
+ * // },
409
+ * // QuipConfiguration: { // QuipConfiguration
410
+ * // Domain: "STRING_VALUE", // required
411
+ * // SecretArn: "STRING_VALUE", // required
412
+ * // CrawlFileComments: true || false,
413
+ * // CrawlChatRooms: true || false,
414
+ * // CrawlAttachments: true || false,
415
+ * // FolderIds: [ // FolderIdList
416
+ * // "STRING_VALUE",
417
+ * // ],
418
+ * // ThreadFieldMappings: "<DataSourceToIndexFieldMappingList>",
419
+ * // MessageFieldMappings: "<DataSourceToIndexFieldMappingList>",
420
+ * // AttachmentFieldMappings: "<DataSourceToIndexFieldMappingList>",
421
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
422
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
423
+ * // VpcConfiguration: "<DataSourceVpcConfiguration>",
424
+ * // },
425
+ * // JiraConfiguration: { // JiraConfiguration
426
+ * // JiraAccountUrl: "STRING_VALUE", // required
427
+ * // SecretArn: "STRING_VALUE", // required
428
+ * // UseChangeLog: true || false,
429
+ * // Project: [ // Project
430
+ * // "STRING_VALUE",
431
+ * // ],
432
+ * // IssueType: [ // IssueType
433
+ * // "STRING_VALUE",
434
+ * // ],
435
+ * // Status: [ // JiraStatus
436
+ * // "STRING_VALUE",
437
+ * // ],
438
+ * // IssueSubEntityFilter: [ // IssueSubEntityFilter
439
+ * // "COMMENTS" || "ATTACHMENTS" || "WORKLOGS",
440
+ * // ],
441
+ * // AttachmentFieldMappings: "<DataSourceToIndexFieldMappingList>",
442
+ * // CommentFieldMappings: "<DataSourceToIndexFieldMappingList>",
443
+ * // IssueFieldMappings: "<DataSourceToIndexFieldMappingList>",
444
+ * // ProjectFieldMappings: "<DataSourceToIndexFieldMappingList>",
445
+ * // WorkLogFieldMappings: "<DataSourceToIndexFieldMappingList>",
446
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
447
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
448
+ * // VpcConfiguration: "<DataSourceVpcConfiguration>",
449
+ * // },
450
+ * // GitHubConfiguration: { // GitHubConfiguration
451
+ * // SaaSConfiguration: { // SaaSConfiguration
452
+ * // OrganizationName: "STRING_VALUE", // required
453
+ * // HostUrl: "STRING_VALUE", // required
454
+ * // },
455
+ * // OnPremiseConfiguration: { // OnPremiseConfiguration
456
+ * // HostUrl: "STRING_VALUE", // required
457
+ * // OrganizationName: "STRING_VALUE", // required
458
+ * // SslCertificateS3Path: {
459
+ * // Bucket: "STRING_VALUE", // required
460
+ * // Key: "STRING_VALUE", // required
461
+ * // },
462
+ * // },
463
+ * // Type: "SAAS" || "ON_PREMISE",
464
+ * // SecretArn: "STRING_VALUE", // required
465
+ * // UseChangeLog: true || false,
466
+ * // GitHubDocumentCrawlProperties: { // GitHubDocumentCrawlProperties
467
+ * // CrawlRepositoryDocuments: true || false,
468
+ * // CrawlIssue: true || false,
469
+ * // CrawlIssueComment: true || false,
470
+ * // CrawlIssueCommentAttachment: true || false,
471
+ * // CrawlPullRequest: true || false,
472
+ * // CrawlPullRequestComment: true || false,
473
+ * // CrawlPullRequestCommentAttachment: true || false,
474
+ * // },
475
+ * // RepositoryFilter: [ // RepositoryNames
476
+ * // "STRING_VALUE",
477
+ * // ],
478
+ * // InclusionFolderNamePatterns: [ // StringList
479
+ * // "STRING_VALUE",
480
+ * // ],
481
+ * // InclusionFileTypePatterns: [
482
+ * // "STRING_VALUE",
483
+ * // ],
484
+ * // InclusionFileNamePatterns: [
485
+ * // "STRING_VALUE",
486
+ * // ],
487
+ * // ExclusionFolderNamePatterns: [
488
+ * // "STRING_VALUE",
489
+ * // ],
490
+ * // ExclusionFileTypePatterns: [
491
+ * // "STRING_VALUE",
492
+ * // ],
493
+ * // ExclusionFileNamePatterns: "<StringList>",
494
+ * // VpcConfiguration: "<DataSourceVpcConfiguration>",
495
+ * // GitHubRepositoryConfigurationFieldMappings: "<DataSourceToIndexFieldMappingList>",
496
+ * // GitHubCommitConfigurationFieldMappings: "<DataSourceToIndexFieldMappingList>",
497
+ * // GitHubIssueDocumentConfigurationFieldMappings: "<DataSourceToIndexFieldMappingList>",
498
+ * // GitHubIssueCommentConfigurationFieldMappings: "<DataSourceToIndexFieldMappingList>",
499
+ * // GitHubIssueAttachmentConfigurationFieldMappings: "<DataSourceToIndexFieldMappingList>",
500
+ * // GitHubPullRequestCommentConfigurationFieldMappings: "<DataSourceToIndexFieldMappingList>",
501
+ * // GitHubPullRequestDocumentConfigurationFieldMappings: "<DataSourceToIndexFieldMappingList>",
502
+ * // GitHubPullRequestDocumentAttachmentConfigurationFieldMappings: "<DataSourceToIndexFieldMappingList>",
503
+ * // },
504
+ * // AlfrescoConfiguration: { // AlfrescoConfiguration
505
+ * // SiteUrl: "STRING_VALUE", // required
506
+ * // SiteId: "STRING_VALUE", // required
507
+ * // SecretArn: "STRING_VALUE", // required
508
+ * // SslCertificateS3Path: {
509
+ * // Bucket: "STRING_VALUE", // required
510
+ * // Key: "STRING_VALUE", // required
511
+ * // },
512
+ * // CrawlSystemFolders: true || false,
513
+ * // CrawlComments: true || false,
514
+ * // EntityFilter: [ // EntityFilter
515
+ * // "wiki" || "blog" || "documentLibrary",
516
+ * // ],
517
+ * // DocumentLibraryFieldMappings: "<DataSourceToIndexFieldMappingList>",
518
+ * // BlogFieldMappings: "<DataSourceToIndexFieldMappingList>",
519
+ * // WikiFieldMappings: "<DataSourceToIndexFieldMappingList>",
520
+ * // InclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
521
+ * // ExclusionPatterns: "<DataSourceInclusionsExclusionsStrings>",
522
+ * // VpcConfiguration: "<DataSourceVpcConfiguration>",
523
+ * // },
524
+ * // TemplateConfiguration: { // TemplateConfiguration
525
+ * // Template: "DOCUMENT_VALUE",
526
+ * // },
527
+ * // },
528
+ * // VpcConfiguration: "<DataSourceVpcConfiguration>",
529
+ * // CreatedAt: new Date("TIMESTAMP"),
530
+ * // UpdatedAt: new Date("TIMESTAMP"),
531
+ * // Description: "STRING_VALUE",
532
+ * // Status: "CREATING" || "DELETING" || "FAILED" || "UPDATING" || "ACTIVE",
533
+ * // Schedule: "STRING_VALUE",
534
+ * // RoleArn: "STRING_VALUE",
535
+ * // ErrorMessage: "STRING_VALUE",
536
+ * // LanguageCode: "STRING_VALUE",
537
+ * // CustomDocumentEnrichmentConfiguration: { // CustomDocumentEnrichmentConfiguration
538
+ * // InlineConfigurations: [ // InlineCustomDocumentEnrichmentConfigurationList
539
+ * // { // InlineCustomDocumentEnrichmentConfiguration
540
+ * // Condition: { // DocumentAttributeCondition
541
+ * // ConditionDocumentAttributeKey: "STRING_VALUE", // required
542
+ * // Operator: "GreaterThan" || "GreaterThanOrEquals" || "LessThan" || "LessThanOrEquals" || "Equals" || "NotEquals" || "Contains" || "NotContains" || "Exists" || "NotExists" || "BeginsWith", // required
543
+ * // ConditionOnValue: { // DocumentAttributeValue
544
+ * // StringValue: "STRING_VALUE",
545
+ * // StringListValue: [ // DocumentAttributeStringListValue
546
+ * // "STRING_VALUE",
547
+ * // ],
548
+ * // LongValue: Number("long"),
549
+ * // DateValue: new Date("TIMESTAMP"),
550
+ * // },
551
+ * // },
552
+ * // Target: { // DocumentAttributeTarget
553
+ * // TargetDocumentAttributeKey: "STRING_VALUE",
554
+ * // TargetDocumentAttributeValueDeletion: true || false,
555
+ * // TargetDocumentAttributeValue: {
556
+ * // StringValue: "STRING_VALUE",
557
+ * // StringListValue: [
558
+ * // "STRING_VALUE",
559
+ * // ],
560
+ * // LongValue: Number("long"),
561
+ * // DateValue: new Date("TIMESTAMP"),
562
+ * // },
563
+ * // },
564
+ * // DocumentContentDeletion: true || false,
565
+ * // },
566
+ * // ],
567
+ * // PreExtractionHookConfiguration: { // HookConfiguration
568
+ * // InvocationCondition: {
569
+ * // ConditionDocumentAttributeKey: "STRING_VALUE", // required
570
+ * // Operator: "GreaterThan" || "GreaterThanOrEquals" || "LessThan" || "LessThanOrEquals" || "Equals" || "NotEquals" || "Contains" || "NotContains" || "Exists" || "NotExists" || "BeginsWith", // required
571
+ * // ConditionOnValue: {
572
+ * // StringValue: "STRING_VALUE",
573
+ * // StringListValue: [
574
+ * // "STRING_VALUE",
575
+ * // ],
576
+ * // LongValue: Number("long"),
577
+ * // DateValue: new Date("TIMESTAMP"),
578
+ * // },
579
+ * // },
580
+ * // LambdaArn: "STRING_VALUE", // required
581
+ * // S3Bucket: "STRING_VALUE", // required
582
+ * // },
583
+ * // PostExtractionHookConfiguration: {
584
+ * // InvocationCondition: {
585
+ * // ConditionDocumentAttributeKey: "STRING_VALUE", // required
586
+ * // Operator: "GreaterThan" || "GreaterThanOrEquals" || "LessThan" || "LessThanOrEquals" || "Equals" || "NotEquals" || "Contains" || "NotContains" || "Exists" || "NotExists" || "BeginsWith", // required
587
+ * // ConditionOnValue: {
588
+ * // StringValue: "STRING_VALUE",
589
+ * // StringListValue: [
590
+ * // "STRING_VALUE",
591
+ * // ],
592
+ * // LongValue: Number("long"),
593
+ * // DateValue: new Date("TIMESTAMP"),
594
+ * // },
595
+ * // },
596
+ * // LambdaArn: "STRING_VALUE", // required
597
+ * // S3Bucket: "STRING_VALUE", // required
598
+ * // },
599
+ * // RoleArn: "STRING_VALUE",
600
+ * // },
601
+ * // };
602
+ *
35
603
  * ```
36
604
  *
37
605
  * @param DescribeDataSourceCommandInput - {@link DescribeDataSourceCommandInput}
@@ -60,6 +628,8 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
60
628
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
61
629
  * Please provide the correct input and try again.</p>
62
630
  *
631
+ * @throws {@link KendraServiceException}
632
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
63
633
  *
64
634
  */
65
635
  export declare class DescribeDataSourceCommand extends $Command<DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput, KendraClientResolvedConfig> {
@@ -35,6 +35,38 @@ export interface DescribeExperienceCommandOutput extends DescribeExperienceRespo
35
35
  * };
36
36
  * const command = new DescribeExperienceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeExperienceResponse
39
+ * // Id: "STRING_VALUE",
40
+ * // IndexId: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Endpoints: [ // ExperienceEndpoints
43
+ * // { // ExperienceEndpoint
44
+ * // EndpointType: "HOME",
45
+ * // Endpoint: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // Configuration: { // ExperienceConfiguration
49
+ * // ContentSourceConfiguration: { // ContentSourceConfiguration
50
+ * // DataSourceIds: [ // DataSourceIdList
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // FaqIds: [ // FaqIdsList
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // DirectPutContent: true || false,
57
+ * // },
58
+ * // UserIdentityConfiguration: { // UserIdentityConfiguration
59
+ * // IdentityAttributeName: "STRING_VALUE",
60
+ * // },
61
+ * // },
62
+ * // CreatedAt: new Date("TIMESTAMP"),
63
+ * // UpdatedAt: new Date("TIMESTAMP"),
64
+ * // Description: "STRING_VALUE",
65
+ * // Status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED",
66
+ * // RoleArn: "STRING_VALUE",
67
+ * // ErrorMessage: "STRING_VALUE",
68
+ * // };
69
+ *
38
70
  * ```
39
71
  *
40
72
  * @param DescribeExperienceCommandInput - {@link DescribeExperienceCommandInput}
@@ -63,6 +95,8 @@ export interface DescribeExperienceCommandOutput extends DescribeExperienceRespo
63
95
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
64
96
  * Please provide the correct input and try again.</p>
65
97
  *
98
+ * @throws {@link KendraServiceException}
99
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
66
100
  *
67
101
  */
68
102
  export declare class DescribeExperienceCommand extends $Command<DescribeExperienceCommandInput, DescribeExperienceCommandOutput, KendraClientResolvedConfig> {