@aws-sdk/client-kendra 3.301.0 → 3.303.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 (118) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/Kendra.js +75 -0
  3. package/dist-cjs/commands/BatchDeleteFeaturedResultsSetCommand.js +45 -0
  4. package/dist-cjs/commands/CreateFeaturedResultsSetCommand.js +45 -0
  5. package/dist-cjs/commands/DescribeFeaturedResultsSetCommand.js +45 -0
  6. package/dist-cjs/commands/ListFeaturedResultsSetsCommand.js +45 -0
  7. package/dist-cjs/commands/UpdateFeaturedResultsSetCommand.js +45 -0
  8. package/dist-cjs/commands/index.js +5 -0
  9. package/dist-cjs/endpoint/ruleset.js +3 -3
  10. package/dist-cjs/models/models_0.js +381 -438
  11. package/dist-cjs/models/models_1.js +20 -0
  12. package/dist-cjs/protocols/Aws_json1_1.js +597 -4
  13. package/dist-es/Kendra.js +75 -0
  14. package/dist-es/commands/BatchDeleteFeaturedResultsSetCommand.js +41 -0
  15. package/dist-es/commands/CreateFeaturedResultsSetCommand.js +41 -0
  16. package/dist-es/commands/DescribeFeaturedResultsSetCommand.js +41 -0
  17. package/dist-es/commands/ListFeaturedResultsSetsCommand.js +41 -0
  18. package/dist-es/commands/UpdateFeaturedResultsSetCommand.js +41 -0
  19. package/dist-es/commands/index.js +5 -0
  20. package/dist-es/endpoint/ruleset.js +3 -3
  21. package/dist-es/models/models_0.js +377 -434
  22. package/dist-es/models/models_1.js +18 -1
  23. package/dist-es/protocols/Aws_json1_1.js +584 -1
  24. package/dist-types/Kendra.d.ts +163 -132
  25. package/dist-types/KendraClient.d.ts +7 -2
  26. package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +1 -1
  27. package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +1 -1
  28. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +6 -6
  29. package/dist-types/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +88 -0
  30. package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +9 -13
  31. package/dist-types/commands/BatchPutDocumentCommand.d.ts +14 -13
  32. package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +1 -1
  33. package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +17 -20
  34. package/dist-types/commands/CreateDataSourceCommand.d.ts +3 -4
  35. package/dist-types/commands/CreateExperienceCommand.d.ts +3 -2
  36. package/dist-types/commands/CreateFaqCommand.d.ts +6 -6
  37. package/dist-types/commands/CreateFeaturedResultsSetCommand.d.ts +117 -0
  38. package/dist-types/commands/CreateIndexCommand.d.ts +3 -2
  39. package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +3 -2
  40. package/dist-types/commands/CreateThesaurusCommand.d.ts +3 -2
  41. package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +5 -5
  42. package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
  43. package/dist-types/commands/DeleteExperienceCommand.d.ts +1 -1
  44. package/dist-types/commands/DeleteFaqCommand.d.ts +1 -1
  45. package/dist-types/commands/DeleteIndexCommand.d.ts +1 -1
  46. package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +13 -15
  47. package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +1 -1
  48. package/dist-types/commands/DeleteThesaurusCommand.d.ts +1 -1
  49. package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +3 -3
  50. package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
  51. package/dist-types/commands/DescribeExperienceCommand.d.ts +1 -1
  52. package/dist-types/commands/DescribeFaqCommand.d.ts +1 -1
  53. package/dist-types/commands/DescribeFeaturedResultsSetCommand.d.ts +86 -0
  54. package/dist-types/commands/DescribeIndexCommand.d.ts +1 -1
  55. package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +8 -9
  56. package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +1 -1
  57. package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +1 -1
  58. package/dist-types/commands/DescribeThesaurusCommand.d.ts +1 -1
  59. package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +1 -1
  60. package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +1 -1
  61. package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +3 -2
  62. package/dist-types/commands/GetSnapshotsCommand.d.ts +3 -4
  63. package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +5 -5
  64. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +1 -1
  65. package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
  66. package/dist-types/commands/ListEntityPersonasCommand.d.ts +1 -1
  67. package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +1 -1
  68. package/dist-types/commands/ListExperiencesCommand.d.ts +1 -1
  69. package/dist-types/commands/ListFaqsCommand.d.ts +1 -1
  70. package/dist-types/commands/ListFeaturedResultsSetsCommand.d.ts +87 -0
  71. package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +4 -5
  72. package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
  73. package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +1 -1
  74. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
  75. package/dist-types/commands/ListThesauriCommand.d.ts +1 -1
  76. package/dist-types/commands/PutPrincipalMappingCommand.d.ts +15 -21
  77. package/dist-types/commands/QueryCommand.d.ts +3 -2
  78. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +2 -2
  79. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +2 -2
  80. package/dist-types/commands/SubmitFeedbackCommand.d.ts +2 -2
  81. package/dist-types/commands/TagResourceCommand.d.ts +4 -5
  82. package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
  83. package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +20 -20
  84. package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
  85. package/dist-types/commands/UpdateExperienceCommand.d.ts +2 -2
  86. package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +105 -0
  87. package/dist-types/commands/UpdateIndexCommand.d.ts +4 -3
  88. package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +2 -2
  89. package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +1 -1
  90. package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
  91. package/dist-types/commands/index.d.ts +5 -0
  92. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  93. package/dist-types/models/models_0.d.ts +1943 -1687
  94. package/dist-types/models/models_1.d.ts +491 -72
  95. package/dist-types/protocols/Aws_json1_1.d.ts +15 -0
  96. package/dist-types/ts3.4/Kendra.d.ts +85 -0
  97. package/dist-types/ts3.4/KendraClient.d.ts +30 -0
  98. package/dist-types/ts3.4/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +41 -0
  99. package/dist-types/ts3.4/commands/CreateFeaturedResultsSetCommand.d.ts +41 -0
  100. package/dist-types/ts3.4/commands/DescribeFeaturedResultsSetCommand.d.ts +41 -0
  101. package/dist-types/ts3.4/commands/ListFeaturedResultsSetsCommand.d.ts +41 -0
  102. package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
  103. package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
  104. package/dist-types/ts3.4/commands/SubmitFeedbackCommand.d.ts +1 -1
  105. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  106. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  107. package/dist-types/ts3.4/commands/UpdateAccessControlConfigurationCommand.d.ts +1 -1
  108. package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
  109. package/dist-types/ts3.4/commands/UpdateExperienceCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/UpdateFeaturedResultsSetCommand.d.ts +41 -0
  111. package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +1 -1
  112. package/dist-types/ts3.4/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +1 -1
  113. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  114. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  115. package/dist-types/ts3.4/models/models_0.d.ts +563 -453
  116. package/dist-types/ts3.4/models/models_1.d.ts +127 -0
  117. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
  118. package/package.json +34 -34
