@aws-sdk/client-kendra 3.535.0 → 3.549.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.
@@ -1,12 +1,14 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.defaultEndpointResolver = void 0;
4
- const util_endpoints_1 = require("@smithy/util-endpoints");
4
+ const util_endpoints_1 = require("@aws-sdk/util-endpoints");
5
+ const util_endpoints_2 = require("@smithy/util-endpoints");
5
6
  const ruleset_1 = require("./ruleset");
6
7
  const defaultEndpointResolver = (endpointParams, context = {}) => {
7
- return (0, util_endpoints_1.resolveEndpoint)(ruleset_1.ruleSet, {
8
+ return (0, util_endpoints_2.resolveEndpoint)(ruleset_1.ruleSet, {
8
9
  endpointParams: endpointParams,
9
10
  logger: context.logger,
10
11
  });
11
12
  };
12
13
  exports.defaultEndpointResolver = defaultEndpointResolver;
14
+ util_endpoints_2.customEndpointFunctions.aws = util_endpoints_1.awsEndpointFunctions;
package/dist-cjs/index.js CHANGED
@@ -4589,9 +4589,6 @@ var paginateListQuerySuggestionsBlockLists = (0, import_core.createPaginator)(Ke
4589
4589
  // src/pagination/ListThesauriPaginator.ts
4590
4590
 
4591
4591
  var paginateListThesauri = (0, import_core.createPaginator)(KendraClient, ListThesauriCommand, "NextToken", "NextToken", "MaxResults");
4592
-
4593
- // src/index.ts
4594
- var import_util_endpoints = require("@aws-sdk/util-endpoints");
4595
4592
  // Annotate the CommonJS export names for ESM import in node:
4596
4593
 
4597
4594
  0 && (module.exports = {
@@ -1,4 +1,5 @@
1
- import { resolveEndpoint } from "@smithy/util-endpoints";
1
+ import { awsEndpointFunctions } from "@aws-sdk/util-endpoints";
2
+ import { customEndpointFunctions, resolveEndpoint } from "@smithy/util-endpoints";
2
3
  import { ruleSet } from "./ruleset";
3
4
  export const defaultEndpointResolver = (endpointParams, context = {}) => {
4
5
  return resolveEndpoint(ruleSet, {
@@ -6,3 +7,4 @@ export const defaultEndpointResolver = (endpointParams, context = {}) => {
6
7
  logger: context.logger,
7
8
  });
8
9
  };
10
+ customEndpointFunctions.aws = awsEndpointFunctions;
package/dist-es/index.js CHANGED
@@ -3,5 +3,4 @@ export * from "./Kendra";
3
3
  export * from "./commands";
4
4
  export * from "./pagination";
5
5
  export * from "./models";
6
- import "@aws-sdk/util-endpoints";
7
6
  export { KendraServiceException } from "./models/KendraServiceException";
@@ -26,7 +26,7 @@ declare const DeleteIndexCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Deletes an existing Amazon Kendra index. An exception is not thrown if the index is
29
+ * <p>Deletes an Amazon Kendra index. An exception is not thrown if the index is
30
30
  * already being deleted. While the index is being deleted, the <code>Status</code> field
31
31
  * returned by a call to the <code>DescribeIndex</code> API is set to
32
32
  * <code>DELETING</code>.</p>
@@ -26,7 +26,7 @@ declare const DeleteThesaurusCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Deletes an existing Amazon Kendra thesaurus.
29
+ * <p>Deletes an Amazon Kendra thesaurus.
30
30
  * </p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -26,7 +26,7 @@ declare const DescribeIndexCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Gets information about an existing Amazon Kendra index.</p>
29
+ * <p>Gets information about an Amazon Kendra index.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -26,7 +26,7 @@ declare const DescribeThesaurusCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Gets information about an existing Amazon Kendra thesaurus.</p>
29
+ * <p>Gets information about an Amazon Kendra thesaurus.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -26,7 +26,7 @@ declare const UpdateDataSourceCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an existing Amazon Kendra data source connector.</p>
29
+ * <p>Updates an Amazon Kendra data source connector.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -26,7 +26,7 @@ declare const UpdateIndexCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an existing Amazon Kendra index.</p>
29
+ * <p>Updates an Amazon Kendra index.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -11,5 +11,4 @@ export { KendraExtensionConfiguration } from "./extensionConfiguration";
11
11
  export * from "./commands";
12
12
  export * from "./pagination";
13
13
  export * from "./models";
14
- import "@aws-sdk/util-endpoints";
15
14
  export { KendraServiceException } from "./models/KendraServiceException";
@@ -2376,6 +2376,16 @@ export type FsxFileSystemType = (typeof FsxFileSystemType)[keyof typeof FsxFileS
2376
2376
  /**
2377
2377
  * <p>Provides the configuration information to connect to Amazon FSx as your data
2378
2378
  * source.</p>
2379
+ * <note>
2380
+ * <p>Amazon Kendra now supports an upgraded Amazon FSx Windows connector.</p>
2381
+ * <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the
2382
+ * <code>FsxConfiguration</code> object to configure your connector.</p>
2383
+ * <p>Connectors configured using the older console and API architecture will continue to
2384
+ * function as configured. However, you won't be able to edit or update them. If you want
2385
+ * to edit or update your connector configuration, you must create a new connector.</p>
2386
+ * <p>We recommended migrating your connector workflow to the upgraded version. Support for
2387
+ * connectors configured using the older architecture is scheduled to end by June 2024.</p>
2388
+ * </note>
2379
2389
  * @public
2380
2390
  */
2381
2391
  export interface FsxConfiguration {
@@ -2508,7 +2518,7 @@ export interface OnPremiseConfiguration {
2508
2518
  */
2509
2519
  HostUrl: string | undefined;
2510
2520
  /**
2511
- * <p>The name of the organization of the GitHub Enterprise Server (in-premise) account you
2521
+ * <p>The name of the organization of the GitHub Enterprise Server (on-premises) account you
2512
2522
  * want to connect to. You can find your organization name by logging into GitHub desktop
2513
2523
  * and selecting <b>Your organizations</b> under your profile
2514
2524
  * picture dropdown.</p>
@@ -2560,6 +2570,18 @@ export type Type = (typeof Type)[keyof typeof Type];
2560
2570
  /**
2561
2571
  * <p>Provides the configuration information to connect to GitHub as your data
2562
2572
  * source.</p>
2573
+ * <note>
2574
+ * <p>Amazon Kendra now supports an upgraded GitHub connector.</p>
2575
+ * <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the
2576
+ * <code>GitHubConfiguration</code> object to configure your connector.</p>
2577
+ * <p>Connectors configured using the older console and API architecture will continue
2578
+ * to function as configured. However, you won’t be able to edit or update them. If you
2579
+ * want to edit or update your connector configuration, you must create a new
2580
+ * connector.</p>
2581
+ * <p>We recommended migrating your connector workflow to the upgraded version. Support
2582
+ * for connectors configured using the older architecture is scheduled to end by June
2583
+ * 2024.</p>
2584
+ * </note>
2563
2585
  * @public
2564
2586
  */
2565
2587
  export interface GitHubConfiguration {
@@ -3157,6 +3179,16 @@ export interface DocumentsMetadataConfiguration {
3157
3179
  /**
3158
3180
  * <p>Provides the configuration information to connect to an Amazon S3
3159
3181
  * bucket.</p>
3182
+ * <note>
3183
+ * <p>Amazon Kendra now supports an upgraded Amazon S3 connector.</p>
3184
+ * <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the
3185
+ * <code>S3DataSourceConfiguration</code> object to configure your connector.</p>
3186
+ * <p>Connectors configured using the older console and API architecture will continue to
3187
+ * function as configured. However, you won't be able to edit or update them. If you want
3188
+ * to edit or update your connector configuration, you must create a new connector.</p>
3189
+ * <p>We recommended migrating your connector workflow to the upgraded version. Support for
3190
+ * connectors configured using the older architecture is scheduled to end by June 2024.</p>
3191
+ * </note>
3160
3192
  * @public
3161
3193
  */
3162
3194
  export interface S3DataSourceConfiguration {
@@ -3171,55 +3203,104 @@ export interface S3DataSourceConfiguration {
3171
3203
  */
3172
3204
  InclusionPrefixes?: string[];
3173
3205
  /**
3174
- * <p>A list of glob patterns for documents that should be indexed. If a document that
3175
- * matches an inclusion pattern also matches an exclusion pattern, the document is not
3176
- * indexed.</p>
3177
- * <p>Some <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">examples</a>
3178
- * are:</p>
3206
+ * <p>A list of glob patterns (patterns that can expand a wildcard pattern into a list of
3207
+ * path names that match the given pattern) for certain file names and file types to include
3208
+ * in your index. If a document matches both an inclusion and exclusion prefix or pattern,
3209
+ * the exclusion prefix takes precendence and the document is not indexed. Examples of glob
3210
+ * patterns include:</p>
3179
3211
  * <ul>
3180
3212
  * <li>
3181
3213
  * <p>
3182
- * <i>*.txt</i> will include all text files in a directory (files
3183
- * with the extension .txt).</p>
3214
+ * <i>/myapp/config/*</i>—All files inside config directory.</p>
3215
+ * </li>
3216
+ * <li>
3217
+ * <p>
3218
+ * <i>**\/*.png</i>—All .png files in all directories.</p>
3219
+ * </li>
3220
+ * <li>
3221
+ * <p>
3222
+ * <i>**\/*.\{png, ico, md\}</i>—All .png, .ico or .md files in all
3223
+ * directories.</p>
3224
+ * </li>
3225
+ * <li>
3226
+ * <p>
3227
+ * <i>/myapp/src/**\/*.ts</i>—All .ts files inside src directory (and all
3228
+ * its subdirectories).</p>
3229
+ * </li>
3230
+ * <li>
3231
+ * <p>
3232
+ * <i>**\/!(*.module).ts</i>—All .ts files but not .module.ts</p>
3233
+ * </li>
3234
+ * <li>
3235
+ * <p>
3236
+ * <i>*.png , *.jpg</i>—All PNG and JPEG image files
3237
+ * in a directory (files with the extensions .png and .jpg).</p>
3184
3238
  * </li>
3185
3239
  * <li>
3186
3240
  * <p>
3187
- * <i>**\/*.txt</i> will include all text files in a directory and
3188
- * its subdirectories.</p>
3241
+ * <i>*internal*</i>—All files in a directory that
3242
+ * contain 'internal' in the file name, such as 'internal', 'internal_only',
3243
+ * 'company_internal'.</p>
3189
3244
  * </li>
3190
3245
  * <li>
3191
3246
  * <p>
3192
- * <i>*tax*</i> will include all files in a directory that contain
3193
- * 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.</p>
3247
+ * <i>**\/*internal*</i>—All internal-related files in
3248
+ * a directory and its subdirectories.</p>
3194
3249
  * </li>
3195
3250
  * </ul>
3251
+ * <p>For more examples, see <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">Use of Exclude and
3252
+ * Include Filters</a> in the Amazon Web Services CLI Command Reference.</p>
3196
3253
  * @public
3197
3254
  */
3198
3255
  InclusionPatterns?: string[];
3199
3256
  /**
3200
- * <p>A list of glob patterns for documents that should not be indexed. If a document that
3201
- * matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the
3202
- * document is not indexed.</p>
3203
- * <p>Some <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">examples</a>
3204
- * are:</p>
3257
+ * <p>A list of glob patterns (patterns that can expand a wildcard pattern into a list of
3258
+ * path names that match the given pattern) for certain file names and file types to exclude
3259
+ * from your index. If a document matches both an inclusion and exclusion prefix or pattern,
3260
+ * the exclusion prefix takes precendence and the document is not indexed. Examples of glob
3261
+ * patterns include:</p>
3205
3262
  * <ul>
3206
3263
  * <li>
3207
3264
  * <p>
3208
- * <i>*.png , *.jpg</i> will exclude all PNG and JPEG image files
3265
+ * <i>/myapp/config/*</i>—All files inside config directory.</p>
3266
+ * </li>
3267
+ * <li>
3268
+ * <p>
3269
+ * <i>**\/*.png</i>—All .png files in all directories.</p>
3270
+ * </li>
3271
+ * <li>
3272
+ * <p>
3273
+ * <i>**\/*.\{png, ico, md\}</i>—All .png, .ico or .md files in all
3274
+ * directories.</p>
3275
+ * </li>
3276
+ * <li>
3277
+ * <p>
3278
+ * <i>/myapp/src/**\/*.ts</i>—All .ts files inside src directory (and all
3279
+ * its subdirectories).</p>
3280
+ * </li>
3281
+ * <li>
3282
+ * <p>
3283
+ * <i>**\/!(*.module).ts</i>—All .ts files but not .module.ts</p>
3284
+ * </li>
3285
+ * <li>
3286
+ * <p>
3287
+ * <i>*.png , *.jpg</i>—All PNG and JPEG image files
3209
3288
  * in a directory (files with the extensions .png and .jpg).</p>
3210
3289
  * </li>
3211
3290
  * <li>
3212
3291
  * <p>
3213
- * <i>*internal*</i> will exclude all files in a directory that
3292
+ * <i>*internal*</i>—All files in a directory that
3214
3293
  * contain 'internal' in the file name, such as 'internal', 'internal_only',
3215
3294
  * 'company_internal'.</p>
3216
3295
  * </li>
3217
3296
  * <li>
3218
3297
  * <p>
3219
- * <i>**\/*internal*</i> will exclude all internal-related files in
3298
+ * <i>**\/*internal*</i>—All internal-related files in
3220
3299
  * a directory and its subdirectories.</p>
3221
3300
  * </li>
3222
3301
  * </ul>
3302
+ * <p>For more examples, see <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">Use of Exclude and
3303
+ * Include Filters</a> in the Amazon Web Services CLI Command Reference.</p>
3223
3304
  * @public
3224
3305
  */
3225
3306
  ExclusionPatterns?: string[];
@@ -3900,6 +3981,16 @@ export declare const SlackEntity: {
3900
3981
  export type SlackEntity = (typeof SlackEntity)[keyof typeof SlackEntity];
3901
3982
  /**
3902
3983
  * <p>Provides the configuration information to connect to Slack as your data source.</p>
3984
+ * <note>
3985
+ * <p>Amazon Kendra now supports an upgraded Slack connector.</p>
3986
+ * <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the
3987
+ * <code>SlackConfiguration</code> object to configure your connector.</p>
3988
+ * <p>Connectors configured using the older console and API architecture will continue to
3989
+ * function as configured. However, you won’t be able to edit or update them. If you want
3990
+ * to edit or update your connector configuration, you must create a new connector.</p>
3991
+ * <p>We recommended migrating your connector workflow to the upgraded version. Support for
3992
+ * connectors configured using the older architecture is scheduled to end by June 2024.</p>
3993
+ * </note>
3903
3994
  * @public
3904
3995
  */
3905
3996
  export interface SlackConfiguration {
@@ -4311,6 +4402,16 @@ export interface DataSourceConfiguration {
4311
4402
  /**
4312
4403
  * <p>Provides the configuration information to connect to an Amazon S3 bucket as your
4313
4404
  * data source.</p>
4405
+ * <note>
4406
+ * <p>Amazon Kendra now supports an upgraded Amazon S3 connector.</p>
4407
+ * <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the
4408
+ * <code>S3DataSourceConfiguration</code> object to configure your connector.</p>
4409
+ * <p>Connectors configured using the older console and API architecture will continue to
4410
+ * function as configured. However, you won't be able to edit or update them. If you want
4411
+ * to edit or update your connector configuration, you must create a new connector.</p>
4412
+ * <p>We recommended migrating your connector workflow to the upgraded version. Support for
4413
+ * connectors configured using the older architecture is scheduled to end by June 2024.</p>
4414
+ * </note>
4314
4415
  * @public
4315
4416
  */
4316
4417
  S3Configuration?: S3DataSourceConfiguration;
@@ -4371,11 +4472,31 @@ export interface DataSourceConfiguration {
4371
4472
  /**
4372
4473
  * <p>Provides the configuration information to connect to Amazon FSx as your data
4373
4474
  * source.</p>
4475
+ * <note>
4476
+ * <p>Amazon Kendra now supports an upgraded Amazon FSx Windows connector.</p>
4477
+ * <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the
4478
+ * <code>FsxConfiguration</code> object to configure your connector.</p>
4479
+ * <p>Connectors configured using the older console and API architecture will continue to
4480
+ * function as configured. However, you won't be able to edit or update them. If you want
4481
+ * to edit or update your connector configuration, you must create a new connector.</p>
4482
+ * <p>We recommended migrating your connector workflow to the upgraded version. Support for
4483
+ * connectors configured using the older architecture is scheduled to end by June 2024.</p>
4484
+ * </note>
4374
4485
  * @public
4375
4486
  */
4376
4487
  FsxConfiguration?: FsxConfiguration;
4377
4488
  /**
4378
4489
  * <p>Provides the configuration information to connect to Slack as your data source.</p>
4490
+ * <note>
4491
+ * <p>Amazon Kendra now supports an upgraded Slack connector.</p>
4492
+ * <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the
4493
+ * <code>SlackConfiguration</code> object to configure your connector.</p>
4494
+ * <p>Connectors configured using the older console and API architecture will continue to
4495
+ * function as configured. However, you won't be able to edit or update them. If you want
4496
+ * to edit or update your connector configuration, you must create a new connector.</p>
4497
+ * <p>We recommended migrating your connector workflow to the upgraded version. Support for
4498
+ * connectors configured using the older architecture is scheduled to end by June 2024.</p>
4499
+ * </note>
4379
4500
  * @public
4380
4501
  */
4381
4502
  SlackConfiguration?: SlackConfiguration;
@@ -4396,6 +4517,18 @@ export interface DataSourceConfiguration {
4396
4517
  JiraConfiguration?: JiraConfiguration;
4397
4518
  /**
4398
4519
  * <p>Provides the configuration information to connect to GitHub as your data source.</p>
4520
+ * <note>
4521
+ * <p>Amazon Kendra now supports an upgraded GitHub connector.</p>
4522
+ * <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the
4523
+ * <code>GitHubConfiguration</code> object to configure your connector.</p>
4524
+ * <p>Connectors configured using the older console and API architecture will continue
4525
+ * to function as configured. However, you won’t be able to edit or update them. If you
4526
+ * want to edit or update your connector configuration, you must create a new
4527
+ * connector.</p>
4528
+ * <p>We recommended migrating your connector workflow to the upgraded version. Support
4529
+ * for connectors configured using the older architecture is scheduled to end by June
4530
+ * 2024.</p>
4531
+ * </note>
4399
4532
  * @public
4400
4533
  */
4401
4534
  GitHubConfiguration?: GitHubConfiguration;
@@ -4403,9 +4536,12 @@ export interface DataSourceConfiguration {
4403
4536
  * @deprecated
4404
4537
  *
4405
4538
  * <p>Provides the configuration information to connect to Alfresco as your data source.</p>
4406
- * <p>Support for <code>AlfrescoConfiguration</code> ended May 2023.
4407
- * We recommend migrating to or using the Alfresco data source template
4408
- * schema / <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> API.</p>
4539
+ * <note>
4540
+ * <p>Support for <code>AlfrescoConfiguration</code> ended May 2023.
4541
+ * We recommend migrating to or using the Alfresco data source template
4542
+ * schema / <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a>
4543
+ * API.</p>
4544
+ * </note>
4409
4545
  * @public
4410
4546
  */
4411
4547
  AlfrescoConfiguration?: AlfrescoConfiguration;
@@ -5236,7 +5372,8 @@ export interface CreateIndexRequest {
5236
5372
  UserContextPolicy?: UserContextPolicy;
5237
5373
  /**
5238
5374
  * <p>Gets users and groups from IAM Identity Center
5239
- * identity source. To configure this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>.</p>
5375
+ * identity source. To configure this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering, where
5376
+ * search results are filtered based on the user or their group access to documents.</p>
5240
5377
  * @public
5241
5378
  */
5242
5379
  UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
@@ -6118,8 +6255,7 @@ export interface Relevance {
6118
6255
  /**
6119
6256
  * <p>Indicates that this field determines how "fresh" a document is. For example, if
6120
6257
  * document 1 was created on November 5, and document 2 was created on October 31, document
6121
- * 1 is "fresher" than document 2. You can only set the <code>Freshness</code> field on one
6122
- * <code>DATE</code> type field. Only applies to <code>DATE</code> fields.</p>
6258
+ * 1 is "fresher" than document 2. Only applies to <code>DATE</code> fields.</p>
6123
6259
  * @public
6124
6260
  */
6125
6261
  Freshness?: boolean;
@@ -6148,13 +6284,13 @@ export interface Relevance {
6148
6284
  * <p>When the <code>RankOrder</code> field is <code>DESCENDING</code>, lower numbers are
6149
6285
  * better. For example, in a task tracking application, a priority 1 task is more important
6150
6286
  * than a priority 5 task.</p>
6151
- * <p>Only applies to <code>LONG</code> and <code>DOUBLE</code> fields.</p>
6287
+ * <p>Only applies to <code>LONG</code> fields.</p>
6152
6288
  * @public
6153
6289
  */
6154
6290
  RankOrder?: Order;
6155
6291
  /**
6156
6292
  * <p>A list of values that should be given a different boost when they appear in the result
6157
- * list. For example, if you are boosting a field called "department," query terms that
6293
+ * list. For example, if you are boosting a field called "department", query terms that
6158
6294
  * match the department field are boosted in the result. However, you can add entries from
6159
6295
  * the department field to boost documents with those values higher. </p>
6160
6296
  * <p>For example, you can add entries to the map with names of departments. If you add
@@ -6322,13 +6458,13 @@ export interface DescribeIndexResponse {
6322
6458
  */
6323
6459
  Edition?: IndexEdition;
6324
6460
  /**
6325
- * <p>The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to
6326
- * write to your Amazon Cloudwatch logs.</p>
6461
+ * <p>The Amazon Resource Name (ARN) of the IAM role that gives
6462
+ * Amazon Kendra permission to write to your Amazon CloudWatch logs.</p>
6327
6463
  * @public
6328
6464
  */
6329
6465
  RoleArn?: string;
6330
6466
  /**
6331
- * <p>The identifier of the KMScustomer master key (CMK) that is used to encrypt
6467
+ * <p>The identifier of the KMS customer master key (CMK) that is used to encrypt
6332
6468
  * your data. Amazon Kendra doesn't support asymmetric CMKs.</p>
6333
6469
  * @public
6334
6470
  */
@@ -6351,7 +6487,7 @@ export interface DescribeIndexResponse {
6351
6487
  */
6352
6488
  CreatedAt?: Date;
6353
6489
  /**
6354
- * <p>The Unix when the index was last updated.</p>
6490
+ * <p>The Unix timestamp when the index was last updated.</p>
6355
6491
  * @public
6356
6492
  */
6357
6493
  UpdatedAt?: Date;
@@ -6394,8 +6530,9 @@ export interface DescribeIndexResponse {
6394
6530
  */
6395
6531
  UserContextPolicy?: UserContextPolicy;
6396
6532
  /**
6397
- * <p>Whether you have enabled the configuration for fetching access levels of groups and
6398
- * users from an IAM Identity Center identity source.</p>
6533
+ * <p>Whether you have enabled IAM Identity Center identity source for your
6534
+ * users and groups. This is useful for user context filtering, where
6535
+ * search results are filtered based on the user or their group access to documents.</p>
6399
6536
  * @public
6400
6537
  */
6401
6538
  UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
@@ -100,7 +100,9 @@ export interface TableExcerpt {
100
100
  */
101
101
  export interface QueryResultItem {
102
102
  /**
103
- * <p>The identifier for the query result.</p>
103
+ * <p>The unique identifier for the query result item id (<code>Id</code>) and the query
104
+ * result item document id (<code>DocumentId</code>) combined. The value of this field changes
105
+ * with every request, even when you have the same documents.</p>
104
106
  * @public
105
107
  */
106
108
  Id?: string;
@@ -146,17 +148,17 @@ export interface QueryResultItem {
146
148
  */
147
149
  DocumentURI?: string;
148
150
  /**
149
- * <p>An array of document fields/attributes assigned to a document in the search results.
150
- * For example, the document author (<code>_author</code>) or the source URI
151
- * (<code>_source_uri</code>) of the document.</p>
151
+ * <p>An array of document fields/attributes assigned to a document in the search results. For
152
+ * example, the document author (<code>_author</code>) or the source URI
153
+ * (<code>_source_uri</code>) of the document.</p>
152
154
  * @public
153
155
  */
154
156
  DocumentAttributes?: DocumentAttribute[];
155
157
  /**
156
- * <p>Indicates the confidence level of Amazon Kendra providing a relevant result for
157
- * the query. Each result is placed into a bin that indicates the confidence,
158
- * <code>VERY_HIGH</code>, <code>HIGH</code>, <code>MEDIUM</code> and <code>LOW</code>.
159
- * You can use the score to determine if a response meets the confidence needed for your
158
+ * <p>Indicates the confidence level of Amazon Kendra providing a relevant result for the
159
+ * query. Each result is placed into a bin that indicates the confidence,
160
+ * <code>VERY_HIGH</code>, <code>HIGH</code>, <code>MEDIUM</code> and <code>LOW</code>. You
161
+ * can use the score to determine if a response meets the confidence needed for your
160
162
  * application.</p>
161
163
  * <p>The field is only set to <code>LOW</code> when the <code>Type</code> field is set to
162
164
  * <code>DOCUMENT</code> and Amazon Kendra is not confident that the result is
@@ -166,7 +168,8 @@ export interface QueryResultItem {
166
168
  ScoreAttributes?: ScoreAttributes;
167
169
  /**
168
170
  * <p>A token that identifies a particular result from a particular query. Use this token to
169
- * provide click-through feedback for the result. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html">Submitting feedback</a>.</p>
171
+ * provide click-through feedback for the result. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html">Submitting
172
+ * feedback</a>.</p>
170
173
  * @public
171
174
  */
172
175
  FeedbackToken?: string;
@@ -705,7 +708,7 @@ export interface UpdateIndexRequest {
705
708
  */
706
709
  Id: string | undefined;
707
710
  /**
708
- * <p>The name of the index you want to update.</p>
711
+ * <p>A new name for the index.</p>
709
712
  * @public
710
713
  */
711
714
  Name?: string;
@@ -747,8 +750,9 @@ export interface UpdateIndexRequest {
747
750
  */
748
751
  UserContextPolicy?: UserContextPolicy;
749
752
  /**
750
- * <p>Enables fetching access levels of groups and users from an IAM Identity Center
751
- * identity source. To configure this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>.</p>
753
+ * <p>Gets users and groups from IAM Identity Center
754
+ * identity source. To configure this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering, where
755
+ * search results are filtered based on the user or their group access to documents.</p>
752
756
  * @public
753
757
  */
754
758
  UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
@@ -940,8 +944,8 @@ export interface Facet {
940
944
  MaxResults?: number;
941
945
  }
942
946
  /**
943
- * <p>Provides the count of documents that match a particular document attribute or
944
- * field when doing a faceted search.</p>
947
+ * <p>Provides the count of documents that match a particular document attribute or field when
948
+ * doing a faceted search.</p>
945
949
  * @public
946
950
  */
947
951
  export interface DocumentAttributeValueCountPair {
@@ -951,8 +955,8 @@ export interface DocumentAttributeValueCountPair {
951
955
  */
952
956
  DocumentAttributeValue?: DocumentAttributeValue;
953
957
  /**
954
- * <p>The number of documents in the response that have the attribute/field value for
955
- * the key.</p>
958
+ * <p>The number of documents in the response that have the attribute/field value for the
959
+ * key.</p>
956
960
  * @public
957
961
  */
958
962
  Count?: number;
@@ -998,14 +1002,13 @@ export interface FacetResult {
998
1002
  }
999
1003
  /**
1000
1004
  * <p>Filters the search results based on document attributes or fields.</p>
1001
- * <p>You can filter results using attributes for your particular documents.
1002
- * The attributes must exist in your index. For example, if your documents
1003
- * include the custom attribute "Department", you can filter documents that
1004
- * belong to the "HR" department. You would use the <code>EqualsTo</code>
1005
- * operation to filter results or documents with "Department" equals to "HR".</p>
1006
- * <p>You can use <code>AndAllFilters</code> and <code>AndOrFilters</code> in
1007
- * combination with each other or with other operations such as <code>EqualsTo</code>.
1008
- * For example:</p>
1005
+ * <p>You can filter results using attributes for your particular documents. The attributes
1006
+ * must exist in your index. For example, if your documents include the custom attribute
1007
+ * "Department", you can filter documents that belong to the "HR" department. You would use
1008
+ * the <code>EqualsTo</code> operation to filter results or documents with "Department" equals
1009
+ * to "HR".</p>
1010
+ * <p>You can use <code>AndAllFilters</code> and <code>AndOrFilters</code> in combination with
1011
+ * each other or with other operations such as <code>EqualsTo</code>. For example:</p>
1009
1012
  * <p>
1010
1013
  * <code>AndAllFilters</code>
1011
1014
  * </p>
@@ -1027,18 +1030,18 @@ export interface FacetResult {
1027
1030
  * </li>
1028
1031
  * </ul>
1029
1032
  * <p>This example filters results or documents that belong to the HR department
1030
- * <i>and</i> belong to projects that contain "new hires"
1031
- * <i>or</i> "new hiring" in the project name (must use
1032
- * <code>ContainAny</code> with <code>StringListValue</code>). This example is
1033
- * filtering with a depth of 2.</p>
1033
+ * <i>and</i> belong to projects that contain "new hires"
1034
+ * <i>or</i> "new hiring" in the project name (must use
1035
+ * <code>ContainAny</code> with <code>StringListValue</code>). This example is filtering
1036
+ * with a depth of 2.</p>
1034
1037
  * <p>You cannot filter more than a depth of 2, otherwise you receive a
1035
- * <code>ValidationException</code> exception with the message "AttributeFilter
1036
- * cannot have a depth of more than 2." Also, if you use more than 10 attribute
1037
- * filters in a given list for <code>AndAllFilters</code> or <code>OrAllFilters</code>,
1038
- * you receive a <code>ValidationException</code> with the message "AttributeFilter
1039
- * cannot have a length of more than 10".</p>
1040
- * <p>For examples of using <code>AttributeFilter</code>, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering">Using
1041
- * document attributes to filter search results</a>.</p>
1038
+ * <code>ValidationException</code> exception with the message "AttributeFilter cannot have
1039
+ * a depth of more than 2." Also, if you use more than 10 attribute filters in a given list
1040
+ * for <code>AndAllFilters</code> or <code>OrAllFilters</code>, you receive a
1041
+ * <code>ValidationException</code> with the message "AttributeFilter cannot have a length
1042
+ * of more than 10".</p>
1043
+ * <p>For examples of using <code>AttributeFilter</code>, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering">Using document attributes to
1044
+ * filter search results</a>.</p>
1042
1045
  * @public
1043
1046
  */
1044
1047
  export interface AttributeFilter {
@@ -1075,32 +1078,32 @@ export interface AttributeFilter {
1075
1078
  */
1076
1079
  ContainsAny?: DocumentAttribute;
1077
1080
  /**
1078
- * <p>Performs a greater than operation on document attributes/fields and their
1079
- * values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1081
+ * <p>Performs a greater than operation on document attributes/fields and their values. Use
1082
+ * with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1080
1083
  * type</a>
1081
1084
  * <code>Date</code> or <code>Long</code>.</p>
1082
1085
  * @public
1083
1086
  */
1084
1087
  GreaterThan?: DocumentAttribute;
1085
1088
  /**
1086
- * <p>Performs a greater or equals than operation on document attributes/fields and
1087
- * their values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1089
+ * <p>Performs a greater or equals than operation on document attributes/fields and their
1090
+ * values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1088
1091
  * type</a>
1089
1092
  * <code>Date</code> or <code>Long</code>.</p>
1090
1093
  * @public
1091
1094
  */
1092
1095
  GreaterThanOrEquals?: DocumentAttribute;
1093
1096
  /**
1094
- * <p>Performs a less than operation on document attributes/fields and their values.
1095
- * Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1097
+ * <p>Performs a less than operation on document attributes/fields and their values. Use with
1098
+ * the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1096
1099
  * type</a>
1097
1100
  * <code>Date</code> or <code>Long</code>.</p>
1098
1101
  * @public
1099
1102
  */
1100
1103
  LessThan?: DocumentAttribute;
1101
1104
  /**
1102
- * <p>Performs a less than or equals operation on document attributes/fields and
1103
- * their values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1105
+ * <p>Performs a less than or equals operation on document attributes/fields and their values.
1106
+ * Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1104
1107
  * type</a>
1105
1108
  * <code>Date</code> or <code>Long</code>.</p>
1106
1109
  * @public
@@ -1201,7 +1204,10 @@ export interface RetrieveRequest {
1201
1204
  /**
1202
1205
  * <p>The input query text to retrieve relevant passages for the search. Amazon Kendra
1203
1206
  * truncates queries at 30 token words, which excludes punctuation and stop words.
1204
- * Truncation still applies if you use Boolean or more advanced, complex queries.</p>
1207
+ * Truncation still applies if you use Boolean or more advanced, complex queries. For
1208
+ * example, <code>Timeoff AND October AND Category:HR</code> is counted as 3 tokens:
1209
+ * <code>timeoff</code>, <code>october</code>, <code>hr</code>. For more information,
1210
+ * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching with advanced query syntax</a> in the Amazon Kendra Developer Guide. </p>
1205
1211
  * @public
1206
1212
  */
1207
1213
  QueryText: string | undefined;
@@ -1311,7 +1317,9 @@ export interface QueryRequest {
1311
1317
  /**
1312
1318
  * <p>The input query text for the search. Amazon Kendra truncates queries at 30 token
1313
1319
  * words, which excludes punctuation and stop words. Truncation still applies if you use
1314
- * Boolean or more advanced, complex queries. </p>
1320
+ * Boolean or more advanced, complex queries. For example, <code>Timeoff AND October AND
1321
+ * Category:HR</code> is counted as 3 tokens: <code>timeoff</code>, <code>october</code>,
1322
+ * <code>hr</code>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching with advanced query syntax</a> in the Amazon Kendra Developer Guide. </p>
1315
1323
  * @public
1316
1324
  */
1317
1325
  QueryText?: string;
@@ -6,5 +6,4 @@ export { KendraExtensionConfiguration } from "./extensionConfiguration";
6
6
  export * from "./commands";
7
7
  export * from "./pagination";
8
8
  export * from "./models";
9
- import "@aws-sdk/util-endpoints";
10
9
  export { KendraServiceException } from "./models/KendraServiceException";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kendra",
3
3
  "description": "AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native",
4
- "version": "3.535.0",
4
+ "version": "3.549.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-kendra",
@@ -20,26 +20,26 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.535.0",
24
- "@aws-sdk/core": "3.535.0",
25
- "@aws-sdk/credential-provider-node": "3.535.0",
23
+ "@aws-sdk/client-sts": "3.549.0",
24
+ "@aws-sdk/core": "3.549.0",
25
+ "@aws-sdk/credential-provider-node": "3.549.0",
26
26
  "@aws-sdk/middleware-host-header": "3.535.0",
27
27
  "@aws-sdk/middleware-logger": "3.535.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.535.0",
29
- "@aws-sdk/middleware-user-agent": "3.535.0",
29
+ "@aws-sdk/middleware-user-agent": "3.540.0",
30
30
  "@aws-sdk/region-config-resolver": "3.535.0",
31
31
  "@aws-sdk/types": "3.535.0",
32
- "@aws-sdk/util-endpoints": "3.535.0",
32
+ "@aws-sdk/util-endpoints": "3.540.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.535.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.535.0",
35
35
  "@smithy/config-resolver": "^2.2.0",
36
- "@smithy/core": "^1.4.0",
36
+ "@smithy/core": "^1.4.1",
37
37
  "@smithy/fetch-http-handler": "^2.5.0",
38
38
  "@smithy/hash-node": "^2.2.0",
39
39
  "@smithy/invalid-dependency": "^2.2.0",
40
40
  "@smithy/middleware-content-length": "^2.2.0",
41
41
  "@smithy/middleware-endpoint": "^2.5.0",
42
- "@smithy/middleware-retry": "^2.2.0",
42
+ "@smithy/middleware-retry": "^2.3.0",
43
43
  "@smithy/middleware-serde": "^2.3.0",
44
44
  "@smithy/middleware-stack": "^2.2.0",
45
45
  "@smithy/node-config-provider": "^2.3.0",