@@ -19,25 +19,18 @@ export interface PutPrincipalMappingCommandOutput extends __MetadataBearer {
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Maps users to their groups so that you only need to provide
23
- * the user ID when you issue the query.</p>
24
- * <p>You can also map sub groups to groups.
25
- * For example, the group "Company Intellectual Property Teams" includes
26
- * sub groups "Research" and "Engineering". These sub groups include their
27
- * own list of users or people who work in these teams. Only users who work
28
- * in research and engineering, and therefore belong in the intellectual
29
- * property group, can see top-secret company documents in their search
30
- * results.</p>
31
- * <p>This is useful for user context filtering, where search results are
32
- * filtered based on the user or their group access to documents. For more
33
- * information, see
34
- * <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering
35
- * on user context</a>.</p>
36
- * <p>If more than five <code>PUT</code> actions for a group are currently
37
- * processing, a validation exception is thrown.</p>
38
- * <p>
39
- * <code>PutPrincipalMapping</code> is currently not supported in the
40
- * Amazon Web Services GovCloud (US-West) region.</p>
22
+ * <p>Maps users to their groups so that you only need to provide the user ID when you issue
23
+ * the query.</p>
24
+ * <p>You can also map sub groups to groups. For example, the group "Company Intellectual
25
+ * Property Teams" includes sub groups "Research" and "Engineering". These sub groups
26
+ * include their own list of users or people who work in these teams. Only users who work
27
+ * in research and engineering, and therefore belong in the intellectual property group,
28
+ * can see top-secret company documents in their search results.</p>
29
+ * <p>This is useful for user context filtering, where search results are filtered based on
30
+ * the user or their group access to documents. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering on
31
+ * user context</a>.</p>
32
+ * <p>If more than five <code>PUT</code> actions for a group are currently processing, a
33
+ * validation exception is thrown.</p>
41
34
  * @example
42
35
  * Use a bare-bones client and the command you need to make an API call.
43
36
  * ```javascript
@@ -88,7 +81,7 @@ export interface PutPrincipalMappingCommandOutput extends __MetadataBearer {
88
81
  *
89
82
  * @throws {@link InternalServerException} (server fault)
90
83
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
91
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
84
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
92
85
  *
93
86
  * @throws {@link ResourceNotFoundException} (client fault)
94
87
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -96,7 +89,8 @@ export interface PutPrincipalMappingCommandOutput extends __MetadataBearer {
96
89
  *
97
90
  * @throws {@link ServiceQuotaExceededException} (client fault)
98
91
  * <p>You have exceeded the set limits for your Amazon Kendra service. Please see
99
- * Quotas[hyperlink Kendra Quotas pg] for more information, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> to inquire about
92
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
93
+ * more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
100
94
  * an increase of limits.</p>
101
95
  *
102
96
  * @throws {@link ThrottlingException} (client fault)
@@ -205,7 +205,7 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
205
205
  *
206
206
  * @throws {@link InternalServerException} (server fault)
207
207
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
208
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
208
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
209
209
  *
210
210
  * @throws {@link ResourceNotFoundException} (client fault)
211
211
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -213,7 +213,8 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
213
213
  *
214
214
  * @throws {@link ServiceQuotaExceededException} (client fault)
215
215
  * <p>You have exceeded the set limits for your Amazon Kendra service. Please see
216
- * Quotas[hyperlink Kendra Quotas pg] for more information, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> to inquire about
216
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
217
+ * more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
217
218
  * an increase of limits.</p>
218
219
  *
219
220
  * @throws {@link ThrottlingException} (client fault)
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { StartDataSourceSyncJobRequest, StartDataSourceSyncJobResponse } from "../models/models_0";
5
+ import { StartDataSourceSyncJobRequest, StartDataSourceSyncJobResponse } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -52,7 +52,7 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync
52
52
  *
53
53
  * @throws {@link InternalServerException} (server fault)
54
54
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
55
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
55
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
56
56
  *
57
57
  * @throws {@link ResourceInUseException} (client fault)
58
58
  * <p>The resource you want to use is currently in use. Please check you have provided the
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { StopDataSourceSyncJobRequest } from "../models/models_0";
5
+ import { StopDataSourceSyncJobRequest } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -47,7 +47,7 @@ export interface StopDataSourceSyncJobCommandOutput extends __MetadataBearer {
47
47
  *
48
48
  * @throws {@link InternalServerException} (server fault)
49
49
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
50
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
50
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
51
51
  *
52
52
  * @throws {@link ResourceNotFoundException} (client fault)
53
53
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { SubmitFeedbackRequest } from "../models/models_0";
5
+ import { SubmitFeedbackRequest } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -62,7 +62,7 @@ export interface SubmitFeedbackCommandOutput extends __MetadataBearer {
62
62
  *
63
63
  * @throws {@link InternalServerException} (server fault)
64
64
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
65
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
65
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
66
66
  *
67
67
  * @throws {@link ResourceNotFoundException} (client fault)
68
68
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
5
+ import { TagResourceRequest, TagResourceResponse } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -19,9 +19,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Adds the specified tag to the specified index, FAQ, or data source
23
- * resource. If the tag already exists, the existing value is replaced with
24
- * the new value.</p>
22
+ * <p>Adds the specified tag to the specified index, FAQ, or data source resource. If the tag
23
+ * already exists, the existing value is replaced with the new value.</p>
25
24
  * @example
26
25
  * Use a bare-bones client and the command you need to make an API call.
27
26
  * ```javascript
@@ -53,7 +52,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
53
52
  *
54
53
  * @throws {@link InternalServerException} (server fault)
55
54
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
56
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
55
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
57
56
  *
58
57
  * @throws {@link ResourceUnavailableException} (client fault)
59
58
  * <p>The resource you want to use isn't available. Please check you have provided the
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
+ import { UntagResourceRequest, UntagResourceResponse } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -48,7 +48,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
48
48
  *
49
49
  * @throws {@link InternalServerException} (server fault)
50
50
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
51
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
51
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
52
52
  *
53
53
  * @throws {@link ResourceUnavailableException} (client fault)
54
54
  * <p>The resource you want to use isn't available. Please check you have provided the
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { UpdateAccessControlConfigurationRequest, UpdateAccessControlConfigurationResponse } from "../models/models_0";
5
+ import { UpdateAccessControlConfigurationRequest, UpdateAccessControlConfigurationResponse } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -19,26 +19,25 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Updates an access control configuration for your documents in an index. This
23
- * includes user and group access information for your documents. This is useful
24
- * for user context filtering, where search results are filtered based on the user
25
- * or their group access to documents.</p>
26
- * <p>You can update an access control configuration you created without indexing all
27
- * of your documents again. For example, your index contains top-secret company
28
- * documents that only certain employees or users should access. You created an 'allow'
29
- * access control configuration for one user who recently joined the 'top-secret' team,
30
- * switching from a team with 'deny' access to top-secret documents. However, the user
31
- * suddenly returns to their previous team and should no longer have access to top secret
32
- * documents. You can update the access control configuration to re-configure access
33
- * control for your documents as circumstances change.</p>
22
+ * <p>Updates an access control configuration for your documents in an index. This includes
23
+ * user and group access information for your documents. This is useful for user context
24
+ * filtering, where search results are filtered based on the user or their group access to
25
+ * documents.</p>
26
+ * <p>You can update an access control configuration you created without indexing all of
27
+ * your documents again. For example, your index contains top-secret company documents that
28
+ * only certain employees or users should access. You created an 'allow' access control
29
+ * configuration for one user who recently joined the 'top-secret' team, switching from a
30
+ * team with 'deny' access to top-secret documents. However, the user suddenly returns to
31
+ * their previous team and should no longer have access to top secret documents. You can
32
+ * update the access control configuration to re-configure access control for your
33
+ * documents as circumstances change.</p>
34
34
  * <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to
35
35
  * apply the updated access control configuration, with the
36
- * <code>AccessControlConfigurationId</code> included in the
37
- * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
36
+ * <code>AccessControlConfigurationId</code> included in the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
38
37
  * object. If you use an S3 bucket as a data source, you synchronize your data source to
39
- * apply the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code> file.
40
- * Amazon Kendra currently only supports access control configuration for S3 data
41
- * sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
38
+ * apply the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code>
39
+ * file. Amazon Kendra currently only supports access control configuration for S3
40
+ * data sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
42
41
  * @example
43
42
  * Use a bare-bones client and the command you need to make an API call.
44
43
  * ```javascript
@@ -91,7 +90,7 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
91
90
  *
92
91
  * @throws {@link InternalServerException} (server fault)
93
92
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
94
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
93
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
95
94
  *
96
95
  * @throws {@link ResourceNotFoundException} (client fault)
97
96
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -99,7 +98,8 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
99
98
  *
100
99
  * @throws {@link ServiceQuotaExceededException} (client fault)
101
100
  * <p>You have exceeded the set limits for your Amazon Kendra service. Please see
102
- * Quotas[hyperlink Kendra Quotas pg] for more information, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> to inquire about
101
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
102
+ * more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
103
103
  * an increase of limits.</p>
104
104
  *
105
105
  * @throws {@link ThrottlingException} (client fault)
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { UpdateDataSourceRequest } from "../models/models_0";
5
+ import { UpdateDataSourceRequest } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -608,7 +608,7 @@ export interface UpdateDataSourceCommandOutput extends __MetadataBearer {
608
608
  *
609
609
  * @throws {@link InternalServerException} (server fault)
610
610
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
611
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
611
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
612
612
  *
613
613
  * @throws {@link ResourceNotFoundException} (client fault)
614
614
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { UpdateExperienceRequest } from "../models/models_0";
5
+ import { UpdateExperienceRequest } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -69,7 +69,7 @@ export interface UpdateExperienceCommandOutput extends __MetadataBearer {
69
69
  *
70
70
  * @throws {@link InternalServerException} (server fault)
71
71
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
72
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
72
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
73
73
  *
74
74
  * @throws {@link ResourceNotFoundException} (client fault)
75
75
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -0,0 +1,105 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
+ import { UpdateFeaturedResultsSetRequest, UpdateFeaturedResultsSetResponse } from "../models/models_1";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link UpdateFeaturedResultsSetCommand}.
10
+ */
11
+ export interface UpdateFeaturedResultsSetCommandInput extends UpdateFeaturedResultsSetRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link UpdateFeaturedResultsSetCommand}.
17
+ */
18
+ export interface UpdateFeaturedResultsSetCommandOutput extends UpdateFeaturedResultsSetResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Updates a set of featured results. Features results are placed
23
+ * above
24
+ * all other results for certain queries. You map specific queries to specific documents
25
+ * for featuring in the results. If a query contains an exact match of a query, then one
26
+ * or more specific documents are featured in the search results.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { KendraClient, UpdateFeaturedResultsSetCommand } from "@aws-sdk/client-kendra"; // ES Modules import
31
+ * // const { KendraClient, UpdateFeaturedResultsSetCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
32
+ * const client = new KendraClient(config);
33
+ * const input = { // UpdateFeaturedResultsSetRequest
34
+ * IndexId: "STRING_VALUE", // required
35
+ * FeaturedResultsSetId: "STRING_VALUE", // required
36
+ * FeaturedResultsSetName: "STRING_VALUE",
37
+ * Description: "STRING_VALUE",
38
+ * Status: "ACTIVE" || "INACTIVE",
39
+ * QueryTexts: [ // QueryTextList
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * FeaturedDocuments: [ // FeaturedDocumentList
43
+ * { // FeaturedDocument
44
+ * Id: "STRING_VALUE",
45
+ * },
46
+ * ],
47
+ * };
48
+ * const command = new UpdateFeaturedResultsSetCommand(input);
49
+ * const response = await client.send(command);
50
+ * ```
51
+ *
52
+ * @param UpdateFeaturedResultsSetCommandInput - {@link UpdateFeaturedResultsSetCommandInput}
53
+ * @returns {@link UpdateFeaturedResultsSetCommandOutput}
54
+ * @see {@link UpdateFeaturedResultsSetCommandInput} for command's `input` shape.
55
+ * @see {@link UpdateFeaturedResultsSetCommandOutput} for command's `response` shape.
56
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
57
+ *
58
+ * @throws {@link AccessDeniedException} (client fault)
59
+ * <p>You don't have sufficient access to perform this action. Please ensure you have the
60
+ * required permission policies and user accounts and try again.</p>
61
+ *
62
+ * @throws {@link FeaturedResultsConflictException} (client fault)
63
+ * <p>An error message with a list of conflicting queries used across different sets
64
+ * of featured results. This occurred with the request for a new featured results set.
65
+ * Check that the queries you specified for featured results are unique per featured
66
+ * results set for each index.</p>
67
+ *
68
+ * @throws {@link InternalServerException} (server fault)
69
+ * <p>An issue occurred with the internal server used for your Amazon Kendra service.
70
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
71
+ *
72
+ * @throws {@link ResourceNotFoundException} (client fault)
73
+ * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
74
+ * resource and try again.</p>
75
+ *
76
+ * @throws {@link ThrottlingException} (client fault)
77
+ * <p>The request was denied due to request throttling. Please reduce the number of requests
78
+ * and try again.</p>
79
+ *
80
+ * @throws {@link ValidationException} (client fault)
81
+ * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
82
+ * Please provide the correct input and try again.</p>
83
+ *
84
+ *
85
+ */
86
+ export declare class UpdateFeaturedResultsSetCommand extends $Command<UpdateFeaturedResultsSetCommandInput, UpdateFeaturedResultsSetCommandOutput, KendraClientResolvedConfig> {
87
+ readonly input: UpdateFeaturedResultsSetCommandInput;
88
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
92
+ constructor(input: UpdateFeaturedResultsSetCommandInput);
93
+ /**
94
+ * @internal
95
+ */
96
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFeaturedResultsSetCommandInput, UpdateFeaturedResultsSetCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
100
+ private serialize;
101
+ /**
102
+ * @internal
103
+ */
104
+ private deserialize;
105
+ }
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { UpdateIndexRequest } from "../models/models_0";
5
+ import { UpdateIndexRequest } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -98,7 +98,7 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
98
98
  *
99
99
  * @throws {@link InternalServerException} (server fault)
100
100
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
101
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
101
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
102
102
  *
103
103
  * @throws {@link ResourceNotFoundException} (client fault)
104
104
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -106,7 +106,8 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
106
106
  *
107
107
  * @throws {@link ServiceQuotaExceededException} (client fault)
108
108
  * <p>You have exceeded the set limits for your Amazon Kendra service. Please see
109
- * Quotas[hyperlink Kendra Quotas pg] for more information, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> to inquire about
109
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
110
+ * more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
110
111
  * an increase of limits.</p>
111
112
  *
112
113
  * @throws {@link ThrottlingException} (client fault)
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { UpdateQuerySuggestionsBlockListRequest } from "../models/models_0";
5
+ import { UpdateQuerySuggestionsBlockListRequest } from "../models/models_1";
6
6
  /**
7
7
  * @public
8
8
  *
@@ -67,7 +67,7 @@ export interface UpdateQuerySuggestionsBlockListCommandOutput extends __Metadata
67
67
  *
68
68
  * @throws {@link InternalServerException} (server fault)
69
69
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
70
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
70
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
71
71
  *
72
72
  * @throws {@link ResourceNotFoundException} (client fault)
73
73
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -65,7 +65,7 @@ export interface UpdateQuerySuggestionsConfigCommandOutput extends __MetadataBea
65
65
  *
66
66
  * @throws {@link InternalServerException} (server fault)
67
67
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
68
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
68
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
69
69
  *
70
70
  * @throws {@link ResourceNotFoundException} (client fault)
71
71
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -57,7 +57,7 @@ export interface UpdateThesaurusCommandOutput extends __MetadataBearer {
57
57
  *
58
58
  * @throws {@link InternalServerException} (server fault)
59
59
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
60
- * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
60
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
61
61
  *
62
62
  * @throws {@link ResourceNotFoundException} (client fault)
63
63
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -1,6 +1,7 @@
1
1
  export * from "./AssociateEntitiesToExperienceCommand";
2
2
  export * from "./AssociatePersonasToEntitiesCommand";
3
3
  export * from "./BatchDeleteDocumentCommand";
4
+ export * from "./BatchDeleteFeaturedResultsSetCommand";
4
5
  export * from "./BatchGetDocumentStatusCommand";
5
6
  export * from "./BatchPutDocumentCommand";
6
7
  export * from "./ClearQuerySuggestionsCommand";
@@ -8,6 +9,7 @@ export * from "./CreateAccessControlConfigurationCommand";
8
9
  export * from "./CreateDataSourceCommand";
9
10
  export * from "./CreateExperienceCommand";
10
11
  export * from "./CreateFaqCommand";
12
+ export * from "./CreateFeaturedResultsSetCommand";
11
13
  export * from "./CreateIndexCommand";
12
14
  export * from "./CreateQuerySuggestionsBlockListCommand";
13
15
  export * from "./CreateThesaurusCommand";
@@ -23,6 +25,7 @@ export * from "./DescribeAccessControlConfigurationCommand";
23
25
  export * from "./DescribeDataSourceCommand";
24
26
  export * from "./DescribeExperienceCommand";
25
27
  export * from "./DescribeFaqCommand";
28
+ export * from "./DescribeFeaturedResultsSetCommand";
26
29
  export * from "./DescribeIndexCommand";
27
30
  export * from "./DescribePrincipalMappingCommand";
28
31
  export * from "./DescribeQuerySuggestionsBlockListCommand";
@@ -39,6 +42,7 @@ export * from "./ListEntityPersonasCommand";
39
42
  export * from "./ListExperienceEntitiesCommand";
40
43
  export * from "./ListExperiencesCommand";
41
44
  export * from "./ListFaqsCommand";
45
+ export * from "./ListFeaturedResultsSetsCommand";
42
46
  export * from "./ListGroupsOlderThanOrderingIdCommand";
43
47
  export * from "./ListIndicesCommand";
44
48
  export * from "./ListQuerySuggestionsBlockListsCommand";
@@ -54,6 +58,7 @@ export * from "./UntagResourceCommand";
54
58
  export * from "./UpdateAccessControlConfigurationCommand";
55
59
  export * from "./UpdateDataSourceCommand";
56
60
  export * from "./UpdateExperienceCommand";
61
+ export * from "./UpdateFeaturedResultsSetCommand";
57
62
  export * from "./UpdateIndexCommand";
58
63
  export * from "./UpdateQuerySuggestionsBlockListCommand";
59
64
  export * from "./UpdateQuerySuggestionsConfigCommand";
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region: string;
15
+ Region?: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;